Class LocalizedString

The string container that supports using localized text.

LocalizedString
LocalizedString
LocalizedString
Assembly: FlaxEngine.dll
File: Engine/Localization/LocalizedString.h
Syntax
public class LocalizedString

Constructors

LocalizedString()

Declaration
public LocalizedString() = default

LocalizedString(const LocalizedString& other)

Declaration
public LocalizedString(const LocalizedString& other)
Parameters
LocalizedString other

LocalizedString(const StringView& value)

Declaration
public LocalizedString(const StringView& value)
Parameters
StringView value

LocalizedString(LocalizedString&& other)

Declaration
public LocalizedString(LocalizedString&& other) noexcept
Parameters
LocalizedString other

LocalizedString(String&& value)

Declaration
public LocalizedString(String&& value) noexcept
Parameters
String value

Fields

Id

The localized string identifier. Used to lookup text value for a current language (via GetString(const String& id, const String& fallback=String::Empty)).

Declaration
public String Id
Field Value
String

Value

The overriden string value to use. If empty, the localized string will be used.

Declaration
public String Value
Field Value
String

Methods

operator=(const LocalizedString& other)

Declaration
public LocalizedString operator=(const LocalizedString& other)
Parameters
LocalizedString other

Returns
LocalizedString

operator=(const StringView& value)

Declaration
public LocalizedString operator=(const StringView& value)
Parameters
StringView value

Returns
LocalizedString

operator=(LocalizedString&& other)

Declaration
public LocalizedString operator=(LocalizedString&& other) noexcept
Parameters
LocalizedString other

Returns
LocalizedString

operator=(String&& value)

Declaration
public LocalizedString operator=(String&& value) noexcept
Parameters
String value

Returns
LocalizedString

operator==(const LocalizedString& other)

Declaration
public bool operator==(const LocalizedString& other) const
Parameters
LocalizedString other

Returns
bool

ToString()

Declaration
public String ToString() const
Returns
String

ToStringPlural(int32 n)

Declaration
public String ToStringPlural(int32 n) const
Parameters
int32 n

Returns
String