Package org.geysermc.geyser.pack.option

Record Class GeyserSubpackOption

java.lang.Object
java.lang.Record
org.geysermc.geyser.pack.option.GeyserSubpackOption
All Implemented Interfaces:
org.geysermc.geyser.api.pack.option.ResourcePackOption<String>, org.geysermc.geyser.api.pack.option.SubpackOption
public record GeyserSubpackOption(String subpackName) extends Record implements org.geysermc.geyser.api.pack.option.SubpackOption
Can be used to specify which subpack from a resource pack a player should load. Available subpacks can be seen in a resource pack manifest ResourcePackManifest.subpacks()

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.geysermc.geyser.api.pack.option.ResourcePackOption

    org.geysermc.geyser.api.pack.option.ResourcePackOption.Type

  • Constructor Summary

    Constructors
    Constructor
    Description
    GeyserSubpackOption(String subpackName)
    Creates an instance of a GeyserSubpackOption record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    String
    subpackName()
    Returns the value of the subpackName record component.
    final String
    toString()
    Returns a string representation of this record class.
    @NonNull org.geysermc.geyser.api.pack.option.ResourcePackOption.Type
    type()
     
    void
    validate(@NonNull org.geysermc.geyser.api.pack.ResourcePack pack)
     
    @NonNull String
    value()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GeyserSubpackOption

      public GeyserSubpackOption(String subpackName)
      Creates an instance of a GeyserSubpackOption record class.
      Parameters:
      subpackName - the value for the subpackName record component

  • Method Details

    • type

      public @NonNull org.geysermc.geyser.api.pack.option.ResourcePackOption.Type type()
      Specified by:
      type in interface org.geysermc.geyser.api.pack.option.ResourcePackOption<String>

    • value

      public @NonNull String value()
      Specified by:
      value in interface org.geysermc.geyser.api.pack.option.ResourcePackOption<String>

    • validate

      public void validate(@NonNull org.geysermc.geyser.api.pack.ResourcePack pack)
      Specified by:
      validate in interface org.geysermc.geyser.api.pack.option.ResourcePackOption<String>

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

    • subpackName

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