Table of Contents

Class BindGroupInitializer

Namespace
RichHudFramework.UI
Assembly
RichHudClient.dll

A collection designed to simplify the definition and registration of groups of key binds.

Supports mixed control types (Strings, MyKeys, RichHudControls, JoystickButtons) via ControlHandle.

public class BindGroupInitializer : IReadOnlyList<MyTuple<string, IReadOnlyList<int>, IReadOnlyList<IReadOnlyList<int>>>>, IReadOnlyCollection<MyTuple<string, IReadOnlyList<int>, IReadOnlyList<IReadOnlyList<int>>>>, IEnumerable<MyTuple<string, IReadOnlyList<int>, IReadOnlyList<IReadOnlyList<int>>>>, IEnumerable
Inheritance
BindGroupInitializer
Implements

Constructors

BindGroupInitializer() 

public BindGroupInitializer()

Properties

Count

Gets the number of elements in the collection.

public int Count { get; }

Property Value

int

The number of elements in the collection.

this[int]

Gets the element at the specified index in the read-only list.

public MyTuple<string, IReadOnlyList<int>, IReadOnlyList<IReadOnlyList<int>>> this[int index] { get; }

Parameters

index int

The zero-based index of the element to get.

Property Value

MyTuple<string, IReadOnlyList<int>, IReadOnlyList<IReadOnlyList<int>>>

The element at the specified index in the read-only list.

Methods

Add(string, KeyComboInit, KeyComboInit)

Adds a new bind using pre-configured KeyComboInit objects for both primary and alias.

public void Add(string bindName, KeyComboInit combo, KeyComboInit alias)

Parameters

bindName string
combo KeyComboInit
alias KeyComboInit

Add(string, KeyComboInit, KeyComboInit, KeyComboInit)

Adds a new bind using pre-configured KeyComboInit objects for primary and two aliases.

public void Add(string bindName, KeyComboInit combo, KeyComboInit alias1, KeyComboInit alias2)

Parameters

bindName string
combo KeyComboInit
alias1 KeyComboInit
alias2 KeyComboInit

Add(string, ControlHandle?, KeyComboInit)

Adds a new bind with a primary control and one alias combination.

public void Add(string bindName, ControlHandle? con1, KeyComboInit alias)

Parameters

bindName string
con1 ControlHandle?
alias KeyComboInit

Add(string, ControlHandle?, ControlHandle?, KeyComboInit)

Adds a new bind with a two-key primary combo and one alias combination.

public void Add(string bindName, ControlHandle? con1, ControlHandle? con2, KeyComboInit alias)

Parameters

bindName string
con1 ControlHandle?
con2 ControlHandle?
alias KeyComboInit

Add(string, ControlHandle?, ControlHandle?, ControlHandle?)

Adds a new bind to the group with a primary key combination.

public void Add(string bindName, ControlHandle? con1 = null, ControlHandle? con2 = null, ControlHandle? con3 = null)

Parameters

bindName string

Unique name for the bind.

con1 ControlHandle?

First control in the primary combo.

con2 ControlHandle?

Optional second control.

con3 ControlHandle?

Optional third control.

Add(string, ControlHandle?, ControlHandle?, ControlHandle?, KeyComboInit)

Adds a new bind with a three-key primary combo and one alias combination.

public void Add(string bindName, ControlHandle? con1, ControlHandle? con2, ControlHandle? con3, KeyComboInit alias)

Parameters

bindName string
con1 ControlHandle?
con2 ControlHandle?
con3 ControlHandle?
alias KeyComboInit

GetBindDefinitions()

Converts the initialization data into an array of BindDefinition structs.

public BindDefinition[] GetBindDefinitions()

Returns

BindDefinition[]

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<MyTuple<string, IReadOnlyList<int>, IReadOnlyList<IReadOnlyList<int>>>> GetEnumerator()

Returns

IEnumerator<MyTuple<string, IReadOnlyList<int>, IReadOnlyList<IReadOnlyList<int>>>>

An enumerator that can be used to iterate through the collection.

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerator IEnumerable.GetEnumerator()

Returns

IEnumerator

An IEnumerator object that can be used to iterate through the collection.

Edit this page