Table of Contents

Struct TerminalMouseEvent

Namespace
RatatuiUnity

A mouse event in terminal cell coordinates.

public readonly struct TerminalMouseEvent
Inherited Members

Constructors

TerminalMouseEvent(MouseEventType, int, int, uint, MouseButton, float, KeyModifiers)

public TerminalMouseEvent(MouseEventType type, int col, int row, uint areaId, MouseButton button, float scrollDelta, KeyModifiers modifiers)

Parameters

type MouseEventType
col int
row int
areaId uint
button MouseButton
scrollDelta float
modifiers KeyModifiers

Fields

AreaId

Area ID at the mouse position (from Rust hit_test). 0 = root area, meaning no specific widget area was hit.

public readonly uint AreaId

Field Value

uint

Button

Which mouse button (for Down/Up/Click events).

public readonly MouseButton Button

Field Value

MouseButton

Col

Terminal column (0-based, left to right).

public readonly int Col

Field Value

int

Modifiers

Active modifier keys.

public readonly KeyModifiers Modifiers

Field Value

KeyModifiers

Row

Terminal row (0-based, top to bottom).

public readonly int Row

Field Value

int

ScrollDelta

Scroll delta (for Scroll events). Positive = up.

public readonly float ScrollDelta

Field Value

float

Type

Type of mouse event.

public readonly MouseEventType Type

Field Value

MouseEventType

Methods

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.