SpawnConvoy
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | SpawnConvoy | |
| Function Description: | Spawns a convoy group with customizable unit types, spawn location, and AI settings, using a flexible configuration table to define the convoy properties and default behaviors. | |
| File Location: | cmm.spawnFunctions.lua | |
| Syntax: | CMM.SpawnConvoy( table argTable ) | |
| Return Value: | nil | |
| Parameters: | Name | Description |
| argTable | {vec3 <vec3>, unitTypeTable <TBL>, groupName <string>, countryID <number>, headingRange <number>, spawnRange <number>, ALS <string>, ARMax <number>, ARMin <number>, DOA <number>, EAW <boolean>, EOA <boolean>, ERR <number>, PAA <boolean>, ROE <string>, RT <number>, skill <string>, canDrive <boolean>} – Table containing required and optional parameters for convoy spawn configuration. | |
| Example: | CMM.SpawnConv或{"vec3" = {100, 200, 300}, "unitTypeTable" = {"BTR", "M113"}, "groupName" = "Convoy1", "countryID" = 1, "headingRange" = 45, "spawnRange" = 10, "ALS" = "AUTO", "ARMax" = 50, "ARMin" = 0, "DOA" = 30, "EAW" = true, "EOA" = false, "ERR" = 80, "PAA" = false, "ROE" = "RETURN_FIRE", "RT" = 1, "skill" = "GOOD", "canDrive" = true} | |
| Example Description: | Spawns a convoy with specific unit types, spawn location, AI settings, and behavior rules, allowing full control over the convoy's configuration and movement. | |
| Related Functions: | ||
| Notes: | -- TODO WORK IN PROGRESS (SHOULD THIS BE RETIRED??), plan is to have this be a generic convoy spawner, supply the unitTable, countryID and spawn location, the other settings are set as a convoy default | |