GroundVehicle.InShadow(CelestialObject) Method

Top 

Description

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

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

 

Method Signature

GroundVehicle.InShadow(

CelestialObject occultingCelestialObject)

 

Arguments

occultingCelestialObject


Description:

CelestialObject to use when determining the calling Vehicle's shadow state.

Repeatable:

1 to Unlimited times

 

 

Return Value

Type:

boolean

 

Returns a value of 1 when the Vehicle is in shadow and a 0 if it is not.

 

Syntax

myVariable1 = myGroundVehicle1.InShadow(myCelestialObject1);

 

See also

GroundVehicle Object

GroundVehicle.InShadow