Class GraphicsComponent

Component to manage drawings, using with the position component

Hierarchy

Component<"ex.graphics">
- GraphicsComponent

Index

Constructors

constructor

new GraphicsComponent(options?: GraphicsComponentOptions): GraphicsComponent
Parameters
- Optional options: GraphicsComponentOptions
Returns GraphicsComponent
Overrides Component.constructor
- Defined in Graphics/GraphicsComponent.ts:312

Properties

anchor

anchor: Vector = Vector.Half

Anchor to apply to graphics by default

copyGraphics

copyGraphics: boolean = false

If set to true graphics added to the component will be copied. This can affect performance

`Optional` `Readonly` dependencies

dependencies?: ComponentCtor<Component<string>>[]

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

layers

layers: GraphicsLayers

offset

offset: Vector = Vector.Zero

Offset to apply to graphics by default

onPostDraw

onPostDraw: ((ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number) => void)

Type declaration

- (ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number): void
- Draws after the entity transform has been applied, and after graphics component graphics has been drawn
  Parameters
  - ctx: ExcaliburGraphicsContext
  - elapsedMilliseconds: number
  Returns void

onPreDraw

onPreDraw: ((ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number) => void)

Type declaration

- (ctx: ExcaliburGraphicsContext, elapsedMilliseconds: number): void
- Draws after the entity transform has bene applied, but before graphics component graphics have been drawn
  Parameters
  - ctx: ExcaliburGraphicsContext
  - elapsedMilliseconds: number
  Returns void

opacity

opacity: number = 1

Sets or gets wither all drawings should have an opacity applied

`Optional` `Readonly` optional

optional?: ComponentCtor<Component<string>>[]

`Optional` owner

owner?: Entity = null

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

`Readonly` type

type: "ex.graphics" = 'ex.graphics'

Type of this component, must be a unique type among component types in you game.

visible

visible: boolean = true

Sets or gets wether any drawing should be visible in this component

Accessors

current

get current(): {
graphic: Graphic;
options: GraphicsShowOptions;
}[]
Returns the currently displayed graphics and their offsets, empty array if hidden

Returns {
graphic: Graphic;
options: GraphicsShowOptions;
}[]
- Defined in Graphics/GraphicsComponent.ts:340

graphics

get graphics(): {
[graphicName: string]: Graphic;
}
Returns all graphics associated with this component

Returns {
[graphicName: string]: Graphic;
}
- [graphicName: string]: Graphic
- Defined in Graphics/GraphicsComponent.ts:347

localBounds

get localBounds(): BoundingBox
Returns BoundingBox
- Defined in Graphics/GraphicsComponent.ts:433
set localBounds(bounds: BoundingBox): void
Parameters
- bounds: BoundingBox
Returns void
- Defined in Graphics/GraphicsComponent.ts:408

Methods

add

add(graphic: Graphic): Graphic
Adds a named graphic to this component, if the name is "default" or not specified, it will be shown by default without needing to call show("default")
Parameters
- graphic: Graphic
Returns Graphic
- Defined in Graphics/GraphicsComponent.ts:356
add(name: string, graphic: Graphic): Graphic
Parameters
- name: string
- graphic: Graphic
Returns Graphic
- Defined in Graphics/GraphicsComponent.ts:357

clone

clone(): GraphicsComponent
Clones any properties on this component, if that property value has a clone() method it will be called

Returns GraphicsComponent
Overrides Component.clone
- Defined in Graphics/GraphicsComponent.ts:455

getGraphic

getGraphic(name: string): Graphic
Parameters
- name: string
Returns Graphic
- Defined in Graphics/GraphicsComponent.ts:266

getNames

getNames(): string[]
Get registered graphics names

Returns string[]
- Defined in Graphics/GraphicsComponent.ts:273

hide

hide(nameOrGraphic: string | Graphic): void
Remove any instance(s) of a graphic currently being shown in the default layer
Parameters
- nameOrGraphic: string | Graphic
Returns void
- Defined in Graphics/GraphicsComponent.ts:398
hide(): void
Remove all currently shown graphics in the default layer

Returns void
- Defined in Graphics/GraphicsComponent.ts:402

`Optional` onAdd

onAdd(owner: Entity): void
Optional callback called when a component is added to an entity
Parameters
- owner: Entity
Returns void
Inherited from Component.onAdd
- Defined in EntityComponentSystem/Component.ts:79

`Optional` onRemove

onRemove(previousOwner: Entity): void
Optional callback called when a component is added to an entity
Parameters
- previousOwner: Entity
Returns void
Inherited from Component.onRemove
- Defined in EntityComponentSystem/Component.ts:84

recalculateBounds

recalculateBounds(): void
Returns void
- Defined in Graphics/GraphicsComponent.ts:412

show

show<T>(nameOrGraphic: string | T, options?: GraphicsShowOptions): T
Show a graphic by name on the default layer, returns the new Graphic
Type Parameters
- T extends Graphic<T> = Graphic
Parameters
- nameOrGraphic: string | T
- Optional options: GraphicsShowOptions
Returns T
- Defined in Graphics/GraphicsComponent.ts:378

update

update(elapsed: number, idempotencyToken?: number): void
Internal
Update underlying graphics if necesary, called internally
Parameters
- elapsed: number
- idempotencyToken: number = 0
Returns void
- Defined in Graphics/GraphicsComponent.ts:445

use

use<T>(nameOrGraphic: string | T, options?: GraphicsShowOptions): T
Use a graphic only, swap out any graphics on the default layer, returns the new Graphic
Type Parameters
- T extends Graphic<T> = Graphic
Parameters
- nameOrGraphic: string | T
- Optional options: GraphicsShowOptions
Returns T
- Defined in Graphics/GraphicsComponent.ts:389

Class GraphicsComponent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: GraphicsComponentOptions

Returns GraphicsComponent

Properties

anchor

copyGraphics

Optional Readonly dependencies

layers

offset

onPostDraw

Type declaration

Parameters

ctx: ExcaliburGraphicsContext

elapsedMilliseconds: number

Returns void

onPreDraw

Type declaration

Parameters

ctx: ExcaliburGraphicsContext

elapsedMilliseconds: number

Returns void

opacity

Optional Readonly optional

Optional owner

Readonly type

visible

Accessors

current

Returns { graphic: Graphic; options: GraphicsShowOptions; }[]

graphics

Returns { [graphicName: string]: Graphic; }

[graphicName: string]: Graphic

localBounds

Returns BoundingBox

Parameters

bounds: BoundingBox

Returns void

Methods

add

Parameters

graphic: Graphic

Returns Graphic

Parameters

name: string

graphic: Graphic

Returns Graphic

clone

Returns GraphicsComponent

getGraphic

Parameters

name: string

Returns Graphic

getNames

Returns string[]

hide

Parameters

nameOrGraphic: string | Graphic

Returns void

Returns void

Optional onAdd

Parameters

owner: Entity

Returns void

Optional onRemove

Parameters

previousOwner: Entity

Returns void

recalculateBounds

Returns void

show

Type Parameters

`Optional` options: GraphicsComponentOptions

`Optional` `Readonly` dependencies

`Optional` `Readonly` optional

`Optional` owner

`Readonly` type

Returns {
graphic: Graphic;
options: GraphicsShowOptions;
}[]

Returns {
[graphicName: string]: Graphic;
}

`Optional` onAdd

`Optional` onRemove

`Optional` options: GraphicsShowOptions

`Optional` options: GraphicsShowOptions