FutureProg functions
nextsunset
Overload 1
nextsunset overload 1
MudDateTime nextsunset(Location locationOrZone, CelestialObject celestial, Calendar calendar)
Available in
- computer function
- computer program
- standard futureprog
Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.
| Parameter | Type | Description |
|---|---|---|
locationOrZone |
Location |
The room or zone whose geography is used as the observer location. |
celestial |
CelestialObject |
The resolved solar celestial. |
calendar |
Calendar |
The calendar used to display the returned mud datetime. |
Overload 2
nextsunset overload 2
MudDateTime nextsunset(Location locationOrZone, CelestialObject celestial, Calendar calendar, Number occurrence)
Available in
- computer function
- computer program
- standard futureprog
Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.
| Parameter | Type | Description |
|---|---|---|
locationOrZone |
Location |
The room or zone whose geography is used as the observer location. |
celestial |
CelestialObject |
The resolved solar celestial. |
calendar |
Calendar |
The calendar used to display the returned mud datetime. |
occurrence |
Number |
The nth next occurrence to return. |
Overload 3
nextsunset overload 3
MudDateTime nextsunset(Location locationOrZone, Number celestialId, Calendar calendar)
Available in
- computer function
- computer program
- standard futureprog
Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.
| Parameter | Type | Description |
|---|---|---|
locationOrZone |
Location |
The room or zone whose geography is used as the observer location. |
celestialId |
Number |
The ID of the solar celestial. |
calendar |
Calendar |
The calendar used to display the returned mud datetime. |
Overload 4
nextsunset overload 4
MudDateTime nextsunset(Location locationOrZone, Number celestialId, Calendar calendar, Number occurrence)
Available in
- computer function
- computer program
- standard futureprog
Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.
| Parameter | Type | Description |
|---|---|---|
locationOrZone |
Location |
The room or zone whose geography is used as the observer location. |
celestialId |
Number |
The ID of the solar celestial. |
calendar |
Calendar |
The calendar used to display the returned mud datetime. |
occurrence |
Number |
The nth next occurrence to return. |
Overload 5
nextsunset overload 5
MudDateTime nextsunset(Zone locationOrZone, CelestialObject celestial, Calendar calendar)
Available in
- computer function
- computer program
- standard futureprog
Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.
| Parameter | Type | Description |
|---|---|---|
locationOrZone |
Zone |
The room or zone whose geography is used as the observer location. |
celestial |
CelestialObject |
The resolved solar celestial. |
calendar |
Calendar |
The calendar used to display the returned mud datetime. |
Overload 6
nextsunset overload 6
MudDateTime nextsunset(Zone locationOrZone, CelestialObject celestial, Calendar calendar, Number occurrence)
Available in
- computer function
- computer program
- standard futureprog
Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.
| Parameter | Type | Description |
|---|---|---|
locationOrZone |
Zone |
The room or zone whose geography is used as the observer location. |
celestial |
CelestialObject |
The resolved solar celestial. |
calendar |
Calendar |
The calendar used to display the returned mud datetime. |
occurrence |
Number |
The nth next occurrence to return. |
Overload 7
nextsunset overload 7
MudDateTime nextsunset(Zone locationOrZone, Number celestialId, Calendar calendar)
Available in
- computer function
- computer program
- standard futureprog
Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.
| Parameter | Type | Description |
|---|---|---|
locationOrZone |
Zone |
The room or zone whose geography is used as the observer location. |
celestialId |
Number |
The ID of the solar celestial. |
calendar |
Calendar |
The calendar used to display the returned mud datetime. |
Overload 8
nextsunset overload 8
MudDateTime nextsunset(Zone locationOrZone, Number celestialId, Calendar calendar, Number occurrence)
Available in
- computer function
- computer program
- standard futureprog
Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.
| Parameter | Type | Description |
|---|---|---|
locationOrZone |
Zone |
The room or zone whose geography is used as the observer location. |
celestialId |
Number |
The ID of the solar celestial. |
calendar |
Calendar |
The calendar used to display the returned mud datetime. |
occurrence |
Number |
The nth next occurrence to return. |