Record Class NexoriMatchResultRequirements

java.lang.Object
java.lang.Record
io.github.hyjn.nexori.plugin.api.minigame.NexoriMatchResultRequirements
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.
requiredPlayerUuids - official players that require a final outcome.
expectedPlayerUuids - players Nexori expected during initial placement.
arrivedPlayerUuids - players that reached the arena runtime.
activePlayerUuids - players currently considered active in the match runtime.
eliminatedPlayerUuids - players with a stored non-active outcome.
public record NexoriMatchResultRequirements(String matchId, String queueId, String arenaId, List<UUID> requiredPlayerUuids, List<UUID> expectedPlayerUuids, List<UUID> arrivedPlayerUuids, List<UUID> activePlayerUuids, List<UUID> eliminatedPlayerUuids) extends Record
Official result requirement set for one active match.

requiredPlayerUuids() is the source of truth for final outcomes. A rules mod may keep its own gameplay participant list, but before submitting the final result it should build outcomes from this set or validate its local list against it.

  • Constructor Details

    • NexoriMatchResultRequirements

      public NexoriMatchResultRequirements(String matchId, String queueId, String arenaId, List<UUID> requiredPlayerUuids, List<UUID> expectedPlayerUuids, List<UUID> arrivedPlayerUuids, List<UUID> activePlayerUuids, List<UUID> eliminatedPlayerUuids)
      Creates an instance of a NexoriMatchResultRequirements record class.
      Parameters:
      matchId - the value for the matchId record component
      queueId - the value for the queueId record component
      arenaId - the value for the arenaId record component
      requiredPlayerUuids - the value for the requiredPlayerUuids record component
      expectedPlayerUuids - the value for the expectedPlayerUuids record component
      arrivedPlayerUuids - the value for the arrivedPlayerUuids record component
      activePlayerUuids - the value for the activePlayerUuids record component
      eliminatedPlayerUuids - the value for the eliminatedPlayerUuids 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 Objects::equals(Object,Object).
      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

    • requiredPlayerUuids

      public List<UUID> requiredPlayerUuids()
      Returns the value of the requiredPlayerUuids record component.
      Returns:
      the value of the requiredPlayerUuids 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