Engine | @bsorrentino/ga-ts

Hierarchy

Engine

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Engine(width: number, height: number, setup: () => void, assetsToLoad?: string[], load?: () => void): Engine

- Defined in engine.ts:981
Parameters
- width: number
- height: number
- setup: () => void
  - - (): void
    - Returns void
- assetsToLoad: string[] = []
- load: () => void = ...
  - - (): void
    - Returns void
Returns Engine

Properties

actx

actx: AudioContext

Optional assetFilePaths

assetFilePaths: string[]

assets

assets: Assets = ...

buttons

buttons: Interactive[] = []

canvas

canvas: HTMLCanvasElement & { ctx?: null | CanvasRenderingContext2D; scaled?: boolean }

dragAndDrop

dragAndDrop: boolean = false

draggableSprites

draggableSprites: DisplayableObject[] = []

interpolate

interpolate: boolean = true

key

key: Keys

load

load: () => void

Type declaration

- (): void
- Returns void

particles

particles: Sprite[]

paused

paused: boolean = false

pointer

pointer: Pointer

Readonly progressBar

progressBar: ProgressBar

scale

scale: number = 1

setup

setup: () => void

Type declaration

- (): void
- Returns void

shakingSprites

shakingSprites: DisplayableObject[]

stage

stage: Stage

Optional state

state: () => void

Type declaration

- (): void
- Returns void

tweens

tweens: any[] = []

updateFunctions

updateFunctions: UpdateFunction[] = []

Static Optional custom

custom: (ga: Engine) => void

Type declaration

- (ga: Engine): void
- Parameters
  - ga: Engine
  Returns void

Static Optional plugins

plugins: (ga: Engine) => void

Type declaration

- (ga: Engine): void
- Parameters
  - ga: Engine
  Returns void

Accessors

backgroundColor

set backgroundColor(value: string): void

- Defined in engine.ts:464
Parameters
- value: string
Returns void

fps

get fps(): number
set fps(value: number): void

- Defined in engine.ts:453
Returns number
- Defined in engine.ts:457
Parameters
- value: number
Returns void

Methods

addStatePlayer

addStatePlayer(sprite: Sprite): void

- Defined in engine.ts:750
Parameters
- sprite: Sprite
Returns void

angle

angle(s1: CenterPoint, s2: CenterPoint): number

- Defined in plugins/utils.ts:19
Parameters
- s1: CenterPoint
- s2: CenterPoint
Returns number

breathe

breathe(param: BreatheArgs): Tweens

- Defined in plugins/tweening.ts:20
Parameters
- param: BreatheArgs
Returns Tweens

burst

burst(param: { maxAlphaSpeed?: number; maxRotationSpeed?: number; maxScaleSpeed?: number; maxSize?: number; maxSpeed?: number; minAlphaSpeed?: number; minRotationSpeed?: number; minScaleSpeed?: number; minSize?: number; minSpeed?: number; numberOfParticles?: number; x?: number; y?: number; spriteFunction: any }): void

- Defined in plugins/sprites.ts:52
Parameters
- param: { maxAlphaSpeed?: number; maxRotationSpeed?: number; maxScaleSpeed?: number; maxSize?: number; maxSpeed?: number; minAlphaSpeed?: number; minRotationSpeed?: number; minScaleSpeed?: number; minSize?: number; minSpeed?: number; numberOfParticles?: number; x?: number; y?: number; spriteFunction: any }
  - Optional maxAlphaSpeed?: number
  - Optional maxRotationSpeed?: number
  - Optional maxScaleSpeed?: number
  - Optional maxSize?: number
  - Optional maxSpeed?: number
  - Optional minAlphaSpeed?: number
  - Optional minRotationSpeed?: number
  - Optional minScaleSpeed?: number
  - Optional minSize?: number
  - Optional minSpeed?: number
  - Optional numberOfParticles?: number
  - Optional x?: number
  - Optional y?: number
  - spriteFunction: function
    - spriteFunction(): Sprite
    - Defined in plugins/sprites.ts:54
      Returns Sprite
Returns void

button

button(source: any): Button

- Defined in engine.ts:732
Parameters
- source: any
Returns Button

capturePreviousSpritePositions

capturePreviousSpritePositions(): void

- Defined in engine.ts:306
Returns void

circle

circle(diameter?: number, fillStyle?: string, strokeStyle?: string, lineWidth?: number, x?: number, y?: number): Circle

- Defined in engine.ts:629
Parameters
- diameter: number = 32
- fillStyle: string = 'red'
- strokeStyle: string = 'none'
- lineWidth: number = 0
- x: number = 0
- y: number = 0
Returns Circle

circleCollision

circleCollision(c1: Circular & GlobalPoint & CenterPoint, c2: Circular & GlobalPoint & CenterPoint, bounce?: boolean, global?: boolean): boolean

- Defined in plugins/collision.ts:82
Parameters
- c1: Circular & GlobalPoint & CenterPoint
- c2: Circular & GlobalPoint & CenterPoint
- Optional bounce: boolean
- Optional global: boolean
Returns boolean

circlePointCollision

circlePointCollision(c1: Circular & GlobalPoint & CenterPoint, point: Point, bounce?: boolean, global?: boolean): boolean

- Defined in plugins/collision.ts:84
Parameters
- c1: Circular & GlobalPoint & CenterPoint
- point: Point
- Optional bounce: boolean
- Optional global: boolean
Returns boolean

circleRectangleCollision

circleRectangleCollision(c1: Circular & GlobalPoint & CenterPoint & HalfSize, r1: GlobalPoint & CenterPoint & Size & HalfSize, bounce?: boolean, global?: boolean): undefined | boolean | Collision

- Defined in plugins/collision.ts:85
Parameters
- c1: Circular & GlobalPoint & CenterPoint & HalfSize
- r1: GlobalPoint & CenterPoint & Size & HalfSize
- Optional bounce: boolean
- Optional global: boolean
Returns undefined | boolean | Collision

circularSprite

circularSprite<S>(source: any): S & Circular

- Defined in engine.ts:722
Type parameters
- S: Sprite<S>
Parameters
- source: any
Returns S & Circular

contain

contain(s: Point & Size & VelocityPoint & Partial<HasMass>, bounds: Point & Size, bounce?: boolean, extra?: (collsion: Collision) => void): undefined | Collision

- Defined in plugins/collision.ts:75
Parameters
- s: Point & Size & VelocityPoint & Partial<HasMass>
- bounds: Point & Size
- Optional bounce: boolean
- Optional extra: (collsion: Collision) => void
  - - (collsion: Collision): void
    - Parameters
      - collsion: Collision
      Returns void
Returns undefined | Collision

cubicBezier

cubicBezier(t: number, a: number, b: number, c: number, d: number): number

- Defined in plugins/tweening.ts:13
Parameters
- t: number
- a: number
- b: number
- c: number
- d: number
Returns number

displaySprite

displaySprite(sprite: any, lagOffset: number): void

- Defined in engine.ts:468
Parameters
- sprite: any
- lagOffset: number
Returns void

distance

distance(s1: CenterPoint, s2: CenterPoint): number

- Defined in plugins/utils.ts:14
Parameters
- s1: CenterPoint
- s2: CenterPoint
Returns number

emitter

emitter(interval: number, particleFunction: () => void): Emitter

- Defined in plugins/sprites.ts:64
Parameters
- interval: number
- particleFunction: () => void
  - - (): void
    - Returns void
Returns Emitter

fadeIn

fadeIn(sprite: TweenSprite, frames?: number): void

- Defined in plugins/tweening.ts:16
Parameters
- sprite: TweenSprite
- Optional frames: number
Returns void

fadeOut

fadeOut(sprite: TweenSprite, frames?: number): void

- Defined in plugins/tweening.ts:15
Parameters
- sprite: TweenSprite
- Optional frames: number
Returns void

filmstrip

filmstrip(imageName: string, frameWidth: number, frameHeight: number, spacing?: number): Frames<any>

- Defined in engine.ts:672
Parameters
- imageName: string
- frameWidth: number
- frameHeight: number
- spacing: number = 0
Returns Frames<any>

followConstant

followConstant(follower: DisplayableObject, leader: Pointer, speed: number): void

- Defined in plugins/utils.ts:16
Parameters
- follower: DisplayableObject
- leader: Pointer
- speed: number
Returns void

followCurve

followCurve(param: FollowCurveArgs): Tween

- Defined in plugins/tweening.ts:28
Parameters
- param: FollowCurveArgs
Returns Tween

followEase

followEase(follower: DisplayableObject, leader: Pointer, speed: number): void

- Defined in plugins/utils.ts:15
Parameters
- follower: DisplayableObject
- leader: Pointer
- speed: number
Returns void

fourKeyController

fourKeyController(s: DisplayableObject, speed: number, up: number, right: number, down: number, left: number): void

- Defined in plugins/sprites.ts:65
Parameters
- s: DisplayableObject
- speed: number
- up: number
- right: number
- down: number
- left: number
Returns void

frame

frame(source: any, x: number, y: number, width: number, height: number): Frame<any>

- Defined in engine.ts:653
Parameters
- source: any
- x: number
- y: number
- width: number
- height: number
Returns Frame<any>

frames

frames(source: any, arrayOfPositions: Position[], width: number, height: number): Frames<any>

- Defined in engine.ts:932
Parameters
- source: any
- arrayOfPositions: Position[]
- width: number
- height: number
Returns Frames<any>

gameLoop

gameLoop(): void

- Defined in engine.ts:255
Returns void

getIndex

getIndex(x: number, y: number, tilewidth: number, tileheight: number, mapWidthInTiles: number): number

- Defined in plugins/tiled.ts:17
Parameters
- x: number
- y: number
- tilewidth: number
- tileheight: number
- mapWidthInTiles: number
Returns number

getPoints

getPoints(s: CollidableTile): Corners

- Defined in plugins/tiled.ts:18
Parameters
- s: CollidableTile
Returns Corners

getTile

getTile(index: number, mapArray: number[], world: TiledWorld): TileObject

- Defined in plugins/tiled.ts:14
Parameters
- index: number
- mapArray: number[]
- world: TiledWorld
Returns TileObject

grid

grid(param: { cellHeight?: number; cellWidth?: number; centerCell?: boolean; columns?: number; rows?: number; xOffset?: number; yOffset?: number; extra?: any; makeSprite: any }): Grid

- Defined in plugins/sprites.ts:25
Parameters
- param: { cellHeight?: number; cellWidth?: number; centerCell?: boolean; columns?: number; rows?: number; xOffset?: number; yOffset?: number; extra?: any; makeSprite: any }
  - Optional cellHeight?: number
  - Optional cellWidth?: number
  - Optional centerCell?: boolean
  - Optional columns?: number
  - Optional rows?: number
  - Optional xOffset?: number
  - Optional yOffset?: number
  - extra: function
    - extra(sprite: DisplayableObject): void
    - Defined in plugins/sprites.ts:34
      Parameters
      - sprite: DisplayableObject
      Returns void
  - makeSprite: function
    - makeSprite(): DisplayableObject
    - Defined in plugins/sprites.ts:33
      Returns DisplayableObject
Returns Grid

group

group(...spritesToGroup: DisplayableObject[]): Group

- Defined in engine.ts:615
Parameters
- Rest ...spritesToGroup: DisplayableObject[]
Returns Group

hidePointer

hidePointer(): void

- Defined in engine.ts:446
Returns void

hit

hit(a: Point | CollidableObject, b: CollidableObject | CollidableObject[], react?: boolean, bounce?: boolean, global?: boolean, extra?: ExtraAction): undefined | boolean | Collision

- Defined in plugins/collision.ts:86
Parameters
- a: Point | CollidableObject
- b: CollidableObject | CollidableObject[]
- Optional react: boolean
- Optional bounce: boolean
- Optional global: boolean
- Optional extra: ExtraAction
Returns undefined | boolean | Collision

hitTestCircle

hitTestCircle(c1: Circular & CenterPoint & GlobalPoint, c2: Circular & CenterPoint & GlobalPoint, global?: boolean): boolean

- Defined in plugins/collision.ts:77
Parameters
- c1: Circular & CenterPoint & GlobalPoint
- c2: Circular & CenterPoint & GlobalPoint
- Optional global: boolean
Returns boolean

hitTestCirclePoint

hitTestCirclePoint(c1: Circular & CenterPoint & GlobalPoint, point: Point, global?: boolean): boolean

- Defined in plugins/collision.ts:79
Parameters
- c1: Circular & CenterPoint & GlobalPoint
- point: Point
- Optional global: boolean
Returns boolean

hitTestCircleRectangle

hitTestCircleRectangle(c1: Circular & GlobalPoint & CenterPoint & HalfSize, r1: GlobalPoint & CenterPoint & Size & HalfSize, global?: boolean): undefined | boolean | Collision

- Defined in plugins/collision.ts:80
Parameters
- c1: Circular & GlobalPoint & CenterPoint & HalfSize
- r1: GlobalPoint & CenterPoint & Size & HalfSize
- Optional global: boolean
Returns undefined | boolean | Collision

hitTestPoint

hitTestPoint(point: Point, sprite: RectangularCollidable | CircularCollidable): boolean

- Defined in plugins/collision.ts:76
Parameters
- point: Point
- sprite: RectangularCollidable | CircularCollidable
Returns boolean

hitTestRectangle

hitTestRectangle(r1: GlobalPoint & CenterPoint & HalfSize, r2: GlobalPoint & CenterPoint & HalfSize, global?: boolean): boolean

- Defined in plugins/collision.ts:78
Parameters
- r1: GlobalPoint & CenterPoint & HalfSize
- r2: GlobalPoint & CenterPoint & HalfSize
- Optional global: boolean
Returns boolean

hitTestTile

hitTestTile(sprite: CollidableTile, mapArray: number[], gidToCheck: number, world: TiledWorld, pointsToCheck?: "center" | "every" | "some"): TileCollision

- Defined in plugins/tiled.ts:15
Parameters
- sprite: CollidableTile
- mapArray: number[]
- gidToCheck: number
- world: TiledWorld
- Optional pointsToCheck: "center" | "every" | "some"
Returns TileCollision

image

image(imageFileName: string): any

- Defined in engine.ts:737
Parameters
- imageFileName: string
Returns any

impulseResponse

impulseResponse(duration: number, decay: number, reverse: boolean): AudioBuffer

- Defined in plugins/sound.ts:13
Parameters
- duration: number
- decay: number
- reverse: boolean
Returns AudioBuffer

json

json(jsonFileName: string): Record<string, any>

- Defined in engine.ts:742
Parameters
- jsonFileName: string
Returns Record<string, any>

keyboard

keyboard(keyCode: number): Keyboard

- Defined in engine.ts:891
Parameters
- keyCode: number
Returns Keyboard

line

line(strokeStyle?: string, lineWidth?: number, ax?: number, ay?: number, bx?: number, by?: number): Line

- Defined in engine.ts:643
Parameters
- strokeStyle: string = 'red'
- lineWidth: number = 1
- ax: number = 0
- ay: number = 0
- bx: number = 32
- by: number = 32
Returns Line

makeKeys

makeKeys(): Keys

- Defined in engine.ts:916
Returns Keys

makeSound

makeSound(source: any, loadHandler: () => void): Sound

- Defined in plugins/sound.ts:12
Parameters
- source: any
- loadHandler: () => void
  - - (): void
    - Returns void
Returns Sound

makeTiledWorld

makeTiledWorld(tiledmapSource: string, tileset: any): TiledWorld

- Defined in plugins/tiled.ts:13
Parameters
- tiledmapSource: string
- tileset: any
Returns TiledWorld

makeTween

makeTween(tweensToAdd: TweenPropertyArgs[]): Tweens

- Defined in plugins/tweening.ts:18
Parameters
- tweensToAdd: TweenPropertyArgs[]
Returns Tweens

move

move(sprites: DisplayableObject | DisplayableObject[]): void

- Defined in plugins/utils.ts:13
Parameters
- sprites: DisplayableObject | DisplayableObject[]
Returns void

movingCircleCollision

movingCircleCollision(c1: Partial<HasMass> & Partial<HasBounce> & Circular & GlobalPoint & CenterPoint & VelocityPoint, c2: Partial<HasMass> & Partial<HasBounce> & Circular & GlobalPoint & CenterPoint & VelocityPoint, global?: boolean): boolean

- Defined in plugins/collision.ts:83
Parameters
- c1: Partial<HasMass> & Partial<HasBounce> & Circular & GlobalPoint & CenterPoint & VelocityPoint
- c2: Partial<HasMass> & Partial<HasBounce> & Circular & GlobalPoint & CenterPoint & VelocityPoint
- Optional global: boolean
Returns boolean

multipleCircleCollision

multipleCircleCollision(arrayOfCircles: (Partial<HasMass> & Partial<HasBounce> & Circular & GlobalPoint & CenterPoint & VelocityPoint)[], global?: boolean): void

- Defined in plugins/collision.ts:87
Parameters
- arrayOfCircles: (Partial<HasMass> & Partial<HasBounce> & Circular & GlobalPoint & CenterPoint & VelocityPoint)[]
- Optional global: boolean
Returns void

noBlurScale

noBlurScale(): void

- Defined in plugins/utils.ts:28
Returns void

outsideBounds

outsideBounds(s: Point & Size, bounds: Point & Size, extra?: (collsion: Collision) => void): undefined | Collision

- Defined in plugins/collision.ts:74
Parameters
- s: Point & Size
- bounds: Point & Size
- Optional extra: (collsion: Collision) => void
  - - (collsion: Collision): void
    - Parameters
      - collsion: Collision
      Returns void
Returns undefined | Collision

particleEffect

particleEffect(param: { gravity?: number; maxAlphaSpeed?: number; maxAngle?: number; maxRotationSpeed?: number; maxScaleSpeed?: number; maxSize?: number; maxSpeed?: number; minAlphaSpeed?: number; minAngle?: number; minRotationSpeed?: number; minScaleSpeed?: number; minSize?: number; minSpeed?: number; numberOfParticles?: number; randomSpacing?: boolean; x?: number; y?: number; spriteFunction: any }): void

- Defined in plugins/sprites.ts:37
Parameters
- param: { gravity?: number; maxAlphaSpeed?: number; maxAngle?: number; maxRotationSpeed?: number; maxScaleSpeed?: number; maxSize?: number; maxSpeed?: number; minAlphaSpeed?: number; minAngle?: number; minRotationSpeed?: number; minScaleSpeed?: number; minSize?: number; minSpeed?: number; numberOfParticles?: number; randomSpacing?: boolean; x?: number; y?: number; spriteFunction: any }
  - Optional gravity?: number
  - Optional maxAlphaSpeed?: number
  - Optional maxAngle?: number
  - Optional maxRotationSpeed?: number
  - Optional maxScaleSpeed?: number
  - Optional maxSize?: number
  - Optional maxSpeed?: number
  - Optional minAlphaSpeed?: number
  - Optional minAngle?: number
  - Optional minRotationSpeed?: number
  - Optional minScaleSpeed?: number
  - Optional minSize?: number
  - Optional minSpeed?: number
  - Optional numberOfParticles?: number
  - Optional randomSpacing?: boolean
  - Optional x?: number
  - Optional y?: number
  - spriteFunction: function
    - spriteFunction(): Sprite
    - Defined in plugins/sprites.ts:40
      Returns Sprite
Returns void

pause

pause(): void

- Defined in engine.ts:435
Returns void

pulse

pulse(sprite: TweenSprite, frames?: number, minAlpha?: number): void

- Defined in plugins/tweening.ts:17
Parameters
- sprite: TweenSprite
- Optional frames: number
- Optional minAlpha: number
Returns void

randomFloat

randomFloat(min: number, max: number): number

- Defined in plugins/utils.ts:21
Parameters
- min: number
- max: number
Returns number

randomInt

randomInt(min: number, max: number): number

- Defined in plugins/utils.ts:20
Parameters
- min: number
- max: number
Returns number

rectangle

rectangle(width?: number, height?: number, fillStyle?: string, strokeStyle?: string, lineWidth?: number, x?: number, y?: number): Rectangle

- Defined in engine.ts:621
Parameters
- width: number = 32
- height: number = 32
- fillStyle: string = 'red'
- strokeStyle: string = 'none'
- lineWidth: number = 0
- x: number = 0
- y: number = 0
Returns Rectangle

rectangleCollision

rectangleCollision(r1: GlobalPoint & CenterPoint & VelocityPoint & HalfSize, r2: GlobalPoint & CenterPoint & HalfSize, bounce?: boolean, global?: boolean): undefined | Collision

- Defined in plugins/collision.ts:81
Parameters
- r1: GlobalPoint & CenterPoint & VelocityPoint & HalfSize
- r2: GlobalPoint & CenterPoint & HalfSize
- Optional bounce: boolean
- Optional global: boolean
Returns undefined | Collision

remove

remove(...sprites: any[]): void

- Defined in engine.ts:944
Parameters
- Rest ...sprites: any[]
Returns void

removeButton

removeButton<T>(o: T): Interactive[]

- Defined in engine.ts:326
remove interactive element from engine

Type parameters
- T: Interactive<T>
Parameters
- o: T
Returns Interactive[]

removeTween

removeTween(tweenObject: { tweens?: Tween[]; pause: any }): void

- Defined in plugins/tweening.ts:27
Parameters
- tweenObject: { tweens?: Tween[]; pause: any }
  - Optional tweens?: Tween[]
  - pause: function
    - pause(): void
    - Defined in plugins/tweening.ts:27
      Returns void
Returns void

render

render(lagOffset: number): void

- Defined in engine.ts:584
Parameters
- lagOffset: number
Returns void

resume

resume(): void

- Defined in engine.ts:438
Returns void

rotateAroundPoint

rotateAroundPoint(pointX: number, pointY: number, distanceX: number, distanceY: number, angle: number): Point

- Defined in plugins/utils.ts:18
Parameters
- pointX: number
- pointY: number
- distanceX: number
- distanceY: number
- angle: number
Returns Point

rotateAroundSprite

rotateAroundSprite(rotatingSprite: DisplayableObject, centerSprite: DisplayableObject, distance: number, angle: number): void

- Defined in plugins/utils.ts:17
Parameters
- rotatingSprite: DisplayableObject
- centerSprite: DisplayableObject
- distance: number
- angle: number
Returns void

scaleToFit

scaleToFit(dimension: "width" | "height", color: string): void

- Defined in plugins/utils.ts:25
Parameters
- dimension: "width" | "height"
- color: string
Returns void

scaleToWindow

scaleToWindow(backgroundColor?: string): void

- Defined in plugins/utils.ts:24
Parameters
- Optional backgroundColor: string
Returns void

scales

scales(sprite: ScalePoint, endScaleX: number, endScaleY: number, frames?: number): Tweens

- Defined in plugins/tweening.ts:21
Parameters
- sprite: ScalePoint
- endScaleX: number
- endScaleY: number
- Optional frames: number
Returns Tweens

shake

shake(sprite: DisplayableObject, magnitude: number, angular: boolean): void

- Defined in plugins/utils.ts:27
Parameters
- sprite: DisplayableObject
- magnitude: number
- angular: boolean
Returns void

shoot

shoot(param: { angle: number; bulletArray: DisplayableObject[]; bulletSpeed: number; offsetFromCenter: number; shooter: CenterPoint; bulletSprite: any }): DisplayableObject

- Defined in plugins/sprites.ts:16
Parameters
- param: { angle: number; bulletArray: DisplayableObject[]; bulletSpeed: number; offsetFromCenter: number; shooter: CenterPoint; bulletSprite: any }
  - angle: number
  - bulletArray: DisplayableObject[]
  - bulletSpeed: number
  - offsetFromCenter: number
  - shooter: CenterPoint
  - bulletSprite: function
    - bulletSprite(): DisplayableObject
    - Defined in plugins/sprites.ts:22
      Returns DisplayableObject
Returns DisplayableObject

showPointer

showPointer(): void

- Defined in engine.ts:449
Returns void

slide

slide(param: SlideArgs): Tweens

- Defined in plugins/tweening.ts:19
Parameters
- param: SlideArgs
Returns Tweens

sound

sound<S>(soundFileName: string): S

- Defined in plugins/sound.ts:14
Type parameters
- S = any
Parameters
- soundFileName: string
Returns S

soundEffect

soundEffect(param: { attack?: number; decay?: number; dissonance?: number; echo?: [number, number, number]; frequencyValue?: number; panValue?: number; pitchBendAmount?: number; randomValue?: number; reverb?: [number, number, boolean]; reverse?: boolean; type?: "sine" | "triangle" | "square" | "sawtooth"; volumeValue?: number; wait?: number }): void

- Defined in plugins/sound.ts:15
Parameters
- param: { attack?: number; decay?: number; dissonance?: number; echo?: [number, number, number]; frequencyValue?: number; panValue?: number; pitchBendAmount?: number; randomValue?: number; reverb?: [number, number, boolean]; reverse?: boolean; type?: "sine" | "triangle" | "square" | "sawtooth"; volumeValue?: number; wait?: number }
  - Optional attack?: number
  - Optional decay?: number
  - Optional dissonance?: number
  - Optional echo?: [number, number, number]
  - Optional frequencyValue?: number
  - Optional panValue?: number
  - Optional pitchBendAmount?: number
  - Optional randomValue?: number
  - Optional reverb?: [number, number, boolean]
  - Optional reverse?: boolean
  - Optional type?: "sine" | "triangle" | "square" | "sawtooth"
  - Optional volumeValue?: number
  - Optional wait?: number
Returns void

sprite

sprite<S>(source: any): S

- Defined in engine.ts:713
Type parameters
- S: Sprite<S> = Sprite
Parameters
- source: any
Returns S

start

start(): void

- Defined in engine.ts:396
Returns void

strobe

strobe(param: StrobeArgs): Tweens

- Defined in plugins/tweening.ts:25
Parameters
- param: StrobeArgs
Returns Tweens

surroundingCells

surroundingCells(index: number, widthInTiles: number): [number, number, number, number, number, number, number, number, number]

- Defined in plugins/collision.ts:88
Parameters
- index: number
- widthInTiles: number
Returns [number, number, number, number, number, number, number, number, number]

text

text(content?: string, font?: string, fillStyle?: string, x?: number, y?: number): Text

- Defined in engine.ts:636
Parameters
- content: string = 'Hello!'
- font: string = '12px sans-serif'
- fillStyle: string = 'red'
- x: number = 0
- y: number = 0
Returns Text

tilingSprite

tilingSprite(width: number, height: number, source: any, x?: number, y?: number): Rectangle

- Defined in plugins/sprites.ts:66
Parameters
- width: number
- height: number
- source: any
- Optional x: number
- Optional y: number
Returns Rectangle

tweenProperty

tweenProperty(param: TweenPropertyArgs): Tween

- Defined in plugins/tweening.ts:14
Parameters
- param: TweenPropertyArgs
Returns Tween

update

update(): void

- Defined in engine.ts:333
Returns void

updateMap

updateMap(mapArray: number[], spritesToUpdate: any, world: TiledWorld): number[]

- Defined in plugins/tiled.ts:16
Parameters
- mapArray: number[]
- spritesToUpdate: any
- world: TiledWorld
Returns number[]

updateParticles

updateParticles(): void

- Defined in plugins/sprites.ts:63
Returns void

updateShakingSprites

updateShakingSprites(): void

- Defined in plugins/utils.ts:26
Returns void

updateTweens

updateTweens(): void

- Defined in plugins/tweening.ts:12
Returns void

wait

wait(duration: number, callBack: () => void): void

- Defined in plugins/utils.ts:22
Parameters
- duration: number
- callBack: () => void
  - - (): void
    - Returns void
Returns void

walkCurve

walkCurve(param: WalkCurveArgs): Tween

- Defined in plugins/tweening.ts:30
Parameters
- param: WalkCurveArgs
Returns Tween

walkPath

walkPath(param: WalkPathArgs): Tweens

- Defined in plugins/tweening.ts:29
Parameters
- param: WalkPathArgs
Returns Tweens

wobble

wobble(param: WobbleArgs): Tweens

- Defined in plugins/tweening.ts:26
Parameters
- param: WobbleArgs
Returns Tweens

worldCamera

worldCamera(world: any, canvas: HTMLCanvasElement): Camera

- Defined in plugins/utils.ts:23
Parameters
- world: any
- canvas: HTMLCanvasElement
Returns Camera

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

width: number

height: number

setup: () => void

Returns void

assetsToLoad: string[] = []

load: () => void = ...

Returns void

Returns Engine

Properties

actx

Optional assetFilePaths

assets

buttons

canvas

dragAndDrop

draggableSprites

interpolate

key

load

Type declaration

Returns void

particles

paused

pointer

Readonly progressBar

scale

setup

Type declaration

Returns void

shakingSprites

stage

Optional state

Type declaration

Returns void

tweens

updateFunctions

Static Optional custom

Type declaration

Parameters

ga: Engine

Returns void

Static Optional plugins

Type declaration

Parameters

ga: Engine

Returns void

Accessors

backgroundColor

Parameters

value: string

Returns void

fps

Returns number

Parameters

value: number

Returns void

Methods

addStatePlayer

Parameters

sprite: Sprite

Returns void

angle

Parameters

s1: CenterPoint

s2: CenterPoint

Returns number

breathe

Parameters

param: BreatheArgs

Returns Tweens

burst