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

Method Signature

Spacecraft.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 = mySpacecraft1.InShadow(myVariable2);