EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Effects

set_weather

Override the weather of a map for a positive duration; afterwards the profile weather returns.

Feature
world
Rights
host_world
Debits
none
Conflict
replacing
Errors
invalid_type faultmissing_reference faultout_of_range faultprecondition_failed rejectionscope_denied faultstale_reference rejectionunknown_field fault

Signature

{ duration_ticks: PositiveTicks, kind: "set_weather", map: MapRef, weather: WeatherId }

Fields

NameTypeMeaning
duration_ticksPositiveTicksDuration of the override.
Range: 1…2147483647; Unit: tick
kind"set_weather"Discriminant
mapMapRefMap whose weather is set.
Length: 1…256; Pattern: ^[\s\S]+$
weatherWeatherIdWeather of the override.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: weather

Validated example

{
  "duration_ticks": 75,
  "kind": "set_weather",
  "map": "m1",
  "weather": "core:hill_golem_storm"
}