Dump.Groups
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | dump.Groups | |
| Function Description: | Dumps a table of airbase information for the specific map the mission is running, filtering groups by coalition ID and category, extracting group names, unit names, positions, and headings, and saves the data to a JSON file named after the mission theatre in the dump directory. | |
| File Location: | cmm.tools.lua | |
| Syntax: | CMM.dump.Groups( number coal , number cat ) | |
| Return Value: | table | |
| Parameters: | Name | Description |
| coal | Coalition ID to filter groups; defaults to 2 if not provided or invalid. | |
| cat | Category of group; 0=AIRPLANE, 1=HELICOPTER, 2=GROUND, 3=SHIP, 4=TRAIN; defaults to 2. | |
| Example: | CMM.dump.Groups(2, 2) | |
| Example Description: | Retrieves ground units from coalition 2 and dumps their group and unit data into a JSON file named based on the current mission theatre. | |
| Related Functions: | ||
| Notes: | ||