LocationView

Read-only view of a Location. Mirrors *View pattern.

public class LocationView

Inheritance System.Object → LocationView

Properties

Ambiences

Ambient audio definitions authored for this location.

public IReadOnlyList<LocationAmbience> Ambiences { get; }
Property Value

System.Collections.Generic.IReadOnlyList<LocationAmbience>

AvailableConnections

Connections whose visibleWhen evaluates true at the time of read. Computed lazily by the runtime when constructing the view; not pre-cached on Location since connection visibility is variable-driven. Empty on AllLocations() views — connection enumeration is a CurrentLocation-only surface (Pack 4 §4.1).

public IReadOnlyList<LocationConnectionView> AvailableConnections { get; }
Property Value

System.Collections.Generic.IReadOnlyList<LocationConnectionView>

Description

Optional author description.

public string? Description { get; }
Property Value

System.String

DisplayName

Display name; resolves under the active locale on each access (lazy) when the view was hydrated with a LocaleService, else the raw source.

public string DisplayName { get; }
Property Value

System.String

Id

Writer’s human-readable location id (e.g. loc_harbor). Stable across runs; safe in expressions and analytics.

public string Id { get; }
Property Value

System.String

UnavailableConnections

Connections currently blocked (visibleWhen false) that opted into greyed rendering via an authored blockedReason (Pack 4 §4.1). Blocked connections without a reason appear in no list at all (secret passages). Empty on AllLocations() views.

public IReadOnlyList<LocationConnectionView> UnavailableConnections { get; }
Property Value

System.Collections.Generic.IReadOnlyList<LocationConnectionView>

Uuid

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

public string Uuid { get; }
Property Value

System.String

Docs last synced: 2026-07-18
Screenshot viewer