DefineBehaviorConfig

@zylem/game-lib

---

@zylem/game-lib / behavior / DefineBehaviorConfig

Interface: DefineBehaviorConfig<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:63

Configuration for defining a new behavior

Type Parameters

O

O extends Record<string, any>

H

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

I

I = unknown

Properties

createHandle?

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

Optional factory to create behavior-specific handle methods. The returned object is merged into the handle returned by entity.use().

Parameters

ref

BehaviorRef<O>

Returns

H

Example

createHandle: (ref) => ({
  getLastHits: () => ref.fsm?.getLastHits() ?? null,
  getMovement: (moveX, moveY) => ref.fsm?.getMovement(moveX, moveY) ?? { moveX, moveY },
}),

---

defaultOptions

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

Default options - these define the type

---

name

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

Human-readable name for debugging

---

systemFactory

systemFactory: BehaviorSystemFactory

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

Factory function to create the system