Search Results for

    Show / Hide Table of Contents

    Class LocalizationSettings

    Game localization and internalization settings container.

    Inheritance
    ISerializable
    SettingsBase
    LocalizationSettings
    Inherited Members
    ISerializable::DeserializeIfExists(DeserializeStream& stream, const char* memberName, ISerializeModifier* modifier)
    LocalizationSettings
    LocalizationSettings
    LocalizationSettings
    ISerializable::~ISerializable()
    Assembly: FlaxEngine.dll
    File: Engine/Localization/LocalizationSettings.h
    Syntax
    public class LocalizationSettings : public SettingsBase

    Fields

    DefaultFallbackLanguage

    The default fallback language to use if localization system fails to pick the system locale language (eg. en-GB).

    Declaration
    public String DefaultFallbackLanguage
    Field Value
    String

    LocalizedStringTables

    The list of the string localization tables used by the game.

    Declaration
    public Array<AssetReference<LocalizedStringTable>> LocalizedStringTables
    Field Value
    Array<AssetReference<LocalizedStringTable>>

    Methods

    Apply()

    Applies the settings to the target system.

    Declaration
    public virtual void Apply() override
    Overrides
    SettingsBase::Apply()

    Deserialize(DeserializeStream& stream, ISerializeModifier* modifier)

    Deserializes object from the input stream.

    Declaration
    public virtual void Deserialize(DeserializeStream& stream, ISerializeModifier* modifier) final override
    Parameters
    DeserializeStream stream

    The input stream.

    ISerializeModifier modifier

    The deserialization modifier object. Always valid.

    Overrides
    SettingsBase::Deserialize(DeserializeStream& stream, ISerializeModifier* modifier)

    Get()

    Gets the instance of the settings asset (default value if missing). Object returned by this method is always loaded with valid data to use.

    Declaration
    public static LocalizationSettings* Get()
    Returns
    LocalizationSettings

    Serialize(SerializeStream& stream, const void* otherObj)

    Serializes object to the output stream compared to the values of the other object instance (eg. default class object). If other object is null then serialize all properties.

    Declaration
    public virtual void Serialize(SerializeStream& stream, const void* otherObj) override
    Parameters
    SerializeStream stream

    The output stream.

    void otherObj

    The instance of the object to compare with and serialize only the modified properties. If null, then serialize all properties.

    Overrides
    SettingsBase::Serialize(SerializeStream& stream, const void* otherObj)
    • Improve this Doc
    • View Source
    In This Article
    Back to top Copyright © 2012-2024 Wojciech Figat