ChoiceGroupView

Projection of a StoryBonsai.Runtime.Models.ChoiceGroup. Attached to each GroupedChoice emitted by the runtime’s GetChoices.

public class ChoiceGroupView

Inheritance System.Object → ChoiceGroupView

Properties

CustomType

Optional custom classifier (e.g. "dialogue", "action") for project-specific UI routing. Ignored by the runtime.

public string? CustomType { get; }
Property Value

System.String

Description

Optional author description of the group’s purpose. Not surfaced to players by default.

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 group id (e.g. group_dialogue_options). Stable across runs; safe in analytics and expressions.

public string Id { get; }
Property Value

System.String

Order

Authored sort order on the source StoryBonsai.Runtime.Models.ChoiceGroup. Informational — the runtime emits groups in first-appearance order of their member nodes (driven by Node.Order), not by this field.

public int Order { get; }
Property Value

System.Int32

Presentation

How the host should present grouped choices — see ChoicePresentation for the Default / Fullscreen / Custom semantics.

public ChoicePresentation Presentation { get; }
Property Value

ChoicePresentation

Uuid

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

public string Uuid { get; }
Property Value

System.String

Docs last synced: 2026-07-08
Screenshot viewer