Skip to main content

BehaviorDescriptor

@zylem/game-lib

@zylem/game-lib / behavior / BehaviorDescriptor

Interface: BehaviorDescriptor<O, H, I>

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/behavior-system-DkFAwLb_.d.ts:42

A typed behavior descriptor that associates a symbol key with:

  • Default options (providing type inference)
  • A system factory to create the behavior system
  • An optional handle factory for behavior-specific methods

Type Parameters​

O​

O extends Record<string, any> = Record<string, any>

H​

H extends Record<string, any> = Record<string, never>

I​

I = unknown

Properties​

createHandle?​

readonly optional createHandle?: (ref) => H

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/behavior-system-DkFAwLb_.d.ts:53

Optional factory to create behavior-specific handle methods. These methods are merged into the handle returned by entity.use().

Parameters​

ref​

any

Returns​

H

defaultOptions​

readonly defaultOptions: O

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/behavior-system-DkFAwLb_.d.ts:46

Default options (used for type inference)

key​

readonly key: symbol

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/behavior-system-DkFAwLb_.d.ts:44

Unique symbol identifying this behavior

systemFactory​

readonly systemFactory: any

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/behavior-system-DkFAwLb_.d.ts:48

Factory to create the behavior system