Options
All
  • Public
  • Public/Protected
  • All
Menu

Construction options for a timer

Type Parameters

  • T

Hierarchy

  • ITimerOptions

Index

Properties

contextObservable: Observable<T>

The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable. Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time

observableParameters?: { insertFirst?: boolean; mask?: number; scope?: any }

Optional parameters when adding an observer to the observable

Type declaration

  • Optional insertFirst?: boolean
  • Optional mask?: number
  • Optional scope?: any
timeout: number

Time-to-end

Methods

  • An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!

    Parameters

    Returns boolean

  • Will be triggered when the break condition has met (prematurely ended)

    Parameters

    Returns void

  • Will be triggered when the time condition has met

    Parameters

    Returns void

  • Optional function to execute on each tick (or count)

    Parameters

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme