Class GridHighlight

A special Graphics class which handles Grid layer highlighting

Hierarchy

SmoothGraphics
- GridHighlight

Index

Properties

Methods

clear destroy highlight

Properties

positions

positions: Set<any>

Track distinct positions which have already been highlighted

Methods

clear

clear(): GridHighlight
Returns GridHighlight
Inherit Doc
Overrides PIXI.smooth.SmoothGraphics.clear

destroy

destroy(...args: any[]): void
Parameters
- ...args: any[]
Returns void
Inherit Doc
Overrides PIXI.smooth.SmoothGraphics.destroy

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