Class SetupUiShellOverlay

Namespace

LibreRally.HUD

Assembly

LibreRally.dll

UI overlay for the garage setup and vehicle tuning menu.

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

Inheritance

object

DisposeBase

ComponentBase

GameSystemBase

SetupUiShellOverlay

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

SetupUiShellOverlay(IServiceRegistry)

Initializes a new instance of the SetupUiShellOverlay class.

public SetupUiShellOverlay(IServiceRegistry services)

Parameters

services IServiceRegistry

The service registry.

Properties

ApplyRequested

Occurs when the user requests to apply the current setup changes.

public Action<SetupUiApplyPayload>? ApplyRequested { get; set; }

Property Value

Action<SetupUiApplyPayload>

CloseRequested

Occurs when the user requests to close the setup menu.

public Action? CloseRequested { get; set; }

Property Value

Action

OverlayVisible

Gets or sets a value indicating whether the setup UI overlay is visible.

public bool OverlayVisible { get; set; }

Property Value

bool

StatusText

Gets or sets the status text displayed in the setup menu.

public string StatusText { get; set; }

Property Value

string

VehicleName

Gets or sets the name of the vehicle being tuned.

public string VehicleName { get; set; }

Property Value

string

Methods

BindVehicle(LoadedVehicle?, VehicleSetupOverrides?, string?)

Binds a vehicle and its setup overrides to the UI.

public void BindVehicle(LoadedVehicle? vehicle, VehicleSetupOverrides? overrides, string? statusText = null)

Parameters

vehicle LoadedVehicle

The loaded vehicle.

overrides VehicleSetupOverrides

The current setup overrides.

statusText string

Optional status text to display.

Destroy()

Disposes of object resources.

protected override void Destroy()

Draw(GameTime)

Draws the garage setup overlay when it is visible.

public override void Draw(GameTime gameTime)

Parameters

gameTime GameTime

Stride timing data for the current frame.

Initialize()

Initializes the garage setup overlay and creates its root desktop widgets.

public override void Initialize()

Update(GameTime)

Processes setup-overlay navigation input for the current frame.

public override void Update(GameTime gameTime)

Parameters

gameTime GameTime

Stride timing data for the current frame.