API Hero edit_party

Hero edit_party

Endpoint: gm.hero.edit_party

Syntax

gm.hero.edit_party <rightSideHero> [leftSideHero]

Parameters

Parameter	Type	Required	Description
rightSideHero	string	Yes	Hero identifier (StringId or partial name match). Their party appears on the right side of the party editor. Alias: hero
leftSideHero	string	No	Hero identifier (StringId or partial name match). Their party appears on the left side for troop transfer. Alias: other. If omitted, the left side is populated with all game troops (100 each) as a discard roster.

Description

Opens the native party editor UI for the specified hero's party. The party editor allows you to manage troop composition by adding, removing, and reorganizing troops within a party.

The command operates in two modes:

Transfer Mode (Two Heroes)

When both rightSideHero and leftSideHero are specified, the party editor opens with both heroes' parties side by side, allowing you to transfer troops between them. The left side displays leftSideHero's party and the right side displays rightSideHero's party.

Discard Mode (One Hero)

When only rightSideHero is specified, the left side is populated with a discard roster containing 100 of every troop type in the game. This allows you to freely add any troop to the hero's party or remove troops from it. The discard roster is available regardless of cheat mode settings.

The rightSideHero must belong to a party for the command to work. If leftSideHero is specified but cannot be found, the command returns an error rather than falling back to discard mode.

Examples

Open party editor in discard mode (all game troops on left):

gm.hero.edit_party player

Open party editor for a specific hero by StringId:

gm.hero.edit_party lord_1_1

Open party editor using hero name with single quotes:

gm.hero.edit_party 'Ira of the Vaegir'

Open party editor using single word hero name or partial hero name:

gm.hero.edit_party derthert

Using named argument:

gm.hero.edit_party hero:lord_1_1

Transfer mode - move troops between two heroes:

gm.hero.edit_party player lord_4_1

Transfer mode with named arguments:

gm.hero.edit_party hero:player other:'Ira of the Vaegir'

Output:

Opened party editor for 'Hero Name' (ID: hero_string_id)
Left side: All game troops (discard) | Right side: Hero Name's party

Notes

• The rightSideHero must belong to a party or the command will return an error
• In discard mode, 100 of every troop in the game is available regardless of cheat mode settings
• If leftSideHero is specified but not found, the command returns an error (does not fall back to discard mode)
• If leftSideHero is omitted entirely, discard mode is used automatically
• Supports both named and positional arguments
• Single quotes are required for hero names containing spaces

Related Commands

• API-Hero-create_party - Create a party for a hero
• API-Hero-add_hero_to_party - Add a hero to another's party
• API-Hero-open_inventory - Open native inventory screen for a hero
• API-Troop-add_basic - Add basic troops to a hero's party
• API-Troop-add_elite - Add elite troops to a hero's party
• API-Hero-Overview - Hero command overview

Last Updated: 2026-02-17