SpawnGroundUnitInZoneScheduledTaskFunction: Difference between revisions
Ozdeadmeat (talk | contribs) SpawnGroundUnitInZoneScheduledTaskFunction – created via PowerShell script (2025-11-11T21:12:42Z) Tag: Recreated |
Ozdeadmeat (talk | contribs) m SpawnGroundUnitInZoneScheduledTaskFunction – created via PowerShell script (2026-06-24T22:27:19Z) |
||
| 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 < | {{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.}} | ||
Latest revision as of 12:27, 24 June 2026
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | SpawnGroundUnitInZoneScheduledTaskFunction | |
| Function Description: | 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. | |
| File Location: | cmm.spawnFunctions.lua | |
| Syntax: | CMM.SpawnGroundUnitInZoneScheduledTaskFunction( table argTable ) | |
| Return Value: | nil | |
| Parameters: | Name | Description |
| argTable | {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. | |
| Example: | CMM.SpawnGroundUnitInZoneScheduledTaskFunction({"Area-10", 1, {"T-72", "BTR-80"}, 100, true}) | |
| Example Description: | 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 Functions: | ||
| Notes: | ||