Skip to content

LoadingScene Class

Definition

Namespace: Brine2D.Engine

Base class for loading screens. Framework properties \(Logger, Renderer\) are set automatically by SceneManager. Loading screens do not have a World; they render between scene scopes. Override OnEnter() and OnExit() for one-time setup and teardown \(e\.g\., starting music\). Both are called on the main thread.

C#
public abstract class LoadingScene : Brine2D.Engine.SceneBase

Inheritance System.Object → SceneBase → LoadingScene

Properties
LoadingMessage Gets the current loading message. Safe to read from any thread.
LoadingProgress Gets the current loading progress \(0\.0–1\.0\). Safe to read from any thread.
LoadingTextOptions Text render options used by OnRenderLoading\(GameTime\). Override to specify a font or adjust the size for the default progress bar UI.
Methods
OnRenderLoading\(GameTime\) Override to customize the loading screen appearance.
UpdateProgress\(float, string\) Updates the loading progress \(0\.0 to 1\.0\). Safe to call from background threads during scene loading.