Package com.btcvelocity.api.bridge

Record Class BridgeMessage.WorldPreload

java.lang.Object
java.lang.Record
com.btcvelocity.api.bridge.BridgeMessage.WorldPreload
Record Components:
serverName - the name of the destination server
worldName - the world to preload, or null if the default world should be used
All Implemented Interfaces:
BridgeMessage
Enclosing interface:
BridgeMessage
public static record BridgeMessage.WorldPreload(String serverName, @Nullable String worldName) extends Record implements BridgeMessage
Proxy -> Backend: a player is about to be transferred, preload the given world.

  • Constructor Details

    • WorldPreload

      public WorldPreload(String serverName, @Nullable @Nullable String worldName)
      Creates an instance of a WorldPreload record class.
      Parameters:
      serverName - the value for the serverName record component
      worldName - the value for the worldName record component

  • Method Details

    • type

      public String type()
      Description copied from interface: BridgeMessage
      Returns the string discriminator used to route this message during (de)serialization.
      Specified by:
      type in interface BridgeMessage
      Returns:
      the message type identifier

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

    • serverName

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

    • worldName

      @Nullable public @Nullable String worldName()
      Returns the value of the worldName record component.
      Returns:
      the value of the worldName record component