MarkerIllum
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | MarkerIllum | |
| Function Description: | Processes a marker event to set illumination intensity at a specified coordinate; extracts a value from the event text, validates it as a number, and ensures it does not exceed the maximum brightness defined in CMM.illum.brightness; if invalid or out of bounds, defaults to the maximum brightness and creates illumination. | |
| File Location: | cmm.MapCommandFunctions.lua | |
| Syntax: | CMM.MarkerIllum( table EventData ) | |
| Return Value: | nil | |
| Parameters: | Name | Description |
| EventData | Custom Event Table passed by S_EVENT_MARK_REMOVED EventHandler, containing text and pos fields; text is split on ':' to extract the illumination power value. | |
| Example: | CMM.MarkerIllum({text = "!illum:50000", pos = <vec3>}) | |
| Example Description: | Sets illumination power to 50000 at a coordinate, but limits it to the maximum brightness defined in CMM.illum.brightness and creates the illumination effect. | |
| Related Functions: | ||
| Notes: | Map Command !illum | |