Class InputBinding

Namespace

BSGameLib.Game.Input

Assembly

BSGameLib.Game.dll

The inputs an action is bound to. Create one with CreateButton(IEnumerable<KeyboardKeyBinding>, IEnumerable<GamepadButtonBinding>) or CreateAxis(IEnumerable<KeyboardAxisBinding>, IEnumerable<GamepadAxisBinding>, IEnumerable<GamepadButtonAxisBinding>); a With method returns a copy with one list replaced.

public sealed class InputBinding

Inheritance

object

InputBinding

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

InputBinding(IEnumerable<KeyboardKeyBinding>, IEnumerable<GamepadButtonBinding>, IEnumerable<KeyboardAxisBinding>, IEnumerable<GamepadAxisBinding>, IEnumerable<GamepadButtonAxisBinding>)

Creates a binding from the given inputs. A null list is empty.

public InputBinding(IEnumerable<KeyboardKeyBinding> keyboardKeys = null, IEnumerable<GamepadButtonBinding> gamepadButtons = null, IEnumerable<KeyboardAxisBinding> keyboardAxes = null, IEnumerable<GamepadAxisBinding> gamepadAxes = null, IEnumerable<GamepadButtonAxisBinding> gamepadButtonAxes = null)

Parameters

keyboardKeys IEnumerable<KeyboardKeyBinding>

gamepadButtons IEnumerable<GamepadButtonBinding>

keyboardAxes IEnumerable<KeyboardAxisBinding>

gamepadAxes IEnumerable<GamepadAxisBinding>

gamepadButtonAxes IEnumerable<GamepadButtonAxisBinding>

Properties

GamepadAxes

The gamepad sticks and triggers bound to an axis action.

public IReadOnlyList<GamepadAxisBinding> GamepadAxes { get; }

Property Value

IReadOnlyList<GamepadAxisBinding>

GamepadButtonAxes

The pairs of gamepad buttons bound to an axis action.

public IReadOnlyList<GamepadButtonAxisBinding> GamepadButtonAxes { get; }

Property Value

IReadOnlyList<GamepadButtonAxisBinding>

GamepadButtons

The gamepad buttons bound to the action.

public IReadOnlyList<GamepadButtonBinding> GamepadButtons { get; }

Property Value

IReadOnlyList<GamepadButtonBinding>

IsEmpty

Whether the binding has no inputs at all.

public bool IsEmpty { get; }

Property Value

bool

KeyboardAxes

The key pairs bound to an axis action.

public IReadOnlyList<KeyboardAxisBinding> KeyboardAxes { get; }

Property Value

IReadOnlyList<KeyboardAxisBinding>

KeyboardKeys

The keyboard keys bound to the action.

public IReadOnlyList<KeyboardKeyBinding> KeyboardKeys { get; }

Property Value

IReadOnlyList<KeyboardKeyBinding>

Methods

CreateAxis(IEnumerable<KeyboardAxisBinding>, IEnumerable<GamepadAxisBinding>, IEnumerable<GamepadButtonAxisBinding>)

Creates a binding for an axis action.

public static InputBinding CreateAxis(IEnumerable<KeyboardAxisBinding> keyboardAxes = null, IEnumerable<GamepadAxisBinding> gamepadAxes = null, IEnumerable<GamepadButtonAxisBinding> gamepadButtonAxes = null)

Parameters

keyboardAxes IEnumerable<KeyboardAxisBinding>

gamepadAxes IEnumerable<GamepadAxisBinding>

gamepadButtonAxes IEnumerable<GamepadButtonAxisBinding>

Returns

InputBinding

CreateButton(IEnumerable<KeyboardKeyBinding>, IEnumerable<GamepadButtonBinding>)

Creates a binding for a button action from keys and gamepad buttons.

public static InputBinding CreateButton(IEnumerable<KeyboardKeyBinding> keyboardKeys = null, IEnumerable<GamepadButtonBinding> gamepadButtons = null)

Parameters

keyboardKeys IEnumerable<KeyboardKeyBinding>

gamepadButtons IEnumerable<GamepadButtonBinding>

Returns

InputBinding

WithGamepadAxes(IEnumerable<GamepadAxisBinding>)

A copy of this binding with its gamepad axes replaced by axes.

public InputBinding WithGamepadAxes(IEnumerable<GamepadAxisBinding> axes)

Parameters

axes IEnumerable<GamepadAxisBinding>

Returns

InputBinding

WithGamepadButtonAxes(IEnumerable<GamepadButtonAxisBinding>)

A copy of this binding with its gamepad button axes replaced by axes.

public InputBinding WithGamepadButtonAxes(IEnumerable<GamepadButtonAxisBinding> axes)

Parameters

axes IEnumerable<GamepadButtonAxisBinding>

Returns

InputBinding

WithGamepadButtons(IEnumerable<GamepadButtonBinding>)

A copy of this binding with its gamepad buttons replaced by buttons.

public InputBinding WithGamepadButtons(IEnumerable<GamepadButtonBinding> buttons)

Parameters

buttons IEnumerable<GamepadButtonBinding>

Returns

InputBinding

WithKeyboardAxes(IEnumerable<KeyboardAxisBinding>)

A copy of this binding with its keyboard axes replaced by axes.

public InputBinding WithKeyboardAxes(IEnumerable<KeyboardAxisBinding> axes)

Parameters

axes IEnumerable<KeyboardAxisBinding>

Returns

InputBinding

WithKeyboardKeys(IEnumerable<KeyboardKeyBinding>)

A copy of this binding with its keyboard keys replaced by keys.

public InputBinding WithKeyboardKeys(IEnumerable<KeyboardKeyBinding> keys)

Parameters

keys IEnumerable<KeyboardKeyBinding>

Returns

InputBinding