Class GridHighlight

A special Graphics class which handles Grid layer highlighting

Hierarchy

Graphics
- GridHighlight

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GridHighlight(name: any, ...args: any[]): GridHighlight

Overrides PIXI.Graphics.constructor
Parameters
- name: any
- Rest ...args: any[]
Returns GridHighlight

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: number, y: number): 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

inheritdoc
Returns any

destroy

destroy(...args: any[]): any

inheritdoc
Parameters
- Rest ...args: any[]
Returns any