This class is used to set up global settings and configure levels and waves for Syncro Spawners. More...

Inheritance diagram for DarkTonic.CoreGameKit.LevelSettings:

Static Public Member Functions
static void	ContinueGame ()
	Call this method to continue the game when the game has ended. Continues from the same global wave the player died on. If the player already won, you should not call this. More...

static void	RestartGame ()
	Call this method to restart the game when the game has ended. Goes back to level #1, wave #1 for Syncro Spawners. More...

static void	EndWave ()
	Call this method to immediately finish the current wave for Syncro Spawners. More...

static void	GotoWave (int levelNum, int waveNum)
	Call this method to immediately finish the current wave for Syncro Spawners and go to a different level / wave you specify. More...

static List< string >	GetSortedPrefabPoolNames ()
	This returns a list of all Prefab Pools More...

static void	PauseWave ()
	Use this method to pause the current wave for Syncro Spawners. More...

static void	RestartCurrentWave ()
	Use this method to restart the current wave for Syncro Spawners. This puts the repeat wave counter back to zero as well. Also, this unpauses the wave if paused. More...

static void	UnpauseWave ()
	Use this method to unpause the current wave for Syncro Spawners. More...

static void	WarpToLevel (int levelNumber, int waveNumber)
	This method lets you start at a custom level and wave number. You must call this no later than Start for it to work properly. More...

static void	AddCustomEventReceiver (ICgkEventReceiver receiver, Transform receiverTrans)
	This method is used to keep track of enabled CustomEventReceivers automatically. This is called when then CustomEventReceiver prefab is enabled. Only call this if you write classes that inherit from ICgkEventReceiver. More...

static void	RemoveCustomEventReceiver (ICgkEventReceiver receiver)
	This method is used to keep track of enabled CustomEventReceivers automatically. This is called when then CustomEventReceiver prefab is disabled. More...

static List< Transform >	ReceiversForEvent (string customEventName)
	Returns a list of all Receivers for a Custom Event More...

static void	FireCustomEventIfValid (string anEvent, Transform eventOrigin)
	Fire a custom event if the name is valid (not "NONE", "TYPE IN", etc); More...

static void	FireCustomEventWithParam (string customEventName, Transform originObject, object eventParam, bool logDupe=true)
	Fires a CGK custom event but with a parameter More...

static void	FireCustomEvent (string customEventName, Transform originObject, bool logDupe=true)
	Calling this method will fire a Custom Event at the originPoint position. All CustomEventReceivers with the named event specified will do whatever action is assigned to them. If there is a distance criteria applied to receivers, it will be applied. More...

static bool	CustomEventExists (string customEventName)
	Calling this method will return whether or not the specified Custom Event exists. More...

Properties
static LevelWave	ActiveWaveInfo `[get]`
	This property returns the current wave info for Syncro Spawners More...

static int	CurrentDisplayLevel `[get]`
	Gets the current level number for display purposes. More...

static int	CurrentDisplayWave `[get]`
	Gets the current wave number for display purposes. More...

static int	CurrentLevel `[get]`
	This property returns the current level number (zero-based) for Syncro Spawners. More...

static int	CurrentLevelWave `[get]`
	This property returns the current wave number (zero-based) in the current level for Syncro Spawners. More...

int	LevelNumber `[get]`
	This property returns the current level number (zero-based) for Syncro Spawners. More...

int	WaveNumber `[get]`
	This property returns the current wave number (zero-based) in the current level for Syncro Spawners. More...

static List< Transform >	GetAllPrefabPools `[get]`
	A list of the Transforms for all Prefab Pools More...

static List< Transform >	GetAllSpawners `[get]`
	A list of the Transforms for all Syncro Spawners More...

static List< WaveSyncroPrefabSpawner >	GetAllSpawnerScripts `[get]`
	This will return all Syncro Spawners in the Scene. More...

static bool	IsGameOver `[get, set]`
	Use this property to read or set "IsGameOver". If game is over, game over behavior will come into play, Syncro Spawners will stop spawning and waves will not advance. More...

static bool	HasNextWave `[get]`
	This property returns whether there is another wave after the current one. More...

static int	LastLevel `[get]`
	This property returns the number of the last level you have set up (zero-based). More...

static List< WaveSyncroPrefabSpawner >	SyncroSpawners `[get]`
	This property returns a list of all Syncro Spawners in the Scene. More...

static WaveSyncroPrefabSpawner	RandomSyncroSpawner `[get]`
	This property returns a random Syncro Spawner in the Scene. More...

static int	TimeRemainingInCurrentWave `[get, set]`
	This property returns the number of seconds remaining in the current wave for Syncro Spawners. -1 is returned for elimination waves. More...

static List< LevelWave >	WaveLengths `[get]`
	This property returns a list of all wave settings in the current Level. More...

static bool	WavesArePaused `[get]`
	This property will return whether the current wave is paused for Syncro Spawners. More...

static float	WavePauseTime `[get]`
	This property will return the amount of time a wave has been paused for. More...

static int	EliminationSpawnersRemaining `[get]`
	This property will return the number of Spawners that haven't had their waves eliminated yet. More...

static int	WaveRemainingItemCount `[get]`
	The number of items left to eliminate in a wave. More...

List< string >	CustomEventNames `[get]`
	This will return a list of all the Custom Events you have defined, including the selectors for "type in" and "none". More...

Detailed Description

This class is used to set up global settings and configure levels and waves for Syncro Spawners.

Member Function Documentation

static void DarkTonic.CoreGameKit.LevelSettings.AddCustomEventReceiver	(	ICgkEventReceiver	receiver,
		Transform	receiverTrans
	)

static

This method is used to keep track of enabled CustomEventReceivers automatically. This is called when then CustomEventReceiver prefab is enabled. Only call this if you write classes that inherit from ICgkEventReceiver.

Parameters

receiver	The receiver object to register.
receiverTrans	The Transform of the receiver.

static void DarkTonic.CoreGameKit.LevelSettings.ContinueGame ( )

static

Call this method to continue the game when the game has ended. Continues from the same global wave the player died on. If the player already won, you should not call this.

static bool DarkTonic.CoreGameKit.LevelSettings.CustomEventExists ( string customEventName )

static

Calling this method will return whether or not the specified Custom Event exists.

Parameters

customEventName The Custom Event name.

static void DarkTonic.CoreGameKit.LevelSettings.EndWave ( )

static

Call this method to immediately finish the current wave for Syncro Spawners.

static void DarkTonic.CoreGameKit.LevelSettings.FireCustomEvent	(	string	customEventName,
		Transform	originObject,
		bool	logDupe = `true`
	)

static

Calling this method will fire a Custom Event at the originPoint position. All CustomEventReceivers with the named event specified will do whatever action is assigned to them. If there is a distance criteria applied to receivers, it will be applied.

Parameters

customEventName	The name of the custom event.
originObject	The Transform origin of the event.
logDupe	Whether or not to log an error with duplicate event firing.

static void DarkTonic.CoreGameKit.LevelSettings.FireCustomEventIfValid	(	string	anEvent,
		Transform	eventOrigin
	)

static

Fire a custom event if the name is valid (not "NONE", "TYPE IN", etc);

Parameters

anEvent	The name of the Custom Event
eventOrigin	The origin position of the Custom Event

static void DarkTonic.CoreGameKit.LevelSettings.FireCustomEventWithParam	(	string	customEventName,
		Transform	originObject,
		object	eventParam,
		bool	logDupe = `true`
	)

static

Fires a CGK custom event but with a parameter

Parameters

customEventName	The name of the custom event.
originObject	The Transform origin of the event.
eventParam	The parameter for the event
logDupe	Whether or not to log an error with duplicate event firing.

static List<string> DarkTonic.CoreGameKit.LevelSettings.GetSortedPrefabPoolNames ( )

static

This returns a list of all Prefab Pools

Returns: A list of all Prefab Pool names.

static void DarkTonic.CoreGameKit.LevelSettings.GotoWave	(	int	levelNum,
		int	waveNum
	)

static

Call this method to immediately finish the current wave for Syncro Spawners and go to a different level / wave you specify.

Parameters

levelNum	The level number to skip to.
waveNum	The wave number to skip to.

static void DarkTonic.CoreGameKit.LevelSettings.PauseWave ( )

static

Use this method to pause the current wave for Syncro Spawners.

static List<Transform> DarkTonic.CoreGameKit.LevelSettings.ReceiversForEvent ( string customEventName )

static

Returns a list of all Receivers for a Custom Event

Parameters

customEventName The name of the Custom Event

Returns: A list of Transforms for all receivers.

static void DarkTonic.CoreGameKit.LevelSettings.RemoveCustomEventReceiver ( ICgkEventReceiver receiver )

static

This method is used to keep track of enabled CustomEventReceivers automatically. This is called when then CustomEventReceiver prefab is disabled.

Parameters

receiver The receiver to remove from the tracking list.

static void DarkTonic.CoreGameKit.LevelSettings.RestartCurrentWave ( )

static

Use this method to restart the current wave for Syncro Spawners. This puts the repeat wave counter back to zero as well. Also, this unpauses the wave if paused.

static void DarkTonic.CoreGameKit.LevelSettings.RestartGame ( )

static

Call this method to restart the game when the game has ended. Goes back to level #1, wave #1 for Syncro Spawners.

static void DarkTonic.CoreGameKit.LevelSettings.UnpauseWave ( )

static

Use this method to unpause the current wave for Syncro Spawners.

static void DarkTonic.CoreGameKit.LevelSettings.WarpToLevel	(	int	levelNumber,
		int	waveNumber
	)

static

This method lets you start at a custom level and wave number. You must call this no later than Start for it to work properly.

Parameters

levelNumber	The level number to start on.
waveNumber	The wave number to start on.

Property Documentation

LevelWave DarkTonic.CoreGameKit.LevelSettings.ActiveWaveInfo

staticget

This property returns the current wave info for Syncro Spawners

int DarkTonic.CoreGameKit.LevelSettings.CurrentDisplayLevel

staticget

Gets the current level number for display purposes.

The current display level.

int DarkTonic.CoreGameKit.LevelSettings.CurrentDisplayWave

staticget

Gets the current wave number for display purposes.

The current display wave.

int DarkTonic.CoreGameKit.LevelSettings.CurrentLevel

staticget

This property returns the current level number (zero-based) for Syncro Spawners.

int DarkTonic.CoreGameKit.LevelSettings.CurrentLevelWave

staticget

This property returns the current wave number (zero-based) in the current level for Syncro Spawners.

List<string> DarkTonic.CoreGameKit.LevelSettings.CustomEventNames

get

This will return a list of all the Custom Events you have defined, including the selectors for "type in" and "none".

int DarkTonic.CoreGameKit.LevelSettings.EliminationSpawnersRemaining

staticget

This property will return the number of Spawners that haven't had their waves eliminated yet.

List<Transform> DarkTonic.CoreGameKit.LevelSettings.GetAllPrefabPools

staticget

A list of the Transforms for all Prefab Pools

List<Transform> DarkTonic.CoreGameKit.LevelSettings.GetAllSpawners

staticget

A list of the Transforms for all Syncro Spawners

List<WaveSyncroPrefabSpawner> DarkTonic.CoreGameKit.LevelSettings.GetAllSpawnerScripts

staticget

This will return all Syncro Spawners in the Scene.

bool DarkTonic.CoreGameKit.LevelSettings.HasNextWave

staticget

This property returns whether there is another wave after the current one.

bool DarkTonic.CoreGameKit.LevelSettings.IsGameOver

staticgetset

Use this property to read or set "IsGameOver". If game is over, game over behavior will come into play, Syncro Spawners will stop spawning and waves will not advance.

int DarkTonic.CoreGameKit.LevelSettings.LastLevel

staticget

This property returns the number of the last level you have set up (zero-based).

int DarkTonic.CoreGameKit.LevelSettings.LevelNumber

get

This property returns the current level number (zero-based) for Syncro Spawners.

WaveSyncroPrefabSpawner DarkTonic.CoreGameKit.LevelSettings.RandomSyncroSpawner

staticget

This property returns a random Syncro Spawner in the Scene.

List<WaveSyncroPrefabSpawner> DarkTonic.CoreGameKit.LevelSettings.SyncroSpawners

staticget

This property returns a list of all Syncro Spawners in the Scene.

int DarkTonic.CoreGameKit.LevelSettings.TimeRemainingInCurrentWave

staticgetset

This property returns the number of seconds remaining in the current wave for Syncro Spawners. -1 is returned for elimination waves.

List<LevelWave> DarkTonic.CoreGameKit.LevelSettings.WaveLengths

staticget

This property returns a list of all wave settings in the current Level.

int DarkTonic.CoreGameKit.LevelSettings.WaveNumber

get

This property returns the current wave number (zero-based) in the current level for Syncro Spawners.

float DarkTonic.CoreGameKit.LevelSettings.WavePauseTime

staticget

This property will return the amount of time a wave has been paused for.

int DarkTonic.CoreGameKit.LevelSettings.WaveRemainingItemCount

staticget

The number of items left to eliminate in a wave.

bool DarkTonic.CoreGameKit.LevelSettings.WavesArePaused

staticget

This property will return whether the current wave is paused for Syncro Spawners.

The documentation for this class was generated from the following file:

DarkSpawner/Assets/Plugins/DarkTonic/CoreGameKit/Scripts/Level/LevelSettings.cs

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation