Record Class ArmatureEvent

java.lang.Object
java.lang.Record
net.ixdarklord.coolcatcanvas.api.client.armature.ArmatureEvent
Record Components:
effect - the sound or particle name, or the instruction's text
locator - the point a particle comes out of; null for the model's origin
time - when in the clip it happened, in seconds
public record ArmatureEvent(ArmatureEvent.Kind kind, String layer, String clip, String effect, @Nullable String locator, float time, ArmatureContext context) extends Record
Something a clip did at a keyframe: a Blockbench sound, particle or timeline keyframe, or a Bedrock sound_effects, particle_effects or timeline entry.

Sounds whose effect names a sound event ("minecraft:entity.wolf.growl") and particles whose effect names a simple particle type ("minecraft:flame") are played by CoolCatLib without any code; listeners get them as well, to do something else or more. An instruction's Molang (for example v.step = v.step + 1;) has already run when listeners get it.

  • Constructor Details

    • ArmatureEvent

      public ArmatureEvent(ArmatureEvent.Kind kind, String layer, String clip, String effect, @Nullable @Nullable String locator, float time, ArmatureContext context)
      Creates an instance of a ArmatureEvent record class.
      Parameters:
      kind - the value for the kind record component
      layer - the value for the layer record component
      clip - the value for the clip record component
      effect - the value for the effect record component
      locator - the value for the locator record component
      time - the value for the time record component
      context - the value for the context record component

  • Method Details

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

    • kind

      public ArmatureEvent.Kind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • layer

      public String layer()
      Returns the value of the layer record component.
      Returns:
      the value of the layer record component

    • clip

      public String clip()
      Returns the value of the clip record component.
      Returns:
      the value of the clip record component

    • effect

      public String effect()
      Returns the value of the effect record component.
      Returns:
      the value of the effect record component

    • locator

      @Nullable public @Nullable String locator()
      Returns the value of the locator record component.
      Returns:
      the value of the locator record component

    • time

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

    • context

      public ArmatureContext context()
      Returns the value of the context record component.
      Returns:
      the value of the context record component