Record Class NativeUiToggle

java.lang.Object
java.lang.Record
com.viaversion.viafabricplus.bedrock.screen.ui.NativeUiToggle
public record NativeUiToggle(boolean radio, boolean defaultChecked, boolean directional, boolean toggleOnHover, int group, int onButton, int offButton, int forcedIndex, int defaultSelected) extends Record
Native toggle initialization and component events; the screen owns collection indices and radio traversal.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    NativeUiToggle.Change
     
    static final class 
    NativeUiToggle.State
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    NativeUiToggle(boolean radio, boolean defaultChecked, boolean directional, boolean toggleOnHover, int group, int onButton, int offButton, int forcedIndex, int defaultSelected)
    Creates an instance of a NativeUiToggle record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    defaultChecked()
    Returns the value of the defaultChecked record component.
    int
    defaultSelected()
    Returns the value of the defaultSelected record component.
    boolean
    directional()
    Returns the value of the directional record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    forcedIndex()
    Returns the value of the forcedIndex record component.
    int
    group()
    Returns the value of the group record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    index(int collectionIndex)
     
    boolean
    initialChecked(int collectionIndex)
     
    int
    offButton()
    Returns the value of the offButton record component.
    int
    onButton()
    Returns the value of the onButton record component.
    static NativeUiToggle
    parse(com.google.gson.JsonObject properties)
     
    boolean
    radio()
    Returns the value of the radio record component.
    boolean
    toggleOnHover()
    Returns the value of the toggleOnHover record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • NativeUiToggle

      public NativeUiToggle(boolean radio, boolean defaultChecked, boolean directional, boolean toggleOnHover, int group, int onButton, int offButton, int forcedIndex, int defaultSelected)
      Creates an instance of a NativeUiToggle record class.
      Parameters:
      radio - the value for the radio record component
      defaultChecked - the value for the defaultChecked record component
      directional - the value for the directional record component
      toggleOnHover - the value for the toggleOnHover record component
      group - the value for the group record component
      onButton - the value for the onButton record component
      offButton - the value for the offButton record component
      forcedIndex - the value for the forcedIndex record component
      defaultSelected - the value for the defaultSelected record component

  • Method Details

    • parse

      public static NativeUiToggle parse(com.google.gson.JsonObject properties)

    • index

      public int index(int collectionIndex)

    • initialChecked

      public boolean initialChecked(int collectionIndex)

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

    • radio

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

    • defaultChecked

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

    • directional

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

    • toggleOnHover

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

    • group

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

    • onButton

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

    • offButton

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

    • forcedIndex

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

    • defaultSelected

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