Enum DialogueEvent 

#[non_exhaustive]
pub enum DialogueEvent {
    NodeStarted(String),
    Line {
        speaker: Option<String>,
        text: String,
        line_id: Option<String>,
        tags: Vec<String>,
        line_mode: LineMode,
        spans: Vec<MarkupSpan>,
    },
    Options(Vec<DialogueOption>),
    Command {
        name: String,
        args: Vec<String>,
        tags: Vec<String>,
    },
    NodeComplete(String),
    DialogueComplete,
}

Events emitted by crate::Runner one at a time via crate::Runner::next_event.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NodeStarted(String)

A node has started executing.

Line

A line of dialogue ready to display.

Fields

speaker: Option<String>

Optional speaker name.

text: String

Display text with all {expr} fragments evaluated and markup tags stripped.

line_id: Option<String>

If the line was tagged with #line:<id>, the stable id (no line: prefix).

tags: Vec<String>

Trailing #tag metadata.

line_mode: LineMode

Hint for filtering or routing (from #narration / #debug when present).

spans: Vec<MarkupSpan>

Inline markup spans over text, in source order. Empty when the line contains no markup tags.

Options(Vec<DialogueOption>)

A set of options for the player to choose from.

Command

A host command to execute.

Fields

name: String

Command name.

args: Vec<String>

Arguments with {expr} substituted.

tags: Vec<String>

Trailing tags.

NodeComplete(String)

The current node has finished.

DialogueComplete

All dialogue has finished.

Trait Implementations

impl Clone for DialogueEvent

fn clone(&self) -> DialogueEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DialogueEvent

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

Formats the value using the given formatter.

impl PartialEq for DialogueEvent

fn eq(&self, other: &DialogueEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DialogueEvent