Skip to main content

GameEntityOptions

@zylem/game-lib

@zylem/game-lib / entity / GameEntityOptions

Type Alias: GameEntityOptions

GameEntityOptions = object

Defined in: packages/game-lib/src/lib/entities/entity.ts:115

Properties​

_builders?​

optional _builders?: object

Defined in: packages/game-lib/src/lib/entities/entity.ts:140

collisionBuilder?​

optional collisionBuilder?: IBuilder | EntityCollisionBuilder | null

materialBuilder?​

optional materialBuilder?: MaterialBuilder | null

meshBuilder?​

optional meshBuilder?: IBuilder | EntityMeshBuilder | null

category?​

optional category?: RenderCategory

Defined in: packages/game-lib/src/lib/entities/entity.ts:132

Render path: environment (bundle), pack (instanced), or none (default).

collision?​

optional collision?: Partial<CollisionOptions>

Defined in: packages/game-lib/src/lib/entities/entity.ts:134

collisionFilter?​

optional collisionFilter?: string[]

Defined in: packages/game-lib/src/lib/entities/entity.ts:139

collisionGroup?​

optional collisionGroup?: string

Defined in: packages/game-lib/src/lib/entities/entity.ts:138

collisionType?​

optional collisionType?: string

Defined in: packages/game-lib/src/lib/entities/entity.ts:137

color?​

optional color?: Color

Defined in: packages/game-lib/src/lib/entities/entity.ts:117

custom?​

optional custom?: object

Defined in: packages/game-lib/src/lib/entities/entity.ts:136

Index Signature​

[key: string]: any

hideUntilPositioned?​

optional hideUntilPositioned?: boolean

Defined in: packages/game-lib/src/lib/entities/entity.ts:128

Spawn visibility behavior:

  • undefined (default): hidden while spawnEntity runs, revealed once the spawn finalizes — even if no position was assigned.
  • true (strict): stays hidden until the first setPosition/setPose, for spawner patterns that place the entity frames after spawn.
  • false: never hidden during spawn.

material?​

optional material?: Partial<MaterialOptions>

Defined in: packages/game-lib/src/lib/entities/entity.ts:135

name?​

optional name?: string

Defined in: packages/game-lib/src/lib/entities/entity.ts:116

position?​

optional position?: Vec3Input

Defined in: packages/game-lib/src/lib/entities/entity.ts:119

runtime?​

optional runtime?: RuntimeEntityOptions

Defined in: packages/game-lib/src/lib/entities/entity.ts:133

size?​

optional size?: Vec3Input

Defined in: packages/game-lib/src/lib/entities/entity.ts:118

visible?​

optional visible?: boolean

Defined in: packages/game-lib/src/lib/entities/entity.ts:130

Explicit render visibility. When false, entity stays hidden until GameEntity.reveal.