Class LoadingOverlay

Namespace

LibreRally.HUD

Assembly

LibreRally.dll

Full-screen loading overlay with progress bar and status text, displayed during vehicle loading.

public sealed class LoadingOverlay : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable

Inheritance

object

DisposeBase

ComponentBase

GameSystemBase

LoadingOverlay

Implements

IDisposable

ICollectorHolder

IGameSystemBase

IComponent

IReferencable

IUpdateable

IDrawable

IContentable

Inherited Members

GameSystemBase.BeginDraw()

GameSystemBase.EndDraw()

GameSystemBase.Game

GameSystemBase.Services

GameSystemBase.Visible

GameSystemBase.DrawOrder

GameSystemBase.Enabled

GameSystemBase.UpdateOrder

GameSystemBase.DrawOrderChanged

GameSystemBase.VisibleChanged

GameSystemBase.EnabledChanged

GameSystemBase.UpdateOrderChanged

ComponentBase.Tags

ComponentBase.ToString()

ComponentBase.Name

DisposeBase.Dispose()

DisposeBase.IsDisposed

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Constructors

LoadingOverlay(IServiceRegistry)

Initializes a new instance of the LoadingOverlay class.

public LoadingOverlay(IServiceRegistry services)

Parameters

services IServiceRegistry

The Stride service registry.

Properties

StatusText

Gets or sets the current loading stage description text.

public string StatusText { get; set; }

Property Value

string

TitleText

Gets or sets the title text displayed above the progress bar.

public string TitleText { get; set; }

Property Value

string

Methods

Destroy()

Disposes of object resources.

protected override void Destroy()

Draw(GameTime)

Draws this instance.

public override void Draw(GameTime gameTime)

Parameters

gameTime GameTime

The current timing.

Initialize()

This method is called when the component is added to the game.

public override void Initialize()

Remarks

This method can be used for tasks like querying for services the component needs and setting up non-graphics resources.

SetProgress(float)

Updates the progress bar fill width.

public void SetProgress(float progress)

Parameters

progress float

Progress value between 0 and 1.

Update(GameTime)

This method is called when this game component is updated.

public override void Update(GameTime gameTime)

Parameters

gameTime GameTime

The current timing.