Struct StringsFileTextProvider 

pub struct StringsFileTextProvider { /* private fields */ }

The default TextProvider used by a DialogueRunner unless overridden with DialogueRunnerBuilder::with_text_provider. If the DialogueRunner’s language is the base language, i.e. the one the Yarn files are written in, this will send the lines as they appear in the Yarn file. If DialogueRunner::set_language or DialogueRunner::set_text_language were used to set the language to a language supported by a translation in the Localizations, this loads the strings file for that translation from the disk at the specified path. If this fails, the base language is used as a fallback.

Implementations

impl StringsFileTextProvider

pub fn from_yarn_project(yarn_project: &YarnProject) -> Self

Create a new text provider from a Yarn project. This will be done for you when using YarnProject::create_dialogue_runner or YarnProject::build_dialogue_runner.

Trait Implementations

impl Clone for StringsFileTextProvider

fn clone(&self) -> StringsFileTextProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringsFileTextProvider

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

Formats the value using the given formatter.

impl TextProvider for StringsFileTextProvider

fn clone_shallow(&self) -> Box<dyn UnderlyingTextProvider>

Creates a shallow clone of this text provider, i.e. a clone that shares the same underlying provider and will thus be perfectly in sync with the original instance.

fn accept_line_hints(&mut self, _line_ids: &[LineId])

Passes the LineIds that this TextProvider should soon provide text for. These are the LineIds that are contained in the current node and are not required to be actually reached.

fn get_text(&self, id: &LineId) -> Option<String>

Returns the text for the given LineId. Will only be called if TextProvider::are_lines_available returns true.

fn set_language(&mut self, language: Option<Language>)

Sets the current language. If None is passed, the base language will be used.

fn get_language(&self) -> Option<Language>

Returns the current language. If None is returned, the base language is used.

fn are_lines_available(&self) -> bool

Returns whether the text for all lines announced by TextProvider::accept_line_hints are available, i.e. have been loaded and are ready to be used.

fn as_any(&self) -> &dyn Any

Gets the TextProvider as a trait object. This allows retrieving the concrete type by downcasting, using the downcast_ref method available through the Any trait.

fn as_any_mut(&mut self) -> &mut dyn Any

Gets the TextProvider as a mutable trait object. This allows retrieving the concrete type by downcasting, using the downcast_mut method available through the Any trait.

impl TextProvider for StringsFileTextProvider

fn set_base_string_table(&mut self, string_table: HashMap<LineId, StringInfo>)

Stores a string table containing the base language strings, i.e. the strings found in the Yarn files themselves.

fn extend_base_string_table( &mut self, string_table: HashMap<LineId, StringInfo>, )

Extends the string table set by TextProvider::set_base_string_table with additional strings.

fn take_fetched_assets(&mut self, asset: Box<dyn Any>)

Stores the assets fetched by TextProvider::fetch_assets. This functionality is split into two functions because TextProvider::take_fetched_assets is mutable, so we lose access to the World when calling it since it contains this very TextProvider.

fn fetch_assets(&self, world: &World) -> Option<Box<dyn Any + 'static>>

Fetches any necessary assets. The returned value is then passed to TextProvider::take_fetched_assets. This functionality is split into two functions because TextProvider::take_fetched_assets is mutable, so we lose access to the World when calling it since it contains this very TextProvider.