Package com.viaversion.viaversion.api.minecraft.item.data

Record Class Equippable

java.lang.Object
java.lang.Record
com.viaversion.viaversion.api.minecraft.item.data.Equippable
All Implemented Interfaces:
Rewritable
public record Equippable(int equipmentSlot, Holder<SoundEvent> soundEvent, @Nullable String model, @Nullable String cameraOverlay, @Nullable HolderSet allowedEntities, boolean dispensable, boolean swappable, boolean damageOnHurt, boolean equipOnInteract) extends Record implements Rewritable

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Type<Equippable>
    TYPE1_21_2
     
    static final Type<Equippable>
    TYPE1_21_5
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Equippable(int equipmentSlot, Holder<SoundEvent> soundEvent, @Nullable String model, @Nullable String cameraOverlay, @Nullable HolderSet allowedEntities, boolean dispensable, boolean swappable, boolean damageOnHurt)
     
    Equippable(int equipmentSlot, Holder<SoundEvent> soundEvent, @Nullable String model, @Nullable String cameraOverlay, @Nullable HolderSet allowedEntities, boolean dispensable, boolean swappable, boolean damageOnHurt, boolean equipOnInteract)
    Creates an instance of a Equippable record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable HolderSet
    allowedEntities()
    Returns the value of the allowedEntities record component.
    @Nullable String
    cameraOverlay()
    Returns the value of the cameraOverlay record component.
    boolean
    damageOnHurt()
    Returns the value of the damageOnHurt record component.
    boolean
    dispensable()
    Returns the value of the dispensable record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    equipmentSlot()
    Returns the value of the equipmentSlot record component.
    boolean
    equipOnInteract()
    Returns the value of the equipOnInteract record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    @Nullable String
    model()
    Returns the value of the model record component.
    Equippable
    rewrite(UserConnection connection, Protocol<?,?,?,?> protocol, boolean clientbound)
    Rewrites the object to a different version, may return self or a new object.
    Holder<SoundEvent>
    soundEvent()
    Returns the value of the soundEvent record component.
    boolean
    swappable()
    Returns the value of the swappable 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

  • Field Details

  • Constructor Details

    • Equippable

      public Equippable(int equipmentSlot, Holder<SoundEvent> soundEvent, @Nullable String model, @Nullable String cameraOverlay, @Nullable HolderSet allowedEntities, boolean dispensable, boolean swappable, boolean damageOnHurt)

    • Equippable

      public Equippable(int equipmentSlot, Holder<SoundEvent> soundEvent, @Nullable String model, @Nullable String cameraOverlay, @Nullable HolderSet allowedEntities, boolean dispensable, boolean swappable, boolean damageOnHurt, boolean equipOnInteract)
      Creates an instance of a Equippable record class.
      Parameters:
      equipmentSlot - the value for the equipmentSlot record component
      soundEvent - the value for the soundEvent record component
      model - the value for the model record component
      cameraOverlay - the value for the cameraOverlay record component
      allowedEntities - the value for the allowedEntities record component
      dispensable - the value for the dispensable record component
      swappable - the value for the swappable record component
      damageOnHurt - the value for the damageOnHurt record component
      equipOnInteract - the value for the equipOnInteract record component

  • Method Details

    • rewrite

      public Equippable rewrite(UserConnection connection, Protocol<?,?,?,?> protocol, boolean clientbound)
      Description copied from interface: Rewritable
      Rewrites the object to a different version, may return self or a new object.
      Specified by:
      rewrite in interface Rewritable
      Parameters:
      connection - user connection
      protocol - protocol
      clientbound - whether it should be rewritten client- or serverbound
      Returns:
      rewritten object, may be (modified or unmodified) self or a new object

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

    • equipmentSlot

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

    • soundEvent

      public Holder<SoundEvent> soundEvent()
      Returns the value of the soundEvent record component.
      Returns:
      the value of the soundEvent record component

    • model

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

    • cameraOverlay

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

    • allowedEntities

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

    • dispensable

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

    • swappable

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

    • damageOnHurt

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

    • equipOnInteract

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