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 {
  // zero arg support required if you want to use component dependencies
  constructor(public optionalPos?: ex.Vector) {}
}

Hierarchy

• Component
  • TransformComponent

Index

Constructors

• constructor

Properties

• dependencies
• owner
• zIndexChanged$

Accessors

• coordPlane
• globalPos
• globalRotation
• globalScale
• globalZ
• pos
• rotation
• scale
• z

Methods

• apply
• applyInverse
• clone
• get
• onAdd
• onRemove

Constructors

constructor

• new TransformComponent(): TransformComponent

• Inherited from Component.constructor

  Returns TransformComponent

Properties

optionalreadonlydependencies

dependencies?: ComponentCtor<Component>[]

Inherited from Component.dependencies

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

optionalowner

owner?: Entity<any> = undefined

Inherited from Component.owner

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

publiczIndexChanged$

zIndexChanged$: Observable<number> = ...

Observable that emits when the z index changes on this component

Accessors

publiccoordPlane

• get coordPlane(): CoordPlane
• set coordPlane(value: CoordPlane): void

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

  ---

  Returns CoordPlane

• Parameters

  • value: CoordPlane

  Returns void

globalPos

• get globalPos(): Vector
• set globalPos(v: Vector): void

• Returns Vector

• Parameters

  • v: Vector

  Returns void

globalRotation

• get globalRotation(): number
• set globalRotation(rotation: number): void

• Returns number

• Parameters

  • rotation: number

  Returns void

globalScale

• get globalScale(): Vector
• set globalScale(v: Vector): void

• Returns Vector

• Parameters

  • v: Vector

  Returns void

publicglobalZ

• get globalZ(): number
• set globalZ(z: number): void

• Returns number

• Parameters

  • z: number

  Returns void

pos

• get pos(): Vector
• set pos(v: Vector): void

• Returns Vector

• Parameters

  • v: Vector

  Returns void

rotation

• get rotation(): number
• set rotation(rotation: number): void

• Returns number

• Parameters

  • rotation: number

  Returns void

scale

• get scale(): Vector
• set scale(v: Vector): void

• Returns Vector

• Parameters

  • v: Vector

  Returns void

publicz

• get z(): number
• set z(val: number): void

• The z-index ordering of the entity, a higher values are drawn on top of lower values. For example z=99 would be drawn on top of z=0.

  ---

  Returns number

• Parameters

  • val: number

  Returns void

Methods

apply

• apply(v: Vector): Vector

• Parameters

  • v: Vector

  Returns Vector

applyInverse

• applyInverse(v: Vector): Vector

• Parameters

  • v: Vector

  Returns Vector

clone

• clone(): TransformComponent

• Overrides Component.clone

  Clones any properties on this component, if that property value has a clone() method it will be called

  ---

  Returns TransformComponent

publicget

• get(): Transform

• Returns Transform

onAdd

• onAdd(owner: Entity<any>): void

• Overrides Component.onAdd

  Optional callback called when a component is added to an entity

  ---

  Parameters

  • owner: Entity<any>

  Returns void

onRemove

• onRemove(_previousOwner: Entity<any>): void

• Overrides Component.onRemove

  Optional callback called when a component is removed from an entity

  ---

  Parameters

  • _previousOwner: Entity<any>

  Returns void