LesserPanda

Class: Timer

Timer

new Timer( [ms])

Timer constructor should not be used directly, use the static methods instead:

Parameters:
Name Type Argument Description
ms number <optional>

Time
Source:

Members

duration :number

Duration of this timer.

Type:
  • number
Default Value:
  • 0
Source:

<readonly> elapsed

Properties:
Name Type Description
elapsed number

Time elapsed since start.
Source:

<readonly> left

Properties:
Name Type Description
left number

Time left till the end.
Source:

<protected> removed :boolean

Whether this timer is already removed.

Type:
  • boolean
Default Value:
  • false
Source:

repeat :boolean

Whether this timer should repeat.

Type:
  • boolean
Default Value:
  • false
Source:

Methods

pause()

Pause timer.

Source:
Returns:

Self for chaining

Type
Timer

reset()

Reset timer to current duration.

Source:
Returns:

Self for chaining

Type
Timer

resume()

Resume paused timer.

Source:
Returns:

Self for chaining

Type
Timer

set(ms)

Set duration for timer.

Parameters:
Name Type Description
ms number

Time to set to
Source:
Returns:

Self for chaining

Type
Timer

<protected> update(delta)

Update method that is called by timer system.

Parameters:
Name Type Description
delta number

Delta time
Source:

Class: Timer

Timer

new Timer()

Source:

Members

duration :number

Duration of this timer.

Type:
  • number
Default Value:
  • 0
Source:

<readonly> elapsed

Properties:
Name Type Description
elapsed number

Time elapsed since start.
Source:

<readonly> left

Properties:
Name Type Description
left number

Time left till the end.
Source:

<protected> removed :boolean

Whether this timer is already removed.

Type:
  • boolean
Default Value:
  • false
Source:

repeat :boolean

Whether this timer should repeat.

Type:
  • boolean
Default Value:
  • false
Source:

Methods

pause()

Pause timer.

Source:
Returns:

Self for chaining

Type
Timer

reset()

Reset timer to current duration.

Source:
Returns:

Self for chaining

Type
Timer

resume()

Resume paused timer.

Source:
Returns:

Self for chaining

Type
Timer

set(ms)

Set duration for timer.

Parameters:
Name Type Description
ms number

Time to set to
Source:
Returns:

Self for chaining

Type
Timer

<protected> update(delta)

Update method that is called by timer system.

Parameters:
Name Type Description
delta number

Delta time
Source: