Class TextSprite

Simple sprite wrapper for Text

Hierarchy

RawSprite<Rectangle>
- TextSprite

Implements

Sprite<Rectangle>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TextSprite(text: string, position: Rectangle, font: Font, align: TextAlign, index?: number): TextSprite

Overrides RawSprite.constructor
- Defined in lib/sprite.ts:392
Parameters
- text: string
- position: Rectangle
- font: Font
- align: TextAlign
- Optional index: number
Returns TextSprite

Properties

Private align

align: TextAlign

Private font

font: Font

Protected index

index: number

Order for sprite rendering

Private offCanvas

offCanvas: HTMLCanvasElement

Canvas used for off-screen rendering (double buffering)

Private offCtx

offCtx: CanvasRenderingContext2D

off-screen Canvas rendering context

Protected shape

shape: Rectangle

Private text

text: string

Text content

Methods

addRotation

addRotation(degrees: number): void

- Defined in lib/sprite.ts:437
Adds angle to current rotation

Parameters
- degrees: number
  
  Rotation angle in degrees (delta)
Returns void

collides

collides(r: Rectangle): boolean

Inherited from RawSprite.collides
- Defined in lib/sprite.ts:184
Checks if Sprite collides a specified Rectangle

Parameters
- r: Rectangle
  
  Rectangle to check
Returns boolean

true only if provided Rectangle collides the Sprite

contains

contains(p: Point): boolean
contains(coordX: number, coordY: number): boolean

Implementation of Sprite.contains

Inherited from RawSprite.contains
- Defined in lib/sprite.ts:168
Parameters
- p: Point
Returns boolean
Implementation of Sprite.contains

Inherited from RawSprite.contains
- Defined in lib/sprite.ts:169
Parameters
- coordX: number
- coordY: number
Returns boolean

getIndex

getIndex(): number

Implementation of Sprite.getIndex

Inherited from RawSprite.getIndex
- Defined in lib/sprite.ts:157
Returns number

getRotation

getRotation(): number

- Defined in lib/sprite.ts:446
Get current rotation angle

Returns number

rotation angle in degrees

getShape

getShape(): Rectangle

Implementation of Sprite.getShape

Inherited from RawSprite.getShape
- Defined in lib/sprite.ts:164
Returns Rectangle

getText

getText(): string

- Defined in lib/sprite.ts:421
Returns current text

Returns string

getX

getX(): number

Implementation of Sprite.getX

Inherited from RawSprite.getX
- Defined in lib/sprite.ts:150
Returns number

getY

getY(): number

Implementation of Sprite.getY

Inherited from RawSprite.getY
- Defined in lib/sprite.ts:153
Returns number

move

move(moveX: number, moveY: number): void
move(vect: Vector): void

Implementation of Sprite.move

Inherited from RawSprite.move
- Defined in lib/sprite.ts:129
Parameters
- moveX: number
- moveY: number
Returns void
Implementation of Sprite.move

Inherited from RawSprite.move
- Defined in lib/sprite.ts:130
Parameters
- vect: Vector
Returns void

moveTo

moveTo(coordX: number, coordY: number): void
moveTo(point: Point): any

Implementation of Sprite.moveTo

Inherited from RawSprite.moveTo
- Defined in lib/sprite.ts:140
Parameters
- coordX: number
- coordY: number
Returns void
Implementation of Sprite.moveTo

Inherited from RawSprite.moveTo
- Defined in lib/sprite.ts:141
Parameters
- point: Point
Returns any

render

render(context: CanvasRenderingContext2D): void

Implementation of Sprite.render

Overrides RawSprite.render
- Defined in lib/sprite.ts:451
Parameters
- context: CanvasRenderingContext2D
Returns void

setIndex

setIndex(newIndex: number): void

Implementation of Sprite.setIndex

Inherited from RawSprite.setIndex
- Defined in lib/sprite.ts:160
Parameters
- newIndex: number
Returns void

setRotation

setRotation(degrees: number): void

- Defined in lib/sprite.ts:429
Set new rotation angle

Parameters
- degrees: number
  
  Rotation angle in degrees (from original image)
Returns void

setText

setText(text: string): void

- Defined in lib/sprite.ts:411
Defines new content for text sprite

Parameters
- text: string
  
  Text to display
Returns void

Generated using TypeDoc