Core GameKit  3.2.9.0
The ultimate pooling / combat / spawning / variable plugin!
DarkTonic.CoreGameKit.LevelSettingsListener Class Reference

This class is used to listen to key events in LevelSettings. Always make a subclass so you can have different Listeners for different LevelSettings. More...

Inheritance diagram for DarkTonic.CoreGameKit.LevelSettingsListener:

Public Member Functions

virtual void WaveItemsRemainingChanged (int waveItemsRemaining)
 This method gets called when the number of wave items spawned changes (something spawns or despawns). More...
 
virtual void WaveTimeRemainingChanged (int secondsRemaining)
 This method gets called when the seconds remaining in a timed wave changes. More...
 
virtual void Win ()
 This method gets called when the player wins (last wave completed and game not over). More...
 
virtual void Lose ()
 This method gets called when the player loses (game ended from lives = 0 or other game-ending trigger). More...
 
virtual void GameOver (bool hasWon)
 This method gets called when the player wins or loses. More...
 
virtual void LevelStarted (int levelNum)
 This method gets called when a Global Level starts. More...
 
virtual void LevelEnded (int levelNum)
 This method gets called when a Global Level ends, just before the next one starts (if any more). More...
 
virtual void WaveStarted (LevelWave levelWaveInfo, GlobalWaveSpec waveSpec)
 This method gets called when a Global Wave begins, before anything has spawned. More...
 
virtual void WavePaused (LevelWave levelWaveInfo)
 This method gets called when a Global Wave is paused. More...
 
virtual void WaveEnded (LevelWave levelWaveInfo)
 This method gets called when a Global Wave ends, just before the next one starts. More...
 
virtual void WaveRestarted (LevelWave levelWaveInf)
 This method gets called when a Global Wave restarts. More...
 
virtual void WaveCompleteBonusesStart (List< WorldVariableModifier > bonusModifiers)
 This method gets called when a Global Wave has been completed and the wave complete bonuses are about to be awarded. You can modify those awards permanently here. More...
 
virtual void WaveEliminationBonusesStart (List< WorldVariableModifier > elimModifiers)
 This method gets called when a Global Wave has been completed and the wave elimination bonuses are about to be awarded. You can modify those awards permanently here. More...
 
virtual void WaveEndedEarly (LevelWave levelWaveInfo)
 This method gets called when a Global Wave ends early. More...
 
virtual void WaveSkipped (LevelWave levelWaveInfo)
 This method gets called when a Global Wave is skipped through Skip Wave criteria or other means. More...
 

Detailed Description

This class is used to listen to key events in LevelSettings. Always make a subclass so you can have different Listeners for different LevelSettings.

Member Function Documentation

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.GameOver ( bool  hasWon)
virtual

This method gets called when the player wins or loses.

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.LevelEnded ( int  levelNum)
virtual

This method gets called when a Global Level ends, just before the next one starts (if any more).

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.LevelStarted ( int  levelNum)
virtual

This method gets called when a Global Level starts.

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.Lose ( )
virtual

This method gets called when the player loses (game ended from lives = 0 or other game-ending trigger).

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.WaveCompleteBonusesStart ( List< WorldVariableModifier >  bonusModifiers)
virtual

This method gets called when a Global Wave has been completed and the wave complete bonuses are about to be awarded. You can modify those awards permanently here.

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.WaveEliminationBonusesStart ( List< WorldVariableModifier >  elimModifiers)
virtual

This method gets called when a Global Wave has been completed and the wave elimination bonuses are about to be awarded. You can modify those awards permanently here.

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.WaveEnded ( LevelWave  levelWaveInfo)
virtual

This method gets called when a Global Wave ends, just before the next one starts.

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.WaveEndedEarly ( LevelWave  levelWaveInfo)
virtual

This method gets called when a Global Wave ends early.

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.WaveItemsRemainingChanged ( int  waveItemsRemaining)
virtual

This method gets called when the number of wave items spawned changes (something spawns or despawns).

Parameters
waveItemsRemaining
virtual void DarkTonic.CoreGameKit.LevelSettingsListener.WavePaused ( LevelWave  levelWaveInfo)
virtual

This method gets called when a Global Wave is paused.

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.WaveRestarted ( LevelWave  levelWaveInf)
virtual

This method gets called when a Global Wave restarts.

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.WaveSkipped ( LevelWave  levelWaveInfo)
virtual

This method gets called when a Global Wave is skipped through Skip Wave criteria or other means.

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.WaveStarted ( LevelWave  levelWaveInfo,
GlobalWaveSpec  waveSpec 
)
virtual

This method gets called when a Global Wave begins, before anything has spawned.

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.WaveTimeRemainingChanged ( int  secondsRemaining)
virtual

This method gets called when the seconds remaining in a timed wave changes.

virtual void DarkTonic.CoreGameKit.LevelSettingsListener.Win ( )
virtual

This method gets called when the player wins (last wave completed and game not over).


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