API Caravan create_notable_caravan

gm.caravan.create_notable_caravan

Endpoint: gm.caravan.create_notable_caravan

Syntax

gm.caravan.create_notable_caravan <settlement>

Parameters

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

Description

Creates a new caravan in the specified settlement owned by a notable who doesn't have one yet. The caravan will be managed by the notable and will travel between settlements conducting trade, generating income for the notable's owner.

The command automatically finds an available notable in the settlement who doesn't already own a caravan and assigns the new caravan to them. If all notables in the settlement already own caravans, the command will fail with an error message suggesting to use gm.caravan.create_player_caravan instead.

NOTE: Settlement must be a city. Caravans can only be created in cities, not in castles, villages, or hideouts.

Example

gm.caravan.create_notable_caravan pen

Output:

Created caravan in '{Settlement Name}' (ID: {settlement_id}) owned by notable {Notable Name}.

Usage Tips

Checking Notable Availability: Before creating a caravan, you can query the settlement to see its notables:

gm.query.settlement_info pen

Multiple Caravans: Create multiple caravans in the same city if there are multiple available notables:

gm.caravan.create_notable_caravan pen
gm.caravan.create_notable_caravan pen

Each execution will assign a caravan to a different available notable.

City Requirement: Only cities can create caravans:

• Cities: Supported
• Castles: Not supported
• Villages: Not supported
• Hideouts: Not supported

Economic Impact: Caravans contribute to the economic activity of the game world and can be raided by bandits or hostile parties.

Related Commands

• API-Caravan-Overview - All caravan commands
• API-Caravan-create_player_caravan - Create player-owned caravans
• API-Caravan-disband_notable_caravans - Disband notable caravans
• API-Caravan-disband_caravans - Disband caravans by various filters
• gm.query.settlement - Find settlements by name
• gm.query.settlement_info - View settlement details

Last Updated: 2025-01-07