| Environment:
|
Mission Scripting
|
|
|
| Function:
|
circleToAll
|
| Function Description:
|
Draws a circular marker visible to all coalition units at the specified coordinates.
|
|
|
| File Location:
|
cmm.drawFunctions.lua
|
|
|
| Syntax:
|
CMM.circleToAll( table vec3Tbl , number or nil radius , number or nil coal , table or nil colour , table or nil fillColour , number or nil lineType ,boolean or nil readOnly , string or nil msg )
|
|
|
| Return Value:
|
number or nil
|
|
|
| Parameters:
|
Name
|
Description
|
| vec3Tbl | REQUIRED table of one or more Vec3 variables {x,y,z} or {{x,y,z},{x,y,z},{x,y,z},{x,y,z}} |
|---|
| radius | Radius [DEFAULT: 50] |
|---|
| coal | -1 All, 0 Neutral, 1 Red, 2 Blue [DEFAULT: -1] |
|---|
| colour | {r=, g=, b=, a=} color components (0‑1) [DEFAULT: CMM.Marker.Colour.Black] |
|---|
| fillColour | {r=, g=, b=, a=} color components (0‑1) [DEFAULT: CMM.Marker.Colour.HalfBlack] |
|---|
| lineType | 0 No Line, 1 Solid, 2 Dashed, 3 Dotted, 4 Dot Dash, 5 Long Dash, 6 Two Dash [DEFAULT: 1] |
|---|
| readOnly | Marker visibility flag (read‑only) [DEFAULT False] |
|---|
| msg | Optional message to display on the marker. |
|---|
|
|
| Example:
|
local markerId = CMM.circleToAll({x=1000,y=2000,z=300}, 75)
|
| Example Description:
|
Creates a circle with radius 75 around the point (1000, 2000, 300) visible to all coalition units.
|
|
|
| Related Functions:
|
|
| Notes:
|
|
