Skip to content

Add Character

Add Character

Creates a new character and adds them to the active or inactive party.

Properties

System

Name Explanation Type
Add to Active Party Whether to add the character to the active party. When disabled, the character is added to the inactive (reserve) party instead. Switch or Value
Add to Scene Whether the character is immediately added to the current scene. When enabled, the party display on the map updates right away. Toggle
Character The database character to add to the party. Variable or Value
Global Whether to store the unique ID in a global variable. Toggle
Local Whether to store the unique ID in a local variable. Toggle
Store ID Whether to store the new character's unique ID in a variable. This allows the character to be referenced later by their unique ID. Toggle
Variable Index The variable index to store the character's unique ID in. Number

Examples

Add a Character to the Active Party

This creates a new character from database index stored in Global Variable 0 and adds them to the active party.

add_character($gv[0]);

{"Data":{"AddToActiveParty":true,"Character":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"Index":0,"IsLocal":false,"IsReflectedImmediately":false,"StoreID":false,"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Party.AddCharacterCommand"}

Add a Character to the Inactive Party

This creates a new character and adds them to the inactive (reserve) party instead of the active party.

add_character($gv[0], active: false);

{"Data":{"AddToActiveParty":false,"Character":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"Index":0,"IsLocal":false,"IsReflectedImmediately":false,"StoreID":false,"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Party.AddCharacterCommand"}

Add a Character and Store the Unique Identifier

This creates a new character, adds them to the active party with immediate scene reflection, and stores their unique identifier in Global Variable 0.

$gv[0] = add_character(1, immediate);

{"Data":{"AddToActiveParty":true,"Character":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"Index":0,"IsLocal":false,"IsReflectedImmediately":true,"StoreID":true,"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.Party.AddCharacterCommand"}