Grimes: Created page with "{{Mission Scripting |fName= mist.marker.drawZone |vNum = Mist 4.5 |desc= Function will use a zone as defined in the editor as a basis for a shape drawn on the map. By defau..."

2021-09-07T11:08:31Z

Created page with "{{Mission Scripting |fName= mist.marker.drawZone |vNum = Mist 4.5 |desc= Function will use a zone as defined in the editor as a basis for a shape drawn on the map. By defau..."

New page

{{Mission Scripting

|fName= mist.marker.drawZone

|vNum = Mist 4.5

|desc= Function will use a zone as defined in the editor as a basis for a shape drawn on the map. By default it will inherit the color the user chooses for the zone. Any valid entry for [[MIST markerAdd|mist.marker.add]] will be inherited by the shape.

|rtnType= table

|reqType1= string

|reqName1= zoneName

|reqType2=

|optType1= table

|optName1= vars

|optType2=

|varExamples= {{varsTable

|r1T=
|r1N=

|o1T= string/number
|o1N= name/id

|o2T= boolean
|o2N= ignoreColor

|o3T= number
|o3N= radius

|o4T= string
|o4N= text

|o5T= table
|o5N= markFor

|o6T= number/string
|o6N= markForCoa
|o7T= table
|o7N= color
|o8T= table
|o8N= fillColor
|o9T= number
|o9N= lineType
|o10T= boolean
|o10N= readOnly
|o11T= text
|o11N= message
|o12T= number
|o12N= fontSize

|r1D= vec3 or table of vec3 points indexed numerically to define the shapes.

|r2D=
|r4D=
|r5D=
|r6D=

|o1D= is used to identify the mark, can be used to replace marks already created.
|o2D= is a boolean that if present the color of the zone as defined in the editor will be ignored.

|o3D= is only relevant if a circle is passed. Radius of the circle to be drawn in meters

|o4D= is relevant to panels and text. Is a string of the text that is to be displayed
|o5D= accepts a string or a table of strings as keywords to define which groups will receive the message. This table can be use a variety of values to send the message to a very specific group of players. Acceptable values are in a table forma similar to the following:
<pre>{
units = {...}, -- unit names.
coa = {...}, -- coa names
countries = {...}, -- country names
CA = {...}, -- looks just like coa.
unitTypes = { red = {TYPENAME}, blue = {}, all = {}, Russia = {},}
}
</pre>
|o6D= is simplified entry more meant for the shapes because the shapes can only be displayed to all or a specific coalition
|o7D= is the color of the outline of a shape in {r, g, b, alpha} table format. Values can are between 0 to 1. However mist supports 0-255 format. If the number is greater than 1 mist will assume it is in 0-255 format. By default if color is not defined mist will generate a color automatically based on who is to see the mark. 80% Red or Blue.
|o8D= is the fill color for the shape. Same rules as stated above apply
|o9D= is the format the outline will be in. By default if not present the value used is 2.

{{DCS_enum_lineTypes}}

|o10D= is a boolean value for whether or not the mark or shapes can be deleted by users. At present only applies to mark panels. If not present defaults to true.
|o11D= is text that will be displayed when the mark is created
|o12D= is only relevant to the text shape. Defines how large of font will be used when displaying the text on the F10 map. If not present the default font size is 16.

}}

|rtnExamples=

|example= Draws a trigger zone named "searchArea" on the map.

mist.marker.drawZone('searchArea')

|notes=
|funcs= {{listOfMistMarkerFuncs}}

}}
[[Category: MIST|marker drawZone]]

MIST markerDrawZone - Revision history

Grimes: Created page with "{{Mission Scripting |fName= mist.marker.drawZone |vNum = Mist 4.5 |desc= Function will use a zone as defined in the editor as a basis for a shape drawn on the map. By defau..."