Runtime Spawner 1.3.0
Generic Runtime spawn and instance pooling system for spawning random AI agents around a map. Works with ANY AI system easily.
Loading...
Searching...
No Matches
MegaCrush.Spawner.SpawnContext Struct Reference

Immutable parameters describing where and why a spawn is occurring. Built by RuntimeSpawner and consumed by ISpawnExecutor. More...

Public Attributes

bool IsGlobal
 True if this request comes from the global flow (used to choose placement strategy).
 
LocalAreaSpawner Region
 Region spawner currently active for the player, if any (null if not a region spawn).
 
WaveTrigger Trigger
 Wave trigger that initiated this request, if any (null for non-wave spawns).
 
Transform WavePoint
 Anchor transform used by wave/special spawns (e.g., a WaveSpawnPoint).
 
float WaveRange
 Sampling radius around WavePoint when locating a placement.
 
GameObject GroupParent
 Optional parent instance used for clustered/group spawns. If set and the SpawnEntry.useGroupSpawn flag is enabled, additional members are placed relative to this object.
 
Vector3 PlayerPos
 Player world position at the time of the request (used for distance/LOS checks).
 
string[] HintTags
 Optional semantic tags requested by the caller (e.g., from WaveSpawnPoint.AnchorTags). The locator prefers EnemySpawnHintPoint that share at least one tag.
 
SpawnSource Source
 Categorical source of the spawn (global/region/wave/special) for bookkeeping and UI.
 
string SourceName
 Human-readable name of the source (e.g., the WaveSpawner asset name) for logs/telemetry.
 
string SpawnTag
 Optional tag to assign to the spawned GameObject on activation.
 

Detailed Description

Immutable parameters describing where and why a spawn is occurring. Built by RuntimeSpawner and consumed by ISpawnExecutor.

Member Data Documentation

◆ GroupParent

GameObject MegaCrush.Spawner.SpawnContext.GroupParent

Optional parent instance used for clustered/group spawns. If set and the SpawnEntry.useGroupSpawn flag is enabled, additional members are placed relative to this object.

◆ HintTags

string [] MegaCrush.Spawner.SpawnContext.HintTags

Optional semantic tags requested by the caller (e.g., from WaveSpawnPoint.AnchorTags). The locator prefers EnemySpawnHintPoint that share at least one tag.

◆ IsGlobal

bool MegaCrush.Spawner.SpawnContext.IsGlobal

True if this request comes from the global flow (used to choose placement strategy).

◆ PlayerPos

Vector3 MegaCrush.Spawner.SpawnContext.PlayerPos

Player world position at the time of the request (used for distance/LOS checks).

◆ Region

LocalAreaSpawner MegaCrush.Spawner.SpawnContext.Region

Region spawner currently active for the player, if any (null if not a region spawn).

◆ Source

SpawnSource MegaCrush.Spawner.SpawnContext.Source

Categorical source of the spawn (global/region/wave/special) for bookkeeping and UI.

◆ SourceName

string MegaCrush.Spawner.SpawnContext.SourceName

Human-readable name of the source (e.g., the WaveSpawner asset name) for logs/telemetry.

◆ SpawnTag

string MegaCrush.Spawner.SpawnContext.SpawnTag

Optional tag to assign to the spawned GameObject on activation.

◆ Trigger

WaveTrigger MegaCrush.Spawner.SpawnContext.Trigger

Wave trigger that initiated this request, if any (null for non-wave spawns).

◆ WavePoint

Transform MegaCrush.Spawner.SpawnContext.WavePoint

Anchor transform used by wave/special spawns (e.g., a WaveSpawnPoint).

◆ WaveRange

float MegaCrush.Spawner.SpawnContext.WaveRange

Sampling radius around WavePoint when locating a placement.


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