IGridRenderer | @simplylinn/tonematrix

Hierarchy

EventEmitter<GridRendererEventMap>
- IGridRenderer

Implemented by

GridCanvasRenderer

Index

Methods

addListener

addListener<T>(event: T, fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void, context?: any): IGridRenderer

Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45
Type parameters
- T: keyof GridRendererEventMap
Parameters
- event: T
- fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void
  - - (...args: ArgumentMap<GridRendererEventMap>[T]): void
    - Parameters
      - Rest ...args: ArgumentMap<GridRendererEventMap>[T]
      Returns void
- Optional context: any
Returns IGridRenderer

Optional dispose

dispose(): void

- Defined in src/Interfaces.ts:126
Returns void

emit

emit<T>(event: T, ...args: ArgumentMap<GridRendererEventMap>[T]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32
Calls each of the listeners registered for a given event.

Type parameters
- T: keyof GridRendererEventMap
Parameters
- event: T
- Rest ...args: ArgumentMap<GridRendererEventMap>[T]
Returns boolean

eventNames

eventNames(): keyof GridRendererEventMap[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15
Return an array listing the events for which the emitter has registered listeners.

Returns keyof GridRendererEventMap[]

listenerCount

listenerCount(event: keyof GridRendererEventMap): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27
Return the number of listeners listening to a given event.

Parameters
- event: keyof GridRendererEventMap
Returns number

listeners

listeners<T>(event: T): ((...args: ArgumentMap<GridRendererEventMap>[T]) => void)[]

Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20
Return the listeners registered for a given event.

Type parameters
- T: keyof GridRendererEventMap
Parameters
- event: T
Returns ((...args: ArgumentMap<GridRendererEventMap>[T]) => void)[]

off

off<T>(event: T, fn?: (...args: ArgumentMap<GridRendererEventMap>[T]) => void, context?: any, once?: boolean): IGridRenderer

Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69
Type parameters
- T: keyof GridRendererEventMap
Parameters
- event: T
- Optional fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void
  - - (...args: ArgumentMap<GridRendererEventMap>[T]): void
    - Parameters
      - Rest ...args: ArgumentMap<GridRendererEventMap>[T]
      Returns void
- Optional context: any
- Optional once: boolean
Returns IGridRenderer

on

on<T>(event: T, fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void, context?: any): IGridRenderer

Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40
Add a listener for a given event.

Type parameters
- T: keyof GridRendererEventMap
Parameters
- event: T
- fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void
  - - (...args: ArgumentMap<GridRendererEventMap>[T]): void
    - Parameters
      - Rest ...args: ArgumentMap<GridRendererEventMap>[T]
      Returns void
- Optional context: any
Returns IGridRenderer

once

once<T>(event: T, fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void, context?: any): IGridRenderer

Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54
Add a one-time listener for a given event.

Type parameters
- T: keyof GridRendererEventMap
Parameters
- event: T
- fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void
  - - (...args: ArgumentMap<GridRendererEventMap>[T]): void
    - Parameters
      - Rest ...args: ArgumentMap<GridRendererEventMap>[T]
      Returns void
- Optional context: any
Returns IGridRenderer

pixelCoordsToTileCoords

pixelCoordsToTileCoords(x: number, y: number, gridWidth: number, gridHeight: number): false | [x: number, y: number]

- Defined in src/Interfaces.ts:119
Converts coordinates in "pixel space" to coordinates in "tile space". In essence, if you pass in an (x, y) position on the canvas, this returns the corresponding (x, y) position on the grid.

Parameters
- x: number
  
  The x position, in pixels, to get the corresponding grid position for
- y: number
  
  The y position, in pixels, to get the corresponding grid position for
- gridWidth: number
  
  The width of the grid, in grid tiles
- gridHeight: number
  
  The height of the grid, in grid tiles
Returns false | [x: number, y: number]

removeAllListeners

removeAllListeners(event?: keyof GridRendererEventMap): IGridRenderer

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79
Remove all listeners, or those of the specified event.

Parameters
- Optional event: keyof GridRendererEventMap
Returns IGridRenderer

removeListener

removeListener<T>(event: T, fn?: (...args: ArgumentMap<GridRendererEventMap>[T]) => void, context?: any, once?: boolean): IGridRenderer

Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63
Remove the listeners of a given event.

Type parameters
- T: keyof GridRendererEventMap
Parameters
- event: T
- Optional fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void
  - - (...args: ArgumentMap<GridRendererEventMap>[T]): void
    - Parameters
      - Rest ...args: ArgumentMap<GridRendererEventMap>[T]
      Returns void
- Optional context: any
- Optional once: boolean
Returns IGridRenderer

setSize

setSize(newWidth: number, newHeight: number): void

- Defined in src/Interfaces.ts:104
Update the grid size width and height.

Parameters
- newWidth: number
- newHeight: number
Returns void

update

update(grid: IGrid): void

- Defined in src/Interfaces.ts:99
Update, then draw the current state of the app to the canvas element.

Parameters
- grid: IGrid
  
  The grid to be rendered
Returns void

Hierarchy

Implemented by

Index

Methods

Methods

addListener

Type parameters

T: keyof GridRendererEventMap

Parameters

event: T

fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void

Parameters

Rest ...args: ArgumentMap<GridRendererEventMap>[T]

Returns void

Optional context: any

Returns IGridRenderer

Optional dispose

Returns void

emit

Type parameters

T: keyof GridRendererEventMap

Parameters

event: T

Rest ...args: ArgumentMap<GridRendererEventMap>[T]

Returns boolean

eventNames

Returns keyof GridRendererEventMap[]

listenerCount

Parameters

event: keyof GridRendererEventMap

Returns number

listeners

Type parameters

T: keyof GridRendererEventMap

Parameters

event: T

Returns ((...args: ArgumentMap<GridRendererEventMap>[T]) => void)[]

off

Type parameters

T: keyof GridRendererEventMap

Parameters

event: T

Optional fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void

Parameters

Rest ...args: ArgumentMap<GridRendererEventMap>[T]

Returns void

Optional context: any

Optional once: boolean

Returns IGridRenderer

on

Type parameters

T: keyof GridRendererEventMap

Parameters

event: T

fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void

Parameters

Rest ...args: ArgumentMap<GridRendererEventMap>[T]

Returns void

Optional context: any

Returns IGridRenderer

once

Type parameters

T: keyof GridRendererEventMap

Parameters

event: T

fn: (...args: ArgumentMap<GridRendererEventMap>[T]) => void

Parameters

Rest ...args: ArgumentMap<GridRendererEventMap>[T]

Returns void

Optional context: any

Returns IGridRenderer

pixelCoordsToTileCoords

Parameters

x: number

y: number

gridWidth: number

gridHeight: number

Returns false | [x: number, y: number]

removeAllListeners

Parameters