1681-engine / index / definePrefab

Function: definePrefab()

function definePrefab<A>(
   name, 
   parts, 
   options?
): Prefab<A>;

Defined in: src/ecs/prefab.ts:51

Defines a prefab.

const Monster = definePrefab('monster', [prefabPart(Health, { hp: 10, max: 10 }), prefabPart(Brain, () => tree.agent())]);
const Boss = definePrefab('boss', [prefabPart(Health, { hp: 200, max: 200 }), prefabPart(Flying, null)], { extends: Monster });
spawnPrefab(world, Boss, { with: [[Position, { x: 40, y: 80 }]] });

Type Parameters

Type Parameter	Default type
A	unknown

Parameters

Parameter	Type
name	string
parts	readonly PrefabPart<A>[]
options	PrefabOptions<A>

Returns

Prefab<A>