Methods

disableFixedDelta() → {Time}

core/Time.js, line 43

Disables the usage of a fixed delta value.

Returns:

Time -

A reference to this time object.

dispose() → {Time}

core/Time.js, line 56

Frees all internal resources.

Returns:

Time -

A reference to this time object.

enableFixedDelta() → {Time}

core/Time.js, line 73

Enables the usage of a fixed delta value. Can be useful for debugging and testing.

Returns:

Time -

A reference to this time object.

getDelta() → {Number}

core/Time.js, line 87

Returns the delta time in seconds. Represents the completion time in seconds since the last simulation step.

Returns:

Number -

The delta time in seconds.

getElapsed() → {Number}

core/Time.js, line 99

Returns the elapsed time in seconds. It's the accumulated value of all previous time deltas.

Returns:

Number -

The elapsed time in seconds.

getFixedDelta() → {Number}

core/Time.js, line 110

Returns the fixed delta time in seconds.

Returns:

Number -

The fixed delta time in seconds.

getTimescale() → {Number}

core/Time.js, line 121

Returns the timescale value.

Returns:

Number -

The timescale value.

reset() → {Time}

core/Time.js, line 132

Resets this time object.

Returns:

Time -

A reference to this time object.

setFixedDelta(fixedDelta) → {Time}

core/Time.js, line 146

Sets a fixed time delta value.

Parameters:

Name	Type	Description
fixedDelta	Number	Fixed time delta in seconds.

Returns:

Time -

A reference to this time object.

setTimescale(timescale) → {Time}

core/Time.js, line 161

Sets a timescale value. This value represents the scale at which time passes. Can be used for slow down or accelerate the simulation.

Parameters:

Name	Type	Description
timescale	Number	The timescale value.

Returns:

Time -

A reference to this time object.

update() → {Time}

core/Time.js, line 174

Updates the internal state of this time object.

Returns:

Time -

A reference to this time object.