Interface IBind

Namespace

RichHudFramework.UI

Assembly

RichHudClient.dll

Interface representing an input tied to one or more key combinations in a IBindGroup

public interface IBind

Properties

AliasCount

Number of key combinations registered to the given bind. If AliasCount == 1, then only the main combo is set. If greater, then it is aliased.

int AliasCount { get; }

Property Value

int

Analog

True if any controls in the bind are marked analog. For these types of binds, IsPressed == IsNewPressed.

bool Analog { get; }

Property Value

bool

AnalogValue

Analog value of the bind, if it has one. Returns the sum of all analog values in key combo. Multiple analog controls per bind are not recommended.

float AnalogValue { get; }

Property Value

float

Index

Index of the bind within its group

int Index { get; }

Property Value

int

IsNewPressed

True if just pressed.

bool IsNewPressed { get; }

Property Value

bool

IsPressed

True if currently pressed.

bool IsPressed { get; }

Property Value

bool

IsPressedAndHeld

True after being held for more than 500ms.

bool IsPressedAndHeld { get; }

Property Value

bool

IsReleased

True if just released.

bool IsReleased { get; }

Property Value

bool

Name

Name of the keybind

string Name { get; }

Property Value

string

Methods

ClearCombo(int)

Clears the current key combination.

void ClearCombo(int alias = 0)

Parameters

alias int

ClearSubscribers()

Clears all event subscibers for this bind.

void ClearSubscribers()

GetCombo(int)

Returns a list of controls representing the key combinaton for the bind

List<ControlHandle> GetCombo(int alias = 0)

Parameters

alias int

Returns

List<ControlHandle>

GetConIDs(int)

Returns a list of control indices representing the key combinaton for the bind

List<int> GetConIDs(int alias = 0)

Parameters

alias int

Returns

List<int>

TrySetCombo(IReadOnlyList<ControlHandle>, int, bool, bool)

Attempts to set the binds combo to the given controls. Returns true if successful.

bool TrySetCombo(IReadOnlyList<ControlHandle> combo, int alias = 0, bool isStrict = true, bool isSilent = true)

Parameters

combo IReadOnlyList<ControlHandle>

alias int

isStrict bool

isSilent bool

Returns

bool

TrySetCombo(IReadOnlyList<int>, int, bool, bool)

Attempts to set the binds combo to the given controls. Returns true if successful.

bool TrySetCombo(IReadOnlyList<int> combo, int alias = 0, bool isStrict = true, bool isSilent = true)

Parameters

combo IReadOnlyList<int>

alias int

isStrict bool

isSilent bool

Returns

bool

TrySetCombo(IReadOnlyList<string>, int, bool, bool)

Attempts to set the binds combo to the given controls. Returns true if successful.

bool TrySetCombo(IReadOnlyList<string> combo, int alias = 0, bool isStrict = true, bool isSilent = true)

Parameters

combo IReadOnlyList<string>

alias int

isStrict bool

isSilent bool

Returns

bool

Events

NewPressed

Invoked when the bind is first pressed.

event EventHandler NewPressed

Event Type

EventHandler

PressedAndHeld

Invoked after the bind has been held and pressed for at least 500ms.

event EventHandler PressedAndHeld

Event Type

EventHandler

Released

Invoked after the bind has been released.

event EventHandler Released

Event Type

EventHandler