API Hero open_inventory

Hero open_inventory

Endpoint: gm.hero.open_inventory

Syntax

gm.hero.open_inventory <hero> [otherHero]

Parameters

Parameter	Type	Required	Description
hero	string	Yes	Hero identifier (StringId or partial name match). Displayed in the middle of the inventory screen. Their party's inventory appears on the left side.
otherHero	string	No	Hero identifier (StringId or partial name match). Their party's inventory appears on the right side. Defaults to MainHero (player) if not specified. Alias: other

Description

Opens the native inventory screen for the specified hero, allowing you to view and manage their party's inventory and equipment. The inventory UI displays three panels:

• Left Side - The hero parameter's party inventory
• Middle - The hero parameter's equipment panel
• Right Side - The otherHero parameter's party inventory (defaults to player)

This enables transferring items between any two heroes' parties, equipping items on the target hero, and inspecting inventories without physically visiting the hero in the game world.

Both heroes must belong to a party for the inventory screen to open. The command supports heroes from any clan, including those outside the player's faction, using synthetic roster support.

Examples

Open inventory for a hero (player on right side):

gm.hero.open_inventory lord_1_1

Using named argument:

gm.hero.open_inventory hero:'Hero Name'

Open inventory between two specific heroes:

gm.hero.open_inventory lord_1_1 lord_2_3

Using named arguments for both heroes:

gm.hero.open_inventory hero:'Hero Name' otherHero:'Other Hero'

Using the alias for otherHero:

gm.hero.open_inventory lord_1_1 other:lord_2_3

Output:

Opened inventory for 'Hero Name' (ID: hero_string_id)

Notes

• Both heroes must belong to a party for the inventory to open
• If otherHero is not specified, the player (MainHero) is used as the right-side party
• The command validates that both heroes exist and have party membership before opening
• Works with heroes from any clan, not just the player's faction
• Returns an error if either hero cannot be found or lacks a party

Related Commands

• API-Item-add - Add items to a hero's inventory
• API-Item-remove - Remove items from inventory
• API-Item-transfer - Transfer items between heroes
• API-Hero-equip_hero - Equip hero with skill-based equipment
• API-Hero-Overview - Hero command overview

Last Updated: 2026-02-06