Class Particle

Initializes this entity, meant to be called by the Scene before first update not by users of Excalibur.

It is not recommended that internal excalibur methods be overridden, do so at your own risk.

It is not recommended that internal excalibur methods be overridden, do so at your own risk.

Internal _preupdate handler for onPostUpdate lifecycle event

It is not recommended that internal excalibur methods be overridden, do so at your own risk.

Internal _preupdate handler for onPreUpdate lifecycle event

Adds an entity to be a child of this entity

Adds a component to the entity

Adds a tag to an entity

Returns

Entity

Adds a copy of all the components from another template entity as a "prefab"

Creates a deep copy of the entity and a copy of all its components

Emits a new event

Get a component by type with typecheck

(Does not work on tag components, use .hasTag("mytag") instead)

Returns a list of parent entities starting with the topmost parent. Includes the current entity.

Returns a list of all the entities that descend from this entity. Includes the current entity.

Check if a component type exists

Check if a tag exists on the entity

Alias for removeEventListener. If only the eventName is specified it will remove all handlers registered for that specific event. If the eventName and the handler instance are specified only that handler will be removed.

Alias for addEventListener. You can listen for a variety of events off of the engine; see the events section below for a complete list.

onInitialize is called before the first update of the entity. This method is meant to be overridden.

Synonymous with the event handler .on('initialize', (evt) => {...})

Safe to override onPostUpdate lifecycle event handler. Synonymous with .on('postupdate', (evt) =>{...})

onPostUpdate is called directly after an entity is updated.

Safe to override onPreUpdate lifecycle event handler. Synonymous with .on('preupdate', (evt) =>{...})

onPreUpdate is called directly before an entity is updated.

Once listens to an event one time, then unsubscribes from that event

Removes all children from this entity

Remove an entity from children if it exists

Removes a component from the entity, by default removals are deferred to the end of entity update to avoid consistency issues

Components can be force removed with the force flag, the removal is not deferred and happens immediately

Removes a tag on the entity

Removals are deferred until the end of update

Unparents this entity, if there is a parent. Otherwise it does nothing.