Class SettingsBase

Base class for all global settings containers for the engine. Helps to apply, store and expose properties to engine/game.

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

Methods

Apply()

Applies the settings to the target system.

Declaration
public virtual void Apply()

Deserialize(DeserializeStream& stream, ISerializeModifier* modifier)

Deserializes object from the input stream.

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

The input stream.
ISerializeModifier modifier

The deserialization modifier object. Always valid.
Overrides

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