Class ScyllaSceneLoadProgressEvent

Published periodically by ScyllaSceneManager while a managed scene load is in flight, whenever the reported progress advances by at least the configured epsilon (ProgressEventEpsilon) since the last published value. Only load operations produce this event; unloads do not.

Inheritance

object

ScyllaEvent

ScyllaSceneLoadProgressEvent

Inherited Members

ScyllaEvent.IsCancelled

ScyllaEvent.StopPropagation()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Scylla.Core.Scenes

Assembly: ScyllaCore.dll

Syntax

public sealed class ScyllaSceneLoadProgressEvent : ScyllaEvent

Remarks

Publishing sits between ScyllaSceneWillLoadEvent (published once at the start of the load, before this event can fire) and ScyllaSceneLoadedEvent (published once the operation completes and no further progress events follow). Zero, one, or many progress events may be published for a single load depending on how quickly Unity reports progress and how large the configured epsilon is; a load that completes within a single frame may produce none at all.

Progress is normalized to the 0-1 range where 1.0 means the scene is fully activated (Unity's raw 0-0.9 pre-activation range is remapped, and the operation holds at 0.9 with State equal to WaitingForActivation while the activation gate is closed). Loading screens that need frame-accurate progress on every frame should poll Progress on the operation handle instead; this event exists for loosely coupled listeners such as diagnostics overlays that do not hold a reference to the operation.

Like every ScyllaEvent, a handler can call StopPropagation() to keep lower-priority subscribers of this same event from receiving it. ScyllaSceneManager never reads IsCancelled after publishing it, so cancelling this event has no effect on the load operation it reports on.

Constructors

ScyllaSceneLoadProgressEvent(string, float, SceneLoadState)

Initializes a new ScyllaSceneLoadProgressEvent.

Declaration

public ScyllaSceneLoadProgressEvent(string sceneName, float progress, SceneLoadState state)

Parameters

Type	Name	Description
string	sceneName	The name of the scene being loaded.
float	progress	The normalized progress in the range 0-1.
SceneLoadState	state	The current operation state.

Properties

Progress

Gets the normalized load progress in the range 0-1, where 1.0 means the scene is fully activated.

Declaration

public float Progress { get; }

Property Value

Type	Description
float	A value between `0.0` and `1.0` inclusive. Holds at `0.9` while the operation waits at the activation gate; jumps to `1.0` only in the final ScyllaSceneLoadedEvent, not in this event.

SceneName

Gets the name of the scene being loaded.

Declaration

public string SceneName { get; }

Property Value

Type	Description
string

State

Gets the lifecycle state of the load operation at the moment this event was published.

Declaration

public SceneLoadState State { get; }

Property Value

Type	Description
SceneLoadState	One of the non-terminal SceneLoadState values reached while a load is in flight, typically Loading, WaitingForActivation, or Activating.