Class Time

Provides time-related information for frame-based game logic.
Access via this.context.time from any component.

Example: Using deltaTime for frame-rate independent movement

update() {
  // Move 1 unit per second regardless of frame rate
  this.gameObject.position.x += 1 * this.context.time.deltaTime;
}

Example: Checking elapsed time

start() {
  console.log(`Time since start: ${this.context.time.time}s`);
  console.log(`Current frame: ${this.context.time.frameCount}`);
}

Implements

Constructors

constructor

Properties

timeScale

Accessors

deltaTime deltaTimeUnscaled fps frame frameCount realtimeSinceStartup smoothedDeltaTime smoothedFps time

Constructors

constructor

Properties

timeScale

timeScale: number = 1

The scale at which time passes. Default is 1.

  • Values < 1 create slow motion (e.g. 0.5 = half speed)
  • Values > 1 speed up time (e.g. 2 = double speed)
  • Value of 0 effectively pauses time-dependent logic

Accessors

deltaTime

  • get deltaTime(): number

    The time in seconds it took to complete the last frame (Read Only).

    Returns number

  • set deltaTime(value: number): void

    Parameters

    • value: number

    Returns void

deltaTimeUnscaled

  • get deltaTimeUnscaled(): number

    The time in seconds it took to complete the last frame (Read Only). Timescale is not applied.

    Returns number

fps

  • get fps(): number

    Returns number

    FPS for this frame.
    Note that this returns the raw value (e.g. 59.88023952362959) and will fluctuate a lot between frames.
    If you want a more stable FPS, use smoothedFps instead.

frame

  • get frame(): number

    same as frameCount

    Returns number

  • set frame(value: number): void

    Parameters

    • value: number

    Returns void

frameCount

  • get frameCount(): number

    The total number of frames that have passed (Read Only). Same as frame

    Returns number

realtimeSinceStartup

  • get realtimeSinceStartup(): number

    The time in seconds it took to complete the last frame (Read Only).

    Returns number

smoothedDeltaTime

  • get smoothedDeltaTime(): number

    The smoothed time in seconds it took to complete the last frame (Read Only).

    Returns number

smoothedFps

  • get smoothedFps(): number

    Approximated frames per second

    Returns number

    the smoothed FPS value over the last 60 frames with decimals.

time

  • get time(): number

    The time in seconds since the start of Needle Engine.

    Returns number

  • set time(value: number): void

    Parameters

    • value: number

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors