CMM Wiki - Recent changes [en-gb]

CMM Map Marker Commands

Ozdeadmeat — Mon, 29 Jun 2026 13:55:56 GMT

Support Aircraft Commands

← Older revision		Revision as of 13:55, 29 June 2026
Line 119:		Line 119:
	====Example2 = place drone in racetrack at location====		====Example2 = place drone in racetrack at location====
	Example2 : will put <u>Colt11</u> into a <u>''RaceTrack''</u> orbit that goes <u>'' west 50km''</u>, <u>from</u> the specified location		Example2 : will put <u>Colt11</u> into a <u>''RaceTrack''</u> orbit that goes <u>'' west 50km''</u>, <u>from</u> the specified location
	Usage : !isr:Colt11 -rt 270:50		Usage : !isr:Colt11
			-rt 270 50

	====Example3 = change altid orbit location====		====Example3 = change altid orbit location====
	Example3 : will ''change the altitude'' of <u>Colt11</u> to <u>''20,000ft''</u>, <u>without</u> changing its orbit location		Example3 : will ''change the altitude'' of <u>Colt11</u> to <u>''20,000ft''</u>, <u>without</u> changing its orbit location
	Usage : !isr:Colt11 -dm -a 20000		Usage : !isr:Colt11
			-dm -a 20000

	====Example4 = change the speed ====		====Example4 = change the speed ====
	Example4 : will ''change the speed'' of <u>Colt11</u> to <u>''350knots''</u>, <u>without</u> changing its orbit location		Example4 : will ''change the speed'' of <u>Colt11</u> to <u>''350knots''</u>, <u>without</u> changing its orbit location
	Usage : !isr:Colt11 -dm -s 350		Usage : !isr:Colt11
			-dm -s 350

	====Example5 = changes speed, alt & locn ====		====Example5 = changes speed, alt & locn ====
	Example5 : will ''change the speed, altitude and location'' of <u>Colt11</u> to <u>''175knots''</u>, <u>''14,000ft''</u> and to a <u>''racetrack''</u> going <u>''south 25km''</u>, <u>from</u> the specified location		Example5 : will ''change the speed, altitude and location'' of <u>Colt11</u> to <u>''175knots''</u>, <u>''14,000ft''</u> and to a <u>''racetrack''</u> going <u>''south 25km''</u>, <u>from</u> the specified location
	Usage : !isr:Colt11 -rt 180:25 -s 175 -a 14000		Usage : !isr:Colt11
			-rt 180 25 -s 175 -a 14000


	''All these examples are available for'' '''!isr, !tanker''' and '''!awacs''' ''commands.''		''All these examples are available for'' '''!isr, !tanker''' and '''!awacs''' ''commands.''


	== Elevated Permissions Section ==		== Elevated Permissions Section ==

GetZone

Ozdeadmeat — Wed, 24 Jun 2026 12:27:31 GMT

GetZone – created via PowerShell script (2026-06-24T22:27:33Z)

← Older revision		Revision as of 12:27, 24 June 2026
Line 1:		Line 1:
	{{Template:FunctionInfo\|fName= ~~getZone~~\|fDescription= Returns a ~~detailed~~ zone table ~~for the given zone~~ name, augmenting the mission’s trigger‑zone data with a vec3 field (x, y = terrain height, z) and optional 3‑D vertex list (verticies3). If the zone cannot be found or the input is not a string, the function logs an error and returns nil.\|parentFile= cmm.~~DCSFunctions~~.lua\|syntax= CMM.~~getZone~~(<string>)\|return= table or nil\|returnDesc= ~~returns~~ a table ~~containing centre~~, ~~radius, vertices and terrain height for the zone or~~ nil ~~if not found~~\|example= ~~local weaponsRange =~~ CMM.~~getZone~~("~~WeaponsRange02~~")\|exampleDesc= ~~The example shows how to obtain all relevant data~~ for "~~WeaponsRange02~~", ~~including the ground elevation at its centre (vec3.y) and the 3‑D coordinates of each vertex in verticies3~~.\|related= \|note= \|envType= CMM\|par1= string ~~ZoneName~~\|reqType1= string\|reqName1= ~~ZoneName~~\|desc1= Name of a zone defined in the mission editor.}}		{{Template:FunctionInfo\|fName= GetZone\|fDescription= Returns a zone table by its name\|parentFile= cmm.ZoneFunctions.lua\|syntax= CMM.GetZone(<string>)\|return= table or nil\|returnDesc= Returns a zone table if found, otherwise nil.\|example= CMM.GetZone("Zone15",1000)\|exampleDesc= Returns a zone table for the zone named "Zone15", or nil if not found.\|related= \|note= \|envType= CMM\|par1= string zoneName\|reqType1= string\|reqName1= zoneName\|desc1= Name of the zone as defined in the mission editor.}}

GenerateSortieReport

Ozdeadmeat — Wed, 24 Jun 2026 12:27:30 GMT

GenerateSortieReport – created via PowerShell script (2026-06-24T22:27:32Z)

New page

{{Template:FunctionInfo|fName= GenerateSortieReport|fDescription= Adds a sortie event to the sortie tracking system using a custom event table, enabling post-event processing such as scoring, notifications, and sortie bank scheduling. The function accepts a table with event data and processes it accordingly. Can be executed during a sortie|parentFile= cmm.XpFunctions.lua|syntax= CMM.GenerateSortieReport(Aircraft <table>, UCID <string>)|return= string or nil,number or nil,number or nil|returnDesc= Returns a string containing the sortie report message, the total sortie time in seconds, and the total score earned during the sortie.|example= CMM.GenerateSortieReport(Unit.getByName("PlayerUnit"), "UCID")|exampleDesc= This would generate a sortie report for the specified player's aircraft, including a breakdown of events, total sortie time, and score earned, which can then be used for notifications and banking the sortie score.|related= |note= |envType= CMM|par1= table Aircraft|reqType1= table|reqName1= Aircraft|desc1= Aircraft (unit) table containing the unit data of the aircraft for which the sortie report is being generated.|par2= string UCID|reqType2= string|reqName2= UCID|desc2= The unique client ID of the player for whom the sortie report}}

GatherDebugEventData

Ozdeadmeat — Wed, 24 Jun 2026 12:27:30 GMT

GatherDebugEventData – created via PowerShell script (2026-06-24T22:27:32Z)

New page

{{Template:FunctionInfo|fName= GatherDebugEventData|fDescription= Adds a sortie event to the sortie tracking system using a custom event table, enabling post-event processing such as scoring, notifications, and sortie bank scheduling. The function accepts a table with event data and processes it accordingly.|parentFile= cmm.XpFunctions.lua|syntax= CMM.GatherDebugEventData(EventData <table>)|return= table|returnDesc= Returns a table containing processed event information into a human readable format, including timestamps, event types, and relevant metadata for debugging purposes.|example= CMM.GatherDebugEventData({id = world.event.S_EVENT_LAND, initiator = unit, place = location})|exampleDesc= This would return an event events and schedules a sortie bank task after a land event, ensuring proper scoring and notification logic is applied.|related= |note= |envType= CMM|par1= table EventData|reqType1= table|reqName1= EventData|desc1= Table containing event data from a DCS event, including initiator and other items}}

AWARD CARRIERLANDING

Ozdeadmeat — Wed, 24 Jun 2026 12:27:29 GMT

AWARD_CARRIERLANDING – created via PowerShell script (2026-06-24T22:27:31Z)

New page

{{Template:FunctionInfo|fName= AWARD_CARRIERLANDING|fDescription= Checks if a player earned a refueling bonus during a sortie by measuring the time between the start of refueling and its end, awarding the bonus if it exceeds 30 seconds and the player hasn't already received it.|parentFile= cmm.XpFunctions.lua|syntax= CMM.AWARD_CARRIERLANDING(PlayerAircraft <table>)|return= |returnDesc= |example= CMM.AWARD_CARRIERLANDING(PlayerAircraft)|exampleDesc= Sets the Sortie Bonus for a Carrier Landing for all crew members in the airframe.|related= |note= --TODO Code review required|envType= CMM|par1= table PlayerAircraft|reqType1= table|reqName1= PlayerAircraft|desc1= Event table from a refueling stopped event containing initiator, time, and position; used to determine the duration of refueling and trigger award logic.}}

AWARD REFUEL

Ozdeadmeat — Wed, 24 Jun 2026 12:27:29 GMT

AWARD_REFUEL – created via PowerShell script (2026-06-24T22:27:31Z)

New page

{{Template:FunctionInfo|fName= AWARD_REFUEL|fDescription= Checks if a player earned a refueling bonus during a sortie by measuring the time between the start of refueling and its end, awarding the bonus if it exceeds 30 seconds and the player hasn't already received it.|parentFile= cmm.XpFunctions.lua|syntax= CMM.AWARD_REFUEL(EventData <TBL>)|return= |returnDesc= |example= CMM.AWARD_REFUEL({initiator = 12345, time = 1640995200})|exampleDesc= Processes a refueling stop event to verify if the refueling duration exceeds 30 seconds and awards a bonus if valid, otherwise notifies the player that the bonus was already earned.|related= |note= --TODO Code review required|envType= CMM|par1= table PlayerAircraft|reqType1= table|reqName1= PlayerAircraft|desc1= Event table from a refueling stopped event containing initiator, time, and position; used to determine the duration of refueling and trigger award logic.}}

Dump.AllPlayerData

Ozdeadmeat — Wed, 24 Jun 2026 12:27:28 GMT

dump.AllPlayerData – created via PowerShell script (2026-06-24T22:27:30Z)

New page

{{Template:FunctionInfo|fName= dump.AllPlayerData|fDescription= |parentFile= cmm.tools.lua|syntax= CMM.dump.AllPlayerData()|return= nil|returnDesc= Writes an audit entry to CMM.dump.Directory/cmm.AllPlayerData.json|example= CMM.dump.AllPlayerData()|exampleDesc= |related= |note= |envType= CMM}}

Tools.drawGlobalPoly

Ozdeadmeat — Wed, 24 Jun 2026 12:27:27 GMT

tools.drawGlobalPoly – created via PowerShell script (2026-06-24T22:27:29Z)

New page

{{Template:FunctionInfo|fName= tools.drawGlobalPoly|fDescription= Draws a set of global vec3 points as a single drawing.|parentFile= cmm.tools.lua|syntax= CMM.tools.drawPoly(PointsArray <TBL>)|return= nil|returnDesc= Returns nothing, triggers a marker overlay on the map with the polygon shape.|example= CMM.tools.drawPoly({x=100, y=200, z=0}, {{dir={x=1, y=0, z=0}, range=50}, {dir={x=0, y=1, z=0}, range=30}})|exampleDesc= Creates a polygon with two relative points, one to the right and one upward from the base position, drawing a visible shape with default line and fill colors.|related= |note= |envType= CMM|par1= table PointsArray|reqType1= table|reqName1= PointsArray|desc1= Table of relative point definitions, each containing 'dir' and 'range' fields specifying direction and distance to offset from the base position.|par2= table Line|reqType2= table|reqName2= Line|desc2= R,G,B,A values for line color (0-1 range)|par3= table Fill|reqType3= table|reqName3= Fill|desc3= R,G,B,A values for fill color (0-1 range}}

Tools.BuildWPpointTable

Ozdeadmeat — Wed, 24 Jun 2026 12:27:27 GMT

tools.BuildWPpointTable – created via PowerShell script (2026-06-24T22:27:29Z)

← Older revision		Revision as of 12:27, 24 June 2026
Line 1:		Line 1:
	{{Template:FunctionInfo\|fName= tools.BuildWPpointTable\|fDescription= Constructs a table of waypoints based on a group's waypoints and a specified mode. It calculates positions relative to a unit or origin point, supporting different modes for position derivation. Returns a table of vectors or nil if group or mode is invalid.\|parentFile= cmm.tools.lua\|syntax= CMM.tools.BuildWPpointTable(GroupName <string>, Mode <number>, SkipFirst <boolean>)\|return= table or nil\|returnDesc= Returns a table of vectors representing the waypoints, or nil if group not found or no waypoints exist.\|example= CMM.tools.BuildWPpointTable("WhyUbreakMyShitED",2,true)\|exampleDesc= Extracts relative positions from the group "WhyUbreakMyShitED", skipping the first waypoint, using mode 2 for relative positioning.\|related= \|note= \|envType= CMM\|par1= string GroupName\|reqType1= string\|reqName1= GroupName\|desc1= Name of the group containing waypoints to extract. Must be a valid group name defined in the mission editor.\|par2= number Mode\|~~reqType2~~= number\|~~reqName2~~= Mode\|desc2= Mode for position calculation (0 = raw positions, 1 = relative to first unit, 2 = relative to unit position using CMM.GetRelativePosition). Defaults to 1 if not provided.\|par3= boolean SkipFirst\|~~reqType3~~= boolean\|~~reqName3~~= SkipFirst\|desc3= If true, skips the first waypoint in the group. Defaults to false.}}		{{Template:FunctionInfo\|fName= tools.BuildWPpointTable\|fDescription= Constructs a table of waypoints based on a group's waypoints and a specified mode. It calculates positions relative to a unit or origin point, supporting different modes for position derivation. Returns a table of vectors or nil if group or mode is invalid.\|parentFile= cmm.tools.lua\|syntax= CMM.tools.BuildWPpointTable(GroupName <string>, Mode <number>, SkipFirst <boolean>)\|return= table or nil\|returnDesc= Returns a table of vectors representing the waypoints, or nil if group not found or no waypoints exist.\|example= CMM.tools.BuildWPpointTable("WhyUbreakMyShitED",2,true)\|exampleDesc= Extracts relative positions from the group "WhyUbreakMyShitED", skipping the first waypoint, using mode 2 for relative positioning.\|related= \|note= \|envType= CMM\|par1= string GroupName\|reqType1= string\|reqName1= GroupName\|desc1= Name of the group containing waypoints to extract. Must be a valid group name defined in the mission editor.\|par2= number or nil Mode\|optType2= number or nil\|optName2= Mode\|desc2= Mode for position calculation (0 = raw positions, 1 = relative to first unit, 2 = relative to unit position using CMM.GetRelativePosition). Defaults to 1 if not provided.\|par3= boolean or nil SkipFirst\|optType3= boolean or nil\|optName3= SkipFirst\|desc3= If true, skips the first waypoint in the group. Defaults to false.}}

Tools.BuildNewMarkerPointTable

Ozdeadmeat — Wed, 24 Jun 2026 12:27:27 GMT

tools.BuildNewMarkerPointTable – created via PowerShell script (2026-06-24T22:27:29Z)

← Older revision		Revision as of 12:27, 24 June 2026
Line 1:		Line 1:
	{{Template:FunctionInfo\|fName= tools.BuildNewMarkerPointTable\|fDescription= Creates a table of marker points from a specified group, with options to define position mode and skip the first waypoint. The function uses internal waypoint processing to derive positions either as world coordinates, relative to the first unit, or via heading and distance. Returns a table of waypoints or nil if invalid input.\|parentFile= cmm.tools.lua\|syntax= CMM.tools.BuildNewMarkerPointTable(GroupName <string>, Mode <number>, SkipFirst <boolean>)\|return= table or nil\|returnDesc= Returns a table containing the processed waypoints or nil if group not found or no waypoints exist.\|example= CMM.tools.BuildNewMarkerPointTable("DebrisArea",1,false)\|exampleDesc= Generates a table of waypoints from the group "DebrisArea" using relative positioning to the first unit, without skipping the first point.\|related= \|note= \|envType= CMM\|par1= string GroupName\|reqType1= string\|reqName1= GroupName\|desc1= Name of the group in the mission editor containing waypoints to extract. Must be valid and defined in the mission.\|par2= number Mode\|~~reqType2~~= number\|~~reqName2~~= Mode\|desc2= Mode for position derivation: 0 = world positions, 1 = relative to first unit (default), 2 = heading and distance from first unit. Defaults to 1 if not specified.\|par3= boolean SkipFirst\|~~reqType3~~= boolean\|~~reqName3~~= SkipFirst\|desc3= If true, the first waypoint in the group is skipped. Defaults to false.}}		{{Template:FunctionInfo\|fName= tools.BuildNewMarkerPointTable\|fDescription= Creates a table of marker points from a specified group, with options to define position mode and skip the first waypoint. The function uses internal waypoint processing to derive positions either as world coordinates, relative to the first unit, or via heading and distance. Returns a table of waypoints or nil if invalid input.\|parentFile= cmm.tools.lua\|syntax= CMM.tools.BuildNewMarkerPointTable(GroupName <string>, Mode <number>, SkipFirst <boolean>)\|return= table or nil\|returnDesc= Returns a table containing the processed waypoints or nil if group not found or no waypoints exist.\|example= CMM.tools.BuildNewMarkerPointTable("DebrisArea",1,false)\|exampleDesc= Generates a table of waypoints from the group "DebrisArea" using relative positioning to the first unit, without skipping the first point.\|related= \|note= \|envType= CMM\|par1= string GroupName\|reqType1= string\|reqName1= GroupName\|desc1= Name of the group in the mission editor containing waypoints to extract. Must be valid and defined in the mission.\|par2= number or nil Mode\|optType2= number or nil\|optName2= Mode\|desc2= Mode for position derivation: 0 = world positions, 1 = relative to first unit (default), 2 = heading and distance from first unit. Defaults to 1 if not specified.\|par3= boolean or nil SkipFirst\|optType3= boolean or nil\|optName3= SkipFirst\|desc3= If true, the first waypoint in the group is skipped. Defaults to false.\|par4= boolean or nil WriteToFile\|optType4= boolean or nil\|optName4= WriteToFile\|desc4= If true, will write the CMM.DEV}}

TemplateBuilder

Ozdeadmeat — Wed, 24 Jun 2026 12:27:22 GMT

TemplateBuilder – created via PowerShell script (2026-06-24T22:27:24Z)

← Older revision		Revision as of 12:27, 24 June 2026
Line 1:		Line 1:
	{{Template:FunctionInfo\|fName= TemplateBuilder\|fDescription= Builds Saved Tempates\|parentFile= cmm.templates.lua\|syntax= CMM.TemplateBuilder(pos <TBL>, dir <number>, TemplateName <string>, BuildSide <number>, BuildTime <number>)\|return= string or nil\|returnDesc= Returns the name prefix for the template or nil if error\|example= CMM.TemplateBuilder({x,y,z}, 33,"FOB_01", 81, 300)\|exampleDesc= Build a template named FOB_01 in the direction of 33 facing the country side 81 and have it complete the build process in 300 seconds\|related= \|note= \|envType= CMM\|par1= table pos\|reqType1= table\|reqName1= pos\|desc1= vec3 table\|par2= number dir\|reqType2= number\|reqName2= dir\|desc2= Direction the template will face when deployed\|par3= string ~~TemplateName~~\|reqType3= string\|reqName3= TemplateName\|~~desc3~~= Name of the template to lookup\|~~par4~~= number ~~BuildSide~~\|~~reqType4~~= number\|~~reqName4~~= ~~BuildSide~~\|~~desc4~~= The country side to build the template for\|~~par5~~= number BuildTime\|~~reqType5~~= number\|~~reqName5~~= BuildTime\|~~desc5~~= How long you want the build to take to complete}}		{{Template:FunctionInfo\|fName= TemplateBuilder\|fDescription= Builds Saved Tempates\|parentFile= cmm.templates.lua\|syntax= CMM.TemplateBuilder(pos <TBL>, dir <number>, TemplateName <string>, BuildSide <number>, BuildTime <number>)\|return= string or nil\|returnDesc= Returns the name prefix for the template or nil if error\|example= CMM.TemplateBuilder({x,y,z}, 33,"FOB_01", 81, 300)\|exampleDesc= Build a template named FOB_01 in the direction of 33 facing the country side 81 and have it complete the build process in 300 seconds\|related= \|note= \|envType= CMM\|par1= table pos\|reqType1= table\|reqName1= pos\|desc1= vec3 table\|par2= number dir\|reqType2= number\|reqName2= dir\|desc2= Direction the template will face when deployed\|par3= string DeploymentName\|reqType3= string\|reqName3= DeploymentName\|desc3= Name of the Deployment, (Do Check if unique against CMM.DEPLOYED)\|par4= string TemplateName\|reqType4= string\|reqName4= TemplateName\|desc4= Name of the template to lookup\|par5= number BuildCountry\|reqType5= number\|reqName5= BuildCountry\|desc5= The country side to build the template for\|par6= number BuildTime\|reqType6= number\|reqName6= BuildTime\|desc6= How long you want the build to take to complete\|par7= table or nil FARPSettings\|optType7= table or nil\|optName7= FARPSettings\|desc7= How long you want the build to take to complete}}

ScheduleSpawnFARPObject

Ozdeadmeat — Wed, 24 Jun 2026 12:27:22 GMT

ScheduleSpawnFARPObject – created via PowerShell script (2026-06-24T22:27:24Z)

← Older revision		Revision as of 12:27, 24 June 2026
Line 1:		Line 1:
	{{Template:FunctionInfo\|fName= ScheduleSpawnFARPObject\|fDescription= Spawns a FARP object with a set of parameters supplied\|parentFile= cmm.templates.lua\|syntax= CMM.ScheduleSpawnFARPObject(argTable <TBL>)\|return= nil\|returnDesc= Returns nothing but spawns a static object based on the arguments provided and adds it to the CMM.DEPLOYED table for tracking\|example= CMM.ScheduleSpawnFARPObject({TemplateTBL = "FOB_01#01245", GroupName = "FOB_01#01245_FARP", Country = 82, SpawnPoint = {x=0,y=0,z=0}, Heading = 33, DynamicSpawn = true, Hotstart = false})\|exampleDesc= Returns nothing but spawns the FARP object and then adds it to the CMM.DEPLOYED table for tracking under the "FOB_01#01245" template\|related= \|note= \|envType= CMM\|par1= table argTable\|reqType1= table\|reqName1= argTable\|desc1= Argument table for spawning FARP objects, {TemplateTBL <string>, GroupName <string>, Country <number>, SpawnPoint <table vec3>, Heading <number>, DynamicSpawn <boolean>, Hotstart <boolean>}}}		{{Template:FunctionInfo\|fName= ScheduleSpawnFARPObject\|fDescription= Spawns a FARP object with a set of parameters supplied\|parentFile= cmm.templates.lua\|syntax= CMM.ScheduleSpawnFARPObject(argTable <TBL>)\|return= nil\|returnDesc= Returns nothing but spawns a static object based on the arguments provided and adds it to the CMM.DEPLOYED table for tracking\|example= CMM.ScheduleSpawnFARPObject({TemplateTBL = "FOB_01#01245", GroupName = "FOB_01#01245_FARP", Country = 82, SpawnPoint = {x=0,y=0,z=0}, Heading = 33, DynamicSpawn = true, Hotstart = false})\|exampleDesc= Returns nothing but spawns the FARP object and then adds it to the CMM.DEPLOYED table for tracking under the "FOB_01#01245" template\|related= \|note= \|envType= CMM\|par1= table argTable\|reqType1= table\|reqName1= argTable\|desc1= Argument table for spawning FARP objects, {TemplateTBL <string>, GroupName <string>, Country <number>, SpawnPoint <table vec3>, Heading <number>, DynamicSpawn <boolean>, Hotstart <boolean>, DynamicCargo <boolean>}}}

GetNewMarkerID

Ozdeadmeat — Wed, 24 Jun 2026 12:27:18 GMT

GetNewMarkerID – created via PowerShell script (2026-06-24T22:27:20Z)

← Older revision		Revision as of 12:27, 24 June 2026
Line 1:		Line 1:
	{{Template:FunctionInfo\|fName= GetNewMarkerID\|fDescription= Generates a ~~new unused marker ID~~ by ~~checking against existing allocated IDs and returning the first available one~~, with ~~a fallback to -1 if no ID can be found after extensive retries~~.\|parentFile= cmm.~~markerFunctions~~.lua\|syntax= CMM.GetNewMarkerID()\|return= ~~number~~\|returnDesc= A new ~~unused marker ID that has not been allocated~~ in the ~~MarkerPanels table~~, or -1 if no ~~valid ID could~~ be found.\|example= CMM.GetNewMarkerID()\|exampleDesc= ~~Returns~~ a unique ~~marker ID~~ such as ~~205~~, ~~which has~~ not ~~been previously used~~ in the mission~~, ensuring no conflicts with existing markers~~.\|related= \|note= \|envType= CMM}}		{{Template:FunctionInfo\|fName= GetNewMarkerID\|fDescription= Generates a unique convoy group name by incrementing a counter until a name not already in use is found, ensuring no name conflicts with existing groups.\|parentFile= cmm.spawnFunctions.lua\|syntax= CMM.GetNewMarkerID()\|return= string\|returnDesc= Returns a new available convoy group name in the format "Convoy#XXXX" where XXXX is a zero-padded number, or "NO-NEW-CONVOY-NAME" if no unique name can be found after maximum retries.\|example= CMM.GetNewMarkerID()\|exampleDesc= Invokes the function to generate a unique convoy name, such as "Convoy#0001", ensuring it does not conflict with existing group names in the mission.\|related= \|note= --TODO CODE REVIEW REQUIRED\|envType= CMM}}

SpawnGroundUnitInZoneScheduledTaskFunction

Ozdeadmeat — Wed, 24 Jun 2026 12:27:17 GMT

SpawnGroundUnitInZoneScheduledTaskFunction – created via PowerShell script (2026-06-24T22:27:19Z)

← Older revision		Revision as of 12:27, 24 June 2026
Line 1:		Line 1:
	{{Template:FunctionInfo\|fName= SpawnGroundUnitInZoneScheduledTaskFunction\|fDescription= Scheduled task function that spawns ground units in a specified zone using a provided unit type table, country, and optional limits and road constraints. It validates input parameters and delegates execution to CMM.SpawnGroundUnitInZone.\|parentFile= cmm.spawnFunctions.lua\|syntax= CMM.SpawnGroundUnitInZoneScheduledTaskFunction(<argTable table>)\|return= nil\|returnDesc= Returns nothing, as the function performs spawning and does not return a value.\|example= CMM.SpawnGroundUnitInZoneScheduledTaskFunction({"Area-10", 1, {"T-72", "BTR-80"}, 100, true})\|exampleDesc= Schedules the spawning of up to 100 units in "Area-10" using T-72 and BTR-80 units, assigned to BLUFOR, with all spawns forced to occur on roads.\|related= \|note= \|envType= CMM\|par1= table argTable\|reqType1= table\|reqName1= argTable\|desc1= {ZoneName <string>, Country <number>, UnitTypeTable <TBL>, UnitLimit <number>, ForceRoad <~~nil\|~~boolean>} – Table containing zone name, country ID, list of unit types, maximum unit count, and whether to force spawns on roads.}}		{{Template:FunctionInfo\|fName= SpawnGroundUnitInZoneScheduledTaskFunction\|fDescription= Scheduled task function that spawns ground units in a specified zone using a provided unit type table, country, and optional limits and road constraints. It validates input parameters and delegates execution to CMM.SpawnGroundUnitInZone.\|parentFile= cmm.spawnFunctions.lua\|syntax= CMM.SpawnGroundUnitInZoneScheduledTaskFunction(<argTable table>)\|return= nil\|returnDesc= Returns nothing, as the function performs spawning and does not return a value.\|example= CMM.SpawnGroundUnitInZoneScheduledTaskFunction({"Area-10", 1, {"T-72", "BTR-80"}, 100, true})\|exampleDesc= Schedules the spawning of up to 100 units in "Area-10" using T-72 and BTR-80 units, assigned to BLUFOR, with all spawns forced to occur on roads.\|related= \|note= \|envType= CMM\|par1= table argTable\|reqType1= table\|reqName1= argTable\|desc1= {ZoneName <string>, Country <number>, UnitTypeTable <TBL>, UnitLimit <number>, ForceRoad <boolean>} – Table containing zone name, country ID, list of unit types, maximum unit count, and whether to force spawns on roads.}}

GetRouteDistancePoints

Ozdeadmeat — Wed, 24 Jun 2026 12:27:16 GMT

GetRouteDistancePoints – created via PowerShell script (2026-06-24T22:27:18Z)

New page

{{Template:FunctionInfo|fName= GetRouteDistancePoints|fDescription= Calculates a series of points along a road path at a specified distance, starting from the first point and progressing sequentially until the target distance is reached. It adds each point to a table, stopping when the cumulative distance exceeds the specified value or reaches the end of the path.|parentFile= cmm.spawnFunctions.lua|syntax= CMM.PointsOnRoad(PathOnRoadsTbl <TBL>, distance <number>)|return= table|returnDesc= Returns a set of vec2 points where the numbers are less than|example= CMM.PointsOnRoad({{x=100,y=200},{x=300,y=400},{x=500,y=600}}, 3000)|exampleDesc= Retrieves points along a road path from (100,200) to (500,600), measuring 3000 units, and returns a table of points that lie within that distance.|related= |note= |envType= CMM|par1= table PathOnRoadsTbl|reqType1= table|reqName1= PathOnRoadsTbl|desc1= Array of road points, each containing x and y coordinates, representing a path to traverse.|par2= table percPoints|reqType2= table|reqName2= percPoints|desc2= Table of numbers from 0.01 - 0.99 as percentages}}

GetRouteDistance

Ozdeadmeat — Wed, 24 Jun 2026 12:27:15 GMT

GetRouteDistance – created via PowerShell script (2026-06-24T22:27:17Z)

New page

{{Template:FunctionInfo|fName= GetRouteDistance|fDescription= Calculates a series of points along a road path at a specified distance, starting from the first point and progressing sequentially until the target distance is reached. It adds each point to a table, stopping when the cumulative distance exceeds the specified value or reaches the end of the path.|parentFile= cmm.spawnFunctions.lua|syntax= CMM.GetRouteDistance(PathOnRoadsTbl <TBL>)|return= number|returnDesc= Table containing the points along the path that are at or within the specified distance from the start.|example= CMM.GetRouteDistance({{x=100,y=200},{x=300,y=400},{x=500,y=600}})|exampleDesc= Measures the total distance along the path defined by the points (100,200), (300,400), and (500,600) by calculating the 2D distance between each consecutive point and summing them up, returning the total distance as a number.|related= |note= |envType= CMM|par1= table PathOnRoadsTbl|reqType1= table|reqName1= PathOnRoadsTbl|desc1= Array of vec2 road points, each containing x and y coordinates, representing a path to traverse.}}

OutSoundForCoalition

Ozdeadmeat — Wed, 24 Jun 2026 12:27:13 GMT

outSoundForCoalition – created via PowerShell script (2026-06-24T22:27:15Z)

← Older revision	Revision as of 12:27, 24 June 2026
(One intermediate revision by the same user not shown)
(No difference)

GetCargoState

Ozdeadmeat — Wed, 24 Jun 2026 12:27:12 GMT

GetCargoState – created via PowerShell script (2026-06-24T22:27:14Z)

New page

{{Template:FunctionInfo|fName= GetCargoState|fDescription= Gets the Max Wounded, Personnel , maxmass and current weight of cargo on board the player's current airframe. Returns a table with the cargo state information or nil if an error occurs. Logs informational messages for errors or successful retrievals.|parentFile= cmm.sideMissionFunctions.lua|syntax= CMM.GetCargoState(UnitObject <table>)|return= nil or table|returnDesc= Returns a table containing the cargo state information (max wounded, max personnel, max,cargo, max weight, current weight) or nil if an error occurs.|example= CMM.Miz.CheckAirFrame(player, "CargoMission")|exampleDesc= Verifies that the player's airframe has the required cargo capacity for a cargo mission, returning true if valid and logging the match details.|related= |note= |envType= CMM|par1= table UnitObject|reqType1= table|reqName1= UnitObject|desc1= Player object}}

Miz.CheckAirFrame

Ozdeadmeat — Wed, 24 Jun 2026 12:27:12 GMT

Miz.CheckAirFrame – created via PowerShell script (2026-06-24T22:27:14Z)

← Older revision		Revision as of 12:27, 24 June 2026
Line 1:		Line 1:
	{{Template:FunctionInfo\|fName= Miz.CheckAirFrame\|fDescription= Checks if a player's airframe is compatible with a specified mission type by comparing the airframe's cargo capacity against the mission's required cargo type. Returns true if the airframe has sufficient cargo capacity, otherwise returns false. Logs informational messages for errors or successful matches.\|parentFile= cmm.sideMissionFunctions.lua\|syntax= CMM.Miz.CheckAirFrame(playerObject <object>, MissionType <string>)\|return= boolean\|returnDesc= Returns true if the airframe meets the mission's cargo requirement, false otherwise.\|example= CMM.Miz.CheckAirFrame(player, "CargoMission")\|exampleDesc= Verifies that the player's airframe has the required cargo capacity for a cargo mission, returning true if valid and logging the match details.\|related= \|note= \|envType= CMM\|par1= ~~object~~ playerObject\|reqType1= ~~object~~\|reqName1= playerObject\|desc1= Player object to retrieve the airframe type from, must have a getTypeName method.\|par2= string MissionType\|reqType2= string\|reqName2= MissionType\|desc2= The mission type string, case-insensitive, used to determine cargo requirements from sidequest data.}}		{{Template:FunctionInfo\|fName= Miz.CheckAirFrame\|fDescription= Checks if a player's airframe is compatible with a specified mission type by comparing the airframe's cargo capacity against the mission's required cargo type. Returns true if the airframe has sufficient cargo capacity, otherwise returns false. Logs informational messages for errors or successful matches.\|parentFile= cmm.sideMissionFunctions.lua\|syntax= CMM.Miz.CheckAirFrame(playerObject <object>, MissionType <string>)\|return= boolean\|returnDesc= Returns true if the airframe meets the mission's cargo requirement, false otherwise.\|example= CMM.Miz.CheckAirFrame(player, "CargoMission")\|exampleDesc= Verifies that the player's airframe has the required cargo capacity for a cargo mission, returning true if valid and logging the match details.\|related= \|note= \|envType= CMM\|par1= table playerObject\|reqType1= table\|reqName1= playerObject\|desc1= Player object to retrieve the airframe type from, must have a getTypeName method.\|par2= string MissionType\|reqType2= string\|reqName2= MissionType\|desc2= The mission type string, case-insensitive, used to determine cargo requirements from sidequest data.}}

GetTerrainHeightFlatness

Ozdeadmeat — Wed, 24 Jun 2026 12:27:12 GMT

GetTerrainHeightFlatness – created via PowerShell script (2026-06-24T22:27:14Z)

New page

{{Template:FunctionInfo|fName= GetTerrainHeightFlatness|fDescription= Returns a height difference value|parentFile= cmm.positionFunctions.lua|syntax= CMM.GetTerrainHeightFlatness(vec3<table>)|return= number or boolean or nil|returnDesc= Returns a number if all items are valid, if a limit number is defined it will return a boolean if it is within the limit or not, if the vec3 is invalid it will return nil|example= CMM.GetTerrainHeightFlatness({x=100, y=50, z=10})|exampleDesc= Returns the closest point on the road network to the given position, or the original position if no roads are found.|related= |note= |envType= CMM|par1= table vec3|reqType1= table|reqName1= vec3|desc1= Vec3 table with x, y, z coordinates|par2= number or nil radius|optType2= number or nil|optName2= radius|desc2= A number representing the radius in meters around the point to sample terrain heights [DEFAULT: 30]|par3= number or nil limit|optType3= number or nil|optName3= limit|desc3= An optional number representing a maximum acceptable height difference; if provided, the function will return a boolean indicating whether the height difference is within this limit.}}

GetClosestPointOnRoads

Ozdeadmeat — Wed, 24 Jun 2026 12:27:12 GMT

GetClosestPointOnRoads – created via PowerShell script (2026-06-24T22:27:14Z)

New page

{{Template:FunctionInfo|fName= GetClosestPointOnRoads|fDescription= Converts a heading in degrees into a forward Vec3 vector.|parentFile= cmm.positionFunctions.lua|syntax= CMM.GetClosestPointOnRoads(vec3<table>)|return= table or nil|returnDesc= Closest Road Vec3 vector {x, y, z}|example= CMM.GetClosestPointOnRoads({x=100, y=50, z=10})|exampleDesc= Returns the closest point on the road network to the given position, or the original position if no roads are found.|related= |note= |envType= CMM|par1= table vec3|reqType1= table|reqName1= vec3|desc1= Vec3 table with x, y, z coordinates}}

IsDegrees

Ozdeadmeat — Wed, 24 Jun 2026 12:27:08 GMT

IsDegrees – created via PowerShell script (2026-06-24T22:27:10Z)

New page

{{Template:FunctionInfo|fName= IsDegrees|fDescription= Checks whether a given number is within the valid degree range of 0 to 360 inclusive.|parentFile= cmm.positionFunctions.lua|syntax= CMM.IsDegrees(value <number>)|return= boolean|returnDesc= Returns true if the value is a number between 0 and 360 (inclusive), otherwise false.|example= CMM.IsDegrees(270)|exampleDesc= Checks if 270 is a valid degree value, returning true.|related= |note= |envType= CMM|par1= number value|reqType1= number|reqName1= value|desc1= The numeric value to validate as a degree measurement.}}

LogPointsTransaction