Skip to main content

Interface: RegisterUiSystemsOptions

Defined in: ui/utilities/register-ui-systems.ts:21

Options for registerUiSystems.

Properties​

getSafeAreaInsets?​

optional getSafeAreaInsets?: () => SafeAreaInsets

Defined in: ui/utilities/register-ui-systems.ts:41

Returns the browser viewport's current safe-area insets - supply it (getSafeAreaInsets from @forge-game-engine/forge/rendering satisfies this directly) to register createUiSafeAreaEcsSystem, so any UiSafeAreaEcsComponent element on any canvas stays clear of a notch/cutout/home indicator. Omit for a game that doesn't need safe-area support.

Returns​

SafeAreaInsets

pointerSource?​

optional pointerSource?: UiPointerSource

Defined in: ui/utilities/register-ui-systems.ts:31

The pointer source every canvas's interactables (see UiInteractableEcsComponent) are hit-tested and pressed/hovered/dragged against - MouseInputSource satisfies this without any changes, and any other device (e.g. a touchscreen) can too by exposing the same shape. Omit for a game with no pointer interaction at all - canvases are still fully focus-navigable through their own submitInput/navigateInput (see CanvasInputOptions).