API Caravan count

gm.caravan.count

Endpoint: gm.caravan.count

Back to Caravan Overview | Back to Home

Syntax

gm.caravan.count

Parameters

None required.

Description

Displays comprehensive statistics about all caravans in the game, organized by owner type. This command provides a detailed breakdown showing:

• Total Caravan Count: Overall number of caravans, split into active and disbanding
• By Owner Type: Individual counts for each owner category:
  • Player: Caravans owned by the player's clan
  • Notable: Caravans owned by settlement notables (merchants, artisans, etc.)
  • NPC Lord: Caravans owned by AI lords and their clans

For each owner type, the command displays:

• Active caravans (currently trading)
• Disbanding caravans (in the process of returning to home settlement)
• Total caravans (sum of active and disbanding)

This is an information-only command that does not modify game state. It's particularly useful for:

• Monitoring the health of the game's trade economy
• Planning caravan management operations
• Understanding caravan distribution across factions
• Checking caravan counts before executing disband commands

Examples

Display caravan statistics

gm.caravan.count

Output:

Caravan Statistics:
Total Caravans: 47 active, 3 disbanding (50 total)

By Owner Type:
  Player: 8 active, 2 disbanding (10 total)
  Notable: 24 active, 0 disbanding (24 total)
  NPC Lord: 15 active, 1 disbanding (16 total)

Example with no caravans

gm.caravan.count

Output:

Caravan Statistics:
Total Caravans: 0 active, 0 disbanding (0 total)

By Owner Type:
  Player: 0 active, 0 disbanding (0 total)
  Notable: 0 active, 0 disbanding (0 total)
  NPC Lord: 0 active, 0 disbanding (0 total)

Example with all caravans disbanding

gm.caravan.count

Output:

Caravan Statistics:
Total Caravans: 0 active, 50 disbanding (50 total)

By Owner Type:
  Player: 0 active, 10 disbanding (10 total)
  Notable: 0 active, 24 disbanding (24 total)
  NPC Lord: 0 active, 16 disbanding (16 total)

Notes

Best Practices:

• Run this command before executing any disband operations to know current counts
• Use to verify the results of caravan creation or disbanding commands
• Monitor regularly to track the natural evolution of trade economy

Understanding the Output:

• Active caravans are currently traveling between settlements and trading
• Disbanding caravans are returning to their home settlement to disband
• The disbanding count increases when you use disband commands or when caravans fail naturally
• Once a disbanding caravan reaches its home settlement, it's removed from the counts

Economic Insights:

• Player caravans provide income to the player's clan
• Notable caravans support settlement prosperity and trade
• NPC Lord caravans contribute to AI faction economies
• High disbanding counts may indicate economic stress or recent management actions

Information Only:

• This command does not modify game state
• Safe to run at any time without affecting your campaign
• Can be used in combination with other caravan commands for planning

Related Commands

• API-Caravan-disband_caravans - Disband random caravans from all owner types
• API-Caravan-disband_player_caravans - Disband only player-owned caravans
• API-Caravan-disband_notable_caravans - Disband only notable-owned caravans
• API-Caravan-disband_npc_lord_caravans - Disband only NPC lord-owned caravans
• API-Caravan-create_player_caravan - Create a new player caravan
• API-Caravan-create_notable_caravan - Create a new notable caravan
• API-Caravan-Overview - All caravan commands

Version Information

• Added: v1.3.13.3
• Last Updated: 2025-01-07
• Status: Stable

---

Back to Caravan Overview | Back to Home