Class RatatuiTerminalApp

Namespace

RatatuiUnity

Base class for terminal apps that can be opened and closed from any scene. Provides shared toggle-key handling, touch toggle, and open/close lifecycle.

[DefaultExecutionOrder(-100)]
public abstract class RatatuiTerminalApp : RatatuiRenderer

Inheritance

object

Object

MonoBehaviour

RatatuiRenderer

RatatuiTerminalApp

Inherited Members

RatatuiRenderer.Texture

RatatuiRenderer.Terminal

RatatuiRenderer.HoverState

RatatuiRenderer.IsFocused

RatatuiRenderer.RequestFocus()

RatatuiRenderer.Cols

RatatuiRenderer.Rows

RatatuiRenderer.FitColsAndRows

RatatuiRenderer.FontSize

RatatuiRenderer.SizingMode

RatatuiRenderer.BackgroundColor

RatatuiRenderer.OnGuiDisplayMode

RatatuiRenderer.OnGuiHorizontalAlignment

RatatuiRenderer.OnGuiVerticalAlignment

RatatuiRenderer.WindowStartMaximized

RatatuiRenderer.WindowInitialWidth

RatatuiRenderer.WindowInitialHeight

RatatuiRenderer.WindowChromeFont

RatatuiRenderer.EnableInput

RatatuiRenderer.EnableMouseInput

RatatuiRenderer.EnableKeyboardInput

RatatuiRenderer.OnTerminalResized

RatatuiRenderer.OnCloseClicked

RatatuiRenderer.Awake()

RatatuiRenderer.OnRectTransformDimensionsChange()

RatatuiRenderer.OnEnable()

RatatuiRenderer.OnDisable()

RatatuiRenderer.OnDestroy()

RatatuiRenderer.BuildFrame(RatatuiTerminal)

RatatuiRenderer.OnTerminalKeyDown(TerminalKeyEvent)

RatatuiRenderer.OnTerminalMouseEvent(TerminalMouseEvent)

RatatuiRenderer.OnTerminalHoverChanged(TerminalHoverState, TerminalHoverState)

RatatuiRenderer.OnFocusChanged(bool)

RatatuiRenderer.TryGetTerminalCell(Vector2, out int, out int)

RatatuiRenderer.FitRawImageToTexture()

RatatuiRenderer.ForceRefit()

RatatuiRenderer.SetCustomFont(byte[])

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

FreshOpenFrames

Skip mouse input until BuildFrame populates area_map after opening.

protected int FreshOpenFrames { get; }

Property Value

int

IsOpen

True when the app window is visible and receiving render/input.

public bool IsOpen { get; }

Property Value

bool

ToggleKey

Keyboard key that toggles this app. KeyCode.None disables keyboard toggle.

protected virtual KeyCode ToggleKey { get; }

Property Value

KeyCode

TouchToggleFingerCount

Simultaneous touch count that toggles this app on full release.

protected virtual int TouchToggleFingerCount { get; }

Property Value

int

Methods

OnClosed()

Called when the app closes. Override for app-specific cleanup.

protected virtual void OnClosed()

OnGUI()

protected override void OnGUI()

OnOpened()

Called when the app opens. Override for app-specific setup.

protected virtual void OnOpened()

SetOpen(bool)

Open or close the app window.

public void SetOpen(bool open)

Parameters

open bool

ShouldIgnoreMouseThisFrame()

Skip mouse events for one frame after opening when area_map is stale.

protected bool ShouldIgnoreMouseThisFrame()

Returns

bool

ShouldSuppressToggleKeyEvent(TerminalKeyEvent)

Drop toggle-key events so the held toggle key does not leak into the app. Call from OnTerminalKeyDown before handling other keys.

protected bool ShouldSuppressToggleKeyEvent(TerminalKeyEvent e)

Parameters

e TerminalKeyEvent

Returns

bool

Toggle()

Toggle the app window open/closed.

public void Toggle()

Update()

protected override void Update()

Events

OnOpenChanged

Fires after open state changes. Argument is the new open state.

public event Action<bool> OnOpenChanged

Event Type

Action<bool>