abstractPlugin

An Excalibur plugin packages up changes to excalibur in a convenient package such as

• Custom config intercepting and implementation
• Engine initialization customization
• Graphics Context configuration including
  • Custom RendererPlugins
  • Custom PostProcessors
• Scene customization including default ECS Systems, Components

Index

Constructors

• constructor

Properties

• name
• priority

Methods

• dispose
• onEnginePostConfig
• onEnginePostInitialize
• onEnginePreConfig
• onEnginePreInitialize
• onGraphicsPostConfig
• onGraphicsPostInitialize
• onGraphicsPreConfig
• onGraphicsPreInitialize
• onLoad
• onLoadComplete
• onScenePostInitialize
• onScenePreInitialize

Constructors

constructor

• new Plugin(): Plugin

• Returns Plugin

Properties

name

name: string

Unique name of the plugin

priority

priority: number = 0

Plugin priority determines the order they're run, lower is first, higher is last, default is 0

Methods

optionaldispose

• dispose(): void

• Optinally perform any cleanup necessary when the engine is disposed

  ---

  Returns void

optionalonEnginePostConfig

• onEnginePostConfig(engine: Engine<any>, options: EngineOptions<any>): void

• Optionally intercept and mutate the {@param options} passed into the Engine, and modify the engine

  ---

  Parameters

  • engine: Engine<any>

  • options: EngineOptions<any>

  Returns void

optionalonEnginePostInitialize

• onEnginePostInitialize(engine: Engine<any>): void

• Optionally intercept the engine and modify after initialize

  ---

  Parameters

  • engine: Engine<any>

  Returns void

optionalonEnginePreConfig

• onEnginePreConfig(engine: Engine<any>, options: EngineOptions<any>): void

• Optionally intercept and mutate the {@param options} passed into the Engine, and modify the engine

  ---

  Parameters

  • engine: Engine<any>

  • options: EngineOptions<any>

  Returns void

optionalonEnginePreInitialize

• onEnginePreInitialize(engine: Engine<any>): void

• Optinally intercept the engine and modify before initialize

  ---

  Parameters

  • engine: Engine<any>

  Returns void

optionalonGraphicsPostConfig

• onGraphicsPostConfig(context: ExcaliburGraphicsContext, options: ExcaliburGraphicsContextOptions): void

• Optionally intercept the grpahics context after configuration and modify either the context or options

  ---

  Parameters

  • context: ExcaliburGraphicsContext

  • options: ExcaliburGraphicsContextOptions

  Returns void

optionalonGraphicsPostInitialize

• onGraphicsPostInitialize(context: ExcaliburGraphicsContext): void

• Optionally intercetp the graphics context and modify after initialize

  ---

  Parameters

  • context: ExcaliburGraphicsContext

  Returns void

optionalonGraphicsPreConfig

• onGraphicsPreConfig(context: ExcaliburGraphicsContext, options: ExcaliburGraphicsContextOptions): void

• Optionally intercept the grpahics context before configuration and modify either the context or options

  ---

  Parameters

  • context: ExcaliburGraphicsContext

  • options: ExcaliburGraphicsContextOptions

  Returns void

optionalonGraphicsPreInitialize

• onGraphicsPreInitialize(context: ExcaliburGraphicsContext): void

• Optionally intercetp the graphics context and modify before initialize

  ---

  Parameters

  • context: ExcaliburGraphicsContext

  Returns void

optionalonLoad

• onLoad(): Promise<void>

• Perform any async loading

  ---

  Returns Promise<void>

optionalonLoadComplete

• onLoadComplete(): Promise<void>

• Perform any extras when load complete

  ---

  Returns Promise<void>

optionalonScenePostInitialize

• onScenePostInitialize(scene: Scene<unknown>): void

• Optionally intercept a scene and modify after initialize

  ---

  Parameters

  • scene: Scene<unknown>

  Returns void

optionalonScenePreInitialize

• onScenePreInitialize(scene: Scene<unknown>): void

• Optionally intercept a scene and modify before initialize

  ---

  Parameters

  • scene: Scene<unknown>

  Returns void