Enum HygieneOverride
Tri-state override used by ScyllaSceneLoadOptions to control a single step of the scene-transition hygiene pipeline (tween kill, timescale-modifier clear, or event-bus prune) on a per-call basis.
Namespace: Scylla.Core.Scenes
Assembly: ScyllaCore.dll
Syntax
public enum HygieneOverrideRemarks
The default value UseConfig defers to the corresponding flag on the active ScyllaSceneConfiguration, so a default-constructed ScyllaSceneLoadOptions follows the project configuration without any explicit setup. Under UseConfig the step also still depends on whether the operation is destructive by default: single-mode loads, reloads, and unloads run the step when the matching configuration flag is enabled, while additive loads skip it unless the step is explicitly set to ForceOn. ForceOn and ForceOff both bypass this default-by-operation-kind behavior entirely and apply unconditionally.
Fields
| Name | Description |
|---|---|
| ForceOff | Skip this hygiene step for this operation regardless of the active configuration and regardless of whether the operation would otherwise run the step by default. Use this when the caller already performs the equivalent cleanup itself and the framework's pass would be redundant or destructive. |
| ForceOn | Run this hygiene step for this operation regardless of the active configuration and regardless of whether the operation would otherwise run the step by default. Use this to force cleanup on an additive load that is known to replace objects the outgoing scene depended on. |
| UseConfig | Follow the corresponding flag on the active ScyllaSceneConfiguration, and only run the step at all when the operation is destructive by default (a single-mode load, a reload, or an unload). Additive loads leave the step disabled under this setting. |