API Settlement reset_names

Settlement Name Reset Commands

Category: Settlement Management

Commands

gm.settlement.reset_name

Resets a single settlement to its original name.

Syntax:

gm.settlement.reset_name <settlement>

Parameters:

Parameter	Type	Required	Description
settlement	string	Yes	Settlement identifier (StringId or partial name match)

Example:

gm.settlement.reset_name pen

Output:

Settlement name reset from 'New Penraic' to 'Penraic' (original: 'Penraic') (ID: town_EN1).

---

gm.settlement.reset_all_names

Resets all renamed settlements to their original names.

Syntax:

gm.settlement.reset_all_names

Parameters: None

Example:

gm.settlement.reset_all_names

Output:

Reset 5 settlement(s) to their original names.

---

Description

These commands restore settlements to their original game names after they have been renamed using gm.settlement.rename. The system tracks all renamed settlements and can restore them individually or all at once.

Name Tracking: The mod maintains a persistent record of:

• Original settlement names
• Current custom names
• Which settlements have been renamed

Save Persistence: Name resets are saved with your game and persist through save/load cycles.

Usage Examples

Reset Single Settlement

# Rename a settlement
gm.settlement.rename pen 'Castle of Heroes'

# Later, reset it back
gm.settlement.reset_name pen

Reset All Settlements

# After renaming multiple settlements
gm.settlement.rename pen 'New Penraic'
gm.settlement.rename pravend 'Pravend City'
gm.settlement.rename vostrum 'Imperial Capital'

# Reset all at once
gm.settlement.reset_all_names

Check Before Reset

# Query to see current name
gm.query.settlement pen --details

# Reset if needed
gm.settlement.reset_name pen

Usage Tips

Selective Reset: Use reset_name to restore individual settlements while keeping others renamed:

gm.settlement.reset_name pen        # Reset only Penraic
gm.settlement.reset_name pravend    # Reset only Pravend

Bulk Reset: Use reset_all_names to restore all settlements in one command:

gm.settlement.reset_all_names       # Resets everything

No Changes Message: If you try to reset a settlement that hasn't been renamed:

ERROR: Settlement 'Penraic' (ID: town_EN1) has not been renamed.

Empty Reset: If no settlements have been renamed:

No settlements have been renamed.

Finding Renamed Settlements: Currently there's no direct query to list renamed settlements, but you can:

1. Keep track of your renames manually
2. Use reset_all_names to clear everything
3. Rename again selectively

Related Commands

• gm.settlement.rename - Rename a settlement
• API-Settlement-Overview - All settlement commands
• gm.query.settlement - Find settlements

Notes

Original Names: The system stores the original name when first renaming a settlement. Subsequent renames don't change the stored original name.

Display Updates: After resetting, the map label updates follow the same timing as renaming (may require visiting settlement or save/load).

Cannot Reset Non-Renamed: The reset command only works on settlements that have been renamed through the mod. You cannot "reset" a settlement to a different name than its original.

Last Updated: 2025-12-18