NewConoy
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | NewConoy | |
| Function Description: | Creates a new convoy by defining a path of waypoints using predefined cone markers, assigning a group of units to follow the path, and executing custom waypoint scripts to control unit behavior during movement. | |
| File Location: | cmm.spawnFunctions.lua | |
| Syntax: | CMM.NewConoy( any Grp , table path ) | |
| Return Value: | boolean | |
| Parameters: | Name | Description |
| Grp | Either a table or string representing the group to be assigned to the convoy; must reference a valid group in the mission editor. | |
| path | Array of waypoints as a table, where each waypoint contains a point location; used to define the route for the convoy. | |
| Example: | CMM.NewConoy("MyGuy", {"CONE-1", "CONE-2", "CONE-3"}) | |
| Example Description: | initialises a convoy using the "MyGuy" group and a path defined by cone markers, executing scripts at each waypoint to control unit movement and behavior. | |
| Related Functions: | ||
| Notes: | ||