Struct gdnative::api::PHashTranslation

pub struct PHashTranslation { /* fields omitted */ }

core class PHashTranslation inherits Translation (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

PHashTranslation inherits methods from:

• Translation
• Resource
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl PHashTranslation

pub fn new() -> Ref<PHashTranslation, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn generate(&self, from: impl AsArg<Translation>)

Generates and sets an optimized translation from the given [Translation] resource.

Methods from Deref<Target = Translation>

pub fn add_message(
    &self,
    src_message: impl Into<GodotString>,
    xlated_message: impl Into<GodotString>
)

Adds a message if nonexistent, followed by its translation.

pub fn erase_message(&self, src_message: impl Into<GodotString>)

Erases a message.

pub fn locale(&self) -> GodotString

The locale of the translation.

pub fn get_message(&self, src_message: impl Into<GodotString>) -> GodotString

Returns a message's translation.

pub fn get_message_count(&self) -> i64

Returns the number of existing messages.

pub fn get_message_list(&self) -> TypedArray<GodotString>

Returns all the messages (keys).

pub fn set_locale(&self, locale: impl Into<GodotString>)

The locale of the translation.

Trait Implementations

impl Debug for PHashTranslation

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

Formats the value using the given formatter.

impl Deref for PHashTranslation

type Target = Translation

The resulting type after dereferencing.

fn deref(&self) -> &Translation

Dereferences the value.

impl DerefMut for PHashTranslation

fn deref_mut(&mut self) -> &mut Translation

Mutably dereferences the value.

impl GodotObject for PHashTranslation

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for PHashTranslation

fn construct() -> Ref<PHashTranslation, Unique>

impl SubClass<Object> for PHashTranslation

impl SubClass<Reference> for PHashTranslation

impl SubClass<Resource> for PHashTranslation

impl SubClass<Translation> for PHashTranslation