ParallaxComponent

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
  • ParallaxComponent

Index

Constructors

• constructor

Properties

• dependencies
• owner
• parallaxFactor

Methods

• clone
• onAdd
• onRemove

Constructors

constructor

• new ParallaxComponent(parallaxFactor?: Vector): ParallaxComponent

• Overrides Component.constructor

  Parameters

  • optionalparallaxFactor: Vector

  Returns ParallaxComponent

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

parallaxFactor

parallaxFactor: Vector = ...

Methods

clone

• clone(): Component

• Inherited from Component.clone

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

  ---

  Returns Component

optionalonAdd

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

• Inherited from Component.onAdd

  Optional callback called when a component is added to an entity

  ---

  Parameters

  • owner: Entity<any>

  Returns void

optionalonRemove

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

• Inherited from Component.onRemove

  Optional callback called when a component is removed from an entity

  ---

  Parameters

  • previousOwner: Entity<any>

  Returns void