Class MotionComponent

Components are containers for state in Excalibur, the are meant to convey capabilities that an Entity possesses

Implementations of Component must have a zero-arg constructor to support dependencies

class MyComponent extends ex.Component<'my'> {
  public readonly type = 'my';
  // zero arg support required if you want to use component dependencies
  constructor(public optionalPos?: ex.Vector) {}
}

Hierarchy

Constructors

constructor

Properties

acc angularVelocity dependencies? inertia optional? owner? scaleFactor torque type vel

Methods

clone onAdd? onRemove?

Constructors

constructor

Properties

acc

acc: Vector = Vector.Zero

The acceleration of entity in pixels per second^2

angularVelocity

angularVelocity: number = 0

The angular velocity which is how quickly the entity is rotating in radians per second

Optional Readonly dependencies

dependencies?: ComponentCtor<Component<string>>[]

Optionally list any component types this component depends on If the owner entity does not have these components, new components will be added to the entity

Only components with zero-arg constructors are supported as automatic component dependencies

inertia

inertia: number = 1

Inertia can be thought of as the resistance to motion

Optional Readonly optional

optional?: ComponentCtor<Component<string>>[]

Optional owner

owner?: Entity = null

Current owning Entity, if any, of this component. Null if not added to any Entity

scaleFactor

scaleFactor: Vector = Vector.Zero

The scale rate of change in scale units per second

torque

torque: number = 0

The amount of torque applied to the entity, angular acceleration is torque * inertia

Readonly type

type: "ex.motion" = 'ex.motion'

Type of this component, must be a unique type among component types in you game.

vel

vel: Vector = Vector.Zero

The velocity of an entity in pixels per second

Methods

clone

Optional onAdd

Optional onRemove

Settings

Member Visibility

Theme