Class OffscreenSystem

An Excalibur [[System]] that updates entities of certain types. Systems are scene specific

Excalibur Systems currently require at least 1 Component type to operated

Multiple types are declared as a type union For example:

class MySystem extends System<ComponentA | ComponentB> {
  public readonly types = ['a', 'b'] as const;
  public readonly systemType = SystemType.Update;
  public update(entities: Entity<ComponentA | ComponentB>) {
     ...
  }
}

Hierarchy

Constructors

constructor

Properties

priority systemType types

Methods

initialize notify postupdate? preupdate? sort? update

Constructors

constructor

Properties

priority

priority: number = -1

System can execute in priority order, by default all systems are priority 0. Lower values indicated higher priority. For a system to execute before all other a lower priority value (-1 for example) must be set. For a system to execute after all other a higher priority value (10 for example) must be set.

systemType

systemType: SystemType = SystemType.Draw

Determine whether the system is called in the [[SystemType.Update]] or the [[SystemType.Draw]] phase. Update is first, then Draw.

Readonly types

types: readonly ["ex.transform", "ex.graphics"] = ...

The types of entities that this system operates on For example ['transform', 'motion']

Methods

initialize

notify

Optional postupdate

  • Optionally run a postupdate after the system processes matching entities

    Parameters

    • engine: Scene<unknown>
    • elapsedMs: number

      Time in milliseconds since the last frame

    Returns void

Optional preupdate

  • Optionally run a preupdate before the system processes matching entities

    Parameters

    • engine: Scene<unknown>
    • elapsedMs: number

      Time in milliseconds since the last frame

    Returns void

Optional sort

update

Settings

Member Visibility

Theme

On This Page