VariableView

Read-only view of a Variable’s metadata (id, type, defaults, meter hint, range). Returned from AllVariables and GetVariable(string). For the live value, use GetVariableValue(string).

public class VariableView

Inheritance System.Object → VariableView

Properties

Default

Initial value at session start.

public object? Default { get; }
Property Value

System.Object

ExternalSync

Author-declared external-sync flag. When true, the host MUST bind a getter via SyncVariable(string, Func<object>); otherwise reads fall back to Default.

public bool ExternalSync { get; }
Property Value

System.Boolean

Id

Expression-namespace id (the form used in authored expressions).

public string Id { get; }
Property Value

System.String

Max

Maximum allowed value (numeric variables). Null = unconstrained.

public object? Max { get; }
Property Value

System.Object

Meter

Author-assigned meter display name when this variable should render as a meter; null otherwise.

public string? Meter { get; }
Property Value

System.String

Min

Minimum allowed value (numeric variables). Null = unconstrained.

public object? Min { get; }
Property Value

System.Object

Type

Declared VariableType (Bool / Int / Decimal / String).

public VariableType Type { get; }
Property Value

VariableType

Uuid

Structural uuid — the universal cross-reference key. Use this when storing references to the variable in host state.

public string Uuid { get; }
Property Value

System.String

Docs last synced: 2026-07-08
Screenshot viewer