Class: ComponentRegistry

Constructors

Constructor

new ComponentRegistry(): ComponentRegistry;

Returns

ComponentRegistry

Methods

AddComponent()

AddComponent<Component, Args>(
   entityId, 
   type, 
   ...args
): Component;

Type Parameters

Type Parameter
Component
Args extends unknown[]

Parameters

Parameter	Type
entityId	number
type	ComponentClass<Component, Args>
...args	Args

Returns

Component

---

Clear()

Clear(): void;

Returns

void

---

GetAllDescriptors()

static GetAllDescriptors(): readonly ComponentDescriptor[];

Returns

readonly ComponentDescriptor[]

---

GetComponent()

GetComponent<Component>(entityId, type): Component;

Type Parameters

Type Parameter
Component

Parameters

Parameter	Type
entityId	number
type	ComponentClass<Component>

Returns

Component

---

GetDescriptor()

static GetDescriptor<T>(ctor): ComponentDescriptor;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
ctor	ComponentClass<T>

Returns

ComponentDescriptor

---

GetDescriptorByName()

static GetDescriptorByName(name): 
  | ComponentDescriptor
  | undefined;

Parameters

Parameter	Type
name	string

Returns

| ComponentDescriptor | undefined

---

GetOrCreateSparseSet()

GetOrCreateSparseSet<Component>(type): SparseSet<Component>;

Type Parameters

Type Parameter
Component

Parameters

Parameter	Type
type	ComponentClass<Component>

Returns

SparseSet<Component>

---

GetOrCreateSparseSetByTypeId()

GetOrCreateSparseSetByTypeId(typeId): SparseSet<any>;

Parameters

Parameter	Type
typeId	number

Returns

SparseSet<any>

---

GetSparseSet()

GetSparseSet<Component>(type): 
  | SparseSet<Component>
  | undefined;

Type Parameters

Type Parameter
Component

Parameters

Parameter	Type
type	ComponentClass<Component>

Returns

| SparseSet<Component> | undefined

---

GetSparseSetByTypeId()

GetSparseSetByTypeId(typeId): 
  | SparseSet<any>
  | undefined;

Parameters

Parameter	Type
typeId	number

Returns

| SparseSet<any> | undefined

---

GetTypeId()

static GetTypeId<T>(ctor): number;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
ctor	ComponentClass<T>

Returns

number

---

GetView()

GetView<Components>(...types): View<Components>;

Type Parameters

Type Parameter
Components extends readonly ComponentClass<any, any[]>[]

Parameters

Parameter	Type
...types	Components

Returns

View<Components>

---

HasComponent()

HasComponent<Component>(entityId, type): boolean;

Type Parameters

Type Parameter
Component

Parameters

Parameter	Type
entityId	number
type	ComponentClass<Component>

Returns

boolean

---

OnComponentAdded()

OnComponentAdded(listener): () => void;

Parameters

Parameter	Type
listener	ComponentEventListener

Returns

() => void

---

OnComponentRemoved()

OnComponentRemoved(listener): () => void;

Parameters

Parameter	Type
listener	ComponentEventListener

Returns

() => void

---

Register()

static Register<T>(ctor, schema): ComponentDescriptor;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
ctor	ComponentClass<T>
schema	ComponentSchema

Returns

ComponentDescriptor

---

RegisterScript()

static RegisterScript<T>(ctor, schema): ComponentDescriptor;

Fields come from @property decorators on the class plus schema.fields; an explicit entry wins over a decorated one of the same name.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
ctor	ComponentClass<T>
schema	ScriptSchema

Returns

ComponentDescriptor

---

RemoveComponent()

RemoveComponent<Component>(entityId, type): void;

Type Parameters

Type Parameter
Component

Parameters

Parameter	Type
entityId	number
type	ComponentClass<Component>

Returns

void

---

RemoveEntity()

RemoveEntity(entityId): void;

Scripts first: their OnDisable / OnDestroy can still read the entity's other components (Unity) — removal otherwise goes by type id, which puts Name / Transform ahead of scripts.

Parameters

Parameter	Type
entityId	number

Returns

void

---

RemoveScripts()

RemoveScripts(entityId): void;

Just the script components — Scene.DestroyEntity runs them before taking the hierarchy apart.

Parameters

Parameter	Type
entityId	number

Returns

void

---

TryGetComponent()

TryGetComponent<Component>(entityId, type): Component | undefined;

Type Parameters

Type Parameter
Component

Parameters

Parameter	Type
entityId	number
type	ComponentClass<Component>

Returns

Component | undefined