Package dev.twilite.game.simulation.model

Record Class MoveSpeed

java.lang.Object
java.lang.Record
dev.twilite.game.simulation.model.MoveSpeed
Record Components:
stepsPerTick - number of movement steps that can be completed per game tick
public record MoveSpeed(double stepsPerTick) extends Record
Movement rate used by a simulation expansion.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final MoveSpeed
    CRAWLING
    Crawling movement, one step every two ticks.
    static final MoveSpeed
    RUNNING
    Running movement, two steps per tick.
    static final MoveSpeed
    WALKING
    Walking movement, one step per tick.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MoveSpeed(double stepsPerTick)
    Creates an instance of a MoveSpeed record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    maxSteps(int maxTicks)
    Returns how many movement steps can be considered inside a maximum tick window.
    double
    stepsPerTick()
    Returns the value of the stepsPerTick record component.
    int
    tickForStep(int steps)
    Returns the game tick when a path length has been reached.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • CRAWLING

      public static final MoveSpeed CRAWLING
      Crawling movement, one step every two ticks.

    • WALKING

      public static final MoveSpeed WALKING
      Walking movement, one step per tick.

    • RUNNING

      public static final MoveSpeed RUNNING
      Running movement, two steps per tick.

  • Constructor Details

    • MoveSpeed

      public MoveSpeed(double stepsPerTick)
      Creates an instance of a MoveSpeed record class.
      Parameters:
      stepsPerTick - the value for the stepsPerTick record component

  • Method Details

    • maxSteps

      public int maxSteps(int maxTicks)
      Returns how many movement steps can be considered inside a maximum tick window.
      Parameters:
      maxTicks - maximum number of ticks to simulate

    • tickForStep

      public int tickForStep(int steps)
      Returns the game tick when a path length has been reached.
      Parameters:
      steps - movement steps from the starting coordinate

    • 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. All components in this record class 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.

    • stepsPerTick

      public double stepsPerTick()
      Returns the value of the stepsPerTick record component.
      Returns:
      the value of the stepsPerTick record component