API

Assembly: Spark.Scenes Interface: IScenesPlugin Implementation: ScenesPlugin

Interface

public interface IScenesPlugin
{
    List<SceneEntry> GetAllSceneEntries();
    SceneEntry GetSceneEntry(string sceneId);
    bool HasSceneEntry(string sceneId);
    void LoadScene(SceneEntry sceneEntry);
    void LoadSceneById(string sceneId);
    void LoadSceneByName(string sceneName);
}

Methods

GetAllSceneEntries

List<SceneEntry> GetAllSceneEntries()

Returns all scene entries in the database.

GetSceneEntry

SceneEntry GetSceneEntry(string sceneId)

Returns the scene entry with the given ID, or null if not found.

HasSceneEntry

bool HasSceneEntry(string sceneId)

Returns true if a scene entry exists with the given ID.

LoadScene / LoadSceneById / LoadSceneByName

void LoadScene(SceneEntry sceneEntry)
void LoadSceneById(string sceneId)
void LoadSceneByName(string sceneName)

Loads a scene using the SceneLoader system. Triggers loading screen, publishes events, and repositions the player entity on completion.

SceneEntry

Extends SparkDatabaseEntry. Defines a game scene.

Field	Type	Description
sceneFileName	string	Scene name as registered in Build Settings
defaultSpawnPosition	Vector3	Where the player spawns
defaultSpawnRotation	Vector3	Player facing direction (Euler angles)
loadingImages	List<Sprite>	Images shown during loading

Methods:

Vector3 GetDefaultSpawnPosition()
Quaternion GetDefaultSpawnRotation()
Sprite GetRandomLoadingImage()
bool HasLoadingImages()
string GetSceneFileName()

Commands

Command	Fields	Description
LoadSceneCommand	string SceneEntryId	Requests a scene load

Events

SceneLoadStartedEvent

Published when a scene begins loading.

Property	Type	Description
SceneEntryId	string	ID of the scene entry
SceneFileName	string	Scene file name

EventType: "Scenes.LoadStarted"

SceneLoadCompletedEvent

Published when a scene finishes loading.

Property	Type	Description
SceneEntryId	string	ID of the scene entry
SceneFileName	string	Scene file name

EventType: "Scenes.LoadCompleted"

SceneLoader

Static utility class that handles async scene loading with progress tracking. Integrates with LoadingScreenManager for visual feedback.

Usage

var scenesPlugin = Spark.GetPlugin<IScenesPlugin>();
if (scenesPlugin != null)
{
    // Load by entry
    SceneEntry dungeon = scenesPlugin.GetSceneEntry("dungeon_01");
    scenesPlugin.LoadScene(dungeon);

    // Load by ID
    scenesPlugin.LoadSceneById("town_01");

    // Load by name
    scenesPlugin.LoadSceneByName("MainMenu");
}

// Listen for scene load events
SparkEventBus.Subscribe<SceneLoadCompletedEvent>(this);

public bool Handle(SceneLoadCompletedEvent evt)
{
    Debug.Log($"Scene loaded: {evt.SceneFileName}");
    return false;
}