Record Class SwingAnimation

java.lang.Object

java.lang.Record

fr.fidorial.item.component.SwingAnimation

Record Components:

type - the kind of swing to play

duration - how long the animation runs, in ticks

public record SwingAnimation(SwingAnimation.SwingAnimationType type, int duration)
extends Record

The animation played when an item is used to attack or interact with something, able to be specified using minecraft:attack_animation and minecraft:interact_animation.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SwingAnimation.SwingAnimationType	The kind of swing an item's attack or interact animation plays.

Field Summary

Fields

Modifier and Type	Field	Description
static final SwingAnimation	DEFAULT

Constructor Summary

Constructors

Constructor	Description
SwingAnimation(SwingAnimation.SwingAnimationType type, int duration)	Creates an instance of a SwingAnimation record class.

Method Summary

Modifier and Type	Method	Description
int	duration()	Returns the value of the duration record component.
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.
final String	toString()	Returns a string representation of this record class.
SwingAnimation.SwingAnimationType	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Field Details

DEFAULT

public static final SwingAnimation DEFAULT

Constructor Details

SwingAnimation

public SwingAnimation(SwingAnimation.SwingAnimationType type,
 int duration)

Creates an instance of a SwingAnimation record class.

Parameters:

type - the value for the type record component

duration - the value for the duration record component

Method Details

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

type

public SwingAnimation.SwingAnimationType type()

Returns the value of the type record component.

Returns:

the value of the type record component

duration

public int duration()

Returns the value of the duration record component.

Returns:

the value of the duration record component