Class ShipControls

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

Implements

Controls

Constructors

constructor

new ShipControls(
    spaceship: Spaceship,
    scene: Scene,
    soundPlayer: ISoundPlayer,
    tts: ITts,
): ShipControls
Parameters
- spaceship: Spaceship
- scene: Scene
- soundPlayer: ISoundPlayer
- tts: ITts
Returns ShipControls
- Defined in src/ts/frontend/spaceship/shipControls.ts:91

Properties

`Readonly`firstPersonCamera

firstPersonCamera: FreeCamera

`Readonly`onCompleteLanding

onCompleteLanding: Observable<void> = ...

`Readonly`onToggleWarpDrive

onToggleWarpDrive: Observable<boolean> = ...

`Readonly`thirdPersonCamera

thirdPersonCamera: ArcRotateCamera

`Readonly`thirdPersonCameraDefaultAlpha

thirdPersonCameraDefaultAlpha: number = ...

`Readonly`thirdPersonCameraDefaultBeta

thirdPersonCameraDefaultBeta: number = ...

`Readonly`thirdPersonCameraDefaultRadius

thirdPersonCameraDefaultRadius: 60

`Readonly`thirdPersonCameraTransform

thirdPersonCameraTransform: TransformNode

Methods

dispose

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

getActiveCamera

getActiveCamera(): Camera
Returns the camera used by the controls.

Returns Camera
Implementation of Controls.getActiveCamera
- Defined in src/ts/frontend/spaceship/shipControls.ts:290

getCameras

getCameras(): Camera[]
Returns Camera[]
Implementation of Controls.getCameras
- Defined in src/ts/frontend/spaceship/shipControls.ts:294

getClosestLandableFacility

getClosestLandableFacility(): | null
| Transformable & HasBoundingSphere & ManagesLandingPads
Returns null | Transformable & HasBoundingSphere & ManagesLandingPads
- Defined in src/ts/frontend/spaceship/shipControls.ts:302

getSpaceship

getSpaceship(): Spaceship
Returns Spaceship
- Defined in src/ts/frontend/spaceship/shipControls.ts:500

getTransform

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

Returns TransformNode
Implementation of Controls.getTransform
- Defined in src/ts/frontend/spaceship/shipControls.ts:282

reset

reset(): void
Returns void
- Defined in src/ts/frontend/spaceship/shipControls.ts:407

setClosestLandableFacility

setClosestLandableFacility(
facility: null | Transformable & HasBoundingSphere & ManagesLandingPads,
): void
Parameters
- facility: null | Transformable & HasBoundingSphere & ManagesLandingPads
Returns void
- Defined in src/ts/frontend/spaceship/shipControls.ts:298

setSpaceship

setSpaceship(ship: Spaceship): void
Parameters
- ship: Spaceship
Returns void
- Defined in src/ts/frontend/spaceship/shipControls.ts:413

shouldLockPointer

shouldLockPointer(): boolean
Returns boolean
Implementation of Controls.shouldLockPointer
- Defined in src/ts/frontend/spaceship/shipControls.ts:286

syncCameraTransform

syncCameraTransform(): void
Returns void
- Defined in src/ts/frontend/spaceship/shipControls.ts:403

update

update(deltaSeconds: number): Vector3
Makes the controller listen to all its inputs and returns the displacement to apply to the player
Parameters
- deltaSeconds: number
  the time between 2 frames
Returns Vector3
Implementation of Controls.update
- Defined in src/ts/frontend/spaceship/shipControls.ts:306

`Static`CreateDefault

CreateDefault(
    scene: Scene,
    assets: RenderingAssets,
    tts: ITts,
    soundPlayer: ISoundPlayer,
): ShipControls
Parameters
- scene: Scene
- assets: RenderingAssets
- tts: ITts
- soundPlayer: ISoundPlayer
Returns ShipControls
- Defined in src/ts/frontend/spaceship/shipControls.ts:504