Class WarpDrive

constructor

• new WarpDrive(
      serializedWarpDrive: {
          quality: number;
          size: number;
          type: "warpDrive";
      },
      enabledByDefault?: boolean,
  ): WarpDrive

  Parameters

  • serializedWarpDrive: { quality: number; size: number; type: "warpDrive" }
  • enabledByDefault: boolean = false

  Returns WarpDrive

ReadonlydefaultThrottle

ReadonlymaxWarpSpeed

Readonlyquality

ReadonlyrangeLY

Readonlysize

Readonlytype

disengage

• disengage(): void

  Disengages the warp drive: the ship will start to decelerate towards 0. The warp drive will be disabled when the ship reaches 0 speed.

  Returns void

emergencyStop

• emergencyStop(): void

  Returns void

enable

• enable(): void

  Enables the warp drive: the ship will start to accelerate towards the target speed.

  Returns void

getFuelConsumption

• getFuelConsumption(distanceLY: number): number

  Returns the amount of fuel consumed by the warp drive to travel the given distance in light-years.

  Parameters

  • distanceLY: number

    The distance to travel in light-years.

  Returns number

getThrottle

• getThrottle(): number

  Returns the current target throttle of the warp drive.

  Returns number

  The current target throttle of the warp drive.

getWarpSpeed

• getWarpSpeed(): number

  Returns the current speed of the warp drive in m/s.

  Returns number

  The current speed of the warp drive in m/s.

increaseThrottle

• increaseThrottle(deltaThrottle: number): void

  Increases the target throttle by the given delta and clamps it between 0 and 1.

  Parameters

  • deltaThrottle: number

    The delta to apply to the target throttle.

  Returns void

isDisabled

• isDisabled(): boolean

  Returns true if the warp drive is disabled. Returns false otherwise.

  Returns boolean

  True if the warp drive is disabled. Returns false otherwise.

isDisengaging

• isDisengaging(): boolean

  Returns true if the warp drive is disengaging. Returns false otherwise.

  Returns boolean

  True if the warp drive is disengaging. Returns false otherwise.

isEnabled

• isEnabled(): boolean

  Returns true if the warp drive is enabled and not disengaging. Returns false otherwise.

  Returns boolean

  True if the warp drive is enabled and not disengaging. Returns false otherwise.

serialize

• serialize(): { quality: number; size: number; type: "warpDrive" }

  Returns { quality: number; size: number; type: "warpDrive" }

update

• update(
      closestObjectDistance: number,
      closestObjectRadius: number,
      deltaSeconds: number,
  ): void

  Updates the warp drive based on the current speed of the ship, the distance to the closest body and the time elapsed since the last update.

  Parameters

  • closestObjectDistance: number
  • closestObjectRadius: number
  • deltaSeconds: number

    The time elapsed since the last update in seconds.

  Returns void

updateMaxTargetSpeed

• updateMaxTargetSpeed(
      closestObjectDistance: number,
      closestObjectRadius: number,
  ): number

  Computes the target speed of the warp drive based on the distance to the closest body and the user throttle.

  Parameters

  • closestObjectDistance: number

    The distance to the closest body in m.
  • closestObjectRadius: number

  Returns number

  The computed target speed in m/s.