GroundVehicle.InShadow(Variable) Method

Top 

Description

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

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

 

Method Signature

GroundVehicle.InShadow(

Variable occultingBodyID)

 

Arguments

occultingBodyID


Description:

BodyID of a 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(myVariable2);

 

See also

GroundVehicle Object

GroundVehicle.InShadow