Logo FSBarV1_Archived

HubEvent Type

Hub-wide event payload. Equality and comparison are opted out — feature 040 added cases carrying `VizConfig`, whose transitive `ColorScheme.MapValue` function field has no structural equality. Rather than forcing every downstream record to custom-equal, tests compare events by pattern-match + per-field check.

Union cases

Union case Description

ActiveTabChanged tab

Full Usage: ActiveTabChanged tab

Parameters:

Authoritative active-tab changed. Payload = new tab.

tab : HubTab

AdminChannelStatusChanged status

Full Usage: AdminChannelStatusChanged status

Parameters:

The admin channel's hub-level status changed (feature 039).

status : AdminChannelStatus

CameraChanged camera

Full Usage: CameraChanged camera

Parameters:

Viewer-tab camera (pan/zoom/autofit) changed.

camera : ViewerCamera

DiagnosticsLine(severity, message)

Full Usage: DiagnosticsLine(severity, message)

Parameters:

A free-form diagnostic message was emitted.

severity : Severity
message : string

EncyclopediaSelectionChanged selection

Full Usage: EncyclopediaSelectionChanged selection

Parameters:

Units-tab filter or pinned selection changed.

selection : EncyclopediaSelection

EngineSpeedChanged speed

Full Usage: EngineSpeedChanged speed

Parameters:
    speed : float32

The engine time multiplier was changed.

speed : float32

HubSettingsChanged settings

Full Usage: HubSettingsChanged settings

Parameters:

The persisted `HubSettings` snapshot changed.

settings : HubSettings

LobbyChanged lobby

Full Usage: LobbyChanged lobby

Parameters:

Setup-tab lobby edited; only valid while `SessionManager` is idle.

lobby : LobbyConfig

PresetDeleted name

Full Usage: PresetDeleted name

Parameters:
    name : string

A style preset was deleted.

name : string

PresetLoaded name

Full Usage: PresetLoaded name

Parameters:
    name : string

A style preset was loaded into the live `VizConfig`.

name : string

PresetSaved name

Full Usage: PresetSaved name

Parameters:
    name : string

A style preset was persisted under `name`.

name : string

ProxyInstallProgress(step, outcome)

Full Usage: ProxyInstallProgress(step, outcome)

Parameters:

One step of the proxy-install flow reported its outcome.

step : ProxyInstallStep
outcome : StepOutcome

ScriptingClientConnected(clientId, remote)

Full Usage: ScriptingClientConnected(clientId, remote)

Parameters:
    clientId : Guid
    remote : string

A scripting-client successfully attached to `StreamGameFrames`.

clientId : Guid
remote : string

ScriptingClientDetached(clientId, reason)

Full Usage: ScriptingClientDetached(clientId, reason)

Parameters:

A scripting-client was detached; `reason` tells operators whether this was the client's doing or a hub-initiated teardown.

clientId : Guid
reason : DetachReason

SessionPaused paused

Full Usage: SessionPaused paused

Parameters:
    paused : bool

The engine's paused-ness was toggled.

paused : bool

StateChanged tag

Full Usage: StateChanged tag

Parameters:

The session lifecycle transitioned to a new tag.

tag : SessionStateTag

VizAttributeChanged(key, oldValue, newValue)

Full Usage: VizAttributeChanged(key, oldValue, newValue)

Parameters:

A single-attribute change within `VizConfig`. Both old/new values are carried so subscribers can produce a focused UI diff or an authoritative wire event without re-reading the store.

key : string
oldValue : AttributeValue
newValue : AttributeValue

VizConfigChanged config

Full Usage: VizConfigChanged config

Parameters:

A whole-`VizConfig` replacement was applied (e.g. preset load).

config : VizConfig

Instance members

Instance member Description

this.IsActiveTabChanged

Full Usage: this.IsActiveTabChanged

Returns: bool
Returns: bool

this.IsAdminChannelStatusChanged

Full Usage: this.IsAdminChannelStatusChanged

Returns: bool
Returns: bool

this.IsCameraChanged

Full Usage: this.IsCameraChanged

Returns: bool
Returns: bool

this.IsDiagnosticsLine

Full Usage: this.IsDiagnosticsLine

Returns: bool
Returns: bool

this.IsEncyclopediaSelectionChanged

Full Usage: this.IsEncyclopediaSelectionChanged

Returns: bool
Returns: bool

this.IsEngineSpeedChanged

Full Usage: this.IsEngineSpeedChanged

Returns: bool
Returns: bool

this.IsHubSettingsChanged

Full Usage: this.IsHubSettingsChanged

Returns: bool
Returns: bool

this.IsLobbyChanged

Full Usage: this.IsLobbyChanged

Returns: bool
Returns: bool

this.IsPresetDeleted

Full Usage: this.IsPresetDeleted

Returns: bool
Returns: bool

this.IsPresetLoaded

Full Usage: this.IsPresetLoaded

Returns: bool
Returns: bool

this.IsPresetSaved

Full Usage: this.IsPresetSaved

Returns: bool
Returns: bool

this.IsProxyInstallProgress

Full Usage: this.IsProxyInstallProgress

Returns: bool
Returns: bool

this.IsScriptingClientConnected

Full Usage: this.IsScriptingClientConnected

Returns: bool
Returns: bool

this.IsScriptingClientDetached

Full Usage: this.IsScriptingClientDetached

Returns: bool
Returns: bool

this.IsSessionPaused

Full Usage: this.IsSessionPaused

Returns: bool
Returns: bool

this.IsStateChanged

Full Usage: this.IsStateChanged

Returns: bool
Returns: bool

this.IsVizAttributeChanged

Full Usage: this.IsVizAttributeChanged

Returns: bool
Returns: bool

this.IsVizConfigChanged

Full Usage: this.IsVizConfigChanged

Returns: bool
Returns: bool

Type something to start searching.