Class Entity

An entity in the world.

Hierarchy

Entity

Index

Constructors

constructor

Properties

alive
id

Methods

Constructors

constructor

new Entity(): Entity

Returns Entity

Properties

alive

alive: boolean

Whether or not the entity is alive or removed.

id

id: number

A unique ID for this entity.

Methods

addComponent

addComponent<C>(Component: RealComponentConstructor<C>, values?: Partial<Pick<C, Exclude<keyof C, "copy" | "clone" | "reset" | "dispose">>>): Entity

- Defined in node_modules/ecsy/src/Entity.d.ts:62
Add a component to the entity.

Type parameters
- C: Component<any, C>
Parameters
- Component: RealComponentConstructor<C>
  
  Type of component to add to this entity
- Optional values: Partial<Pick<C, Exclude<keyof C, "copy" | "clone" | "reset" | "dispose">>>
  
  Optional values to replace the default attributes on the component
Returns Entity

clone

clone(): Entity

- Defined in node_modules/ecsy/src/Entity.d.ts:121
Returns Entity

copy

copy(source: Entity): Entity

- Defined in node_modules/ecsy/src/Entity.d.ts:119
Parameters
- source: Entity
Returns Entity

getComponent

getComponent<C>(Component: RealComponentConstructor<C>, includeRemoved?: boolean): undefined | Readonly<C>

- Defined in node_modules/ecsy/src/Entity.d.ts:22
Get an immutable reference to a component on this entity.

Type parameters
- C: Component<any, C>
Parameters
- Component: RealComponentConstructor<C>
  
  Type of component to get
- Optional includeRemoved: boolean
  
  Whether a component that is staled to be removed should be also considered
Returns undefined | Readonly<C>

getComponentTypes

getComponentTypes(): Component<any>[]

- Defined in node_modules/ecsy/src/Entity.d.ts:47
Get a list of component types that have been added to this entity.

Returns Component<any>[]

getComponents

getComponents(): {}

- Defined in node_modules/ecsy/src/Entity.d.ts:37
Get an object containing all the components on this entity, where the object keys are the component types.

Returns {}
- [componentName: string]: Component<any>

getComponentsToRemove

getComponentsToRemove(): {}

- Defined in node_modules/ecsy/src/Entity.d.ts:42
Get an object containing all the components that are slated to be removed from this entity, where the object keys are the component types.

Returns {}
- [componentName: string]: Component<any>

getMutableComponent

getMutableComponent<C>(Component: RealComponentConstructor<C>): undefined | C

- Defined in node_modules/ecsy/src/Entity.d.ts:53
Get a mutable reference to a component on this entity.

Type parameters
- C: Component<any, C>
Parameters
- Component: RealComponentConstructor<C>
  
  Type of component to get
Returns undefined | C

getRemovedComponent

getRemovedComponent<C>(Component: RealComponentConstructor<C>): undefined | Readonly<C>

- Defined in node_modules/ecsy/src/Entity.d.ts:30
Get a component that is slated to be removed from this entity.

Type parameters
- C: Component<any, C>
Parameters
- Component: RealComponentConstructor<C>
Returns undefined | Readonly<C>

hasAllComponents

hasAllComponents(Components: RealComponentConstructor<any>[]): boolean

- Defined in node_modules/ecsy/src/Entity.d.ts:99
Check if the entity has all components in a list.

Parameters
- Components: RealComponentConstructor<any>[]
  
  Component types to check
Returns boolean

hasAnyComponents

hasAnyComponents(Components: RealComponentConstructor<any>[]): boolean

- Defined in node_modules/ecsy/src/Entity.d.ts:107
Check if the entity has any of the components in a list.

Parameters
- Components: RealComponentConstructor<any>[]
  
  Component types to check
Returns boolean

hasComponent

hasComponent<C>(Component: RealComponentConstructor<C>, includeRemoved?: boolean): boolean

- Defined in node_modules/ecsy/src/Entity.d.ts:82
Check if the entity has a component.

Type parameters
- C: Component<any, C>
Parameters
- Component: RealComponentConstructor<C>
  
  Type of component
- Optional includeRemoved: boolean
  
  Whether a component that is staled to be removed should be also considered
Returns boolean

hasRemovedComponent

hasRemovedComponent<C>(Component: RealComponentConstructor<C>): boolean

- Defined in node_modules/ecsy/src/Entity.d.ts:91
Check if the entity has a component that is slated to be removed.

Type parameters
- C: Component<any, C>
Parameters
- Component: RealComponentConstructor<C>
  
  Type of component
Returns boolean

remove

remove(forceImmediate?: boolean): void

- Defined in node_modules/ecsy/src/Entity.d.ts:129
Remove this entity from the world.

Parameters
- Optional forceImmediate: boolean
  
  Whether this entity should be removed immediately
Returns void

removeAllComponents

removeAllComponents(forceImmediate?: boolean): void

- Defined in node_modules/ecsy/src/Entity.d.ts:115
Remove all components on this entity.

Parameters
- Optional forceImmediate: boolean
  
  Whether all components should be removed immediately
Returns void

removeComponent

removeComponent<C>(Component: RealComponentConstructor<C>, forceImmediate?: boolean): Entity

- Defined in node_modules/ecsy/src/Entity.d.ts:72
Remove a component from the entity.

Type parameters
- C: Component<any, C>
Parameters
- Component: RealComponentConstructor<C>
  
  Type of component to remove from this entity
- Optional forceImmediate: boolean
  
  Whether a component should be removed immediately
Returns Entity

reset

reset(): void

- Defined in node_modules/ecsy/src/Entity.d.ts:123
Returns void

Generated using TypeDoc