VFXSpawnerState
The spawn state of a Spawn system.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Class
- Namespace: UnityEngine.VFX
- Assembly: UnityEngine.VFXModule
- Implements: IDisposable
public sealed class VFXSpawnerState : IDisposable
Remarks
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.
Examples
using UnityEngine;using UnityEngine.VFX;class ConstantRateEquivalent : VFXSpawnerCallbacks{ public class InputProperties { [Min(0), Tooltip("Sets the number of particles to spawn per second.")] public float Rate = 10; } static private readonly int rateID = Shader.PropertyToID("Rate"); public sealed override void OnPlay(VFXSpawnerState state, VFXExpressionValues vfxValues, VisualEffect vfxComponent) { } public sealed override void OnUpdate(VFXSpawnerState state, VFXExpressionValues vfxValues, VisualEffect vfxComponent) { if (state.playing) { float currentRate = vfxValues.GetFloat(rateID); state.spawnCount += currentRate * state.deltaTime; } } public sealed override void OnStop(VFXSpawnerState state, VFXExpressionValues vfxValues, VisualEffect vfxComponent) { }}
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). |