CanDraw | Excalibur.js v0.24.5 API Documentation

Hierarchy

OnPreDraw
OnPostDraw
- CanDraw

Implemented by

Index

Methods

off

off(eventName: Events.predraw, handler?: function): void
off(eventName: Events.postdraw, handler?: function): void

Overrides OnPreDraw.off
- Defined in src/engine/Interfaces/LifecycleEvents.ts:159
Parameters
- eventName: Events.predraw
- Optional handler: function
  - - (event: PreDrawEvent): void
    - Parameters
      - event: PreDrawEvent
      Returns void
Returns void
Overrides OnPreDraw.off
- Defined in src/engine/Interfaces/LifecycleEvents.ts:160
Parameters
- eventName: Events.postdraw
- Optional handler: function
  - - (event: PostDrawEvent): void
    - Parameters
      - event: PostDrawEvent
      Returns void
Returns void

on

on(eventName: Events.predraw, handler: function): void
on(eventName: Events.postdraw, handler: function): void

Overrides OnPreDraw.on
- Defined in src/engine/Interfaces/LifecycleEvents.ts:153
Parameters
- eventName: Events.predraw
- handler: function
  - - (event: PreDrawEvent): void
    - Parameters
      - event: PreDrawEvent
      Returns void
Returns void
Overrides OnPreDraw.on
- Defined in src/engine/Interfaces/LifecycleEvents.ts:154
Parameters
- eventName: Events.postdraw
- handler: function
  - - (event: PostDrawEvent): void
    - Parameters
      - event: PostDrawEvent
      Returns void
Returns void

onPostDraw

onPostDraw(_ctx: CanvasRenderingContext2D, _delta: number): void

Inherited from OnPostDraw.onPostDraw
- Defined in src/engine/Interfaces/LifecycleEvents.ts:142
Overridable implementation

Parameters
- _ctx: CanvasRenderingContext2D
- _delta: number
Returns void

onPreDraw

onPreDraw(_ctx: CanvasRenderingContext2D, _delta: number): void

Inherited from OnPreDraw.onPreDraw
- Defined in src/engine/Interfaces/LifecycleEvents.ts:128
Overridable implementation

Parameters
- _ctx: CanvasRenderingContext2D
- _delta: number
Returns void

once

once(eventName: Events.predraw, handler: function): void
once(eventName: Events.postdraw, handler: function): void

Overrides OnPreDraw.once
- Defined in src/engine/Interfaces/LifecycleEvents.ts:156
Parameters
- eventName: Events.predraw
- handler: function
  - - (event: PreDrawEvent): void
    - Parameters
      - event: PreDrawEvent
      Returns void
Returns void
Overrides OnPreDraw.once
- Defined in src/engine/Interfaces/LifecycleEvents.ts:157
Parameters
- eventName: Events.postdraw
- handler: function
  - - (event: PostDrawEvent): void
    - Parameters
      - event: PostDrawEvent
      Returns void
Returns void

Hierarchy

Implemented by

Index

Methods

Methods

off

Parameters

eventName: Events.predraw

Optional handler: function

Parameters

event: PreDrawEvent

Returns void

Returns void

Parameters

eventName: Events.postdraw

Optional handler: function

Parameters

event: PostDrawEvent

Returns void

Returns void

on

Parameters

eventName: Events.predraw

handler: function

Parameters

event: PreDrawEvent

Returns void

Returns void

Parameters

eventName: Events.postdraw

handler: function

Parameters

event: PostDrawEvent

Returns void

Returns void

onPostDraw

Parameters

_ctx: CanvasRenderingContext2D

_delta: number

Returns void

onPreDraw

Parameters

_ctx: CanvasRenderingContext2D

_delta: number

Returns void

once

Parameters

eventName: Events.predraw

handler: function

Parameters

event: PreDrawEvent

Returns void

Returns void

Parameters

eventName: Events.postdraw

handler: function

Parameters

event: PostDrawEvent

Returns void

Returns void