Package net.minestom.server.item.firework

Record Class FireworkEffect

java.lang.Object
java.lang.Record
net.minestom.server.item.firework.FireworkEffect
public record FireworkEffect(boolean flicker, boolean trail, @NotNull FireworkEffectType type, @NotNull List<Color> colors, @NotNull List<Color> fadeColors) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    FireworkEffect(boolean flicker, boolean trail, @NotNull FireworkEffectType type, @NotNull List<Color> colors, @NotNull List<Color> fadeColors)
    Creates an instance of a FireworkEffect record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound
    asCompound()
    Retrieves the FireworkEffect as a NBTCompound.
    @NotNull List<Color>
    colors()
    Returns the value of the colors record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull List<Color>
    fadeColors()
    Returns the value of the fadeColors record component.
    boolean
    flicker()
    Returns the value of the flicker record component.
    static @NotNull FireworkEffect
    fromCompound(@NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
    Retrieves a firework effect from the given compound.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    trail()
    Returns the value of the trail record component.
    @NotNull FireworkEffectType
    type()
    Returns the value of the type record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FireworkEffect

      public FireworkEffect(boolean flicker, boolean trail, @NotNull @NotNull FireworkEffectType type, @NotNull @NotNull List<Color> colors, @NotNull @NotNull List<Color> fadeColors)
      Creates an instance of a FireworkEffect record class.
      Parameters:
      flicker - the value for the flicker record component
      trail - the value for the trail record component
      type - the value for the type record component
      colors - the value for the colors record component
      fadeColors - the value for the fadeColors record component

  • Method Details

    • fromCompound

      @NotNull public static @NotNull FireworkEffect fromCompound(@NotNull @NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
      Retrieves a firework effect from the given compound.
      Parameters:
      compound - The NBT connection, which should be a fireworks effect.
      Returns:
      A new created firework effect.

    • asCompound

      @NotNull public @NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound asCompound()
      Retrieves the FireworkEffect as a NBTCompound.
      Returns:
      The firework effect as a nbt compound.

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

    • flicker

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

    • trail

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

    • type

      @NotNull public @NotNull FireworkEffectType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • colors

      @NotNull public @NotNull List<Color> colors()
      Returns the value of the colors record component.
      Returns:
      the value of the colors record component

    • fadeColors

      @NotNull public @NotNull List<Color> fadeColors()
      Returns the value of the fadeColors record component.
      Returns:
      the value of the fadeColors record component