Struct TranslationServer

pub struct TranslationServer { /* private fields */ }

Expand description

Godot class TranslationServer.

Inherits Object.

Related symbols:

translation_server: sidecar module with related enum/flag types

§Singleton

This class is a singleton. You can get the one instance using Singleton::singleton().

§Final class

This class is final, meaning you cannot inherit from it, and it comes without I* interface trait. It is still possible that other Godot classes inherit from it, but that is limited to the engine itself.

§Godot docs

The translation server is the API backend that manages all language translations.

Translations are stored in TranslationDomains, which can be accessed by name. The most commonly used translation domain is the main translation domain. It always exists and can be accessed using an empty StringName. The translation server provides wrapper methods for accessing the main translation domain directly, without having to fetch the translation domain first. Custom translation domains are mainly for advanced usages like editor plugins. Names starting with godot. are reserved for engine internals.

Implementations§

§

impl TranslationServer

pub fn set_locale(&mut self, locale: impl AsArg<GString>)

Sets the locale of the project. The locale string will be standardized to match known locales (e.g. en-US would be matched to en_US).

If translations have been loaded beforehand for the new locale, they will be applied.

pub fn get_locale(&self) -> GString

Returns the current locale of the project.

See also get_locale and get_locale_language to query the locale of the user system.

pub fn get_tool_locale(&self) -> GString

Returns the current locale of the editor.

Note: When called from an exported project returns the same value as get_locale.

pub fn compare_locales( &self, locale_a: impl AsArg<GString>, locale_b: impl AsArg<GString>, ) -> i32

Compares two locales and returns a similarity score between 0 (no match) and 10 (full match).

pub fn standardize_locale(&self, locale: impl AsArg<GString>) -> GString

To set the default parameters, use standardize_locale_ex and its builder methods. See the book for detailed usage instructions. Returns a locale string standardized to match known locales (e.g. en-US would be matched to en_US). If add_defaults is true, the locale may have a default script or country added.

pub fn standardize_locale_ex<'ex>( &'ex self, locale: impl AsArg<GString> + 'ex, ) -> ExStandardizeLocale<'ex>

Returns a locale string standardized to match known locales (e.g. en-US would be matched to en_US). If add_defaults is true, the locale may have a default script or country added.

pub fn get_all_languages(&self) -> PackedArray<GString>

Returns array of known language codes.

pub fn get_language_name(&self, language: impl AsArg<GString>) -> GString

Returns a readable language name for the language code.

pub fn get_all_scripts(&self) -> PackedArray<GString>

Returns an array of known script codes.

pub fn get_script_name(&self, script: impl AsArg<GString>) -> GString

Returns a readable script name for the script code.

pub fn get_all_countries(&self) -> PackedArray<GString>

Returns an array of known country codes.

pub fn get_country_name(&self, country: impl AsArg<GString>) -> GString

Returns a readable country name for the country code.

pub fn get_locale_name(&self, locale: impl AsArg<GString>) -> GString

Returns a locale’s language and its variant (e.g. "en_US" would return "English (United States)").

pub fn get_plural_rules(&self, locale: impl AsArg<GString>) -> GString

Returns the default plural rules for the locale.

pub fn translate(&self, message: impl AsArg<StringName>) -> StringName

To set the default parameters, use translate_ex and its builder methods. See the book for detailed usage instructions. Returns the current locale’s translation for the given message and context.

Note: This method always uses the main translation domain.

pub fn translate_ex<'ex>( &'ex self, message: impl AsArg<StringName> + 'ex, ) -> ExTranslate<'ex>

Returns the current locale’s translation for the given message and context.

Note: This method always uses the main translation domain.

pub fn translate_plural( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> StringName

To set the default parameters, use translate_plural_ex and its builder methods. See the book for detailed usage instructions. Returns the current locale’s translation for the given message, plural message and context.

The number n is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language.

Note: This method always uses the main translation domain.

pub fn translate_plural_ex<'ex>( &'ex self, message: impl AsArg<StringName> + 'ex, plural_message: impl AsArg<StringName> + 'ex, n: i32, ) -> ExTranslatePlural<'ex>

Returns the current locale’s translation for the given message, plural message and context.

The number n is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language.

Note: This method always uses the main translation domain.

pub fn add_translation( &mut self, translation: impl AsArg<Option<Gd<Translation>>>, )

Adds a translation to the main translation domain.

pub fn remove_translation( &mut self, translation: impl AsArg<Option<Gd<Translation>>>, )

Removes the given translation from the main translation domain.

pub fn get_translation_object( &self, locale: impl AsArg<GString>, ) -> Option<Gd<Translation>>

Returns the Translation instance that best matches locale in the main translation domain. Returns null if there are no matches.

pub fn get_translations(&self) -> Array<Gd<Translation>>

Returns all available Translation instances in the main translation domain as added by add_translation.

pub fn find_translations( &self, locale: impl AsArg<GString>, exact: bool, ) -> Array<Gd<Translation>>

Returns the Translation instances in the main translation domain that match locale (see compare_locales). If exact is true, only instances whose locale exactly equals locale will be returned.

pub fn has_translation_for_locale( &self, locale: impl AsArg<GString>, exact: bool, ) -> bool

Returns true if there are any Translation instances in the main translation domain that match locale (see compare_locales). If exact is true, only instances whose locale exactly equals locale are considered.

pub fn has_translation( &self, translation: impl AsArg<Option<Gd<Translation>>>, ) -> bool

Returns true if the main translation domain contains the given translation.

pub fn has_domain(&self, domain: impl AsArg<StringName>) -> bool

Returns true if a translation domain with the specified name exists.

pub fn get_or_add_domain( &self, domain: impl AsArg<StringName>, ) -> Option<Gd<TranslationDomain>>

Returns the translation domain with the specified name. An empty translation domain will be created and added if it does not exist.

pub fn remove_domain(&mut self, domain: impl AsArg<StringName>)

Removes the translation domain with the specified name.

Note: Trying to remove the main translation domain is an error.

pub fn clear(&mut self)

Removes all translations from the main translation domain.

pub fn get_loaded_locales(&self) -> PackedArray<GString>

Returns an array of all loaded locales of the project.

pub fn format_number( &self, number: impl AsArg<GString>, locale: impl AsArg<GString>, ) -> GString

Converts a number from Western Arabic (0..9) to the numeral system used in the given locale.

pub fn get_percent_sign(&self, locale: impl AsArg<GString>) -> GString

Returns the percent sign used in the given locale.

pub fn parse_number( &self, number: impl AsArg<GString>, locale: impl AsArg<GString>, ) -> GString

Converts number from the numeral system used in the given locale to Western Arabic (0..9).

pub fn is_pseudolocalization_enabled(&self) -> bool

pub fn set_pseudolocalization_enabled(&mut self, enabled: bool)

pub fn reload_pseudolocalization(&mut self)

Reparses the pseudolocalization options and reloads the translation for the main translation domain.

pub fn pseudolocalize(&self, message: impl AsArg<StringName>) -> StringName

Returns the pseudolocalized string based on the message passed in.

Note: This method always uses the main translation domain.

Methods from Deref<Target = Object>§

pub fn get_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error

pub fn get_class(&self) -> GString

Returns the object’s built-in class name, as a String. See also is_class.

Note: This method ignores class_name declarations. If this object’s script has defined a class_name, the base, built-in class name is returned instead.

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

Returns true if the object inherits from the given class. See also get_class.

var sprite2d = Sprite2D.new()
sprite2d.is_class("Sprite2D") # Returns true
sprite2d.is_class("Node")     # Returns true
sprite2d.is_class("Node3D")   # Returns false

Note: This method ignores class_name declarations in the object’s script.

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

Assigns value to the given property. If the property does not exist or the given value’s type doesn’t match, nothing happens.

var node = Node2D.new()
node.set("global_scale", Vector2(8, 2.5))
print(node.global_scale) # Prints (8.0, 2.5)

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

Returns the Variant value of the given property. If the property does not exist, this method returns null.

var node = Node2D.new()
node.rotation = 1.5
var a = node.get("rotation") # a is 1.5

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

Assigns a new value to the property identified by the property_path. The path should be a NodePath relative to this object, and can use the colon character (:) to access nested properties.

var node = Node2D.new()
node.set_indexed("position", Vector2(42, 0))
node.set_indexed("position:y", -10)
print(node.position) # Prints (42.0, -10.0)

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

Gets the object’s property indexed by the given property_path. The path should be a NodePath relative to the current object and can use the colon character (:) to access nested properties.

Examples: "position:x" or "material:next_pass:blend_mode".

var node = Node2D.new()
node.position = Vector2(5, -10)
var a = node.get_indexed("position")   # a is Vector2(5, -10)
var b = node.get_indexed("position:y") # b is -10

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

Note: This method does not support actual paths to nodes in the SceneTree, only sub-property paths. In the context of nodes, use get_node_and_resource instead.

pub fn get_property_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns the object’s property list as an Array of dictionaries. Each Dictionary contains the following entries:

name is the property’s name, as a String;
class_name is an empty StringName, unless the property is VariantType::OBJECT and it inherits from a class;
type is the property’s type, as an int (see [enum Variant.Type]);
hint is how the property is meant to be edited (see [enum PropertyHint]);
hint_string depends on the hint (see [enum PropertyHint]);
usage is a combination of [enum PropertyUsageFlags].

Note: In GDScript, all class members are treated as properties. In C# and GDExtension, it may be necessary to explicitly mark class members as Godot properties using decorators or attributes.

pub fn get_method_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns this object’s methods and their signatures as an Array of dictionaries. Each Dictionary contains the following entries:

name is the name of the method, as a String;
args is an Array of dictionaries representing the arguments;
default_args is the default arguments as an Array of variants;
flags is a combination of [enum MethodFlags];
id is the method’s internal identifier int;
return is the returned value, as a Dictionary;

Note: The dictionaries of args and return are formatted identically to the results of get_property_list, although not all entries are used.

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

Returns true if the given property has a custom default value. Use property_get_revert to get the property’s default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_can_revert] to customize the default value. If [method _property_can_revert] is not implemented, this method returns false.

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

Returns the custom default value of the given property. Use property_can_revert to check if the property has a custom default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_get_revert] to customize the default value. If [method _property_get_revert] is not implemented, this method returns null.

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

Adds or changes the entry name inside the object’s metadata. The metadata value can be any Variant, although some types cannot be serialized correctly.

If value is null, the entry is removed. This is the equivalent of using remove_meta. See also has_meta and get_meta.