Class GridHighlight

A special Graphics class which handles Grid layer highlighting

Hierarchy

Graphics
- GridHighlight

Index

Properties

Methods

highlight clear destroy

Properties

name

name: string

Track the Grid Highlight name

positions

positions: Set<any>

Track distinct positions which have already been highlighted

Methods

highlight

highlight(x, y): boolean
Record a position that is highlighted and return whether or not it should be rendered
Parameters
- x: number
  The x-coordinate to highlight
- y: number
  The y-coordinate to highlight
Returns boolean
Whether or not to draw the highlight for this location

clear

clear(): any
Returns any
Inherit Doc

destroy

destroy(...args): any
Parameters
- Rest ...args: any[]
Returns any
Inherit Doc