DebugGraphicsComponent

Provide arbitrary drawing for the purposes of debugging your game

Will only show when the Engine is set to debug mode Engine.showDebug or Engine.toggleDebug

Hierarchy

• Component
  • DebugGraphicsComponent

Index

Constructors

• constructor

Properties

• dependencies
• draw
• owner
• useTransform

Methods

• clone
• deserialize
• onAdd
• onRemove
• serialize
• toJSON

Constructors

constructor

• new DebugGraphicsComponent(draw: (ctx: ExcaliburGraphicsContext, debugFlags: DebugConfig) => void, useTransform?: boolean): DebugGraphicsComponent

• Overrides Component.constructor

  Parameters

  • draw: (ctx: ExcaliburGraphicsContext, debugFlags: DebugConfig) => void

  • useTransform: boolean = true

  Returns DebugGraphicsComponent

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

publicdraw

draw: (ctx: ExcaliburGraphicsContext, debugFlags: DebugConfig) => void

Type declaration

• • (ctx: ExcaliburGraphicsContext, debugFlags: DebugConfig): void

  • Parameters

    • ctx: ExcaliburGraphicsContext

    • debugFlags: DebugConfig

    Returns void

optionalowner

owner?: Entity<any> = undefined

Inherited from Component.owner

Current owning Entity, if any, of this component. Null if not added to any Entity

publicuseTransform

useTransform: boolean = true

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

deserialize

• deserialize(data: Record<string, any>): void

• Inherited from Component.deserialize

  Parameters

  • data: Record<string, any>

  Returns void

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

serialize

• serialize(): Record<string, any>

• Inherited from Component.serialize

  Returns Record<string, any>

toJSON

• toJSON(pretty?: boolean): string

• Inherited from Component.toJSON

  Parameters

  • pretty: boolean = false

  Returns string