Class InputActionsContainer

The input actions processing helper that handles input bindings configuration layer.

System.Object
InputActionsContainer
Namespace: FlaxEditor.Options
Assembly: FlaxEngine.CSharp.dll
Syntax
public class InputActionsContainer : Object

Constructors

InputActionsContainer()

Initializes a new instance of the InputActionsContainer class.

Declaration
public InputActionsContainer()

InputActionsContainer(InputActionsContainer.Binding[])

Initializes a new instance of the InputActionsContainer class.

Declaration
public InputActionsContainer(params InputActionsContainer.Binding[] bindings)
Parameters
InputActionsContainer.Binding[] bindings

The input bindings collection.

Fields

Bindings

List of all available bindings.

Declaration
public List<InputActionsContainer.Binding> Bindings
Field Value
System.Collections.Generic.List<InputActionsContainer.Binding>

Methods

Add(InputActionsContainer.Binding)

Adds the specified binding.

Declaration
public void Add(InputActionsContainer.Binding binding)
Parameters
InputActionsContainer.Binding binding

The input binding.

Add(InputActionsContainer.Binding[])

Adds the specified bindings.

Declaration
public void Add(params InputActionsContainer.Binding[] bindings)
Parameters
InputActionsContainer.Binding[] bindings

The input bindings collection.

Add(Func<InputOptions, InputBinding>, Action)

Adds the specified binding.

Declaration
public void Add(Func<InputOptions, InputBinding> binder, Action callback)
Parameters
System.Func<FlaxEditor.Options.InputOptions, FlaxEditor.Options.InputBinding> binder

The input binding options getter (can read from editor options or use constant binding).
System.Action callback

The callback to invoke on user input.

Invoke(Editor, InputBinding)

Invokes a specific binding.

Declaration
public bool Invoke(Editor editor, InputBinding binding)
Parameters
Editor editor

The editor instance.
FlaxEditor.Options.InputBinding binding

The binding to execute.
Returns
System.Boolean

True if event has been handled, otherwise false.

Process(Editor, Control, KeyboardKeys)

Processes the specified key input and tries to invoke first matching callback for the current user input state.

Declaration
public bool Process(Editor editor, Control control, KeyboardKeys key)
Parameters
Editor editor

The editor instance.
Control control

The input providing control.
KeyboardKeys key

The input key.
Returns
System.Boolean

True if event has been handled, otherwise false.

Extension Methods