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

Class Advance

java.lang.Object

com.csse3200.game.cutscene.models.object.Advance

public class Advance
extends Object

Class to store data for the Advance setting Each type of advance has their own generator.

Constructor Summary

Constructors

Constructor	Description
Advance(AdvanceMode mode, int delayMs, String signalKey)	Creates an Advance with parameter details This is NOT to be used, rather use provided static methods (e.g.

Method Summary

Modifier and Type	Method	Description
static Advance	auto()	Get an Advance configured for AdvanceMode.AUTO.
static Advance	autoDelay(int ms)	Get an Advance configured for AdvanceMode.AUTO_DELAY.
int	getDelayMs()
AdvanceMode	getMode()
String	getSignalKey()
static Advance	input()	Get an Advance configured for AdvanceMode.INPUT.
static Advance	signal(String key)	Get an Advance configured for AdvanceMode.SIGNAL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Advance

public Advance(AdvanceMode mode,
 int delayMs,
 String signalKey)

Creates an Advance with parameter details This is NOT to be used, rather use provided static methods (e.g. auto().

Parameters:

mode - The AdvanceMode mode

delayMs - The delay in ms

signalKey - The signal key

Method Details

getMode

public AdvanceMode getMode()

getDelayMs

public int getDelayMs()

getSignalKey

public String getSignalKey()

input

public static Advance input()

Get an Advance configured for AdvanceMode.INPUT. No delay or signal key are used.

Returns:

Advance in INPUT mode

auto

public static Advance auto()

Get an Advance configured for AdvanceMode.AUTO. No delay or signal key are used.

Returns:

Advance in AUTO mode

autoDelay

public static Advance autoDelay(int ms)

Get an Advance configured for AdvanceMode.AUTO_DELAY. No signal key is set.

Parameters:

ms - The delay (in Milliseconds) to set the advance to

Returns:

Advance in AUTO_DELAY mode with ms set

signal

public static Advance signal(String key)

Get an Advance configured for AdvanceMode.SIGNAL. No delay is set.

Parameters:

key - The signal key to set

Returns:

Advance in SIGNAL mode with key set