1681-engine / index / PrefabLibrary

Class: PrefabLibrary

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

Prefabs by name, loadable from data a designer edits. Components are named through component(name, type); a value in the data is plain JSON, so factories (a sprite, a brain) are given in code with factory.

Constructors

Constructor

new PrefabLibrary(): PrefabLibrary;

Returns

PrefabLibrary

Methods

add()

add(prefab): this;

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

Adds a prefab made in code.

Parameters

Parameter	Type
prefab	Prefab

Returns

this

---

component()

component(name, type): this;

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

Lets data name a component type.

Parameters

Parameter	Type
name	string
type	ComponentType<unknown>

Returns

this

---

factory()

factory<T>(
   prefab, 
   type, 
   make
): this;

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

A value made in code for a prefab loaded from data (and its variants): the data cannot hold a function.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
prefab	string
type	ComponentType<T>
make	(ctx) => T

Returns

this

---

get()

get(name): Prefab;

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

Parameters

Parameter	Type
name	string

Returns

Prefab

---

has()

has(name): boolean;

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

Parameters

Parameter	Type
name	string

Returns

boolean

---

load()

load(data): this;

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

Builds the prefabs of data, bases before their variants (in any order in the data), and adds them. Throws, naming the prefab, on an unknown component or base, or a prefab that extends itself.

Parameters

Parameter	Type
data	PrefabData

Returns

this

---

names()

names(): string[];

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

Returns

string[]

---

spawn()

spawn<A>(
   world, 
   name, 
   options?
): number;

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

spawnPrefab by name.

Type Parameters

Type Parameter	Default type
A	unknown

Parameters

Parameter	Type
world	World
name	string
options	SpawnOptions<A>

Returns

number