API Settlement set_prosperity

gm.settlement.set_prosperity

Endpoint: gm.settlement.set_prosperity

Syntax

gm.settlement.set_prosperity <settlement> <value>

Parameters

Parameter	Type	Required	Description
settlement	string	Yes	Settlement identifier (StringId or partial name match)
value	integer	Yes	Prosperity value (range: 0-20000)

Description

Sets the prosperity level for a city or castle. Prosperity represents economic development, population wealth, and settlement growth. Higher prosperity increases tax income, improves available goods in markets, and enhances settlement economic output. However, high prosperity also makes settlements more attractive targets for conquest.

NOTE: This command only works for cities and castles. Villages use hearths instead (see gm.settlement.set_hearths).

Example

gm.settlement.set_prosperity pen 15000

Output:

Set prosperity for {Settlement Name} to 15000.
Previous prosperity: {old_value}

Value Guidelines

• 0-5000 - Poor settlement, minimal economic activity
• 5000-10000 - Developing settlement, moderate trade
• 10000-15000 - Prosperous settlement, strong economy
• 15000-20000 - Extremely wealthy settlement, maximum economic output

Related Commands

• API-Settlement-set_hearths - Set village hearth value (village equivalent)
• API-Settlement-set_loyalty - Set settlement loyalty
• API-Settlement-give_gold - Add gold to settlement treasury
• API-Settlement-Overview - All settlement commands

Last Updated: 2025-12-17