Class Ping

A class to manage a user ping on the canvas.

Hierarchy (View Summary)

Container
- Ping
  - PulsePing
  - ChevronPing

Index

Constructors

Properties

Methods

animate destroy _animateFrame

Constructors

constructor

new Ping(origin: Point, options?: PingOptions): Ping
Parameters
- origin: Point
  The canvas coordinates of the origin of the ping.
- Optionaloptions: PingOptions = {}
  Additional options to configure the ping animation.
Returns Ping
Overrides PIXI.Container.constructor

Properties

`Protected`_color

_color: Color

The color of the ping.

Methods

animate

animate(): Promise<boolean>
Start the ping animation.

Returns Promise<boolean>
Returns true if the animation ran to completion, false otherwise.

destroy

destroy(options?: {}): void
Parameters
- options: {} = {}
Returns void
Inherit Doc
Overrides PIXI.Container.destroy

`Protected`_animateFrame

_animateFrame(dt: number, animation: CanvasAnimationData): void
Protected
On each tick, advance the animation.
Parameters
- dt: number
  The number of ms that elapsed since the previous frame.
- animation: CanvasAnimationData
  The animation state.
Returns void