new Time(game)
Time constructor.
Parameters:
| Name | Type | Description |
|---|---|---|
game |
Phaser.Game | A reference to the currently running game. |
- Source:
Members
-
advancedTiming
-
- Default Value:
- false
- Source:
Properties:
Name Type Description advancedTimingboolean If true Phaser.Time will perform advanced profiling including the fps rate, fps min/max and msMin and msMax.
-
deltaCap
-
- Source:
Properties:
Name Type Description deltaCapnumber If you need to cap the delta timer, set the value here. For 60fps the delta should be 0.016, so try variances just above this.
-
<protected> elapsed
-
- Source:
Properties:
Name Type Description elapsednumber Elapsed time since the last frame (in ms).
-
events
-
- Source:
Properties:
Name Type Description eventsPhaser.Timer This is a Phaser.Timer object bound to the master clock to which you can add timed events.
-
<protected> fps
-
- Source:
Properties:
Name Type Description fpsnumber Frames per second. Only calculated if Time.advancedTiming is true.
-
fpsMax
-
- Source:
Properties:
Name Type Description fpsMaxnumber The highest rate the fps has reached (usually no higher than 60fps). Only calculated if Time.advancedTiming is true.
-
fpsMin
-
- Source:
Properties:
Name Type Description fpsMinnumber The lowest rate the fps has dropped to. Only calculated if Time.advancedTiming is true.
-
frames
-
- Source:
Properties:
Name Type Description framesnumber The number of frames record in the last second. Only calculated if Time.advancedTiming is true.
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game Local reference to game.
-
lastTime
-
- Source:
Properties:
Name Type Description lastTimenumber Internal value used by timeToCall as part of the setTimeout loop
-
msMax
-
- Source:
Properties:
Name Type Description msMaxnumber The maximum amount of time the game has taken between two frames. Only calculated if Time.advancedTiming is true.
-
msMin
-
- Default Value:
- 1000
- Source:
Properties:
Name Type Description msMinnumber The minimum amount of time the game has taken between two frames. Only calculated if Time.advancedTiming is true.
-
<protected> now
-
- Source:
Properties:
Name Type Description nownumber The time right now.
-
<protected> pausedTime
-
- Source:
Properties:
Name Type Description pausedTimenumber Records how long the game has been paused for. Is reset each time the game pauses.
-
pauseDuration
-
- Source:
Properties:
Name Type Description pauseDurationnumber Records how long the game was paused for in miliseconds.
-
physicsElapsed
-
- Source:
Properties:
Name Type Description physicsElapsednumber The elapsed time calculated for the physics motion updates. In a stable 60fps system this will be 0.016 every frame.
-
<protected> time
-
- Source:
Properties:
Name Type Description timenumber Game time counter. If you need a value for in-game calculation please use Phaser.Time.now instead.
-
timeCap
-
- Source:
Properties:
Name Type Description timeCapnumber If the difference in time between two frame updates exceeds this value, the frame time is reset to avoid huge elapsed counts.
-
timeToCall
-
- Source:
Properties:
Name Type Description timeToCallnumber The value that setTimeout needs to work out when to next update
Methods
-
add(timer) → {Phaser.Timer}
-
Adds an existing Phaser.Timer object to the Timer pool.
Parameters:
Name Type Description timerPhaser.Timer An existing Phaser.Timer object.
- Source:
Returns:
The given Phaser.Timer object.
- Type
- Phaser.Timer
-
<protected> boot()
-
Called automatically by Phaser.Game after boot. Should not be called directly.
- Source:
-
create(autoDestroy) → {Phaser.Timer}
-
Creates a new stand-alone Phaser.Timer object.
Parameters:
Name Type Argument Default Description autoDestroyboolean <optional>
true A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).
- Source:
Returns:
The Timer object that was created.
- Type
- Phaser.Timer
-
elapsedSecondsSince(since) → {number}
-
How long has passed since the given time (in seconds).
Parameters:
Name Type Description sincenumber The time you want to measure (in seconds).
- Source:
Returns:
Duration between given time and now (in seconds).
- Type
- number
-
elapsedSince(since) → {number}
-
How long has passed since the given time.
Parameters:
Name Type Description sincenumber The time you want to measure against.
- Source:
Returns:
The difference between the given time and now.
- Type
- number
-
removeAll()
-
Remove all Timer objects, regardless of their state. Also clears all Timers from the Time.events timer.
- Source:
-
reset()
-
Resets the private _started value to now and removes all currently running Timers.
- Source:
-
totalElapsedSeconds() → {number}
-
The number of seconds that have elapsed since the game was started.
- Source:
Returns:
The number of seconds that have elapsed since the game was started.
- Type
- number
-
<protected> update(time)
-
Updates the game clock and if enabled the advanced timing data. This is called automatically by Phaser.Game.
Parameters:
Name Type Description timenumber The current timestamp.
- Source: