Package kr.toxicity.model.api.data.blueprint

Record Class BlueprintAnimation

java.lang.Object
java.lang.Record
kr.toxicity.model.api.data.blueprint.BlueprintAnimation
Record Components:
name - the name of the animation
loop - the default loop mode
length - the length of the animation in seconds
override - whether this animation overrides others
animator - a map of animators for each bone
script - the script associated with this animation, if any
emptyAnimator - a list of empty movements, used as a fallback or for initialization
public record BlueprintAnimation(@NotNull String name, AnimationIterator.Type loop, float length, boolean override, @NotNull @Unmodifiable Map<BoneName,BlueprintAnimator> animator, @Nullable BlueprintScript script, @NotNull TimedStorage<AnimationProgress> emptyAnimator) extends Record
Represents a complete, processed animation for a model.

This record contains all the necessary data to play an animation, including keyframes for each bone, loop settings, and associated scripts.

Since:
1.15.2

  • Constructor Details

    • BlueprintAnimation

      public BlueprintAnimation(@NotNull @NotNull String name, @NotNull AnimationIterator.Type loop, float length, boolean override, @NotNull @NotNull @Unmodifiable Map<BoneName,BlueprintAnimator> animator, @Nullable @Nullable BlueprintScript script, @NotNull @NotNull TimedStorage<AnimationProgress> emptyAnimator)
      Creates an instance of a BlueprintAnimation record class.
      Parameters:
      name - the value for the name record component
      loop - the value for the loop record component
      length - the value for the length record component
      override - the value for the override record component
      animator - the value for the animator record component
      script - the value for the script record component
      emptyAnimator - the value for the emptyAnimator record component

  • Method Details

    • script

      @Nullable public @Nullable BlueprintScript script(@NotNull @NotNull AnimationModifier modifier)
      Retrieves the script for this animation, considering the provided modifier.

      If the modifier overrides the animation or specifies a player, the script may be suppressed.

      Parameters:
      modifier - the animation modifier
      Returns:
      the script, or null if suppressed
      Since:
      1.15.2

    • emptyIterator

      @NotNull public @NotNull AnimationIterator<AnimationProgress> emptyIterator(@NotNull AnimationIterator.Type type)
      Creates an iterator for the empty animation sequence.
      Parameters:
      type - the loop type
      Returns:
      an animation iterator
      Since:
      1.15.2

    • 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 '=='.
      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

    • loop

      @NotNull public AnimationIterator.Type loop()
      Returns the value of the loop record component.
      Returns:
      the value of the loop record component

    • length

      public float length()
      Returns the value of the length record component.
      Returns:
      the value of the length record component

    • override

      public boolean override()
      Returns the value of the override record component.
      Returns:
      the value of the override record component

    • animator

      @NotNull public @NotNull @Unmodifiable Map<BoneName,BlueprintAnimator> animator()
      Returns the value of the animator record component.
      Returns:
      the value of the animator record component

    • script

      @Nullable public @Nullable BlueprintScript script()
      Returns the value of the script record component.
      Returns:
      the value of the script record component

    • emptyAnimator

      @NotNull public @NotNull TimedStorage<AnimationProgress> emptyAnimator()
      Returns the value of the emptyAnimator record component.
      Returns:
      the value of the emptyAnimator record component