@vsmode/starship | @vsmode/starship

Index

Enumerations

Button

Interfaces

Type aliases

Variables

Functions

Type aliases

StarshipDestroy

StarshipDestroy<T>: (state: T) => void

Called once to teardown

Type parameters

T

Type declaration

- (state: T): void
- Parameters
  - state: T
  Returns void

StarshipInit

StarshipInit<T>: () => T

Called once to initialize the state

Type parameters

T

Type declaration

- (): T
- Returns T

StarshipUpdate

StarshipUpdate<T, E>: (state: T, queue: E[]) => boolean | void

Called each frame

Type parameters

T
E

Type declaration

- (state: T, queue: E[]): boolean | void
- Parameters
  - state: T
  - queue: E[]
  Returns boolean | void

Variables

Const FONT_5x5

FONT_5x5: string = BASE64_5x5 + PARAMS_5x5

Default 5x5 font

Const FONT_8x8

FONT_8x8: string = BASE64_8x8 + PARAMS_8x8

Default 8x8 font

Functions

clear

clear(color?: Color): void

- Defined in index.ts:263
Clears the canvas

Parameters
- Default value color: Color = BLACK
Returns void

drawFilledRect

drawFilledRect(rect: Rectangle, color: Color): void

- Defined in index.ts:270
Draws a filled rectangle

Parameters
- rect: Rectangle
- color: Color
Returns void

drawSprite

drawSprite(src: string, rect: Rectangle, pos: Vector2): void

- Defined in index.ts:279
Draws a sprite

Parameters
- src: string
- rect: Rectangle
- pos: Vector2
Returns void

drawText

drawText(src: string, text: string, pos: Vector2, color?: Color): void

- Defined in index.ts:312
Draws text. NOTE: Font image file should arrange ASCII characters in a 16x9 grid. Font image src should also end with a querystring specifying char width/height. Example: my_font.png?charw=8charh=8

Parameters
- src: string
- text: string
- pos: Vector2
- Default value color: Color = WHITE
Returns void

isButtonDown

isButtonDown(btn: Button): boolean

- Defined in index.ts:190
Checks if a button is pressed this frame

Parameters
- btn: Button
Returns boolean

isButtonPressed

isButtonPressed(btn: Button): boolean

- Defined in index.ts:195
Checks if a button is held down this frame

Parameters
- btn: Button
Returns boolean

isSoundPlaying

isSoundPlaying(src: string): boolean

- Defined in index.ts:232
Returns whether a sound file is currently playing

Parameters
- src: string
Returns boolean

playSound

playSound(src: string): void

- Defined in index.ts:209
Plays an audio file

Parameters
- src: string
Returns void

rect

rect(x: number, y: number, width: number, height: number): Rectangle

- Defined in index.ts:25
Creates a rectangle

Parameters
- x: number
- y: number
- width: number
- height: number
Returns Rectangle

rgba

rgba(r: number, g: number, b: number, a?: number): Color

- Defined in index.ts:43
Creates a Color

Parameters
- r: number
- g: number
- b: number
- Default value a: number = 255
Returns Color

run

run<T, E>(config: StarshipConfig, init: StarshipInit<T>, destroy: StarshipDestroy<T>, update: StarshipUpdate<T, E>): void

- Defined in index.ts:72
Runs the game

Type parameters
- T
- E
Parameters
- config: StarshipConfig
- init: StarshipInit<T>
- destroy: StarshipDestroy<T>
- update: StarshipUpdate<T, E>
Returns void

stopSound

stopSound(src: string): void

- Defined in index.ts:223
Stops an audio file

Parameters
- src: string
Returns void

vec2

vec2(x: number, y: number): Vector2

- Defined in index.ts:12
Creates a Vector2

Parameters
- x: number
- y: number
Returns Vector2