Struct KeyboardAxisBinding

Namespace

BSGameLib.Game.Input

Assembly

BSGameLib.Game.dll

A pair of keys that move an axis action negative and positive.

public readonly record struct KeyboardAxisBinding : IEquatable<KeyboardAxisBinding>

Implements

IEquatable<KeyboardAxisBinding>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

KeyboardAxisBinding(Key, Key, float)

A pair of keys that move an axis action negative and positive.

public KeyboardAxisBinding(Key Negative, Key Positive, float Scale = 1)

Parameters

Negative Key

The key that moves the axis toward -1.

Positive Key

The key that moves the axis toward 1.

Scale float

How much each held key adds to the value, clamped to -1 to 1.

Properties

Negative

The key that moves the axis toward -1.

public Key Negative { get; init; }

Property Value

Key

Positive

The key that moves the axis toward 1.

public Key Positive { get; init; }

Property Value

Key

Scale

The amount each held key adds to the value. The total is clamped to -1 to 1.

public float Scale { get; init; }

Property Value

float