Record Class NexoriSetPlayerAfkRequest

java.lang.Object
java.lang.Record
io.github.hyjn.nexori.plugin.api.minigame.NexoriSetPlayerAfkRequest
Record Components:
matchId - Nexori local match id.
playerUuid - player whose AFK state should change.
afk - true to mark AFK; false to mark active.
reason - short public reason for diagnostics.
showHud - whether Nexori should show its AFK HUD when marking the player AFK.
public record NexoriSetPlayerAfkRequest(String matchId, UUID playerUuid, boolean afk, String reason, boolean showHud) extends Record
Request to set the AFK state of one player inside one active match.

Nexori maintains a single public AFK state per player. If Nexori's built-in detection is still enabled for the match, player input can continue to change that same state. Minigames that want full control over AFK detection should disable the built-in policy first via the runtime AFK policy APIs, then use this request to report AFK state from their own logic.

showHud controls whether the Nexori AFK HUD is shown to the player when afk=true. Set to false when the minigame handles its own AFK feedback and the Nexori overlay would be redundant or unwanted. Defaults to true.

  • Constructor Details

    • NexoriSetPlayerAfkRequest

      public NexoriSetPlayerAfkRequest(String matchId, UUID playerUuid, boolean afk, String reason)
      Convenience constructor — showHud defaults to true.

    • NexoriSetPlayerAfkRequest

      public NexoriSetPlayerAfkRequest(String matchId, UUID playerUuid, boolean afk, String reason, boolean showHud)
      Creates an instance of a NexoriSetPlayerAfkRequest record class.
      Parameters:
      matchId - the value for the matchId record component
      playerUuid - the value for the playerUuid record component
      afk - the value for the afk record component
      reason - the value for the reason record component
      showHud - the value for the showHud 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.

    • matchId

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

    • playerUuid

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

    • afk

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

    • reason

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

    • showHud

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