Class Text

Represent Text graphics in excalibur

Useful for in game labels, ui, or overlays

Hierarchy

Graphic
- Text

Index

Constructors

Properties

color? id opacity showDebug tint transform

Accessors

flipHorizontal flipVertical font height localBounds origin rotation scale text width

Methods

_drawImage _flip _postDraw _preDraw _rotate clone cloneGraphicOptions draw isStale

Constructors

constructor

new Text(options: TextOptions & GraphicOptions): Text
Parameters
- options: TextOptions & GraphicOptions
Returns Text
Overrides Graphic.constructor
- Defined in Graphics/Text.ts:32

Properties

`Optional` color

color?: Color

`Readonly` id

id: number = ...

opacity

opacity: number = 1

Gets or sets the opacity of the graphic, 0 is transparent, 1 is solid (opaque).

showDebug

showDebug: boolean = false

Gets or sets wether to show debug information about the graphic

tint

tint: Color = null

transform

transform: AffineMatrix = ...

Accessors

flipHorizontal

get flipHorizontal(): boolean
Gets or sets the flipHorizontal, which will flip the graphic horizontally (across the y axis)

Returns boolean
Inherited from Graphic.flipHorizontal
- Defined in Graphics/Graphic.ts:77
set flipHorizontal(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Graphic.flipHorizontal
- Defined in Graphics/Graphic.ts:81

flipVertical

get flipVertical(): boolean
Gets or sets the flipVertical, which will flip the graphic vertically (across the x axis)

Returns boolean
Inherited from Graphic.flipVertical
- Defined in Graphics/Graphic.ts:90
set flipVertical(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Graphic.flipVertical
- Defined in Graphics/Graphic.ts:94

font

get font(): Font | SpriteFont
Returns Font | SpriteFont
- Defined in Graphics/Text.ts:61
set font(font: Font | SpriteFont): void
Parameters
- font: Font | SpriteFont
Returns void
- Defined in Graphics/Text.ts:64

height

get height(): number
Gets or sets the height of the graphic (always positive)

Returns number
Overrides Graphic.height
- Defined in Graphics/Text.ts:78

localBounds

get localBounds(): BoundingBox
Gets a copy of the bounds in pixels occupied by the graphic on the the screen. This includes scale.

Returns BoundingBox
Overrides Graphic.localBounds
- Defined in Graphics/Text.ts:91

origin

get origin(): Vector
Gets or sets the origin of the graphic, if not set the center of the graphic is the origin

Returns Vector
Inherited from Graphic.origin
- Defined in Graphics/Graphic.ts:136
set origin(value: Vector): void
Parameters
- value: Vector
Returns void
Inherited from Graphic.origin
- Defined in Graphics/Graphic.ts:140

rotation

get rotation(): number
Gets or sets the rotation of the graphic

Returns number
Inherited from Graphic.rotation
- Defined in Graphics/Graphic.ts:103
set rotation(value: number): void
Parameters
- value: number
Returns void
Inherited from Graphic.rotation
- Defined in Graphics/Graphic.ts:107

scale

get scale(): Vector
Gets or sets the scale of the graphic, this affects the width and

Returns Vector
Inherited from Graphic.scale
- Defined in Graphics/Graphic.ts:121
set scale(value: Vector): void
Parameters
- value: Vector
Returns void
Inherited from Graphic.scale
- Defined in Graphics/Graphic.ts:125

text

get text(): string
Returns string
- Defined in Graphics/Text.ts:49
set text(value: string): void
Parameters
- value: string
Returns void
- Defined in Graphics/Text.ts:53

width

get width(): number
Gets or sets the width of the graphic (always positive)

Returns number
Overrides Graphic.width
- Defined in Graphics/Text.ts:70

Methods

`Protected` _drawImage

_drawImage(ex: ExcaliburGraphicsContext, x: number, y: number): void
Meant to be overridden by the graphic implementation to draw the underlying image (HTMLCanvasElement or HTMLImageElement) to the graphics context without transform. Transformations like position, rotation, and scale are handled by Graphic._preDraw and Graphic._postDraw
Parameters
- ex: ExcaliburGraphicsContext
  
  The excalibur graphics context
- x: number
- y: number
Returns void
Overrides Graphic._drawImage
- Defined in Graphics/Text.ts:105

`Protected` _flip

_flip(_ex: ExcaliburGraphicsContext): void
Parameters
- _ex: ExcaliburGraphicsContext
Returns void
Overrides Graphic._flip
- Defined in Graphics/Text.ts:100

`Protected` _postDraw

_postDraw(ex: ExcaliburGraphicsContext): void
Apply any additional work after Graphic._drawImage and restore the context state.
Parameters
- ex: ExcaliburGraphicsContext
Returns void
Inherited from Graphic._postDraw
- Defined in Graphics/Graphic.ts:277

`Protected` _preDraw

_preDraw(ex: ExcaliburGraphicsContext, x: number, y: number): void
Apply affine transformations to the graphics context to manipulate the graphic before Graphic._drawImage
Parameters
- ex: ExcaliburGraphicsContext
- x: number
- y: number
Returns void
Inherited from Graphic._preDraw
- Defined in Graphics/Graphic.ts:232

`Protected` _rotate

_rotate(_ex: ExcaliburGraphicsContext): void
Parameters
- _ex: ExcaliburGraphicsContext
Returns void
Overrides Graphic._rotate
- Defined in Graphics/Text.ts:95

clone

clone(): Text
Returns a new instance of the graphic that has the same properties

Returns Text
Overrides Graphic.clone
- Defined in Graphics/Text.ts:40

cloneGraphicOptions

cloneGraphicOptions(): GraphicOptions
Returns GraphicOptions
Inherited from Graphic.cloneGraphicOptions
- Defined in Graphics/Graphic.ts:158

draw

draw(ex: ExcaliburGraphicsContext, x: number, y: number): void
Draw the whole graphic to the context including transform
Parameters
- ex: ExcaliburGraphicsContext
  
  The excalibur graphics context
- x: number
- y: number
Returns void
Inherited from Graphic.draw
- Defined in Graphics/Graphic.ts:210

isStale

isStale(): boolean
Returns boolean
Inherited from Graphic.isStale
- Defined in Graphics/Graphic.ts:63