Interface CanDraw

Hierarchy

OnPreDraw
OnPostDraw
- CanDraw

Implemented by

Engine
Scene

Index

Methods

off on onPostDraw onPreDraw once

Methods

off

off(eventName: "predraw", handler?: ((event: Events.PreDrawEvent) => void)): void
Parameters
- eventName: "predraw"
- Optional handler: ((event: Events.PreDrawEvent) => void)
  - - (event: Events.PreDrawEvent): void
    - Parameters
      
      event: Events.PreDrawEvent
      
      Returns void
Returns void
Overrides OnPostDraw.off
- Defined in Interfaces/LifecycleEvents.ts:187
off(eventName: "postdraw", handler?: ((event: Events.PostDrawEvent) => void)): void
Parameters
- eventName: "postdraw"
- Optional handler: ((event: Events.PostDrawEvent) => void)
  - - (event: Events.PostDrawEvent): void
    - Parameters
      
      event: Events.PostDrawEvent
      
      Returns void
Returns void
Overrides OnPreDraw.off
- Defined in Interfaces/LifecycleEvents.ts:188

on

on(eventName: "predraw", handler: ((event: Events.PreDrawEvent) => void)): void
Event signatures
Parameters
- eventName: "predraw"
- handler: ((event: Events.PreDrawEvent) => void)
  - - (event: Events.PreDrawEvent): void
    - Parameters
      
      event: Events.PreDrawEvent
      
      Returns void
Returns void
Overrides OnPostDraw.on
- Defined in Interfaces/LifecycleEvents.ts:181
on(eventName: "postdraw", handler: ((event: Events.PostDrawEvent) => void)): void
Parameters
- eventName: "postdraw"
- handler: ((event: Events.PostDrawEvent) => void)
  - - (event: Events.PostDrawEvent): void
    - Parameters
      
      event: Events.PostDrawEvent
      
      Returns void
Returns void
Overrides OnPreDraw.on
- Defined in Interfaces/LifecycleEvents.ts:182

onPostDraw

onPostDraw(_ctx: ExcaliburGraphicsContext, _delta: number): void
Overridable implementation
Parameters
- _ctx: ExcaliburGraphicsContext
- _delta: number
Returns void
Inherited from OnPostDraw.onPostDraw
- Defined in Interfaces/LifecycleEvents.ts:170

onPreDraw

onPreDraw(_ctx: ExcaliburGraphicsContext, _delta: number): void
Overridable implementation
Parameters
- _ctx: ExcaliburGraphicsContext
- _delta: number
Returns void
Inherited from OnPreDraw.onPreDraw
- Defined in Interfaces/LifecycleEvents.ts:156

once

once(eventName: "predraw", handler: ((event: Events.PreDrawEvent) => void)): void
Parameters
- eventName: "predraw"
- handler: ((event: Events.PreDrawEvent) => void)
  - - (event: Events.PreDrawEvent): void
    - Parameters
      
      event: Events.PreDrawEvent
      
      Returns void
Returns void
Overrides OnPostDraw.once
- Defined in Interfaces/LifecycleEvents.ts:184
once(eventName: "postdraw", handler: ((event: Events.PostDrawEvent) => void)): void
Parameters
- eventName: "postdraw"
- handler: ((event: Events.PostDrawEvent) => void)
  - - (event: Events.PostDrawEvent): void
    - Parameters
      
      event: Events.PostDrawEvent
      
      Returns void
Returns void
Overrides OnPreDraw.once
- Defined in Interfaces/LifecycleEvents.ts:185

Interface CanDraw

Hierarchy

Implemented by

Index

Methods

Methods

off

Parameters

eventName: "predraw"

Optional handler: ((event: Events.PreDrawEvent) => void)

Parameters

event: Events.PreDrawEvent

Returns void

Returns void

Parameters

eventName: "postdraw"

Optional handler: ((event: Events.PostDrawEvent) => void)

Parameters

event: Events.PostDrawEvent

Returns void

Returns void

on

Parameters

eventName: "predraw"

handler: ((event: Events.PreDrawEvent) => void)

Parameters

event: Events.PreDrawEvent

Returns void

Returns void

Parameters

eventName: "postdraw"

handler: ((event: Events.PostDrawEvent) => void)

Parameters

event: Events.PostDrawEvent

Returns void

Returns void

onPostDraw

Parameters

_ctx: ExcaliburGraphicsContext

_delta: number

Returns void

onPreDraw

Parameters

_ctx: ExcaliburGraphicsContext

_delta: number

Returns void

once

Parameters

eventName: "predraw"

handler: ((event: Events.PreDrawEvent) => void)

Parameters

event: Events.PreDrawEvent

Returns void

Returns void

Parameters

eventName: "postdraw"

handler: ((event: Events.PostDrawEvent) => void)

Parameters

event: Events.PostDrawEvent

Returns void

Returns void

Settings

Member Visibility

Theme

`Optional` handler: ((event: Events.PreDrawEvent) => void)

`Optional` handler: ((event: Events.PostDrawEvent) => void)