Class Spaceship

ReadonlyacceleratingWarpDriveSound

Readonlyaggregate

ReadonlyboundingExtent

ReadonlydeceleratingWarpDriveSound

ReadonlydisableWarpDriveSound

ReadonlyenableWarpDriveSound

ReadonlyfuelScoop

ReadonlyfuelTanks

ReadonlyhyperSpaceSound

ReadonlyhyperSpaceTunnel

Readonlyid

ReadonlyinstanceRoot

ReadonlymaxPitchSpeed

ReadonlymaxRollSpeed

ReadonlymaxYawSpeed

Readonlyname

ReadonlyonAutoPilotEngaged

ReadonlyonFuelScoopEnd

ReadonlyonFuelScoopStart

ReadonlyonLandingCancelled

ReadonlyonLandingObservable

ReadonlyonPlanetaryLandingEngaged

ReadonlyonTakeOff

ReadonlyonWarpDriveDisabled

ReadonlyonWarpDriveEnabled

ReadonlythrusterSound

ReadonlywarpTunnel

burnFuel

• burnFuel(amount: number): number

  Parameters

  • amount: number

  Returns number

cancelLanding

• cancelLanding(): void

  Returns void

disableWarpDrive

• disableWarpDrive(): void

  Returns void

dispose

• dispose(): void

  Deletes all resources used by the Transformable object

  Returns void

emergencyStopWarpDrive

• emergencyStopWarpDrive(): void

  Returns void

enableWarpDrive

• enableWarpDrive(): void

  Returns void

engageLandingOnPad

• engageLandingOnPad(landingPad: LandingPad): void

  Parameters

  • landingPad: LandingPad

  Returns void

engageSurfaceLanding

• engageSurfaceLanding(landingTarget: TransformNode): void

  Parameters

  • landingTarget: TransformNode

  Returns void

getClosestWalkableObject

• getClosestWalkableObject(): null | Transformable & HasBoundingSphere

  Returns null | Transformable & HasBoundingSphere

getNearestOrbitalObject

• getNearestOrbitalObject(): null | OrbitalObject

  Returns null | OrbitalObject

getRemainingFuel

• getRemainingFuel(): number

  Returns number

getSpeed

• getSpeed(): number

  Returns the speed of the ship in m/s If warp drive is enabled, returns the warp speed If warp drive is disabled, returns the linear velocity of the ship

  Returns number

  The speed of the ship in m/s

getTargetLandingPad

• getTargetLandingPad(): null | LandingPad

  Returns null | LandingPad

getThrottle

• getThrottle(): number

  Returns number

getTotalFuelCapacity

• getTotalFuelCapacity(): number

  Returns number

getTransform

• getTransform(): TransformNode

  Returns the transform node of the Transformable object

  Returns TransformNode

getWarpDrive

• getWarpDrive(): WarpDrive

  Returns a readonly interface to the warp drive of the ship.

  Returns WarpDrive

  A readonly interface to the warp drive of the ship.

increaseMainEngineThrottle

• increaseMainEngineThrottle(delta: number): void

  Parameters

  • delta: number

  Returns void

isAutoPiloted

• isAutoPiloted(): boolean

  Returns boolean

isLanded

• isLanded(): boolean

  Returns boolean

isLandedAtFacility

• isLandedAtFacility(): boolean

  Returns boolean

isLanding

• isLanding(): boolean

  Returns boolean

isWarpDriveEnabled

• isWarpDriveEnabled(): boolean

  Returns boolean

refuel

• refuel(amount: number): number

  Parameters

  • amount: number

  Returns number

serialize

• serialize(): SerializedSpaceship

  Returns SerializedSpaceship

setClosestWalkableObject

• setClosestWalkableObject(object: Transformable & HasBoundingSphere): void

  Parameters

  • object: Transformable & HasBoundingSphere

  Returns void

setEnabled

• setEnabled(enabled: boolean, havokPlugin: HavokPlugin): void

  Parameters

  • enabled: boolean
  • havokPlugin: HavokPlugin

  Returns void

setMainEngineThrottle

• setMainEngineThrottle(throttle: number): void

  Parameters

  • throttle: number

  Returns void

setNearestCelestialBody

• setNearestCelestialBody(celestialBody: CelestialBody): void

  Parameters

  • celestialBody: CelestialBody

  Returns void

setNearestOrbitalObject

• setNearestOrbitalObject(orbitalObject: OrbitalObject): void

  Parameters

  • orbitalObject: OrbitalObject

  Returns void

spawnOnPad

• spawnOnPad(landingPad: LandingPad): void

  Parameters

  • landingPad: LandingPad

  Returns void

takeOff

• takeOff(): void

  Returns void

toggleWarpDrive

• toggleWarpDrive(): void

  Returns void

update

• update(deltaSeconds: number): void

  Parameters

  • deltaSeconds: number

  Returns void

StaticCreateDefault

• CreateDefault(scene: Scene): Spaceship

  Parameters

  • scene: Scene

  Returns Spaceship

StaticDeserialize

• Deserialize(serializedSpaceship: SerializedSpaceship, scene: Scene): Spaceship

  Parameters

  • serializedSpaceship: SerializedSpaceship
  • scene: Scene

  Returns Spaceship