Skip to content

SusLoadingScreenContent

SusLoadingScreenContent

Full-bleed loading — brand banner, spinner and/or linear bar, message + optional subline.

Package

SusGame · Screens (commercial)

Open in Playground

SusGame · Screens

Props

NameTypeDefault
BrandTextProp<string>""
MessageProp<string>"Loading..."
SubMessageProp<string>""
ProgressProp<float>0f
ShowSpinnerProp<bool>true

Slots

No slots.

Events

No public events.

Style hooks

USS class contract — override appearance without touching C#. States toggle via these classes:

  • sus-banner__body
  • sus-banner__text
  • sus-loading-screen
  • sus-loading-screen__bar
  • sus-loading-screen__brand
  • sus-loading-screen__indicator
  • sus-loading-screen__message
  • sus-loading-screen__sub

Usage

xml
<template>
  <sus:SusLoadingScreenContent
    :BrandText="Brand.Value"
    :Message="Msg.Value"
    :SubMessage="Sub.Value"
    :Progress="Prog.Value"
    :ShowSpinner="Spin.Value"
  />
</template>

<script>
public Prop<string> Brand = new("My Game");
public Prop<string> Msg = new("Loading...");
public Prop<string> Sub = new("");
public Prop<float> Prog = new(0.35f); // 0…1; <0 = indeterminate
public Prop<bool> Spin = new(true);
</script>
csharp
var loading = new SusLoadingScreenContent();
loading.BrandText.Value = "My Game";
loading.Message.Value = "Connecting…";
loading.SubMessage.Value = "Region EU";
loading.Progress.Value = 0.4f;   // shows linear bar
loading.Progress.Value = -1f;    // indeterminate → spinner if ShowSpinner
loading.ShowSpinner.Value = true;
Prop / APIRole
BrandTextTop banner; empty → hidden
MessagePrimary label
SubMessageSecondary label; empty → hidden
Progress0…1 → bar %; < 0 → indeterminate mode
ShowSpinnerWhen indeterminate, show circular spinner
BrandBannerBuilt banner host

Notes

  • Determinate path clamps Progress to 0…1 and maps to bar 0…100.
  • Indeterminate hides the bar; spinner visibility also needs ShowSpinner=true.
  • Distinct from kit MigratedLoadingScreen (different package / props).