Delete Weather

Delete Weather

Removes a specific weather effect from the map scene by its unique ID.

Properties

System

Name	Explanation	Type
Apply Immediately	Whether the weather effect ends immediately without a transition.	Toggle
Skip Exit Script	Whether to skip the weather effect's exit script when deleting it.	Toggle
Weather Unique ID	The unique ID of the weather effect to remove. This is the ID returned when the weather effect was added.	Variable or Value

Examples

Delete a Specific Weather Instance by Unique ID

This removes the weather instance identified by the Unique ID stored in Global Variable 0.

Code ScriptVisual Script

delete_weather($gv[0]);

{"Data":{"IsImmediate":false,"SkipExitScript":false,"Target":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Map.MapWeatherDeleteCommand"}

Delete Weather Immediately, Skipping Exit Script

This immediately removes the weather instance from Global Variable 0, skipping the exit script.

Code ScriptVisual Script

delete_weather($gv[0], immediate, skip_script);

{"Data":{"IsImmediate":true,"SkipExitScript":true,"Target":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Map.MapWeatherDeleteCommand"}