Spacecraft.Occult(Spacecraft) Method

Top

Description

Returns a 1 when the referencePositionSpacecraft is occulted or 0 when it is not. When multiple objects are specified, the method returns a '1' if any of the objects are occulted and '0' if none are occulted.

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.Occult(

Spacecraft referencePositionSpacecraft)

Arguments

referencePositionSpacecraft
Description:	Spacecraft to check for occultation with the calling Spacecraft.
Repeatable:	1 to 30 times

Return Value

Type:

boolean

Returns a 1 when the object is occulted or 0 when it is not. When multiple objects are specified, the method returns a '1' if any of the objects are occulted and '0' if none are occulted.

Syntax

myVariable1 = mySpacecraft1.Occult(mySpacecraft2);