Struct Story 

pub struct Story {
    pub asset_id: AssetId,
    pub title: String,
    pub nodes: Vec<StoryNode>,
    pub text_speed: f32,
    pub scaffold: StoryScaffold,
    pub save_key: String,
}

A compiled branching story graph, played at runtime by the story system.

A Story is normally produced by a StoryImport expansion at build time rather than written by hand: the Markdown source compiles into this graph plus the stage scaffolding (a single dialogue Screen whose labels and sprites the story system mutates page by page). All references are pre-resolved: dialog text is pre-wrapped, speakers carry their display name and color, stage images carry their on-canvas rectangle, and jump / choice targets are node indices into nodes.

The story system reads the graph and drives the stage screen named <name>_stage: it fills the dialogue and name-plate labels (revealing text at text_speed), swaps the backdrop and portrait sprite textures, shows the choice menu when a node ends in one, and plays page audio. Clicking the stage (or pressing Space) advances; story:start restarts from the first node.

Fields

asset_id: AssetId

Asset identity; injected via inject_name. Not part of args.

title: String

The story title, as shown on the generated title screen.

nodes: Vec<StoryNode>

The node graph in document order. Play starts at the first node; a node whose last page has no jump and no choices falls through to the next node, and the last node ends the story.

text_speed: f32

Dialogue reveal speed in characters per second. 0 shows each page instantly.

scaffold: StoryScaffold

The generated stage assets the story system drives. All references are resolved to ids at build time, like every other cross-reference.

save_key: String

Stable key naming this story’s save file (position + flags, auto-saved page by page under the project data directory). Empty disables saving.

Trait Implementations

impl Clone for Story

fn clone(&self) -> Story

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for Story

const NAME: &'static str = "Story"

The registry name a world authors this component under.

fn inject_name(&mut self, id: AssetId)

Called after construction to inject the asset’s identity from the blob def. Only meaningful for components that look themselves up by id at runtime. The default implementation does nothing.

fn from_baked(bytes: &[u8]) -> Result<Story, CnResult>

Reconstruct this component from a blob record, whose bytes are the serialized runtime component (cook already ran the asset -> component translation). The default rejects: runtime-only components are never stored in a blob, so only loadable types provide an implementation.

fn inject_locator(&mut self, _locator: PayloadLocator)

Called after construction to inject the payload locator from the blob def. Only meaningful for components with a compiled payload. The default implementation does nothing (correct for most components).

impl ComponentSlot for Story

const DISCRIMINANT: u8

The component type’s stable id, used as its ComponentId.

fn slot(s: &ComponentStorage) -> &Column<Story>

Borrow this type’s column out of the storage.

fn slot_mut(s: &mut ComponentStorage) -> &mut Column<Story>

Mutably borrow this type’s column out of the storage.

impl Debug for Story

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Story

fn default() -> Story

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Story

where Story: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Story, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Story> for ComponentAsset

fn from(c: Story) -> ComponentAsset

Converts to this type from the input type.

impl RuntimeComponent for Story

impl Serialize for Story

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.