Vehicle.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.

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

 

Method Signature

Vehicle.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 = myVehicle1.InShadow(myCelestialObject1);

 

 

See also

Vehicle Object

Vehicle.InShadow