ProjectMetadata

Static project-level facts (name, uuid, schema version, source locale, etc.). Snapshot taken once at runtime construction — does not track mid-session mutations to the underlying project.

public readonly struct ProjectMetadata

Properties

CloseOnTransition

Whether scene transitions close the previous scene by default.

public bool CloseOnTransition { get; }
Property Value

System.Boolean

DefaultHideWhenResolved

Project-level default for StoryBonsai.Runtime.Models.Scene.HideWhenResolved when “inherit”.

public bool DefaultHideWhenResolved { get; }
Property Value

System.Boolean

DefaultModal

Project-level default for StoryBonsai.Runtime.Models.Scene.Modal when “inherit”.

public bool DefaultModal { get; }
Property Value

System.Boolean

EntrySceneId

Uuid of the entry scene (the scene Start activates).

public string? EntrySceneId { get; }
Property Value

System.String

Id

Writer-facing project id (human-readable).

public string Id { get; }
Property Value

System.String

Name

Project display name.

public string Name { get; }
Property Value

System.String

NumPlayers

Number of seats this project expects. 1 = single-player.

public int NumPlayers { get; }
Property Value

System.Int32

OutroNodeId

Optional orphan-node uuid whose events fire on completeProject.

public string? OutroNodeId { get; }
Property Value

System.String

ProjectVersion

Optional writer-set release/version tag for the content itself.

public string? ProjectVersion { get; }
Property Value

System.String

SchemaVersion

Project file schema version (e.g. “5.2.0”).

public string SchemaVersion { get; }
Property Value

System.String

SourceLocale

Locale used as the source-of-truth for authored strings.

public string SourceLocale { get; }
Property Value

System.String

StartingLocationId

Optional starting location uuid; applied during Start.

public string? StartingLocationId { get; }
Property Value

System.String

Uuid

Internal stable identifier — survives renames.

public string Uuid { get; }
Property Value

System.String

Docs last synced: 2026-07-08
Screenshot viewer