Spacecraft.OrbitPeriapsis(String) Method

Top

Description

Returns the point in the orbit where the Spacecraft is at its closest approach to the celestial body represented by referenceBodyName.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Note: This is a Stop-Propagation method. See the Stop-Propagation Properties and Methods page for more information.

Note: This method has a state. See the Methods and Properties with State page for more information.

Method Signature

Spacecraft.OrbitPeriapsis(

String referenceBodyName)

Arguments

referenceBodyName
Description:	A String containing the name of the celestial object to use when looking for periapsis.

Return Value

Type:	number
Units:	km

Returns the point in the orbit where the Spacecraft is at its closest approach to a Planet, Moon, or CelestialObject.

Syntax

Step mySpacecraft1 to ( mySpacecraft1.OrbitPeriapsis(myString1));