FutureProg functions
celestialelevation
Overload 1
celestialelevation overload 1
Number celestialelevation(Location locationOrZone, Number celestialId)
Available in
- computer function
- computer program
- standard futureprog
Looks up a celestial object by ID in the supplied room or zone and returns its current elevation above or below the horizon in radians. Positive values are above the horizon. Returns 0 if the zone or celestial object cannot be found.
| Parameter | Type | Description |
|---|---|---|
locationOrZone |
Location |
The room or zone whose celestial collection is searched. |
celestialId |
Number |
The ID of the celestial object to inspect. |
Overload 2
celestialelevation overload 2
Number celestialelevation(Zone locationOrZone, Number celestialId)
Available in
- computer function
- computer program
- standard futureprog
Looks up a celestial object by ID in the supplied room or zone and returns its current elevation above or below the horizon in radians. Positive values are above the horizon. Returns 0 if the zone or celestial object cannot be found.
| Parameter | Type | Description |
|---|---|---|
locationOrZone |
Zone |
The room or zone whose celestial collection is searched. |
celestialId |
Number |
The ID of the celestial object to inspect. |