Weather presets | Parallel 42 Documentation

Flow APIFlow Pro scriptingWeather

This article covers the following platforms

Use the Weather API to list the available weather presets or apply one by name.

`get_presets()`

Get every weather preset available to Flow.

SignatureTypeScript contract

get_presets(): unknown[]

ExampleJavaScript

const presets = this.$api.weather.get_presets();
console.log(presets);

Returns

unknown[]Array of available weather presets.

Apply an available weather preset by name.

SignatureTypeScript contract

set_preset(preset_name: string): void

Parameters

Name	Type	Required	Description
`preset_name`	`string`	Yes	Preset name. Use get_presets() to obtain an available name.

ExampleJavaScript

this.$api.weather.set_preset("Clear Skies");

Returns

voidNo direct return value is documented.