Table of Contents

Interface ITab

Namespace
RatatuiUnity

Contract for a self-contained demo tab. The host RatatuiRenderer calls Update(float) every frame, then Render(RatatuiTerminal, uint) inside BuildFrame, and forwards user input via OnKeyEvent(TerminalKeyEvent), OnMouseEvent(TerminalMouseEvent), and OnHoverChanged(TerminalHoverState, TerminalHoverState).

public interface ITab

Properties

Title

Label shown in the tab bar.

string Title { get; }

Property Value

string

Methods

OnHoverChanged(TerminalHoverState, TerminalHoverState)

Called when the hover state changes (cell or area changed).

void OnHoverChanged(TerminalHoverState oldState, TerminalHoverState newState)

Parameters

oldState TerminalHoverState
newState TerminalHoverState

OnInput(KeyCode)

[Obsolete("Use OnKeyEvent instead")]
void OnInput(KeyCode key)

Parameters

key KeyCode

OnKeyEvent(TerminalKeyEvent)

Forward a keyboard event to the tab.

void OnKeyEvent(TerminalKeyEvent e)

Parameters

e TerminalKeyEvent

OnMouseEvent(TerminalMouseEvent)

Forward a mouse event to the tab.

void OnMouseEvent(TerminalMouseEvent e)

Parameters

e TerminalMouseEvent

Render(RatatuiTerminal, uint)

Render all widgets for this tab into area.

void Render(RatatuiTerminal term, uint area)

Parameters

term RatatuiTerminal
area uint

Update(float)

Called every frame for animation / signal advancement.

void Update(float deltaTime)

Parameters

deltaTime float