Package com.csse3200.game.cutscene.models.object.actiondata

Record Class BackgroundSetData

java.lang.Object

java.lang.Record

com.csse3200.game.cutscene.models.object.actiondata.BackgroundSetData

Record Components:

background - The background object containing background info (image & id)

transition - How the background will transition into existence (Transition enum)

duration - How long the transition will take

await - Wait for transition to complete before continuing

All Implemented Interfaces:

ActionData

public record BackgroundSetData(Background background, Transition transition, int duration, boolean await)
extends Record
implements ActionData

Stores data for the background.set event

Constructor Summary

Constructors

Constructor	Description
BackgroundSetData(Background background, Transition transition, int duration, boolean await)	Creates an instance of a BackgroundSetData record class.

Method Summary

Modifier and Type	Method	Description
boolean	await()	Returns the value of the await record component.
Background	background()	Returns the value of the background record component.
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.
Transition	transition()	Returns the value of the transition record component.

Methods inherited from class java.lang.Object

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

Constructor Details

BackgroundSetData

public BackgroundSetData(Background background,
 Transition transition,
 int duration,
 boolean await)

Creates an instance of a BackgroundSetData record class.

Parameters:

background - the value for the background record component

transition - the value for the transition record component

duration - the value for the duration record component

await - the value for the await 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 '=='.

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.

background

public Background background()

Returns the value of the background record component.

Returns:

the value of the background record component

transition

public Transition transition()

Returns the value of the transition record component.

Returns:

the value of the transition record component

duration

public int duration()

Returns the value of the duration record component.

Returns:

the value of the duration record component

await

public boolean await()

Returns the value of the await record component.

Returns:

the value of the await record component