Skip to main content

ScreenVisibilityOptions

@zylem/game-lib

@zylem/game-lib / behavior / ScreenVisibilityOptions

Interface: ScreenVisibilityOptions

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:40

Properties​

cameraName​

cameraName: string | null

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:45

Restrict visibility checks to one active camera by name. When omitted, any active camera can make the entity visible.

fallbackSize​

fallbackSize: ScreenVisibilitySize | null

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:60

Optional bounds to use when the entity has no renderable mesh/group. Falls back to the entity's configured size when available.

onChange?​

optional onChange?: (context) => 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:61

Parameters​

context​

ScreenVisibilityChangeContext

Returns​

void

onEnter?​

optional onEnter?: (context) => 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:62

Parameters​

context​

ScreenVisibilityChangeContext

Returns​

void

onExit?​

optional onExit?: (context) => 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:63

Parameters​

context​

ScreenVisibilityChangeContext

Returns​

void

padding​

padding: number

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:55

Expand or shrink the computed bounds in world units. Positive values make visibility checks more generous.

requireFullyVisible​

requireFullyVisible: 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:50

Require the full entity bounds to remain inside the camera frustum. Defaults to partial visibility (any intersection counts).