Record Class GhostState

java.lang.Object
java.lang.Record
com.iantapply.conflux.api.GhostState
Record Components:
playerId - unique identifier of the remote player
username - current Minecraft username of the remote player
world - name of the world containing the remote player
x - world x-coordinate
y - world y-coordinate
z - world z-coordinate
yaw - horizontal rotation in degrees
pitch - vertical rotation in degrees
onGround - whether the player is touching the ground
sneaking - whether the player is sneaking
sprinting - whether the player is sprinting
swimming - whether the player is swimming
gliding - whether the player is gliding with an elytra
skinValue - signed profile texture value, or an empty string
skinSignature - profile texture signature, or an empty string
equipment - equipment worn or held by the player
public record GhostState(UUID playerId, String username, String world, double x, double y, double z, float yaw, float pitch, boolean onGround, boolean sneaking, boolean sprinting, boolean swimming, boolean gliding, String skinValue, String skinSignature, GhostEquipment equipment) extends Record
One remote player's visual state at a point in time.

  • Constructor Details

    • GhostState

      public GhostState(UUID playerId, String username, String world, double x, double y, double z, float yaw, float pitch, boolean onGround, boolean sneaking, boolean sprinting, boolean swimming, boolean gliding, String skinValue, String skinSignature, GhostEquipment equipment)
      Validates and creates a player ghost state.

  • Method Details

    • movement

      public GhostMovement movement()
      Returns the frequently changing portion of this full snapshot.
      Returns:
      movement portion

    • appearance

      public GhostAppearance appearance()
      Returns the infrequently changing portion of this full snapshot.
      Returns:
      appearance portion

    • combine

      public static GhostState combine(GhostMovement movement, GhostAppearance appearance)
      Combines movement and appearance state into a renderable full snapshot.
      Parameters:
      movement - movement portion
      appearance - appearance portion for the same player
      Returns:
      combined renderable snapshot

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

    • playerId

      public UUID playerId()
      Returns the value of the playerId record component.
      Returns:
      the value of the playerId record component

    • username

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

    • world

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

    • x

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

    • y

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

    • z

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

    • yaw

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

    • pitch

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

    • onGround

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

    • sneaking

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

    • sprinting

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

    • swimming

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

    • gliding

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

    • skinValue

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

    • skinSignature

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

    • equipment

      public GhostEquipment equipment()
      Returns the value of the equipment record component.
      Returns:
      the value of the equipment record component