Record Class PlayerInput

java.lang.Object
java.lang.Record
fr.fidorial.entity.player.PlayerInput
Record Components:
forward - the forward key
backward - the backward key
left - the strafe left key
right - the strafe right key
jump - the jump key
sneak - the sneak key
sprint - the sprint key
public record PlayerInput(boolean forward, boolean backward, boolean left, boolean right, boolean jump, boolean sneak, boolean sprint) extends Record
The movement keys a player is holding, as their client reports them.

The client sends this state whether or not the player can actually move, so it also works as a plain keyboard reader while movement is blocked.

Since:
0.1.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final PlayerInput
    NONE
    No key held.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlayerInput(boolean forward, boolean backward, boolean left, boolean right, boolean jump, boolean sneak, boolean sprint)
    Creates an instance of a PlayerInput record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    backward()
    Returns the value of the backward record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    forward()
    Returns the value of the forward record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    jump()
    Returns the value of the jump record component.
    boolean
    left()
    Returns the value of the left record component.
    boolean
    right()
    Returns the value of the right record component.
    boolean
    sneak()
    Returns the value of the sneak record component.
    boolean
    sprint()
    Returns the value of the sprint record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Field Details

    • NONE

      public static final PlayerInput NONE
      No key held.

  • Constructor Details

    • PlayerInput

      public PlayerInput(boolean forward, boolean backward, boolean left, boolean right, boolean jump, boolean sneak, boolean sprint)
      Creates an instance of a PlayerInput record class.
      Parameters:
      forward - the value for the forward record component
      backward - the value for the backward record component
      left - the value for the left record component
      right - the value for the right record component
      jump - the value for the jump record component
      sneak - the value for the sneak record component
      sprint - the value for the sprint 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. All components in this record class 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.

    • forward

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

    • backward

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

    • left

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

    • right

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

    • jump

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

    • sneak

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

    • sprint

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