Class GameSettings

The main game engine configuration service. Loads and applies game configuration.

Assembly: FlaxEngine.dll
File: Engine/Core/Config/GameSettings.h
Syntax
public class GameSettings : public SettingsBase

Fields

AndroidPlatform

Declaration
public Guid AndroidPlatform
Field Value
Guid

Audio

Declaration
public Guid Audio
Field Value
Guid

CompanyName

The company full name.

Declaration
public String CompanyName
Field Value
String

CopyrightNotice

The copyright note used for content signing (eg. source code header).

Declaration
public String CopyrightNotice
Field Value
String

CustomSettings

The custom settings to use with a game. Can be specified by the user to define game-specific options and be used by the external plugins (used as key-value pair).

Declaration
public Dictionary<String, Guid> CustomSettings
Field Value
Dictionary<String, Guid>

FirstScene

Reference to the first scene to load on a game startup.

Declaration
public Guid FirstScene = Guid::Empty
Field Value
Guid

GameCooking

Declaration
public Guid GameCooking
Field Value
Guid

Graphics

Declaration
public Guid Graphics
Field Value
Guid

Icon

The default application icon.

Declaration
public Guid Icon = Guid::Empty
Field Value
Guid

Input

Declaration
public Guid Input
Field Value
Guid

iOSPlatform

Declaration
public Guid iOSPlatform
Field Value
Guid

LayersAndTags

Declaration
public Guid LayersAndTags
Field Value
Guid

LinuxPlatform

Declaration
public Guid LinuxPlatform
Field Value
Guid

Localization

Declaration
public Guid Localization
Field Value
Guid

MacPlatform

Declaration
public Guid MacPlatform
Field Value
Guid

Navigation

Declaration
public Guid Navigation
Field Value
Guid

Network

Declaration
public Guid Network
Field Value
Guid

NoSplashScreen

True if skip showing splash screen image on the game startup.

Declaration
public bool NoSplashScreen = false
Field Value
bool

Physics

Declaration
public Guid Physics
Field Value
Guid

ProductName

The product full name.

Declaration
public String ProductName
Field Value
String

PS4Platform

Declaration
public Guid PS4Platform
Field Value
Guid

PS5Platform

Declaration
public Guid PS5Platform
Field Value
Guid

SplashScreen

Reference to the splash screen image to show on a game startup.

Declaration
public Guid SplashScreen = Guid::Empty
Field Value
Guid

Streaming

Declaration
public Guid Streaming
Field Value
Guid

SwitchPlatform

Declaration
public Guid SwitchPlatform
Field Value
Guid

Time

Declaration
public Guid Time
Field Value
Guid

UWPPlatform

Declaration
public Guid UWPPlatform
Field Value
Guid

WindowsPlatform

Declaration
public Guid WindowsPlatform
Field Value
Guid

XboxOnePlatform

Declaration
public Guid XboxOnePlatform
Field Value
Guid

XboxScarlettPlatform

Declaration
public Guid XboxScarlettPlatform
Field Value
Guid

Methods

Apply()

Applies the settings to the target system.

Declaration
public virtual void Apply() override
Overrides

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

Get()

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

Declaration
public static GameSettings* Get()
Returns
GameSettings

Load()

Loads the game settings (including other settings such as Physics, Input, etc.).

Declaration
public static bool Load()
Returns
bool

True if failed, otherwise false.