Record Class SignalTag

java.lang.Object
java.lang.Record
com.hypixel.hytale.builtin.triggervolumes.effect.SignalTag
public record SignalTag(@Nonnull String key, @Nullable String value) extends Record
A single key/value tag carried by a signal event. A signal may carry several of these so receivers can filter on more than one key (see TagCondition with Source: EVENT). A blank value is normalized to null, which a TagCondition treats as "matches any value for this key".

  • Constructor Summary

    Constructors
    Constructor
    Description
    SignalTag(String key, String value)
    Creates an instance of a SignalTag 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
    key()
    Returns the value of the key record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    value()
    Returns the value of the value record component.
    static List<SignalTag>
    zip(String[] keys, String[] values)
    Builds a tag list from index-aligned key/value arrays (the editor-friendly representation).

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SignalTag

      public SignalTag(@Nonnull String key, @Nullable String value)
      Creates an instance of a SignalTag record class.
      Parameters:
      key - the value for the key record component
      value - the value for the value record component

  • Method Details

    • zip

      @Nonnull public static List<SignalTag> zip(@Nullable String[] keys, @Nullable String[] values)
      Builds a tag list from index-aligned key/value arrays (the editor-friendly representation). Keys that are null or blank are skipped; a missing or blank value yields a null value.

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

    • key

      @Nonnull public String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • value

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