Interface IBindGroup

Namespace

RichHudFramework.UI

Assembly

RichHudClient.dll

A collection of unique keybinds in the BindManager

public interface IBindGroup : IReadOnlyList<IBind>, IReadOnlyCollection<IBind>, IEnumerable<IBind>, IEnumerable

Inherited Members

this[int]

Count

GetEnumerator()

Properties

ID

Unique identifer

object ID { get; }

Property Value

object

Index

Index of the bind group in its associated client

int Index { get; }

Property Value

int

this[string]

Returns the bind with the name given, if it exists.

IBind this[string name] { get; }

Parameters

name string

Property Value

IBind

Name

Bind group name

string Name { get; }

Property Value

string

Methods

AddBind(string, IReadOnlyList<ControlHandle>, IReadOnlyList<IReadOnlyList<ControlHandle>>)

Adds a bind with the given name and the given key combo. Throws an exception if the bind is invalid.

IBind AddBind(string bindName, IReadOnlyList<ControlHandle> combo, IReadOnlyList<IReadOnlyList<ControlHandle>> aliases = null)

Parameters

bindName string

combo IReadOnlyList<ControlHandle>

aliases IReadOnlyList<IReadOnlyList<ControlHandle>>

Returns

IBind

AddBind(string, IReadOnlyList<int>, IReadOnlyList<IReadOnlyList<int>>)

Adds a bind with the given name and the given key combo. Throws an exception if the bind is invalid.

IBind AddBind(string bindName, IReadOnlyList<int> newConIDs, IReadOnlyList<IReadOnlyList<int>> aliases = null)

Parameters

bindName string

newConIDs IReadOnlyList<int>

aliases IReadOnlyList<IReadOnlyList<int>>

Returns

IBind

ClearSubscribers()

Clears bind subscribers for the entire group

void ClearSubscribers()

DoesBindExist(string)

Returns true if the group contains a bind with the given name.

bool DoesBindExist(string name)

Parameters

name string

Returns

bool

DoesComboConflict(IReadOnlyList<ControlHandle>, IBind, int)

Returns true if the given list of controls conflicts with any existing combos

bool DoesComboConflict(IReadOnlyList<ControlHandle> newCombo, IBind currentBind = null, int alias = 0)

Parameters

newCombo IReadOnlyList<ControlHandle>

currentBind IBind

alias int

Returns

bool

DoesComboConflict(IReadOnlyList<int>, IBind, int)

Determines if given combo is equivalent to any existing combos

bool DoesComboConflict(IReadOnlyList<int> newConIDs, IBind currentBind = null, int alias = 0)

Parameters

newConIDs IReadOnlyList<int>

currentBind IBind

alias int

Returns

bool

GetBind(string)

Returns the bind with the name given, if it exists.

IBind GetBind(string name)

Parameters

name string

Returns

IBind

GetBindData()

Retrieves the set of key binds as an array of BindDefinition

MyTuple<string, string[], string[][]>[] GetBindData()

Returns

MyTuple<string, string[], string[][]>[]

GetBindDefinitions()

Retrieves the set of key binds as an array of BindDefinition

BindDefinition[] GetBindDefinitions()

Returns

BindDefinition[]

RegisterBinds(BindGroupInitializer)

Registers a list of binds using the names given paired with associated control indices.

void RegisterBinds(BindGroupInitializer bindData)

Parameters

bindData BindGroupInitializer

RegisterBinds(IReadOnlyList<string>)

Registers a list of binds using the names given.

void RegisterBinds(IReadOnlyList<string> bindNames)

Parameters

bindNames IReadOnlyList<string>

TryLoadBindData(IReadOnlyList<BindDefinition>)

Attempts to load bind combinations from bind data. Will not register new binds.

bool TryLoadBindData(IReadOnlyList<BindDefinition> bindData)

Parameters

bindData IReadOnlyList<BindDefinition>

Returns

bool

TryRegisterBind(string, out IBind)

Tries to register an empty bind using the given name.

bool TryRegisterBind(string bindName, out IBind newBind)

Parameters

bindName string

newBind IBind

Returns

bool

TryRegisterBind(string, out IBind, IReadOnlyList<ControlHandle>, IReadOnlyList<IReadOnlyList<ControlHandle>>)

Tries to register a bind using the given name and the given key combo.

bool TryRegisterBind(string bindName, out IBind newBind, IReadOnlyList<ControlHandle> combo, IReadOnlyList<IReadOnlyList<ControlHandle>> aliases = null)

Parameters

bindName string

newBind IBind

combo IReadOnlyList<ControlHandle>

aliases IReadOnlyList<IReadOnlyList<ControlHandle>>

Returns

bool

TryRegisterBind(string, out IBind, IReadOnlyList<int>, IReadOnlyList<IReadOnlyList<int>>)

Tries to register a bind using the given name and the given key combo.

bool TryRegisterBind(string bindName, out IBind newBind, IReadOnlyList<int> combo, IReadOnlyList<IReadOnlyList<int>> aliases = null)

Parameters

bindName string

newBind IBind

combo IReadOnlyList<int>

aliases IReadOnlyList<IReadOnlyList<int>>

Returns

bool