Struct yarnspinner::runtime::Dialogue

pub struct Dialogue { /* private fields */ }

Co-ordinates the execution of Yarn programs.

The main functions of interest are Dialogue::continue_ and Dialogue::set_selected_option.

Implementations

impl Dialogue

pub fn new( variable_storage: Box<dyn VariableStorage>, text_provider: Box<dyn TextProvider> ) -> Dialogue

Creates a new Dialogue instance with the given VariableStorage and TextProvider.

• The TextProvider is used to retrieve the text of lines and options.
• The VariableStorage is used to store and retrieve variables.

If you don’t need any fancy behavior, you can use StringTableTextProvider and MemoryVariableStorage.

impl Dialogue

pub fn language_code(&self) -> Option<&Language>

The Dialogue’s locale, as an IETF BCP 47 code.

This code is used to determine how the plural and ordinal markers determine the plural class of numbers.

For example, the code “en-US” represents the English language as used in the United States.

Returns

Returns the last language code.

pub fn set_language_code( &mut self, language_code: impl Into<Option<Language>> ) -> Option<Language>

Sets the Dialogue’s language. A value of None means that you are using the base language, i.e. the one the Yarn files are written in. Returns the last language code.

pub fn library(&self) -> &Library

Gets the Library that this Dialogue uses to locate functions.

When the Dialogue is constructed, the Library is initialized with the built-in operators like +, -, and so on.

pub fn library_mut(&mut self) -> &mut Library

See Dialogue::library.

pub fn line_hints_enabled(&self) -> bool

Gets whether Dialogue::next is able able to return DialogueEvent::LineHints events. The default is false.

pub fn set_line_hints_enabled(&mut self, enabled: bool) -> &mut Dialogue

Mutable gets whether Dialogue::next is able able to return DialogueEvent::LineHints events. The default is false.

pub fn text_provider(&self) -> &dyn TextProvider

Gets the currently registered TextProvider.

pub fn text_provider_mut(&mut self) -> &mut dyn TextProvider

Mutable gets the currently registered TextProvider.

pub fn variable_storage(&self) -> &dyn VariableStorage

Gets the currently registered VariableStorage.

pub fn variable_storage_mut(&mut self) -> &mut dyn VariableStorage

Mutable gets the currently registered VariableStorage.

impl Dialogue

pub fn continue_(&mut self) -> Result<Vec<DialogueEvent>, DialogueError>

Starts, or continues, execution of the current program.

Calling this method returns a batch of DialogueEvents that should be handled by the caller before calling Dialogue::continue_ again. Some events can be ignored, however this method will error if the following events are not properly handled:

• DialogueEvent::Options indicates that the program is waiting for the user to select an option. The user’s selection must be passed to Dialogue::set_selected_option before calling Dialogue::continue_ again.
• DialogueEvent::DialogueComplete means that the program reached its end. When this occurs, Dialogue::set_node must be called before Dialogue::continue_ is called again.

See the documentation of DialogueEvent for more information on how to handle each event.

The Iterator implementation of Dialogue is a convenient way to call Dialogue::next repeatedly, although it panics if an error occurs.

Implementation Notes

All handlers in the original were converted to DialogueEvents because registration of complex callbacks is very unidiomatic in Rust. Specifically, we cannot guarantee Send and Sync properly without a lot of std::sync::RwLock boilerplate. The original implementation also allows unsound parallel mutation of Dialogue’s state, which would result in a deadlock in our case.

pub fn replace_program(&mut self, program: Program) -> &mut Dialogue

Sets or replaces the Dialogue’s current Program. The program is replaced, all current state is reset.

pub fn add_program(&mut self, program: Program) -> &mut Dialogue

Merges the currently set Program with the given one. If there is no program set, the given one is set.

pub fn set_node( &mut self, node_name: impl Into<String> ) -> Result<&mut Dialogue, DialogueError>

Prepares the Dialogue that the user intends to start running a node.

After this method is called, you call Dialogue::next to start executing it.

If Dialogue::line_hints_enabled has been set, the next Dialogue::next call will return a DialogueEvent::LineHints, as the Dialogue determines which lines may be delivered during the node_name node’s execution.

Errors

Returns an error if no node with the value of node_name has been loaded.

pub fn pop_line_hints(&mut self) -> Option<Vec<LineId>>

Attempts to pop the line hints that were generated by the last Dialogue::set_node call.

Panics if Dialogue::line_hints_enabled is false.

pub fn stop(&mut self) -> Vec<DialogueEvent>

Immediately stops the Dialogue

Returns unfinished DialogueEvents that should be handled by the caller. The last is guaranteed to be DialogueEvent::DialogueComplete.

pub fn unload_all(&mut self)

Unloads all nodes from the Dialogue.

pub fn node_names(&self) -> Option<impl Iterator<Item = &str>>

Gets the names of the nodes in the currently loaded Program, if there is one.

pub fn get_line_id_for_node(&self, node_name: &str) -> Option<LineId>

Returns the line ID that contains the original, uncompiled source text for a node.

A node’s source text will only be present in the string table if its tags header contains rawText.

Because the Dialogue API is designed to be unaware of the contents of the string table, this method does not test to see if the string table contains an entry with the line ID. You will need to test for that yourself.

pub fn get_tags_for_node(&self, node_name: &str) -> Option<Vec<String>>

Returns the tags for the node node_name.

The tags for a node are defined by setting the tags header in the node’s source code. This header must be a space-separated list

Returns None if the node is not present in the program.

pub fn node_exists(&self, node_name: &str) -> bool

Gets a value indicating whether a specified node exists in the Program.

pub fn current_node(&self) -> Option<String>

Gets the name of the node that this Dialogue is currently executing.

If Dialogue::next has never been called, this value will be None.

pub fn analyse(&self, context: &mut Context) -> &Dialogue

Analyses the currently loaded Yarn program with the given Context. Call Context::finish_analysis afterwards to get the results.

pub fn set_selected_option( &mut self, selected_option_id: OptionId ) -> Result<&mut Dialogue, DialogueError>

Signals to the Dialogue that the user has selected a specified DialogueOption.

After the Dialogue emitted a DialogueEvent::Options in Dialogue::continue_, this method must be called before Dialogue::next is called.

The ID number that should be passed as the parameter to this method should be the OptionId field in the DialogueOption that represents the user’s selection.

Panics

• If the Dialogue is not expecting an option to be selected.
• If the option ID is not found in the vector of DialogueOption provided by DialogueEvent::Options.

See Also

• Dialogue::continue_

pub fn is_active(&self) -> bool

Gets a value indicating whether the Dialogue is currently executing Yarn instructions.

pub fn is_waiting_for_option_selection(&self) -> bool

Returns true if the last call to Dialogue::continue_ returned DialogueEvent::Options and the dialogue is therefore waiting for the user to select an option via Dialogue::set_selected_option. If this is true, calling Dialogue::continue_ will error and Dialogue::next will panic.

Trait Implementations

impl Debug for Dialogue

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

Formats the value using the given formatter.

impl Iterator for Dialogue

fn next(&mut self) -> Option<<Dialogue as Iterator>::Item>

Panicking version of Dialogue::continue_.

type Item = Vec<DialogueEvent>

The type of the elements being iterated over.

fn next_chunk<const N: usize>( &mut self ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk)

Advances the iterator and returns an array containing the next N values.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn count(self) -> usize

where Self: Sized,

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>

where Self: Sized,

Consumes the iterator, returning the last element.

fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)

Advances the iterator by n elements.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator.

fn step_by(self, step: usize) -> StepBy<Self>

where Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration.

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence.

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs.

fn intersperse(self, separator: Self::Item) -> Intersperse<Self>

where Self: Sized, Self::Item: Clone,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places a copy of separator between adjacent items of the original iterator.

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>

where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places an item generated by separator between adjacent items of the original iterator.

fn map<B, F>(self, f: F) -> Map<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element.

fn for_each<F>(self, f: F)

where Self: Sized, F: FnMut(Self::Item),

Calls a closure on each element of an iterator.

fn filter<P>(self, predicate: P) -> Filter<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded.

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>

where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>

where Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information.

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate.

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate.

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>

where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps.

fn skip(self, n: usize) -> Skip<Self>

where Self: Sized,

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>

where Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>

where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>

where Self: Sized, U: IntoIterator, F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure.

fn flatten(self) -> Flatten<Self>

where Self: Sized, Self::Item: IntoIterator,

Creates an iterator that flattens nested structure.

fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>

where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (iter_map_windows)

Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well.

fn fuse(self) -> Fuse<Self>

where Self: Sized,

Creates an iterator which ends after the first None.

fn inspect<F>(self, f: F) -> Inspect<Self, F>

where Self: Sized, F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Borrows an iterator, rather than consuming it.

fn collect<B>(self) -> B

where B: FromIterator<Self::Item>, Self: Sized,

Transforms an iterator into a collection.

fn collect_into<E>(self, collection: &mut E) -> &mut E

where E: Extend<Self::Item>, Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into)

Collects all the items from an iterator into a collection.

fn partition<B, F>(self, f: F) -> (B, B)

where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it.

fn is_partitioned<P>(self, predicate: P) -> bool

where Self: Sized, P: FnMut(Self::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_is_partitioned)

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false.

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R

where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value.

fn try_for_each<F, R>(&mut self, f: F) -> R

where Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error.

fn fold<B, F>(self, init: B, f: F) -> B

where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result.

fn reduce<F>(self, f: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation.

fn try_reduce<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType

where Self: Sized, F: FnMut(Self::Item, Self::Item) -> R, R: Try<Output = Self::Item>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce)

Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately.

fn all<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate.

fn find<P>(&mut self, predicate: P) -> Option<Self::Item>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate.

fn find_map<B, F>(&mut self, f: F) -> Option<B>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result.

fn try_find<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType

where Self: Sized, F: FnMut(&Self::Item) -> R, R: Try<Output = bool>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (try_find)

Applies function to the elements of iterator and returns the first true result or the first error.

fn position<P>(&mut self, predicate: P) -> Option<usize>

where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function.

fn max_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function.

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function.

fn min_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function.

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)

where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers.

fn copied<'a, T>(self) -> Copied<Self>

where T: 'a + Copy, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements.

fn cloned<'a, T>(self) -> Cloned<Self>

where T: 'a + Clone, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements.

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks)

Returns an iterator over N elements of the iterator at a time.

fn sum<S>(self) -> S

where Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator.

fn product<P>(self) -> P

where Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn partial_cmp<I>(self, other: I) -> Option<Ordering>

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned.

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn eq<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are equal to those of another.

fn eq_by<I, F>(self, other: I, eq: F) -> bool

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_order_by)

Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function.

fn ne<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are not equal to those of another.

fn lt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less than those of another.

fn le<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

fn gt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than those of another.

fn ge<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.

fn is_sorted_by<F>(self, compare: F) -> bool

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> bool,

🔬This is a nightly-only experimental API. (is_sorted)

Checks if the elements of this iterator are sorted using the given comparator function.

fn is_sorted_by_key<F, K>(self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd,

🔬This is a nightly-only experimental API. (is_sorted)

Checks if the elements of this iterator are sorted using the given key extraction function.