NewConoy: Difference between revisions
Ozdeadmeat (talk | contribs) NewConoy – created via PowerShell script (2025-11-11T21:12:43Z) Tag: Recreated |
Ozdeadmeat (talk | contribs) m NewConoy – created via PowerShell script (2026-01-01T06:03:34Z) |
||
| Line 1: | Line 1: | ||
{{Template:FunctionInfo|fName= NewConoy|fDescription= 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.|parentFile= cmm.spawnFunctions.lua|syntax= CMM.NewConoy(Grp <any>, path <TBL>)|return= boolean|returnDesc= Returns true if the convoy was successfully created and assigned to the path, otherwise false.|example= CMM.NewConoy("MyGuy", {"CONE-1", "CONE-2", "CONE-3"})|exampleDesc= | {{Template:FunctionInfo|fName= NewConoy|fDescription= 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.|parentFile= cmm.spawnFunctions.lua|syntax= CMM.NewConoy(Grp <any>, path <TBL>)|return= boolean|returnDesc= Returns true if the convoy was successfully created and assigned to the path, otherwise false.|example= CMM.NewConoy("MyGuy", {"CONE-1", "CONE-2", "CONE-3"})|exampleDesc= 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= |note= |envType= CMM|par1= any Grp|reqType1= any|reqName1= Grp|desc1= Either a table or string representing the group to be assigned to the convoy; must reference a valid group in the mission editor.|par2= table path|reqType2= table|reqName2= path|desc2= Array of waypoints as a table, where each waypoint contains a point location; used to define the route for the convoy.}} | ||
Latest revision as of 19:03, 31 December 2025
| 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: | ||