Save State

Save State

Saves the current game state to the specified index, including optional data such as pictures, weather, and system settings.

Properties

System

Name	Explanation	Type
Is Visible	Whether the save state is visible when listing saved games.	Switch or Value
Result	The switch to store whether the save operation succeeded.	Switch or Value
Save Background Effects	When enabled, background effects playing at the time of saving are included in the save state.	Switch or Value
Save Pictures	When enabled, pictures displayed at the time of saving are included in the save state.	Switch or Value
Save Video and Audio Settings	When enabled, video and audio system settings are included in the save state.	Switch or Value
Save Weather	When enabled, active weather effects are included in the save state.	Switch or Value
State Index	The index of the save slot to write the game state to.	Variable or Value
Store Results	When enabled, the result of the save operation is stored in a switch.	Toggle
Tags	Key-value tags to associate with the save state for identification or filtering.	Tags
Title	The display title for the save state.	Variable or Value

Examples

Save the Game State to Slot 1

This saves the current game state to save slot 1.

Code ScriptVisual Script

save_state(1);

{"Data":{"IncludeBackgroundEffects":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":false,"SwitchIndex":0,"Metadata":null},"IncludePictures":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":false,"SwitchIndex":0,"Metadata":null},"IncludeSystemSettings":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":false,"SwitchIndex":0,"Metadata":null},"IncludeWeather":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":false,"SwitchIndex":0,"Metadata":null},"IsVisible":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"Result":{"IsGlobalSwitch":true,"IsLocalSwitch":false,"IsValue":false,"Value":false,"SwitchIndex":0,"Metadata":null},"StateIndex":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"StoreResults":false,"Tags":{},"Title":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.StateData.SaveStateCommand"}

Save the Game State with a Title and Pictures

This saves the current game state to the slot specified by Global Variable 0, with a custom title and including pictures.

Code ScriptVisual Script

$gs[0] = save_state($gv[0], title: "My Save", include_pictures);

{"Data":{"IncludeBackgroundEffects":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":false,"SwitchIndex":0,"Metadata":null},"IncludePictures":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"IncludeSystemSettings":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":false,"SwitchIndex":0,"Metadata":null},"IncludeWeather":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":false,"SwitchIndex":0,"Metadata":null},"IsVisible":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"Result":{"IsGlobalSwitch":true,"IsLocalSwitch":false,"IsValue":false,"Value":false,"SwitchIndex":0,"Metadata":null},"StateIndex":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"StoreResults":true,"Tags":{},"Title":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"My Save","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.StateData.SaveStateCommand"}

Save the Game State with All Optional Data Included

This saves the game state to slot 0, including pictures, weather, background effects, and system settings, with a title from Global Variable 1.

Code ScriptVisual Script

save_state(0, title: $gv[1], include_bg_effects, include_pictures, include_system, include_weather);

{"Data":{"IncludeBackgroundEffects":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"IncludePictures":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"IncludeSystemSettings":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"IncludeWeather":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"IsVisible":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"Result":{"IsGlobalSwitch":true,"IsLocalSwitch":false,"IsValue":false,"Value":false,"SwitchIndex":0,"Metadata":null},"StateIndex":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"StoreResults":false,"Tags":{},"Title":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":1,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.StateData.SaveStateCommand"}