IMyShipController.TryGetPlanetElevation Method

IMyShipControllerTryGetPlanetElevation Method

v01.180.0 (Beta)

[This is preliminary documentation and is subject to change.]

Attempts to get the elevation of the ship in relation to the nearest planet. This method is only available when a ship is within the gravity well of a planet.

Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

bool TryGetPlanetElevation(
	MyPlanetElevation detail,
	out double elevation
)

Function TryGetPlanetElevation ( 
	detail As MyPlanetElevation,
	<OutAttribute> ByRef elevation As Double
) As Boolean

bool TryGetPlanetElevation(
	MyPlanetElevation detail, 
	[OutAttribute] double% elevation
)

abstract TryGetPlanetElevation : 
        detail : MyPlanetElevation * 
        elevation : float byref -> bool

Parameters

detail: Type: Sandbox.ModAPI.IngameMyPlanetElevation
elevation: Type: SystemDouble

Return Value

Type: Boolean

Reference

IMyShipController Interface

Sandbox.ModAPI.Ingame Namespace