Class ActionBindings

Namespace: MicroEngine.Input
Assembly: MicroEngine.Input.dll
Guide: Input

What an action is bound to, for display or a rebinding screen (GetBindings).

C#

public sealed record ActionBindings : IEquatable<ActionBindings>

Inheritance

object ← ActionBindings

Implements

IEquatable<ActionBindings>

Constructors

ActionBindings(IReadOnlyList<Key>, IReadOnlyList<PadButton>, StickDirection, IReadOnlyList<(PadAxis Axis, bool Positive)>)

What an action is bound to, for display or a rebinding screen (GetBindings).

C#

public ActionBindings(IReadOnlyList<Key> Keys, IReadOnlyList<PadButton> Buttons, InputMap.StickDirection Stick, IReadOnlyList<(PadAxis Axis, bool Positive)> Axes)

Parameters

Keys IReadOnlyList<Key>

Buttons IReadOnlyList<PadButton>

Stick InputMap.StickDirection

Axes IReadOnlyList<(PadAxis Axis, bool Positive)>

Properties

Axes

C#

public IReadOnlyList<(PadAxis Axis, bool Positive)> Axes { get; init; }

Property Value

IReadOnlyList<(PadAxis Axis, bool Positive)>

Buttons

C#

public IReadOnlyList<PadButton> Buttons { get; init; }

Property Value

IReadOnlyList<PadButton>

Chords

The key combinations that press the action (Alt+Enter).

C#

public IReadOnlyList<KeyChord> Chords { get; init; }

Property Value

IReadOnlyList<KeyChord>

Keys

C#

public IReadOnlyList<Key> Keys { get; init; }

Property Value

IReadOnlyList<Key>

Stick

C#

public InputMap.StickDirection Stick { get; init; }

Property Value

InputMap.StickDirection

Methods

<Clone>$()

C#

public ActionBindings <Clone>$()

Returns

ActionBindings

Deconstruct(out IReadOnlyList<Key>, out IReadOnlyList<PadButton>, out StickDirection, out IReadOnlyList<(PadAxis Axis, bool Positive)>)

C#

public void Deconstruct(out IReadOnlyList<Key> Keys, out IReadOnlyList<PadButton> Buttons, out InputMap.StickDirection Stick, out IReadOnlyList<(PadAxis Axis, bool Positive)> Axes)

Parameters

Keys IReadOnlyList<Key>

Buttons IReadOnlyList<PadButton>

Stick InputMap.StickDirection

Axes IReadOnlyList<(PadAxis Axis, bool Positive)>

Equals(object?)

C#

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(ActionBindings?)

C#

public bool Equals(ActionBindings? other)

Parameters

other ActionBindings?

Returns

bool

GetHashCode()

C#

public override int GetHashCode()

Returns

int

ToString()

C#

public override string ToString()

Returns

string

Operators

operator ==(ActionBindings?, ActionBindings?)

C#

public static bool operator ==(ActionBindings? left, ActionBindings? right)

Parameters

left ActionBindings?

right ActionBindings?

Returns

bool

operator !=(ActionBindings?, ActionBindings?)

C#

public static bool operator !=(ActionBindings? left, ActionBindings? right)

Parameters

left ActionBindings?

right ActionBindings?

Returns

bool