Package cloud.spawnery.agent.api

Record Class ConnectResult

java.lang.Object
java.lang.Record
cloud.spawnery.agent.api.ConnectResult
Record Components:
alreadyThere - the one case where nothing was ordered and nothing is wrong: the player was on target when the request arrived.
public record ConnectResult(boolean ordered, boolean alreadyThere, String target) extends Record
What the operator did with a SpawneryApi.connect(java.util.UUID, cloud.spawnery.agent.api.Target) call.

ordered is not moved. The proxy that carries a move does not wait for the connection to finish, so nothing can report whether a player arrived. ordered says the instruction reached a proxy holding the player; to know they arrived, read SpawneryApi.player(java.util.UUID) a moment later.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConnectResult(boolean ordered, boolean alreadyThere, String target)
    Creates an instance of a ConnectResult record class.

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConnectResult

      public ConnectResult(boolean ordered, boolean alreadyThere, String target)
      Creates an instance of a ConnectResult record class.
      Parameters:
      ordered - the value for the ordered record component
      alreadyThere - the value for the alreadyThere record component
      target - the value for the target 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 '=='.
      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.

    • ordered

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

    • alreadyThere

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

    • target

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