ecsia-monorepo / react/src / EcsiaWorld

Interface: EcsiaWorld

Defined in: react/src/world.ts:35

The structural world slice @ecsia/react consumes and useWorld() returns.

Properties

tick

readonly tick: number;

Defined in: react/src/world.ts:36

---

query

query: WorldQuery;

Defined in: react/src/world.ts:46

Methods

currentTick()

currentTick(): number;

Defined in: react/src/world.ts:37

Returns

number

---

spawn()

spawn(): EntityHandle;

Defined in: react/src/world.ts:38

Returns

EntityHandle

---

spawnWith()

spawnWith<T>(...specs): EntityHandle;

Defined in: react/src/world.ts:39

Type Parameters

Type Parameter
T extends readonly SpawnArg[]

Parameters

Parameter	Type
...specs	{ [I in string | number | symbol]: SpawnArgFor<T[I]> }

Returns

EntityHandle

---

add()

add(handle, def): void;

Defined in: react/src/world.ts:40

Parameters

Parameter	Type
handle	EntityHandle
def	ComponentDef<Readonly<Record<string, FieldToken>>>

Returns

void

---

remove()

remove(handle, def): void;

Defined in: react/src/world.ts:41

Parameters

Parameter	Type
handle	EntityHandle
def	ComponentDef<Readonly<Record<string, FieldToken>>>

Returns

void

---

despawn()

despawn(handle): void;

Defined in: react/src/world.ts:42

Parameters

Parameter	Type
handle	EntityHandle

Returns

void

---

isAlive()

isAlive(handle): boolean;

Defined in: react/src/world.ts:43

Parameters

Parameter	Type
handle	EntityHandle

Returns

boolean

---

has()

has(handle, def): boolean;

Defined in: react/src/world.ts:44

Parameters

Parameter	Type
handle	EntityHandle
def	ComponentDef<Readonly<Record<string, FieldToken>>>

Returns

boolean

---

entity()

entity(handle, opts?): EntityRefLike;

Defined in: react/src/world.ts:45

Parameters

Parameter	Type
handle	EntityHandle
opts?	{ lenient?: boolean; }
opts.lenient?	boolean

Returns

EntityRefLike

---

observe()

observe(term, handler): ObserverHandle;

Defined in: react/src/world.ts:47

Parameters

Parameter	Type
term	ObserverTerm
handler	(e, ctx) => void

Returns

ObserverHandle

---

decodeHandle()

decodeHandle(handle): {
  index: EntityIndex;
};

Defined in: react/src/world.ts:48

Parameters

Parameter	Type
handle	EntityHandle

Returns

{
  index: EntityIndex;
}

index

index: EntityIndex;