GroundVehicle.InShadow Method

 Top 

Description

Returns an integer value indicating whether the Vehicle is in shadow. A value of 1 is returned when the Vehicle is in shadow, and a 0 is returned if it is not.

 

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.

 

Overload List

Signatures

Return Value

Description

GroundVehicle.InShadow()

Variable

Only the Vehicle's CentralBody will be considered in shadow calculations.

GroundVehicle.InShadow(CelestialObject occultingCelestialObject)

Variable

Returns true if the calling Spacecraft is in the shadow of any of the specified CelestialObjects at the Vehicle's Epoch.

GroundVehicle.InShadow(Variable occultingBodyID)

Variable

Returns true if the calling Vehicle is in the shadow of any of the CelestialObjects specified by their BodyID at the Vehicle's Epoch.

 

 

See also

GroundVehicle Object