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

Record Class FireworkExplosion

java.lang.Object
java.lang.Record
com.viaversion.viaversion.api.minecraft.item.data.FireworkExplosion
All Implemented Interfaces:
Copyable
public record FireworkExplosion(int shape, int[] colors, int[] fadeColors, boolean hasTrail, boolean hasTwinkle) extends Record implements Copyable

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Type<FireworkExplosion[]>
    ARRAY_TYPE
     
    static final String[]
    SHAPES
     
    static final Type<FireworkExplosion>
    TYPE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    FireworkExplosion(int shape, int[] colors, int[] fadeColors, boolean hasTrail, boolean hasTwinkle)
    Creates an instance of a FireworkExplosion record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int[]
    colors()
    Returns the value of the colors record component.
    FireworkExplosion
    copy()
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int[]
    fadeColors()
    Returns the value of the fadeColors record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    hasTrail()
    Returns the value of the hasTrail record component.
    boolean
    hasTwinkle()
    Returns the value of the hasTwinkle record component.
    int
    shape()
    Returns the value of the shape 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

    • FireworkExplosion

      public FireworkExplosion(int shape, int[] colors, int[] fadeColors, boolean hasTrail, boolean hasTwinkle)
      Creates an instance of a FireworkExplosion record class.
      Parameters:
      shape - the value for the shape record component
      colors - the value for the colors record component
      fadeColors - the value for the fadeColors record component
      hasTrail - the value for the hasTrail record component
      hasTwinkle - the value for the hasTwinkle record component

  • Method Details

    • copy

      public FireworkExplosion copy()
      Specified by:
      copy in interface Copyable

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

    • shape

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

    • colors

      public int[] colors()
      Returns the value of the colors record component.
      Returns:
      the value of the colors record component

    • fadeColors

      public int[] fadeColors()
      Returns the value of the fadeColors record component.
      Returns:
      the value of the fadeColors record component

    • hasTrail

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

    • hasTwinkle

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