Class Spaceship

Describes all objects that can be moved around, rotated and scaled in the scene

Implements

Transformable

Index

Properties

`Readonly`acceleratingWarpDriveSound

acceleratingWarpDriveSound: ISoundInstance

`Readonly`aggregate

aggregate: PhysicsAggregate

`Readonly`boundingExtent

boundingExtent: Vector3

`Readonly`deceleratingWarpDriveSound

deceleratingWarpDriveSound: ISoundInstance

`Readonly`disableWarpDriveSound

disableWarpDriveSound: ISoundInstance

`Readonly`enableWarpDriveSound

enableWarpDriveSound: ISoundInstance

`Readonly`hyperSpaceSound

hyperSpaceSound: ISoundInstance

`Readonly`hyperSpaceTunnel

hyperSpaceTunnel: HyperSpaceTunnel

`Readonly`id

id: string

`Readonly`instanceRoot

instanceRoot: TransformNode

`Readonly`maxPitchSpeed

maxPitchSpeed: 3 = 3.0

`Readonly`maxRollSpeed

maxRollSpeed: 2 = 2.0

`Readonly`maxYawSpeed

maxYawSpeed: 1 = 1.0

`Readonly`name

name: string

`Readonly`onAutoPilotEngaged

onAutoPilotEngaged: Observable<void> = ...

`Readonly`onFuelScoopEnd

onFuelScoopEnd: Observable<void> = ...

`Readonly`onFuelScoopStart

onFuelScoopStart: Observable<void> = ...

`Readonly`onLandingCancelled

onLandingCancelled: Observable<void> = ...

`Readonly`onLandingObservable

onLandingObservable: Observable<void> = ...

`Readonly`onPlanetaryLandingEngaged

onPlanetaryLandingEngaged: Observable<void> = ...

`Readonly`onTakeOff

onTakeOff: Observable<void> = ...

`Readonly`onWarpDriveDisabled

onWarpDriveDisabled: Observable<boolean> = ...

`Readonly`onWarpDriveEnabled

onWarpDriveEnabled: Observable<void> = ...

`Readonly`shipType

shipType: WANDERER

`Readonly`thrusterSound

thrusterSound: ISoundInstance

`Readonly`warpTunnel

warpTunnel: WarpTunnel

Methods

burnFuel

burnFuel(amount: number): number
Parameters
- amount: number
Returns number
- Defined in src/ts/frontend/spaceship/spaceship.ts:701

cancelLanding

cancelLanding(): void
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:397

disableWarpDrive

disableWarpDrive(): void
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:288

dispose

dispose(soundPlayer: ISoundPlayer): void
Parameters
- soundPlayer: ISoundPlayer
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:755

emergencyStopWarpDrive

emergencyStopWarpDrive(): void
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:301

enableWarpDrive

enableWarpDrive(): void
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:270

engageLandingOnPad

engageLandingOnPad(landingPad: ILandingPad): void
Parameters
- landingPad: ILandingPad
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:373

engageSurfaceLanding

engageSurfaceLanding(landingTarget: TransformNode): void
Parameters
- landingTarget: TransformNode
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:359

getRemainingFuel

getRemainingFuel(): number
Returns number
- Defined in src/ts/frontend/spaceship/spaceship.ts:695

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
- Defined in src/ts/frontend/spaceship/spaceship.ts:334

getTargetLandingPad

getTargetLandingPad(): null | ILandingPad
Returns null | ILandingPad
- Defined in src/ts/frontend/spaceship/spaceship.ts:377

getThrottle

getThrottle(): number
Returns number
- Defined in src/ts/frontend/spaceship/spaceship.ts:342

getTotalFuelCapacity

getTotalFuelCapacity(): number
Returns number
- Defined in src/ts/frontend/spaceship/spaceship.ts:689

getTransform

getTransform(): TransformNode
Returns the transform node of the Transformable object

Returns TransformNode
Implementation of Transformable.getTransform
- Defined in src/ts/frontend/spaceship/spaceship.ts:253

increaseMainEngineThrottle

increaseMainEngineThrottle(delta: number): void
Parameters
- delta: number
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:347

isAutoPiloted

isAutoPiloted(): boolean
Returns boolean
- Defined in src/ts/frontend/spaceship/spaceship.ts:369

isLanded

isLanded(): boolean
Returns boolean
- Defined in src/ts/frontend/spaceship/spaceship.ts:422

isLandedAtFacility

isLandedAtFacility(): boolean
Returns boolean
- Defined in src/ts/frontend/spaceship/spaceship.ts:430

isLanding

isLanding(): boolean
Returns boolean
- Defined in src/ts/frontend/spaceship/spaceship.ts:426

refuel

refuel(amount: number): number
Parameters
- amount: number
Returns number
- Defined in src/ts/frontend/spaceship/spaceship.ts:717

serialize

serialize(): {
    components: {
        optional: [
            | null
            | { quality: number; size: number; type: "discoveryScanner" }
            | { quality: number; size: number; type: "fuelScoop" }
            | {
                currentFuel01: number;
                quality: number;
                size: number;
                type: "fuelTank";
            },
            | null
            | { quality: number; size: number; type: "discoveryScanner" }
            | { quality: number; size: number; type: "fuelScoop" }
            | {
                currentFuel01: number;
                quality: number;
                size: number;
                type: "fuelTank";
            },
            | null
            | { quality: number; size: number; type: "discoveryScanner" }
            | { quality: number; size: number; type: "fuelScoop" }
            | {
                currentFuel01: number;
                quality: number;
                size: number;
                type: "fuelTank";
            },
        ];
        primary: {
            fuelTank: | null
            | {
                currentFuel01: number;
                quality: number;
                size: number;
                type: "fuelTank";
            };
            thrusters: null
            | { quality: number; size: number; type: "thrusters" };
            warpDrive: null | { quality: number; size: number; type: "warpDrive" };
        };
    };
    id: string;
    name: string;
    type: WANDERER;
}
Returns {
    components: {
        optional: [
            | null
            | { quality: number; size: number; type: "discoveryScanner" }
            | { quality: number; size: number; type: "fuelScoop" }
            | {
                currentFuel01: number;
                quality: number;
                size: number;
                type: "fuelTank";
            },
            | null
            | { quality: number; size: number; type: "discoveryScanner" }
            | { quality: number; size: number; type: "fuelScoop" }
            | {
                currentFuel01: number;
                quality: number;
                size: number;
                type: "fuelTank";
            },
            | null
            | { quality: number; size: number; type: "discoveryScanner" }
            | { quality: number; size: number; type: "fuelScoop" }
            | {
                currentFuel01: number;
                quality: number;
                size: number;
                type: "fuelTank";
            },
        ];
        primary: {
            fuelTank: | null
            | {
                currentFuel01: number;
                quality: number;
                size: number;
                type: "fuelTank";
            };
            thrusters: null
            | { quality: number; size: number; type: "thrusters" };
            warpDrive: null | { quality: number; size: number; type: "warpDrive" };
        };
    };
    id: string;
    name: string;
    type: WANDERER;
}
- Defined in src/ts/frontend/spaceship/spaceship.ts:743

setClosestWalkableObject

setClosestWalkableObject(object: Transformable & HasBoundingSphere): void
Parameters
- object: Transformable & HasBoundingSphere
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:249

setEnabled

setEnabled(enabled: boolean, havokPlugin: HavokPlugin): void
Parameters
- enabled: boolean
- havokPlugin: HavokPlugin
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:257

setMainEngineThrottle

setMainEngineThrottle(throttle: number): void
Parameters
- throttle: number
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:324

setNearestCelestialBody

setNearestCelestialBody(celestialBody: CelestialBody): void
Parameters
- celestialBody: CelestialBody
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:266

setNearestOrbitalObject

setNearestOrbitalObject(orbitalObject: OrbitalObject): void
Parameters
- orbitalObject: OrbitalObject
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:262

spawnOnPad

spawnOnPad(landingPad: ILandingPad): void
Parameters
- landingPad: ILandingPad
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:413

takeOff

takeOff(): void
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:434

toggleWarpDrive

toggleWarpDrive(): void
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:314

update

update(deltaSeconds: number): void
Parameters
- deltaSeconds: number
Returns void
- Defined in src/ts/frontend/spaceship/spaceship.ts:579

`Static`CreateDefault

CreateDefault(
    scene: Scene,
    assets: RenderingAssets,
    soundPlayer: ISoundPlayer,
): Spaceship
Parameters
- scene: Scene
- assets: RenderingAssets
- soundPlayer: ISoundPlayer
Returns Spaceship
- Defined in src/ts/frontend/spaceship/spaceship.ts:729

`Static`Deserialize

Deserialize(
    serializedSpaceship: {
        components: {
            optional: [
                | null
                | { quality: number; size: number; type: "discoveryScanner" }
                | { quality: number; size: number; type: "fuelScoop" }
                | {
                    currentFuel01: number;
                    quality: number;
                    size: number;
                    type: "fuelTank";
                },
                | null
                | { quality: number; size: number; type: "discoveryScanner" }
                | { quality: number; size: number; type: "fuelScoop" }
                | {
                    currentFuel01: number;
                    quality: number;
                    size: number;
                    type: "fuelTank";
                },
                | null
                | { quality: number; size: number; type: "discoveryScanner" }
                | { quality: number; size: number; type: "fuelScoop" }
                | {
                    currentFuel01: number;
                    quality: number;
                    size: number;
                    type: "fuelTank";
                },
            ];
            primary: {
                fuelTank: | null
                | {
                    currentFuel01: number;
                    quality: number;
                    size: number;
                    type: "fuelTank";
                };
                thrusters: null
                | { quality: number; size: number; type: "thrusters" };
                warpDrive: null | { quality: number; size: number; type: "warpDrive" };
            };
        };
        id: string;
        name: string;
        type: WANDERER;
    },
    unfitComponents: Set<
        | { quality: number; size: number; type: "discoveryScanner" }
        | { quality: number; size: number; type: "fuelScoop" }
        | {
            currentFuel01: number;
            quality: number;
            size: number;
            type: "fuelTank";
        }
        | { quality: number; size: number; type: "thrusters" }
        | { quality: number; size: number; type: "warpDrive" },
    >,
    scene: Scene,
    assets: RenderingAssets,
    soundPlayer: ISoundPlayer,
): Spaceship
Parameters
- serializedSpaceship: {
      components: {
          optional: [
              | null
              | { quality: number; size: number; type: "discoveryScanner" }
              | { quality: number; size: number; type: "fuelScoop" }
              | {
                  currentFuel01: number;
                  quality: number;
                  size: number;
                  type: "fuelTank";
              },
              | null
              | { quality: number; size: number; type: "discoveryScanner" }
              | { quality: number; size: number; type: "fuelScoop" }
              | {
                  currentFuel01: number;
                  quality: number;
                  size: number;
                  type: "fuelTank";
              },
              | null
              | { quality: number; size: number; type: "discoveryScanner" }
              | { quality: number; size: number; type: "fuelScoop" }
              | {
                  currentFuel01: number;
                  quality: number;
                  size: number;
                  type: "fuelTank";
              },
          ];
          primary: {
              fuelTank: | null
              | {
                  currentFuel01: number;
                  quality: number;
                  size: number;
                  type: "fuelTank";
              };
              thrusters: null
              | { quality: number; size: number; type: "thrusters" };
              warpDrive: null | { quality: number; size: number; type: "warpDrive" };
          };
      };
      id: string;
      name: string;
      type: WANDERER;
  }
- unfitComponents: Set<
      | { quality: number; size: number; type: "discoveryScanner" }
      | { quality: number; size: number; type: "fuelScoop" }
      | {
          currentFuel01: number;
          quality: number;
          size: number;
          type: "fuelTank";
      }
      | { quality: number; size: number; type: "thrusters" }
      | { quality: number; size: number; type: "warpDrive" },
  >
- scene: Scene
- assets: RenderingAssets
- soundPlayer: ISoundPlayer
Returns Spaceship
- Defined in src/ts/frontend/spaceship/spaceship.ts:733

Class Spaceship

Implements

Index

Properties

Methods

Properties

ReadonlyacceleratingWarpDriveSound

Readonlyaggregate

ReadonlyboundingExtent

ReadonlydeceleratingWarpDriveSound

ReadonlydisableWarpDriveSound

ReadonlyenableWarpDriveSound

ReadonlyhyperSpaceSound

ReadonlyhyperSpaceTunnel

Readonlyid

ReadonlyinstanceRoot

ReadonlymaxPitchSpeed

ReadonlymaxRollSpeed

ReadonlymaxYawSpeed

Readonlyname

ReadonlyonAutoPilotEngaged

ReadonlyonFuelScoopEnd

ReadonlyonFuelScoopStart

ReadonlyonLandingCancelled

ReadonlyonLandingObservable

ReadonlyonPlanetaryLandingEngaged

ReadonlyonTakeOff

ReadonlyonWarpDriveDisabled

ReadonlyonWarpDriveEnabled

ReadonlyshipType

ReadonlythrusterSound

ReadonlywarpTunnel

Methods

burnFuel

Parameters

Returns number

cancelLanding

Returns void

disableWarpDrive

Returns void

dispose

Parameters

Returns void

emergencyStopWarpDrive

Returns void

enableWarpDrive

Returns void

engageLandingOnPad

Parameters

Returns void

engageSurfaceLanding

Parameters

Returns void

getClosestWalkableObject

Returns null | Transformable & HasBoundingSphere

getInternals

Returns SpaceshipInternals

getNearestOrbitalObject

Returns null | OrbitalObject

getRemainingFuel

Returns number

getSpeed

Returns number

getTargetLandingPad

Returns null | ILandingPad

getThrottle

Returns number

getTotalFuelCapacity

Returns number

getTransform

Returns TransformNode

increaseMainEngineThrottle

Parameters

Returns void

isAutoPiloted

Returns boolean

isLanded

Returns boolean

isLandedAtFacility

Returns boolean

`Readonly`acceleratingWarpDriveSound

`Readonly`aggregate

`Readonly`boundingExtent

`Readonly`deceleratingWarpDriveSound

`Readonly`disableWarpDriveSound

`Readonly`enableWarpDriveSound

`Readonly`hyperSpaceSound

`Readonly`hyperSpaceTunnel

`Readonly`id

`Readonly`instanceRoot

`Readonly`maxPitchSpeed

`Readonly`maxRollSpeed

`Readonly`maxYawSpeed

`Readonly`name

`Readonly`onAutoPilotEngaged

`Readonly`onFuelScoopEnd

`Readonly`onFuelScoopStart

`Readonly`onLandingCancelled

`Readonly`onLandingObservable

`Readonly`onPlanetaryLandingEngaged

`Readonly`onTakeOff

`Readonly`onWarpDriveDisabled

`Readonly`onWarpDriveEnabled

`Readonly`shipType

`Readonly`thrusterSound

`Readonly`warpTunnel

`Static`CreateDefault

`Static`Deserialize