Record Class SequenceType

java.lang.Object
java.lang.Record
com.botwithus.bot.api.model.SequenceType
Record Components:
id - the sequence type ID
frameCount - the total number of frames
frameLengths - the duration of each frame
loopOffset - the frame offset to loop from, or -1 for no looping
priority - the animation priority
offHand - the off-hand weapon override, or -1 for none
mainHand - the main-hand weapon override, or -1 for none
maxLoops - the maximum number of loops, or 0 for unlimited
animatingPrecedence - the precedence when already animating
walkingPrecedence - the precedence when walking
replayMode - the replay mode
tweened - whether the animation uses tweening between frames
params - additional key-value parameters from the sequence definition
public record SequenceType(int id, int frameCount, List<Integer> frameLengths, int loopOffset, int priority, int offHand, int mainHand, int maxLoops, int animatingPrecedence, int walkingPrecedence, int replayMode, boolean tweened, Map<String,Object> params) extends Record
Animation sequence definition from the game cache.
See Also:

  • Constructor Details

    • SequenceType

      public SequenceType(int id, int frameCount, List<Integer> frameLengths, int loopOffset, int priority, int offHand, int mainHand, int maxLoops, int animatingPrecedence, int walkingPrecedence, int replayMode, boolean tweened, Map<String,Object> params)
      Creates an instance of a SequenceType record class.
      Parameters:
      id - the value for the id record component
      frameCount - the value for the frameCount record component
      frameLengths - the value for the frameLengths record component
      loopOffset - the value for the loopOffset record component
      priority - the value for the priority record component
      offHand - the value for the offHand record component
      mainHand - the value for the mainHand record component
      maxLoops - the value for the maxLoops record component
      animatingPrecedence - the value for the animatingPrecedence record component
      walkingPrecedence - the value for the walkingPrecedence record component
      replayMode - the value for the replayMode record component
      tweened - the value for the tweened record component
      params - the value for the params 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.

    • id

      public int id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • frameCount

      public int frameCount()
      Returns the value of the frameCount record component.
      Returns:
      the value of the frameCount record component

    • frameLengths

      public List<Integer> frameLengths()
      Returns the value of the frameLengths record component.
      Returns:
      the value of the frameLengths record component

    • loopOffset

      public int loopOffset()
      Returns the value of the loopOffset record component.
      Returns:
      the value of the loopOffset record component

    • priority

      public int priority()
      Returns the value of the priority record component.
      Returns:
      the value of the priority record component

    • offHand

      public int offHand()
      Returns the value of the offHand record component.
      Returns:
      the value of the offHand record component

    • mainHand

      public int mainHand()
      Returns the value of the mainHand record component.
      Returns:
      the value of the mainHand record component

    • maxLoops

      public int maxLoops()
      Returns the value of the maxLoops record component.
      Returns:
      the value of the maxLoops record component

    • animatingPrecedence

      public int animatingPrecedence()
      Returns the value of the animatingPrecedence record component.
      Returns:
      the value of the animatingPrecedence record component

    • walkingPrecedence

      public int walkingPrecedence()
      Returns the value of the walkingPrecedence record component.
      Returns:
      the value of the walkingPrecedence record component

    • replayMode

      public int replayMode()
      Returns the value of the replayMode record component.
      Returns:
      the value of the replayMode record component

    • tweened

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

    • params

      public Map<String,Object> params()
      Returns the value of the params record component.
      Returns:
      the value of the params record component