Class UnityBootFailureOverlayComponent

The minimal on-screen message a boot that did not go cleanly leaves behind, drawn with legacy IMGUI because that is the only drawing path that needs no camera, no canvas and no Serenity service — the failure may be the UI system's own install, so anything richer could fail with it. A halted boot takes the screen; a degraded one draws a strip at the top and leaves the running game visible under it.

Inheritance

object

UnityBootFailureOverlayComponent

Namespace: Serenity.InitializationPipeline.Infrastructure.BootFailure

Assembly: Serenity.UnityInitializationPipeline.Infrastructure.dll

Syntax

public sealed class UnityBootFailureOverlayComponent : MonoBehaviour

Constructors

UnityBootFailureOverlayComponent()

Declaration

public UnityBootFailureOverlayComponent()

Properties

BlocksTheScreen

Declaration

public bool BlocksTheScreen { get; }

Property Value

Type	Description
bool	True when this overlay covers the screen — a halt — rather than sitting above a running game. Read by a test instead of the pixels.

Message

Declaration

public string Message { get; }

Property Value

Type	Description
string	The text this overlay draws — read by a test instead of the pixels.

Methods

Show(string, bool)

Shows message until the scene reloads.

Declaration

public void Show(string message, bool blocksTheScreen)

Parameters

Type	Name	Description
string	message	The text to draw.
bool	blocksTheScreen	True for a halt; false for a degraded boot, which stays playable.