Struct Translations

pub struct Translations { /* private fields */ }

The main Resource type that stores translation data.

Implementations

impl Translations

pub fn new() -> Self

pub fn tr(&self, key: impl ToString) -> String

The short call to acquire a translation. Translations work through a key-value pair that are loaded based on the currently selected locale. Here we specificially take a generic argument for the key such that any value that implements ToString can be translated. This creates a decent amount of flexibility for users as they will be able to “translate” custom types if they so choose.

Examples found in repository

examples/minimal.rs (line 34)

fn system_use_translation(trans: Res<Translations>) {
    for key in ["hello", "green", "invalid"] {
        // using Res<Translations>.tr('key') to perform the key-value lookup.
        // Without the feature `catch-missing-values` enabled, this will simply provide the key again when failing to find a matching value for the current locale.
        println!("{} = {}", key, trans.tr(key))
    }
}

pub fn csv_file(&mut self, path: &Path, locale: &String) -> &mut Self

Modifies the current Translations data to load from a specified CSV file and load a particular locale.

Examples found in repository

examples/minimal.rs (line 15)

fn main() {
    let mut world = World::new();
    world.insert_resource(
        // initialize as default
        Translations::default()
            // select a CSV file and a default locale
            .csv_file(&Path::new("assets/lang.csv"), &"en".into())
            // optionally switch the current locale
            .use_locale("es")
            // Strips mutability to easily finish inserting into the world.
            .build(),
    );

    let mut schedule = Schedule::default();
    schedule.add_systems(system_use_translation);

    schedule.run(&mut world);
}

pub fn csv_raw(&mut self, csv_data: String, locale: &String) -> &mut Self

Modifies the current Translations data to load from a raw string in CSV format and load a particular locale.

pub fn data<S>( &mut self, locales: impl Iterator<Item = S>, mapping: impl Iterator<Item = (S, S)>, clear_old_data: bool, ) -> &mut Self

where S: ToString,

Modifies the current Translations data to load from raw data. Note that using this method directly does not support changing locales. If you want that feature, you must use CSV or ODS

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

A convenience method for calling use_locale with the system’s default locale.

pub fn use_locale<S>(&mut self, locale: S) -> &mut Self

where S: ToString + Clone,

Change the current locale to the new locale if available. Also loads the new mapping data allowing for translations to be loaded immediately.

Examples found in repository

examples/minimal.rs (line 17)

fn main() {
    let mut world = World::new();
    world.insert_resource(
        // initialize as default
        Translations::default()
            // select a CSV file and a default locale
            .csv_file(&Path::new("assets/lang.csv"), &"en".into())
            // optionally switch the current locale
            .use_locale("es")
            // Strips mutability to easily finish inserting into the world.
            .build(),
    );

    let mut schedule = Schedule::default();
    schedule.add_systems(system_use_translation);

    schedule.run(&mut world);
}

pub fn get_system_language() -> Option<String>

Returns an optional string if able to acquire the system’s current locale code. Basically just a small wrapper around bevy_device_lang for convenience

pub fn build(&self) -> Self

Consumes and clones the instance to make inserting the resource into a bevy App or World a bit easier when using the builder pattern.

Examples found in repository

examples/minimal.rs (line 19)

fn main() {
    let mut world = World::new();
    world.insert_resource(
        // initialize as default
        Translations::default()
            // select a CSV file and a default locale
            .csv_file(&Path::new("assets/lang.csv"), &"en".into())
            // optionally switch the current locale
            .use_locale("es")
            // Strips mutability to easily finish inserting into the world.
            .build(),
    );

    let mut schedule = Schedule::default();
    schedule.add_systems(system_use_translation);

    schedule.run(&mut world);
}

Trait Implementations

impl Clone for Translations

fn clone(&self) -> Translations

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Translations

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

Formats the value using the given formatter.

impl Default for Translations

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Translations

fn eq(&self, other: &Translations) -> 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 Resource for Translations

where Self: Send + Sync + 'static,

impl StructuralPartialEq for Translations