Skip to content

Restore Party

Restore Party

Restores all party members to full health and removes status effects.

Properties

System

Name Explanation Type
Clear Status Effects Whether to remove all status effects from party members. Switch or Value
Include Inactive Members Whether to also restore inactive (reserve) party members. Switch or Value
Restore Statistics Whether to restore statistics such as health and mana to their maximum values. Switch or Value

Examples

Fully Restore the Entire Party

This restores all party members, including inactive members, to full health and removes all status effects.

restore_party(true, true, true);

{"Data":{"IncludeInactiveMembers":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"IncludeStatistics":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"IncludeStatus":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Party.RestorePartyCommand"}

Restore Only Active Party Members

This restores only the active party members to full health and removes status effects, excluding inactive members.

restore_party(false, true, true);

{"Data":{"IncludeInactiveMembers":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":false,"SwitchIndex":0,"Metadata":null},"IncludeStatistics":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"IncludeStatus":{"IsGlobalSwitch":false,"IsLocalSwitch":false,"IsValue":true,"Value":true,"SwitchIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Party.RestorePartyCommand"}

Restore Party Using Global Switches

This restores the party with all three options controlled by Global Switches 0, 1, and 2.

restore_party($gs[0], $gs[1], $gs[2]);

{"Data":{"IncludeInactiveMembers":{"IsGlobalSwitch":true,"IsLocalSwitch":false,"IsValue":false,"Value":false,"SwitchIndex":0,"Metadata":null},"IncludeStatistics":{"IsGlobalSwitch":true,"IsLocalSwitch":false,"IsValue":false,"Value":false,"SwitchIndex":1,"Metadata":null},"IncludeStatus":{"IsGlobalSwitch":true,"IsLocalSwitch":false,"IsValue":false,"Value":false,"SwitchIndex":2,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Party.RestorePartyCommand"}