Skip to content

API Bandit clear_hideouts

SolWayward edited this page Jan 7, 2026 · 1 revision

Bandit clear_hideouts

Endpoint: gm.bandit.clear_hideouts

Syntax

gm.bandit.clear_hideouts <banditType> [count]

Parameters

Parameter Type Required Description
banditType string Yes Bandit type(s) for hideouts to clear. Use 'all', single type, or comma-separated list
count int No Number of hideouts to clear. Omit to clear ALL matching hideouts

Valid Bandit Types

  • all - All bandit types
  • looters - Basic bandits
  • deserters, desert, desert_bandits - Deserter bandits
  • forest, forest_bandits - Forest bandits
  • mountain, mountain_bandits - Mountain bandits
  • sea_raiders, sea - Sea raiders
  • steppe, steppe_bandits - Steppe bandits
  • corsairs, southern_pirates, pirates - Corsairs (Warsails DLC only)

Named Arguments

Supports named argument notation:

  • banditType:<value> or type:<value> - Specify bandit type
  • count:<value> - Specify count limit

Examples

Example 1: Clear All Forest Bandit Hideouts

gm.bandit.clear_hideouts forest

Output:

Cleared 3 bandit hideouts (all).
Types: Forest Bandits

Remaining Counts:
Total Parties: 42
Total Hideouts: 9
...

Example 2: Clear Limited Number of Hideouts

gm.bandit.clear_hideouts mountain 2

Output:

Cleared 2 bandit hideouts (requested: 2).
Types: Mountain Bandits

Remaining Counts:
...

Example 3: Clear Multiple Hideout Types

gm.bandit.clear_hideouts forest,mountain,sea_raiders

Output:

Cleared 6 bandit hideouts (all).
Types: Forest Bandits, Mountain Bandits, Sea Raiders

Remaining Counts:
...

Example 4: Using Named Arguments

gm.bandit.clear_hideouts type:steppe count:1

Output:

Cleared 1 bandit hideouts (requested: 1).
Types: Steppe Bandits

Remaining Counts:
...

Example 5: Clear All Hideouts

gm.bandit.clear_hideouts all

Output:

Cleared 12 bandit hideouts (all).
Types: Looters, Deserters, Forest Bandits, Mountain Bandits, Sea Raiders, Steppe Bandits

Remaining Counts:
Total Parties: 45
Total Hideouts: 0

Use Cases

  • Reduce long-term bandit respawn rates in specific regions
  • Clear hideouts near important settlements or trade routes
  • Create safer regions by eliminating bandit bases
  • Prevent specific bandit types from respawning in areas
  • Reduce overall bandit pressure more permanently than removing parties

Notes

  • Clearing hideouts has more lasting impact than destroying parties
  • Hideouts respawn slowly over time through game mechanics
  • Parties respawn from remaining hideouts, so clear hideouts for longer-term effect
  • Use gm.bandit.count to verify hideout counts before and after
  • Comma-separated types must have NO SPACES between them

Strategy

Clear hideouts BEFORE destroying parties for maximum long-term impact:

gm.bandit.clear_hideouts forest
gm.bandit.destroy_bandit_parties forest

This removes the hideout spawn points first, then cleans up remaining parties.

Related Commands

Last Updated: 2026-01-06

Quick Links

🏠 Home | Quick Reference | Syntax Guide


Hero Commands
Clan Commands
Kingdom Commands
Settlement Commands
Item Commands
Troop Commands
Caravan Commands
Bandit Commands
Query Commands

Clone this wiki locally