Record Class BlueprintScript

java.lang.Object

java.lang.Record

kr.toxicity.model.api.script.BlueprintScript

Record Components:

name - script name

type - type

length - playtime

scripts - scripts

@Internal
public record BlueprintScript(@NotNull String name, AnimationIterator.Type type, float length, @NotNull List<TimeScript> scripts)
extends Record

A script data of blueprint.

Constructor Summary

Constructors

Constructor	Description
BlueprintScript(@NotNull String name, AnimationIterator.Type type, float length, @NotNull List<TimeScript> scripts)	Creates an instance of a BlueprintScript record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static @NotNull BlueprintScript	fromEmpty(@NotNull ModelAnimation animation)	Creates empty script
final int	hashCode()	Returns a hash code value for this object.
@NotNull AnimationIterator<TimeScript>	iterator(@NotNull AnimationModifier modifier)	Creates animation iterator of this script
float	length()	Returns the value of the length record component.
@NotNull String	name()	Returns the value of the name record component.
@NotNull List<TimeScript>	scripts()	Returns the value of the scripts record component.
final String	toString()	Returns a string representation of this record class.
AnimationIterator.Type	type()	Returns the value of the type record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BlueprintScript

public BlueprintScript(@NotNull
 @NotNull String name,
 @NotNull
 AnimationIterator.Type type,
 float length,
 @NotNull
 @NotNull List<TimeScript> scripts)

Creates an instance of a BlueprintScript record class.

Parameters:

name - the value for the name record component

type - the value for the type record component

length - the value for the length record component

scripts - the value for the scripts record component

Method Details

fromEmpty

@NotNull
public static @NotNull BlueprintScript fromEmpty(@NotNull
 @NotNull ModelAnimation animation)

Creates empty script

Parameters:

animation - animation

Returns:

empty script

iterator

@NotNull
public @NotNull AnimationIterator<TimeScript> iterator(@NotNull
 @NotNull AnimationModifier modifier)

Creates animation iterator of this script

Parameters:

modifier - modifier

Returns:

animation iterator

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

@NotNull
public @NotNull String name()

Returns the value of the name record component.

Returns:

the value of the name record component

type

@NotNull
public AnimationIterator.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

length

public float length()

Returns the value of the length record component.

Returns:

the value of the length record component

scripts

@NotNull
public @NotNull List<TimeScript> scripts()

Returns the value of the scripts record component.

Returns:

the value of the scripts record component