Struct bevy_yarnspinner::prelude::DialogueRunner

impl DialogueRunner

pub fn continue_in_next_update(&mut self) -> &mut Self

Tells the dialogue runner to try to advance the dialogue in the next update. This method must be called by the dialogue view when the user clicks on a button to show the next line.

Note that the actual advancement of the dialogue will be postponed until the following conditions are met:

The text provider has finished loading its lines, indicated by TextProvider::are_lines_available returning true.
The asset providers have finished loading their assets, indicated by all AssetProvider::update_asset_availability calls returning true.
All previously called YarnCommands are finished, indicated by their return type’s TaskFinishedIndicator::is_finished returning true.

pub fn will_continue_in_next_update(&self) -> bool

Returns whether the dialogue runner will try to advance the dialogue in the next update. This can return true multiple updates in a row if the conditions mentioned in DialogueRunner::continue_in_next_update are not yet met.

pub fn select_option(&mut self, option: OptionId) -> Result<&mut Self>

If the dialogue is currently waiting for the user to select an option, this method will select the option with the given id. Implies DialogueRunner::continue_in_next_update.

pub fn is_running(&self) -> bool

Returns whether the dialogue runner is currently running. Returns false if:

The dialogue has not yet been started via DialogueRunner::start_node
The dialogue has been stopped via DialogueRunner::stop
The dialogue has finished running through all nodes

pub fn is_waiting_for_option_selection(&self) -> bool

Returns whether the dialogue runner is currently waiting for the user to select an option. If this is true, DialogueRunner::select_option must be called before the dialogue can continue. Calling DialogueRunner::continue_in_next_update will panic in this case.

pub fn run_selected_options_as_lines( &mut self, run_selected_options_as_lines: bool ) -> &mut Self

If set, every line the user selects will emit a PresentLineEvent. Defaults to false.

pub fn runs_selected_options_as_lines(&self) -> bool

If set, every line the user selects will emit a PresentLineEvent. Defaults to false.

pub fn stop(&mut self) -> &mut Self

Stops the execution of the dialogue. Any pending dialogue events will still be sent in the next update, including a DialogueCompleteEvent. After this, DialogueRunner::start_node must be called before the dialogue can be advanced again.

pub fn start_node(&mut self, node_name: impl AsRef<str>) -> &mut Self

Starts the dialogue at the given node. This method must be called after creation or after calling DialogueRunner::stop before the dialogue can be advanced. Implies DialogueRunner::continue_in_next_update. If the dialogue was already running, this method will panic.

See DialogueRunner::try_start_node for a fallible version of this method.

pub fn try_start_node( &mut self, node_name: impl AsRef<str> ) -> Result<&mut Self>

Fallible version of DialogueRunner::start_node.

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 Yarn files.

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

Gets the name of the node that this Dialogue is currently executing. This is None if DialogueRunner::is_running is false.

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

Returns a shallow clone of the registered VariableStorage. The storage used can be overridden by calling DialogueRunnerBuilder::with_variable_storage.

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

Returns a shallow mutable clone of the registered VariableStorage. The storage used can be overridden by calling DialogueRunnerBuilder::with_variable_storage.

pub fn update_line_availability( &mut self, loaded_untyped_assets: &Assets<LoadedUntypedAsset> ) -> bool

Returns whether both the text and asset providers have loaded all their lines.

pub fn set_language(&mut self, language: impl Into<Language>) -> &mut Self

Sets the language of both the text and asset providers. Same as calling DialogueRunner::set_text_language and DialogueRunner::set_asset_language.

pub fn set_text_language(&mut self, language: impl Into<Language>) -> &mut Self

Sets the language of the text provider.

pub fn set_asset_language(&mut self, language: impl Into<Language>) -> &mut Self

Sets the language of all asset providers. If no asset providers where added via DialogueRunnerBuilder::add_asset_provider, this will do nothing.

pub fn library(&self) -> &Library

Returns the library of functions that can be called from Yarn files.

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

Mutably returns the library of functions that can be called from Yarn files.

pub fn commands(&self) -> &YarnCommands

Returns the command registrations that can be called from Yarn files.

pub fn commands_mut(&mut self) -> &mut YarnCommands

Mutably returns the command registrations that can be called from Yarn files.

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

Returns the language used by the TextProvider. If there are no Localizations available, this will return None.

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

Returns the language used by the AssetProviders. If there are no Localizations available, this will return None. Panics if the asset providers have different languages.

pub fn inner(&self) -> InnerDialogue<'_>

Returns a struct that can be used to access a portion of the underlying [Dialogue]. This is advanced functionality.

pub fn inner_mut(&mut self) -> InnerDialogueMut<'_>

Mutably returns a struct that can be used to access a portion of the underlying [Dialogue]. This is advanced functionality.

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

Returns the registered TextProvider. By default, this is a StringsFileTextProvider.

pub fn asset_provider<T: 'static>(&self) -> Option<&T>

Returns the registered AssetProvider of the given type if it was previously registered with DialogueRunnerBuilder::add_asset_provider.

pub fn asset_providers(&self) -> impl Iterator<Item = &dyn AssetProvider>

Iterates over all registered AssetProviders.

Trait Implementations§

impl Component for DialogueRunner
where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].

impl Debug for DialogueRunner

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !UnwindSafe for DialogueRunner

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AnyExt for T
where T: Any + ?Sized,

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<C> Bundle for C
where C: Component,

fn component_ids( components: &mut Components, storages: &mut Storages, ids: &mut impl FnMut(ComponentId) )

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>,

impl<T, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

fn coerce_box_to(self: Box<X>) -> Box<T>

fn coerce_ref_to(&self) -> &T

fn coerce_mut_to(&mut self) -> &mut T

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.