Skip to content

3D Thermals

Turn the simulator's 3D thermals on or off and check their state from Flow Pro scripts.

Updated View as Markdown
For humans
Flow APIFlow Pro scriptingWeather

This article covers the following platforms

Use the Weather API to turn the simulator’s 3D thermals on or off and to check their current state.

set_3d_thermals()

Enable or disable 3D thermals.

SignatureTypeScript contract
set_3d_thermals(state: boolean): void

Parameters

NameTypeRequiredDescription
statebooleanYesDesired 3D-thermals state.
ExampleJavaScript
this.$api.weather.set_3d_thermals(true);

Returns

voidNo direct return value is documented.

get_3d_thermals()

Get the current 3D-thermals state.

SignatureTypeScript contract
get_3d_thermals(): boolean
ExampleJavaScript
const enabled = this.$api.weather.get_3d_thermals();
console.log(enabled);

Returns

booleanWhether 3D thermals are enabled.
Navigation

Type to search…

↑↓ navigate↵ selectEsc close