Table of Contents

Namespace RichHudFramework.UI.Client

Classes

BindManager

The central hub for creating and retrieving key binds, control groups, and configuring input blacklisting in the framework.

ControlCategory

Represents a horizontally scrolling row of ControlTiles within a ControlPage in the RichHudTerminal.

ControlPage

A page that organizes settings into vertically scrolling ControlCategorys in the RichHudTerminal.

ControlTile

Represents a vertical layout column within a ControlCategory in the RichHudTerminal.

Tiles are organized horizontally within a category. Each tile should generally contain no more than 3 controls to maintain proper UI scaling and layout bounds.

HudMain

Primary entry point for the client-side UI system. Provides shared access to root UI nodes, cursor, clipboard, screen metrics, and world-space projection utilities.

RebindPage

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.

RichHudTerminal

The central windowed settings menu shared by all mods using the framework.

TerminalButton

A clickable button control for a ControlTile.

Mimics the appearance of the standard Space Engineers terminal button.

TerminalCheckbox

A boolean checkbox control for a ControlTile.

Mimics the appearance of the standard Space Engineers terminal checkbox.

TerminalColorPicker

An RGB color picker using three sliders (Red, Green, Blue) for ControlTiles.

Designed to mimic the appearance of the color picker in the SE terminal.

TerminalControlBase

The abstract base class for all controls in the RichHudTerminal

TerminalDragBox

A control allowing the user to visually select a 2D screen position (Vector2) for a ControlTile.

Spawns a temporary draggable window when interacted with. Useful for configuring HUD element positions.

TerminalDropdown<T>

A collapsing dropdown list with a label. For ControlTiles.

Designed to mimic the appearance of the dropdown in the SE terminal.

TerminalLabel

A static text label for a ControlTile.

TerminalList<T>

A non-collapsing, fixed-height list box with a label. For ControlTiles.

Designed to mimic the appearance of the list box in the SE terminal.

TerminalOnOffButton

An On/Off toggle button used for ControlTiles.

Mimics the appearance of the "On/Off" button in the SE Terminal.

TerminalPageBase

Abstract base for interfacing with terminal page implementations

TerminalPageCategory

A collapsable group of RHF terminal pages that can be added to a mod's control root.

Functions as a folder in the sidebar navigation.

TerminalPageCategoryBase

Abstract base class for terminal page containers/groups.

TerminalSlider

A labeled slider for selecting float values within a specific range. For ControlTiles.

Mimics the appearance of the slider in the SE terminal.

TerminalTextField

A single-line text input field with a configurable character filter. For ControlTiles.

Mimics the appearance of the text field in the SE terminal.

TerminalValue<TValue>

Abstract base class for terminal controls that are associated with a specific data value (e.g., sliders, checkboxes) in the RichHudTerminal.

TextPage

A scrolling page of wrapped, read-only text in the RichHudTerminal.

Useful for help screens, changelogs, or information displays.