Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Ping

A class to manage a user ping on the canvas.

param origin

The canvas co-ordinates of the origin of the ping.

param [options]

Additional options to configure the ping animation.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Ping(origin: any, options?: {}): Ping

  • Parameters

    • origin: any
    • options: {} = {}

      Returns Ping

    Properties

    x

    x: any

    y

    y: any

    options

    options: any

    _color

    _color: number | utils.Color

    Methods

    destroy

    • destroy(options?: {}): void
    • inheritdoc

      Parameters

      • options: {} = {}

        Returns void

      animate

      • animate(): Promise<boolean>

      • Start the ping animation.

        Returns Promise<boolean>

        Returns true if the animation ran to completion, false otherwise.

      Protected _animateFrame

      • On each tick, advance the animation.

        Parameters

        • dt: number

          The number of ms that elapsed since the previous frame.

        • animation: CanvasAnimationOptions

          The animation state.

        Returns void