Skip to content

Add Weather

Add Weather

Adds a weather effect from the database to the current map scene.

Properties

System

Name Explanation Type
Input Switches The input switches to pass to the weather effect. Switch or Value
Input Variables The input variables to pass to the weather effect. Variable or Value
Result The variable to store the weather effect's unique ID in. Variable or Value
Skip Enter Script Whether to skip the weather effect's enter script when adding it. Toggle
Store ID Whether to store the weather effect's unique ID in a variable for later reference. Toggle
Weather The index of the weather effect in the database to add. Variable or Value

Examples

Add Weather Effect from Database Index 5

This adds the weather effect at database index 5 to the current map.

add_weather(5);

{"Data":{"InputSwitches":[],"InputVariables":[],"Result":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"SkipEnterScript":false,"StoreID":false,"WeatherIndex":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"5","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Map.MapWeatherAddCommand"}

Add Weather with Input Data, Skipping Enter Script

This adds the weather effect at database index 5, passing in switch and variable inputs, and skipping the weather's enter script.

add_weather(5, switches: [true, false], variables: [100, $gv[0]], skip_script);

{"Data":{"InputSwitches":[{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"SwitchIndex":0,"Value":true},{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"SwitchIndex":0,"Value":false}],"InputVariables":[{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"100","VariableIndex":0,"Metadata":null},{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null}],"Result":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"SkipEnterScript":true,"StoreID":false,"WeatherIndex":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"5","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Map.MapWeatherAddCommand"}