Class InputSettings

Input settings container.

Inheritance

ISerializable

SettingsBase

InputSettings

Inherited Members

ISerializable::DeserializeIfExists(DeserializeStream& stream, const char* memberName, ISerializeModifier* modifier)

InputSettings

SettingsBase::Serialize(SerializeStream& stream, const void* otherObj)

InputSettings

InputSettings

ISerializable::~ISerializable()

Assembly: FlaxEngine.dll

File: Engine/Input/InputSettings.h

Syntax

public class InputSettings : public SettingsBase

Fields

ActionMappings

Maps a discrete button or key press events to a "friendly name" that will later be bound to event-driven behavior. The end effect is that pressing (and/or releasing) a key, mouse button, or keypad button.

Declaration

public Array<ActionConfig> ActionMappings

Field Value

Array<ActionConfig>

AxisMappings

Maps keyboard, controller, or mouse inputs to a "friendly name" that will later be bound to continuous game behavior, such as movement. The inputs mapped in AxisMappings are continuously polled, even if they are just reporting that their input value.

Declaration

public Array<AxisConfig> AxisMappings

Field Value

Array<AxisConfig>

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 InputSettings* Get()

Returns

InputSettings