MarkerClean
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | MarkerClean | |
| Function Description: | Clears units and objects within a specified radius from a given position using a clean radius command. | |
| File Location: | cmm.MapCommandFunctions.lua | |
| Syntax: | CMM.MarkerClean( table EventData ) | |
| Return Value: | nil | |
| Parameters: | Name | Description |
| EventData | Event data containing text and position from the marker interaction | |
| Example: | CMM.MarkerClean(EventData) | |
| Example Description: | Parses the input text to extract a radius value. If the radius is valid and within the allowed limit (CMM.clean.size), it clears all units and objects within that radius. If the radius exceeds the limit, it is capped at CMM.clean.size. If the input is invalid (not a number), an error message is logged. Defaults to a maximum clean radius of 9000 meters if CMM.clean.size is not set. | |
| Related Functions: | ||
| Notes: | Marker Command Syntax = !clean | |