Record Class Cutscene.Subtitle

java.lang.Object

java.lang.Record

net.ixdarklord.coolcatcanvas.api.cutscene.Cutscene.Subtitle

Record Components:

start - when it appears, in ticks from the cutscene's start

duration - how long it stays

Enclosing class:

Cutscene

public static record Cutscene.Subtitle(float start, float duration, net.minecraft.network.chat.Component text)
extends Record

A line of text shown at the foot of the screen for a while.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<Cutscene.Subtitle>	CODEC

Constructor Summary

Constructors

Constructor	Description
Subtitle(float start, float duration, net.minecraft.network.chat.Component text)	Creates an instance of a Subtitle record class.

Method Summary

Modifier and Type	Method	Description
float	duration()	Returns the value of the duration record component.
float	end()
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.
float	start()	Returns the value of the start record component.
net.minecraft.network.chat.Component	text()	Returns the value of the text 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

Field Details

CODEC

public static final com.mojang.serialization.Codec<Cutscene.Subtitle> CODEC

Constructor Details

Subtitle

public Subtitle(float start,
 float duration,
 net.minecraft.network.chat.Component text)

Creates an instance of a Subtitle record class.

Parameters:

start - the value for the start record component

duration - the value for the duration record component

text - the value for the text record component

Method Details

end

public float end()

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.

start

public float start()

Returns the value of the start record component.

Returns:

the value of the start record component

duration

public float duration()

Returns the value of the duration record component.

Returns:

the value of the duration record component

text

public net.minecraft.network.chat.Component text()

Returns the value of the text record component.

Returns:

the value of the text record component