Class Component<T>

Type Parameters

T extends Schema<T>

Hierarchy

Component

Index

Constructors

Properties

isTag maxEntities name schema size

Constructors

constructor

new Component<T>(spec: ComponentSpec<T>): Component<T>
Define a new component.

Returns
A valid Component object - a reusable definitions for the creation of ComponentInstances

Throws
If the spec is invalid
Type Parameters
- T extends Schema<T>
Parameters
- spec: ComponentSpec<T>
  
  the component's specification.
Returns Component<T>
- Defined in src/component/component.ts:39

Properties

`Readonly` isTag

isTag: boolean

true if the component has no schema

`Readonly` maxEntities

maxEntities: null | number

The maximum number of entities able to equip this component per world.

`Readonly` name

name: string

The component's label

`Readonly` schema

schema: Readonly<Schema<T>>

The component's property definitions or null if component is a tag

`Readonly` size

size: number

The storage requirements of the schema in bytes for a single entity

Generated using TypeDoc