Struct Runner 

pub struct Runner<S: VariableStorage> { /* private fields */ }

Drives execution of a compiled Program, yielding DialogueEvents one at a time.

Pull model

The host calls Runner::next_event in a loop until it returns Ok(None) (dialogue ended) or until it receives a DialogueEvent::Options, at which point it must call Runner::select_option before continuing.

Implementations

impl<S: VariableStorage> Runner<S>

pub fn new(program: Program, storage: S) -> Self

Creates a new runner for the given program and variable storage.

Panics

Panics only if the internal Mutex is poisoned, which cannot happen in normal use.

pub fn start(&mut self, node: &str) -> Result<()>

Starts execution at the given node.

Errors

Returns DialogueError::UnknownNode if the title does not exist in the program.

Panics

Panics only if the internal Mutex is poisoned, which cannot happen in normal use.

pub fn next_event(&mut self) -> Result<Option<DialogueEvent>>

Returns the next event, or Ok(None) when dialogue is finished.

Errors

Returns a DialogueError on runtime failures.

pub fn select_option(&mut self, index: usize) -> Result<()>

Selects an option by index after receiving DialogueEvent::Options.

Errors

Returns DialogueError::Runtime if called when not awaiting an option or index is out of range.

pub const fn storage(&self) -> &S

Returns a shared reference to the variable storage.

pub const fn storage_mut(&mut self) -> &mut S

Returns a mutable reference to the variable storage.

pub const fn library_mut(&mut self) -> &mut FunctionLibrary

Returns a mutable reference to the function library (for registering host functions).

pub fn set_saliency(&mut self, strategy: impl SaliencyStrategy)

Replaces the saliency strategy used for line and node group selection.

pub fn set_provider(&mut self, provider: impl LineProvider)

Sets the line provider used for localisation lookup.