This class is used for Syncro Spawners. These are spawners that use sequential or randomly ordered Global Waves set up in Level Settings. More...

Inheritance diagram for DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner:

Public Member Functions
Transform	SpawnOneItem ()
	Calling this method will spawn one of the current wave for this Level and Wave, if this Spawner is configured to use that Level and Wave. More...

Protected Member Functions
virtual void	AffectScale (Transform spawnedTrans)
	Fires after the item spawns and affects the scale of the spawned object. Override if you need custom logic here. More...

virtual void	AfterSpawn (Transform spawnedTrans)
	Fires immediately after the item spawns. Used by post-spawn nudge. Override if you need custom logic here. More...

virtual bool	CanSpawnOne ()
	Returns true always unless the Distance Limit feature is used. Subclass this to override it if needed. More...

virtual Transform	GetSpawnable (WaveSpecifics wave)
	This returns the item to spawn. Override this to apply custom logic if needed. More...

virtual Vector3	GetSpawnPosition (Vector3 pos, int itemSpawnedIndex)
	Returns the position to spawn an item in. Override for your custom logic. More...

virtual Quaternion	GetSpawnRotation (Transform prefabToSpawn, int itemSpawnedIndex)
	Returns the rotation to spawn the item in. Override if you need custom logic for this. More...

virtual Transform	SpawnWaveItem (Transform prefabToSpawn, Vector3 spawnPosition, Quaternion rotation)
	Override this method to call a Network Instantiate method or other. More...

Properties
List< Transform >	SpawnedWaveMembers `[get]`
	Returns a list of Spawned Wave Members More...

bool	GameIsOverForSpawner `[get]`
	This property will return true if the Game Over Behavior setting makes this spawner disabled. More...

bool	SpawnerIsPaused `[get]`
	This property will return true if the Wave Pause Behavior setting makes this spawner paused. More...

Detailed Description

This class is used for Syncro Spawners. These are spawners that use sequential or randomly ordered Global Waves set up in Level Settings.

Member Function Documentation

virtual void DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner.AffectScale ( Transform spawnedTrans )

protectedvirtual

Fires after the item spawns and affects the scale of the spawned object. Override if you need custom logic here.

Parameters

spawnedTrans The spawned Transform.

virtual void DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner.AfterSpawn ( Transform spawnedTrans )

protectedvirtual

Fires immediately after the item spawns. Used by post-spawn nudge. Override if you need custom logic here.

Parameters

spawnedTrans The spawned Transform.

virtual bool DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner.CanSpawnOne ( )

protectedvirtual

Returns true always unless the Distance Limit feature is used. Subclass this to override it if needed.

Returns: boolean value.

virtual Transform DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner.GetSpawnable ( WaveSpecifics wave )

protectedvirtual

This returns the item to spawn. Override this to apply custom logic if needed.

Parameters

wave	The wave specifics.

Returns: The Transform to spawn.

virtual Vector3 DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner.GetSpawnPosition	(	Vector3	pos,
		int	itemSpawnedIndex
	)

protectedvirtual

Returns the position to spawn an item in. Override for your custom logic.

Parameters

pos	Spawner position.
itemSpawnedIndex	Index (counter) of item to spawn. Incremental Settings use this.

Returns: The modified position to spawn in.

virtual Quaternion DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner.GetSpawnRotation	(	Transform	prefabToSpawn,
		int	itemSpawnedIndex
	)

protectedvirtual

Returns the rotation to spawn the item in. Override if you need custom logic for this.

Parameters

prefabToSpawn	The prefab to spawn.
itemSpawnedIndex	Index (counter) of item to spawn. Incremental Settings use this.

Returns: The modified rotation to spawn in.

Transform DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner.SpawnOneItem ( )

Calling this method will spawn one of the current wave for this Level and Wave, if this Spawner is configured to use that Level and Wave.

Returns: The Transform of the spawned item.

virtual Transform DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner.SpawnWaveItem	(	Transform	prefabToSpawn,
		Vector3	spawnPosition,
		Quaternion	rotation
	)

protectedvirtual

Override this method to call a Network Instantiate method or other.

Parameters

prefabToSpawn	The prefab to spawn.
spawnPosition	The position to spawn in.
rotation	The rotation to spawn with.

Returns: Spawned item Transform

Property Documentation

bool DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner.GameIsOverForSpawner

get

This property will return true if the Game Over Behavior setting makes this spawner disabled.

List<Transform> DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner.SpawnedWaveMembers

get

Returns a list of Spawned Wave Members

bool DarkTonic.CoreGameKit.WaveSyncroPrefabSpawner.SpawnerIsPaused

get

This property will return true if the Wave Pause Behavior setting makes this spawner paused.

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

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation