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

Inheritance diagram for DarkTonic.CoreGameKit.TriggeredSpawnerListener:

Public Member Functions
virtual void	EventPropagating (TriggeredSpawner.EventType eType, Transform transmitterTrans, int receiverSpawnerCount)
	This method gets calls when a spawner gets ready to call events on child spawners. Override if you need custom logic. More...

virtual void	PropagatedEventReceived (TriggeredSpawner.EventType eType, Transform transmitterTrans)
	This method gets calls when a child spawner gets notified to call its wave from a parent spawner. Override if you need custom logic. More...

virtual void	WaveEndedEarly (TriggeredSpawner.EventType eType)
	This method gets called if the wave ends early. More...

virtual void	PropagatedWaveEndedEarly (TriggeredSpawner.EventType eType, string customEventName, Transform transmitterTrans, int receiverSpawnerCount)
	This method gets called if a parent spawner's wave ends early, to cancel the child spawners' waves as well. More...

virtual void	ItemFailedToSpawn (TriggeredSpawner.EventType eType, Transform failedPrefabTrans)
	This method gets called if a wave item fails to spawn. More...

virtual void	ItemSpawned (TriggeredSpawner.EventType eType, Transform spawnedTrans)
	This method gets called immediately after a wave item spawns. More...

virtual void	WaveFinishedSpawning (TriggeredSpawner.EventType eType, TriggeredWaveSpecifics spec)
	This method gets called after the last item in a wave has finished spawning. More...

virtual void	WaveEliminated (TriggeredSpawner.EventType eType, TriggeredWaveSpecifics spec)
	This method gets called after the last item in a wave has been despawned. More...

virtual void	WaveStart (TriggeredSpawner.EventType eType, TriggeredWaveSpecifics spec)
	This method gets called when the wave is about to start spawning. More...

virtual void	WaveRepeat (TriggeredSpawner.EventType eType, TriggeredWaveSpecifics spec)
	This method gets called each time the wave is about to repeat. More...

virtual void	SpawnerDespawning (Transform transDespawning)
	This method gets called when a spawner is about to despawn (optional). More...

virtual void	CustomEventReceived (string customEventName, Vector3 eventOrigin)
	This method gets called when a Custom Event is received by the Triggered Spawner. This only happens if the Triggered Spawner has configured a wave for that Custom Event. More...

virtual void	Spawned (MonoBehaviour spawner)
	This method gets called when the Triggered Spawner is spawned. More...

virtual void	Despawned (MonoBehaviour spawner)
	This method gets called when the Triggered Spawner is about to despawn. More...

Detailed Description

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

Member Function Documentation

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.CustomEventReceived	(	string	customEventName,
		Vector3	eventOrigin
	)

virtual

This method gets called when a Custom Event is received by the Triggered Spawner. This only happens if the Triggered Spawner has configured a wave for that Custom Event.

Parameters

customEventName	the Custom Event name.
eventOrigin	The position of the Custom Event's origin (initiator).

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.Despawned ( MonoBehaviour spawner )

virtual

This method gets called when the Triggered Spawner is about to despawn.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.EventPropagating	(	TriggeredSpawner.EventType	eType,
		Transform	transmitterTrans,
		int	receiverSpawnerCount
	)

virtual

This method gets calls when a spawner gets ready to call events on child spawners. Override if you need custom logic.

Parameters

eType	The event type.
transmitterTrans	The parent spawner's Transform.
receiverSpawnerCount	The count of all child spawners of the parent.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.ItemFailedToSpawn	(	TriggeredSpawner.EventType	eType,
		Transform	failedPrefabTrans
	)

virtual

This method gets called if a wave item fails to spawn.

Parameters

eType	The event type.
failedPrefabTrans	The prefab that failed to spawn.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.ItemSpawned	(	TriggeredSpawner.EventType	eType,
		Transform	spawnedTrans
	)

virtual

This method gets called immediately after a wave item spawns.

Parameters

eType	The event type.
spawnedTrans	The spawned item.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.PropagatedEventReceived	(	TriggeredSpawner.EventType	eType,
		Transform	transmitterTrans
	)

virtual

This method gets calls when a child spawner gets notified to call its wave from a parent spawner. Override if you need custom logic.

Parameters

eType	The event type.
transmitterTrans	The parent spawner's Transform.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.PropagatedWaveEndedEarly	(	TriggeredSpawner.EventType	eType,
		string	customEventName,
		Transform	transmitterTrans,
		int	receiverSpawnerCount
	)

virtual

This method gets called if a parent spawner's wave ends early, to cancel the child spawners' waves as well.

Parameters

eType	The event type.
customEventName	The custom event name, if any.
transmitterTrans	The parent spawner's Transform.
receiverSpawnerCount	The count of all child spawners of the parent.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.Spawned ( MonoBehaviour spawner )

virtual

This method gets called when the Triggered Spawner is spawned.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.SpawnerDespawning ( Transform transDespawning )

virtual

This method gets called when a spawner is about to despawn (optional).

Parameters

transDespawning The Transform of the spawner.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.WaveEliminated	(	TriggeredSpawner.EventType	eType,
		TriggeredWaveSpecifics	spec
	)

virtual

This method gets called after the last item in a wave has been despawned.

Parameters

eType	The event type.
spec	The wave specifics.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.WaveEndedEarly ( TriggeredSpawner.EventType eType )

virtual

This method gets called if the wave ends early.

Parameters

eType The event type.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.WaveFinishedSpawning	(	TriggeredSpawner.EventType	eType,
		TriggeredWaveSpecifics	spec
	)

virtual

This method gets called after the last item in a wave has finished spawning.

Parameters

eType	The event type.
spec	The wave specifics.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.WaveRepeat	(	TriggeredSpawner.EventType	eType,
		TriggeredWaveSpecifics	spec
	)

virtual

This method gets called each time the wave is about to repeat.

Parameters

eType	The event type.
spec	The wave specifics.

virtual void DarkTonic.CoreGameKit.TriggeredSpawnerListener.WaveStart	(	TriggeredSpawner.EventType	eType,
		TriggeredWaveSpecifics	spec
	)

virtual

This method gets called when the wave is about to start spawning.

Parameters

eType	The event type.
spec	The wave specifics.

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

DarkSpawner/Assets/Plugins/DarkTonic/CoreGameKit/Scripts/Spawners/TriggeredSpawnerListener.cs

Public Member Functions

Detailed Description

Member Function Documentation