Record Class DustTransitionParticle

java.lang.Object

java.lang.Record

dev.wyck.wrapper.environment.particle.options.DustTransitionParticle

Record Components:

fromColor - The color of the dust.

toColor - The color of the dust.

scale - The scale of the dust.

All Implemented Interfaces:

ParticleData

@NullMarked
@AsOf("2.0.0")
public record DustTransitionParticle(int fromColor, int toColor, float scale)
extends Record
implements ParticleData

Particle data for dust transition particles.

Since:

2.0.0

Constructor Summary

Constructors

Constructor	Description
DustTransitionParticle(int fromColor, int toColor, float scale)	Creates an instance of a DustTransitionParticle record class.

Method Summary

Modifier and Type	Method	Description
ParticleOptions	apply(ParticleType particleType)	Applies the particle data to the given particle type and returns the corresponding ParticleOptions.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	fromColor()	Returns the value of the fromColor record component.
final int	hashCode()	Returns a hash code value for this object.
static DustTransitionParticle	of(String fromHexColor, String toHexColor)
static DustTransitionParticle	of(String fromHexColor, String toHexColor, float scale)
float	scale()	Returns the value of the scale record component.
int	toColor()	Returns the value of the toColor 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

DustTransitionParticle

public DustTransitionParticle(int fromColor,
 int toColor,
 float scale)

Creates an instance of a DustTransitionParticle record class.

Parameters:

fromColor - the value for the fromColor record component

toColor - the value for the toColor record component

scale - the value for the scale record component

Method Details

apply

@AsOf("2.0.0")
public ParticleOptions apply(ParticleType particleType)

Description copied from interface: ParticleData

Applies the particle data to the given particle type and returns the corresponding ParticleOptions.

Specified by:

apply in interface ParticleData

Parameters:

particleType - The particle type to which the data will be applied.

Returns:

The ParticleOptions representing the applied particle data.

of

@AsOf("2.0.0")
public static DustTransitionParticle of(String fromHexColor,
 String toHexColor,
 float scale)

of

@AsOf("2.0.0")
public static DustTransitionParticle of(String fromHexColor,
 String toHexColor)

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.

fromColor

public int fromColor()

Returns the value of the fromColor record component.

Returns:

the value of the fromColor record component

toColor

public int toColor()

Returns the value of the toColor record component.

Returns:

the value of the toColor record component

scale

public float scale()

Returns the value of the scale record component.

Returns:

the value of the scale record component