Enum TextEffectState
Lifecycle states of a text effect.
Namespace: Scylla.TextMode
Assembly: ScyllaTextMode.dll
Syntax
public enum TextEffectStateRemarks
An effect starts Idle. Starting it moves it to Delayed when it has a start delay and to Running otherwise. It ends either Completed after reaching full progress or Stopped after being cancelled. Both end states are terminal until the effect is started again.
Fields
| Name | Description |
|---|---|
| Completed | Ran to full progress and finished on its own. |
| Delayed | Started, but still waiting out its start delay. The effect has written nothing yet. |
| Idle | Created but not yet started. The effect has written nothing. |
| Paused | Started but temporarily suspended. The effect keeps its progress and the cells it has already written, and resumes from where it left off. |
| Running | Started and advancing. The effect owns the cells in its region. |
| Stopped | Cancelled before reaching full progress. |