MarkerFlare
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | MarkerFlare | |
| Function Description: | Processes a marker flare event by extracting a color code from the marker text and creating a flare effect at the marker's position. If no color is specified, it uses the default flare color defined in CMM.DEFAULT_FLARE. The function supports shorthand color codes (g=green, r=red, w=white, y=orange) and falls back to the default color if none are provided. | |
| File Location: | cmm.MapCommandFunctions.lua | |
| Syntax: | CMM.MarkerFlare( table EventData ) | |
| Return Value: | nil | |
| Parameters: | Name | Description |
| EventData | Custom Event Table passed by S_EVENT_MARK_REMOVED EventHandler, contains text and pos fields; text is split by ':' to extract the color code. | |
| Example: | CMM.MarkerFlare({text = "!flare:yellow", pos = <vec3>}) | |
| Example Description: | Creates an orange flare at position {x=100,y=200,z=50} using the shorthand 'y' color code. | |
| Related Functions: | ||
| Notes: | Map Command !flare | |