Class RebindPage

Namespace

RichHudFramework.UI.Client

Assembly

RichHudClient.dll

A terminal page designed specifically for managing key bindings. Presents binds from a IBindGroup in a scrolling list in the RichHudTerminal with a pop-up dialog for changing key combinations when a bind is selected by the user.

public class RebindPage : TerminalPageBase, IModRootMember, IEnumerable<IBindGroup>, IEnumerable

Inheritance

object

TerminalPageBase

RebindPage

Implements

IModRootMember

IEnumerable<IBindGroup>

IEnumerable

Inherited Members

Name

Enabled

Examples

This example creates a new RebindPage, registers a preexisting IBindGroup with it, enables bind aliasing, and adds it to the terminal.

IBindGroup myBinds;

var rebindPage = new RebindPage()
{ 
    // Name in sidebar listing
    Name = "Rebind Page Name",
    // Content
    GroupContainer = 
    {
        { myBinds, true }
    }
};
RichHudTerminal.Root.Add(rebindPage);

Constructors

RebindPage()

public RebindPage()

Properties

BindGroups

Read-only list of bind groups registered to this page.

public IReadOnlyList<IBindGroup> BindGroups { get; }

Property Value

IReadOnlyList<IBindGroup>

GroupContainer

Interface accessor for adding bind groups via collection-initializer syntax.

public RebindPage GroupContainer { get; }

Property Value

RebindPage

Methods

Add(IBindGroup, BindDefinition[], bool)

Adds an existing IBindGroup to the page and registers default bind definitions.

public void Add(IBindGroup bindGroup, BindDefinition[] defaultBinds, bool isAliased = false)

Parameters

bindGroup IBindGroup

The bind group to add.

defaultBinds BindDefinition[]

Array of default bind definitions used for manual reset.

isAliased bool

If true, exposes the ability to set alias bindings in the UI.

Add(IBindGroup, bool)

Adds an existing IBindGroup to the page.

public void Add(IBindGroup bindGroup, bool isAliased = false)

Parameters

bindGroup IBindGroup

The bind group to add.

isAliased bool

If true, exposes the ability to set alias bindings in the UI.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<IBindGroup> GetEnumerator()

Returns

IEnumerator<IBindGroup>

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.