Skip to main content

ScreenVisibilityFSM

@zylem/game-lib


@zylem/game-lib / behavior / ScreenVisibilityFSM

Class: ScreenVisibilityFSM

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/screen-visibility.d.ts:11

Behaviors Module Index

Behaviors now live in the standalone, tree-shakable @zylem/behaviors package (built on @zylem/behaviors/core). This barrel re-exports that public surface so existing @zylem/game-lib/behavior consumers keep working.

IMPORTANT: do NOT use export * from '@zylem/behaviors' here. Because @zylem/behaviors is external in game-lib's tsup build, esbuild compiles a star re-export of an external into a runtime __reExport helper with no static export names. Downstream bundlers (e.g. the examples/arena Vite builds) then cannot statically resolve named value imports such as FractureOptions and fail with "X is not exported by game-lib/dist/behavior.js". Explicit named re-exports below are preserved statically and keep a single runtime copy of @zylem/behaviors (no bundling/duplication).

The lists mirror the full public API of @zylem/behaviors (values from its built dist/index.js export block; types are the remaining dist/index.d.ts exports). When behaviors are added/removed in @zylem/behaviors, update these lists to match.

Constructors​

Constructor​

new ScreenVisibilityFSM(): ScreenVisibilityFSM

Returns​

ScreenVisibilityFSM

Methods​

getState()​

getState(): ScreenVisibilitySnapshot

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/screen-visibility.d.ts:23

Returns​

ScreenVisibilitySnapshot


getVisibleCameraNames()​

getVisibleCameraNames(): string[]

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/screen-visibility.d.ts:22

Returns​

string[]


isInitialized()​

isInitialized(): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/screen-visibility.d.ts:18

Returns​

boolean


isVisible()​

isVisible(): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/screen-visibility.d.ts:19

Returns​

boolean


update()​

update(visible, visibleCameraNames): void

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/screen-visibility.d.ts:17

Parameters​

visible​

boolean

visibleCameraNames​

readonly string[]

Returns​

void


wasJustEntered()​

wasJustEntered(): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/screen-visibility.d.ts:20

Returns​

boolean


wasJustExited()​

wasJustExited(): boolean

Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/screen-visibility.d.ts:21

Returns​

boolean