BasicLevelGate Class Reference

Basic Level Gate contains several methods for triggering and handling a players transition to another level. Its designed to take a majority of players before starting the process. It has built in display for a timer as well as player count. More...

Public Member Functions
void	PlayerReady (Context playerContext)
	Marks the player as ready to transition into the target level.
void	PlayerUnready (Context playerContext)
	Marks the player as not ready to transition into the target level.
void	TriggerGate (Context context)
	Triggers the countdown of the gate, which on successful completion will switch levels.
void	ToggleReadyParticles (Context context, bool ready)
	Toggles the ready particles of the level gate on or off.
bool	GetIsValidDestination ()
	Checks if the target level is a valid destination.

Detailed Description

Basic Level Gate contains several methods for triggering and handling a players transition to another level. Its designed to take a majority of players before starting the process. It has built in display for a timer as well as player count.

Member Function Documentation

GetIsValidDestination()

bool GetIsValidDestination

(

)

Checks if the target level is a valid destination.

Returns

True if the destination is valid, false otherwise.

PlayerReady()

void PlayerReady

(

Context

playerContext

)

Marks the player as ready to transition into the target level.

Parameters

playerContext

The context of the player who has become ready

PlayerUnready()

void PlayerUnready

(

Context

playerContext

)

Marks the player as not ready to transition into the target level.

Parameters

playerContext

The context of the player who has become not ready.

ToggleReadyParticles()

void ToggleReadyParticles	(	Context	context,
		bool	ready )

Toggles the ready particles of the level gate on or off.

Parameters

context	The triggerer
ready	Whether or not the ready particles should be on or off.

TriggerGate()

void TriggerGate

(

Context

context

)

Triggers the countdown of the gate, which on successful completion will switch levels.

Parameters

context