Unity - Scripting API: VFXSpawnerState
class in UnityEngine.VFX
Success!
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
Submission failed
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Description
The spawn state of a Spawn system.
This class is useful for debugging a Visual Effect's spawner. For example, you can see if the effect is currently playing, the number of loops the spawner has processed, as well as the current state of the spawner.
To access the state of a Visual Effect's Spawn system, either use VisualEffect.GetSpawnSystemInfo or, in a class that inherits from VFXSpawnerCallbacks, override the OnUpdate method.
Properties
| Property | Description |
|---|---|
| delayAfterLoop | The current delay time that the VFXSpawner waits for after it finishes a loop. |
| delayBeforeLoop | The current delay time that the VFXSpawner waits for before it starts a loop. |
| deltaTime | The current delta time. |
| loopCount | The current loop count. |
| loopDuration | The duration of the looping state. |
| loopIndex | The current index of loop. |
| loopState | The current state of VFXSpawnerState. |
| newLoop | This boolean indicates if a new loop has just started. |
| playing | The current playing state. |
| spawnCount | The current Spawn count. |
| totalTime | The accumulated delta time since the last Play event. |
| vfxEventAttribute | Gets the modifiable current event attribute (Read Only). |