Record Class NexoriActiveMatchInfo

java.lang.Object
java.lang.Record
io.github.hyjn.nexori.plugin.api.minigame.NexoriActiveMatchInfo
Record Components:
matchId - Nexori's local match id.
queueId - queue id that produced the match, when known.
arenaId - arena id that owns the match, when known.
assignmentId - backend assignment id or local assignment id, when known.
externalMatchId - backend match id, when this match came from a backend assignment.
rulesEngineId - rules engine id that should control gameplay for this match.
matchResolutionTriggerId - legacy compatibility field; use rulesEngineId instead.
expectedPlayerUuids - players Nexori expected during the initial placement phase.
arrivedPlayerUuids - players that reached the arena runtime.
activePlayerUuids - players currently considered active in the match runtime.
eliminatedPlayerUuids - players no longer active because Nexori recorded an outcome.
spectatorPlayerUuids - players marked as logical spectators.
afkPlayerUuids - players currently marked AFK by Nexori's local AFK runtime state.
requiredResultPlayerUuids - official player set that must have outcomes before final result submission.
playerOutcomes - outcome state currently stored by rules mod calls.
expectedPlayerCount - expected initial player count.
completedAtEpochMs - completion timestamp, or 0 while incomplete.
resultSubmittedAtEpochMs - final result submission timestamp, or 0 before submission.
public record NexoriActiveMatchInfo(String matchId, String queueId, String arenaId, String assignmentId, String externalMatchId, String rulesEngineId, String matchResolutionTriggerId, List<UUID> expectedPlayerUuids, List<UUID> arrivedPlayerUuids, List<UUID> activePlayerUuids, List<UUID> eliminatedPlayerUuids, List<UUID> spectatorPlayerUuids, List<UUID> afkPlayerUuids, List<UUID> requiredResultPlayerUuids, List<NexoriPlayerOutcomeState> playerOutcomes, int expectedPlayerCount, long completedAtEpochMs, long resultSubmittedAtEpochMs) extends Record
Public runtime snapshot for one Nexori-managed match.

Use this as a read-only view of the match state Nexori exposes to a rules mod. Lists are normalized by Nexori and should not be mutated by callers.

  • Constructor Details

  • Method Details

    • matchResolutionTriggerId

      @Deprecated(forRemoval=true) public String matchResolutionTriggerId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Legacy field kept only for compatibility.

      Nexori no longer supports built-in match resolution triggers. The legacy value "none" is kept only for older mods that treated it as manual/external resolution. Use rulesEngineId() to identify the external minigame/rules engine. External minigames should resolve matches through the public API. This member will be removed in a future API cleanup.

      Returns:
      the legacy trigger id, normally "none" for compatibility.

    • 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

    • queueId

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

    • arenaId

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

    • assignmentId

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

    • externalMatchId

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

    • rulesEngineId

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

    • expectedPlayerUuids

      public List<UUID> expectedPlayerUuids()
      Returns the value of the expectedPlayerUuids record component.
      Returns:
      the value of the expectedPlayerUuids record component

    • arrivedPlayerUuids

      public List<UUID> arrivedPlayerUuids()
      Returns the value of the arrivedPlayerUuids record component.
      Returns:
      the value of the arrivedPlayerUuids record component

    • activePlayerUuids

      public List<UUID> activePlayerUuids()
      Returns the value of the activePlayerUuids record component.
      Returns:
      the value of the activePlayerUuids record component

    • eliminatedPlayerUuids

      public List<UUID> eliminatedPlayerUuids()
      Returns the value of the eliminatedPlayerUuids record component.
      Returns:
      the value of the eliminatedPlayerUuids record component

    • spectatorPlayerUuids

      public List<UUID> spectatorPlayerUuids()
      Returns the value of the spectatorPlayerUuids record component.
      Returns:
      the value of the spectatorPlayerUuids record component

    • afkPlayerUuids

      public List<UUID> afkPlayerUuids()
      Returns the value of the afkPlayerUuids record component.
      Returns:
      the value of the afkPlayerUuids record component

    • requiredResultPlayerUuids

      public List<UUID> requiredResultPlayerUuids()
      Returns the value of the requiredResultPlayerUuids record component.
      Returns:
      the value of the requiredResultPlayerUuids record component

    • playerOutcomes

      public List<NexoriPlayerOutcomeState> playerOutcomes()
      Returns the value of the playerOutcomes record component.
      Returns:
      the value of the playerOutcomes record component

    • expectedPlayerCount

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

    • completedAtEpochMs

      public long completedAtEpochMs()
      Returns the value of the completedAtEpochMs record component.
      Returns:
      the value of the completedAtEpochMs record component

    • resultSubmittedAtEpochMs

      public long resultSubmittedAtEpochMs()
      Returns the value of the resultSubmittedAtEpochMs record component.
      Returns:
      the value of the resultSubmittedAtEpochMs record component