Class TransformComponent

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

coordPlane dependencies? optional? owner? type zIndexChanged$

Accessors

globalPos globalRotation globalScale pos rotation scale z

Methods

apply applyInverse clone get onAdd onRemove

Constructors

constructor

Properties

coordPlane

coordPlane: CoordPlane = CoordPlane.World

The [[CoordPlane|coordinate plane|]] for this transform for the entity.

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

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]]

Readonly type

type: "ex.transform" = 'ex.transform'

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

zIndexChanged$

zIndexChanged$: Observable<number> = ...

Observable that emits when the z index changes on this component

Accessors

globalPos

globalRotation

globalScale

pos

rotation

scale

z

Methods

apply

applyInverse

clone

get

onAdd

onRemove

Settings

Member Visibility

Theme

On This Page