Listeners

To extend Core GameKit to the limit of your imagination, we have Listener scripts so that you can add custom behavior through code that will hook into a great many Core GameKit events. Each Listener script is an empty skeleton code template that you should not modify. Instead you should create subclasses from them to use for your purposes. For each method in these events, you are passed context objects so you can tell exactly what is happening. If you need more events to listen to, let us know!

Note: There is an example subclass of the Killable Listener in Example Scene 1, attached to the Main Camera prefab. It listens to the Killable on the Player prefab.

 

Hooking Up Listeners

Hooking up Listener scripts is easy. Let's take a look at Killable Listener. To set it up:

     
  1. Select a Killable object in your Scene.
    2.  
  2. In the Inspector, add a Killable Listener script from the Component menu (let's just use the stock one for now).

That's it! The Listener will look for a compatible object to listen to in the same Game Object automatically. i.e. adding a Killable Listener to a Game Object with Killable will automatically hook them together.

 

Note: If you want the listener to live in a different Game Object, the steps are a little different.

     
  1. In the Inspector, add a Killable Listener script from the Component menu (let's just use the stock one for now) to the Game Object you want to listen.
    2.  
  2. Select the Killable you want to listen to in the Hierarchy.
    3.  
  3. Under the Inspector for the Killable script, notice the "Listener" field which is currently unassigned. Drag the Game Object with the Killable Listener script into there.

That's it! Your Listener is now hooked up and will get called from Killable when the events occur. Note that the Listener does not need to be in the same object as the Killable.

 

Included Listeners & Events

We have included Listeners for the following. Click on a link to jump to that section:

     
  1. Level Wave Settings: Events for Level Wave Settings
    2.  
  2. Killable: Events for Killable
    3.  
  3. Pool Boss: Events for Pool Boss
    4.  
  4. Prefab Pool: Events for Prefab Pools
    5.  
  5. Triggered Spawner: Events for Triggered Spawners
    6.  
  6. Syncro Spawner: Events for Syncro Spawners
    7.  
  7. World Variable: Events for World Variables. Can display / update the value on a Text component in Unity uGUI, NGUI, or TextMeshPro.
    8.  
  8. Timed Despawner: Events for Timed Despawner
    9.  
  9. Triggered Despawner: Events for Triggered Despawner
    10.  
  10. Wave Music Changer: Events for Wave Music Changer
 

Level Settings Listener Events

     
  1. GameOver
    2.  
  2. Lose (GameOver but you didn't win)
    3.  
  3. LevelStarted (fired when the first Wave in a Level starts).
    4.  
  4. LevelEnded (fired when the last Wave in a Level is completed).
    5.  
  5. WaveItemsRemainingChanged (to update a display or any logic)
    6.  
  6. WaveTimeRemainingChanged (to update a display of seconds)
    7.  
  7. WaveStarted

    Tip: Use LevelSettings.CurrentLevelWave if you want to get the wave #.
    8.  
  8. WaveEnded
    9.  
  9. WaveEndedEarly
    10.  
  10. WaveSkipped
    11.  
  11. WaveCompleteBonusesStart (in case you want to modify the bonuses before they're awarded).
    12.  
  12. WaveRestarted
    13.  
  13. Win
 

Killable Listener Events

     
  1. Awake
    2.  
  2. SpawnerDestroyed
    3.  
  3. Despawning
    4.  
  4. TakingDamage
    5.  
  5. DamagePrefabSpawned
    6.  
  6. DamagePrefabFailedToSpawn
    7.  
  7. DeathDelayStarted
    8.  
  8. DeathPrefabSpawned
    9.  
  9. DeathPrefabFailedToSpawn
    10.  
  10. ModifyingDamageWorldVariables
    11.  
  11. ModifyingDeathWorldVariables
    12.  
  12. WaitingToDestroyKillable (used to play a death animation or other side effect)
    13.  
  13. DestroyingKillable
    14.  
  14. DeterminingScenario - used to change the Scenario used (which set of World Variables are going to be modified)
 

Pool Boss Listener Events

     
  1. PercentInitialized
    2.  
  2. InitializationComplete
    3.  
  3. ItemSpawned
    4.  
  4. ItemDespawned
 

Prefab Pool Listener Events

     
  1. PrefabGrabbedFromPool
    2.  
  2. PoolRefilling
 

Triggered Spawner Listener Events

     
  1. CustomEventReceived
    2.  
  2. Despawned
    3.  
  3. EventPropagating
    4.  
  4. PropagatedEventReceived
    5.  
  5. WaveEndedEarly
    6.  
  6. PropagatedWaveEndedEarly
    7.  
  7. ItemFailedToSpawn
    8.  
  8. ItemSpawned
    9.  
  9. Spawned
    10.  
  10. WaveEliminated
    11.  
  11. WaveFinishedSpawning
    12.  
  12. WaveStart
    13.  
  13. WaveRepeat
    14.  
  14. SpawnerDespawning
 

Syncro Spawner Listener Events

     
  1. EliminationWaveCompleted
    2.  
  2. ItemFailedToSpawn
    3.  
  3. ItemSpawned
    4.  
  4. WaveFinishedSpawning
    5.  
  5. WaveStart
    6.  
  6. WaveRepeat
 

World Variable Listener Events

     
  1. UpdateValue
 

World Variable Listener also has some fields for display logic.

     
  1. Decimal Places (number of decimal places).
    2.  
  2. Use Comma formatting.
 

Timed Despawner Listener Events

     
  1. Despawning
 

Triggered Despawner Listener Events

     
  1. Despawning
 

Wave Music Changer Listener Events

     
  1. MusicChanging