five-on-it / packages/protocol/src/city / parseWeather

Function: parseWeather()

parseWeather(text): { climate: "none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast"; night?: boolean; script?: { from: number; intensity: number; kind: "clear" | "overcast" | "rain" | "storm" | "fog" | "snow"; ramp: number; until?: number; }; seed: number; type: "weather"; } | undefined

Defined in: packages/protocol/src/city.ts:95

Parses a text frame as the room's weather; undefined when it is not one.

Parameters

text

string

Returns

{ climate: "none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast"; night?: boolean; script?: { from: number; intensity: number; kind: "clear" | "overcast" | "rain" | "storm" | "fog" | "snow"; ramp: number; until?: number; }; seed: number; type: "weather"; } | undefined