Class Sprite

A drawable object made from an image ressource. Can be rotated, flipped, scalled and translated around in the canvas.

Hierarchy

Sprite
- AnimatedSprite

Index

Constructors

constructor

Properties

Accessors

Methods

render

Constructors

constructor

new Sprite(image: CanvasImageSource, sourceRect: Rect, destRect?: Rect): Sprite

- Defined in sprite.ts:38
Parameters
- image: CanvasImageSource
  
  sprite image
- sourceRect: Rect
  
  rectangle in the texture
- Optional destRect: Rect
  
  rectangle in the canvas
Returns Sprite

Properties

anchor

anchor: AnchorType

destRect

destRect: Rect

flipX

flipX: boolean = false

flipY

flipY: boolean = false

image

image: CanvasImageSource

rotation

rotation: number = 0

scale

scale: number = 1

sourceRect

sourceRect: Rect

Accessors

pos

get pos(): Vec2
set pos(v: Vec2): void

- Defined in sprite.ts:71
Position of the sprite defined by anchor Do not set components of the position directly, it will not update it properly. Instead, assign to the property:
example
```
const p = sprite.pos
p.x += 0.5;
sprite.pos = p;
```
Returns Vec2
- Defined in sprite.ts:88
Position of the sprite defined by anchor Do not set components of the position directly, it will not update it properly. Instead, assign to the property:
example
```
const p = sprite.pos
p.x += 0.5;
sprite.pos = p;
```
Parameters
- v: Vec2
Returns void

rect

get rect(): Rect

- Defined in sprite.ts:111
The rect bounding the sprite, taking scaling into account.

Returns Rect

Methods

render

render(can: Canvas): Sprite

- Defined in sprite.ts:141
Draw the sprite on a canvas.

Parameters
- can: Canvas
Returns Sprite

Generated using TypeDoc