Text

Represent Text graphics in excalibur

Useful for in game labels, ui, or overlays

Hierarchy

• Graphic
  • Text

Index

Constructors

• constructor

Properties

• color
• id
• maxWidth
• opacity
• showDebug
• tint
• transform

Accessors

• flipHorizontal
• flipVertical
• font
• height
• localBounds
• origin
• rotation
• scale
• text
• width

Methods

• clone
• cloneGraphicOptions
• draw
• isStale

Constructors

constructor

• Text(options: TextOptions & GraphicOptions): Text

• Overrides Graphic.constructor

  Parameters

  • options: TextOptions & GraphicOptions

  Returns Text

Properties

publicoptionalcolor

color?: Color

readonlyinheritedid

id: number = ...

Inherited from Graphic.id

publicoptionalmaxWidth

maxWidth?: number

publicinheritedopacity

opacity: number = 1

Inherited from Graphic.opacity

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

publicinheritedshowDebug

showDebug: boolean = false

Inherited from Graphic.showDebug

Gets or sets wether to show debug information about the graphic

publicoptionalinheritedtint

tint?: Color

Inherited from Graphic.tint

publicinheritedtransform

transform: AffineMatrix = ...

Inherited from Graphic.transform

Accessors

publicinheritedflipHorizontal

• get flipHorizontal(): boolean
• set flipHorizontal(value: boolean): void

• Inherited from Graphic.flipHorizontal

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

  ---

  Returns boolean

• Inherited from Graphic.flipHorizontal

  Parameters

  • value: boolean

  Returns void

publicinheritedflipVertical

• get flipVertical(): boolean
• set flipVertical(value: boolean): void

• Inherited from Graphic.flipVertical

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

  ---

  Returns boolean

• Inherited from Graphic.flipVertical

  Parameters

  • value: boolean

  Returns void

publicfont

• get font(): SpriteFont | Font
• set font(font: SpriteFont | Font): void

• Returns SpriteFont | Font

• Parameters

  • font: SpriteFont | Font

  Returns void

publicheight

• get height(): number

• Overrides Graphic.height

  Gets or sets the height of the graphic (always positive)

  ---

  Returns number

publiclocalBounds

• get localBounds(): BoundingBox

• Overrides Graphic.localBounds

  Gets a copy of the bounds in pixels occupied by the graphic on the the screen. This includes scale.

  ---

  Returns BoundingBox

publicinheritedorigin

• get origin(): Vector | undefined
• set origin(value: Vector | undefined): void

• Inherited from Graphic.origin

  Gets or sets the origin of the graphic, if not set the center of the graphic is the origin

  ---

  Returns Vector | undefined

• Inherited from Graphic.origin

  Parameters

  • value: Vector | undefined

  Returns void

publicinheritedrotation

• get rotation(): number
• set rotation(value: number): void

• Inherited from Graphic.rotation

  Gets or sets the rotation of the graphic

  ---

  Returns number

• Inherited from Graphic.rotation

  Parameters

  • value: number

  Returns void

publicinheritedscale

• get scale(): Vector
• set scale(value: Vector): void

• Inherited from Graphic.scale

  Gets or sets the scale of the graphic, this affects the width and

  ---

  Returns Vector

• Inherited from Graphic.scale

  Parameters

  • value: Vector

  Returns void

publictext

• get text(): string
• set text(value: string): void

• Returns string

• Parameters

  • value: string

  Returns void

publicwidth

• get width(): number

• Overrides Graphic.width

  Gets or sets the width of the graphic (always positive)

  ---

  Returns number

Methods

publicclone

• clone(): Text

• Overrides Graphic.clone

  Returns a new instance of the graphic that has the same properties

  ---

  Returns Text

publicinheritedcloneGraphicOptions

• cloneGraphicOptions(): GraphicOptions

• Inherited from Graphic.cloneGraphicOptions

  Returns GraphicOptions

publicinheriteddraw

• draw(ex: ExcaliburGraphicsContext, x: number, y: number): void

• Inherited from Graphic.draw

  Draw the whole graphic to the context including transform

  ---

  Parameters

  • ex: ExcaliburGraphicsContext

    The excalibur graphics context

  • x: number

  • y: number

  Returns void

publicinheritedisStale

• isStale(): boolean

• Inherited from Graphic.isStale

  Returns boolean