API Hero imprison

Hero imprison

Endpoint: gm.hero.imprison

Syntax

gm.hero.imprison <prisoner> <captor>

Parameters

Parameter	Type	Required	Description
prisoner	string	Yes	Hero to be imprisoned (StringId or partial name match)
captor	string	Yes	Hero who will hold the prisoner (StringId or partial name match)

Example

gm.hero.imprison lord_1_1 lord_2_1

Output:

{Prisoner Name} (ID: lord_1_1) is now imprisoned by {Captor Name}.

NOTE: The captor must have a valid party or settlement to hold prisoners. Returns an error if the hero is already a prisoner or if the captor cannot hold prisoners.

Related Commands

• API-Hero-release - Release from prison
• API-Hero-kill - Kill a hero
• API-Hero-Overview - Hero command overview

Last Updated: 2025-12-16