Skip to main content

Interface: TooltipEcsComponent

Defined in: ui/components/tooltip-component.ts:42

Attach to an interactable entity (alongside its own UiInteractableEcsComponent) to show a floating panel/label near it after it's been hovered or focused for showDelayMilliseconds - see createTooltip for the usual way to build one, and createUiTooltipEcsSystem for the system that drives it.

Extends​

Properties​

hoverElapsedMilliseconds​

hoverElapsedMilliseconds: number

Defined in: ui/components/tooltip-component.ts:50

Milliseconds the source element has been continuously hovered or focused - deriveUiInteractionVisualState's hover/pressed states, normal/disabled reset it to 0. System-owned, written by createUiTooltipEcsSystem; read-only to callers.

label​

label: number

Defined in: ui/components/tooltip-component.ts:20

The entity carrying the tooltip's TextEcsComponent - toggled enabled alongside panel. createTooltip builds this for you.

Inherited from​

TooltipRequiredOptions.label

panel​

panel: number

Defined in: ui/components/tooltip-component.ts:14

The entity carrying the tooltip's SpriteEcsComponent (its background panel) - toggled enabled by createUiTooltipEcsSystem to show/hide the tooltip. createTooltip builds this for you.

Inherited from​

TooltipRequiredOptions.panel

showDelayMilliseconds​

showDelayMilliseconds: number

Defined in: ui/components/tooltip-component.ts:32

How long, in milliseconds, the source element must stay hovered or focused before the tooltip appears. Defaults to 400.

Inherited from​

TooltipDefaultedOptions.showDelayMilliseconds