Grimes at 08:58, 8 November 2023

2023-11-08T08:58:31Z

Grimes at 23:12, 13 April 2018

2018-04-13T23:12:23Z

New page

{{Mission Scripting

|fName= mist.flagFunc.units_in_polygon

|vNum = Mist 1.0

|desc= Sets a flag true when the a required number of units are inside of the specified polygon zone.

|rtnType= nothing

|reqType1= table

|reqName1= vars

|reqType2=

|optType1=

|varExamples= {{varsTable

|r1T= UnitNameTable
|r1N= units

|r2T= table
|r2N= zone

|r3T= number/string
|r3N= flag

|r4N=

|o1T= number/string
|o1N= stopFlag

|o2T= number
|o2N= maxalt

|o3T= number
|o3N= req_num

|o4T= number
|o4N= interval

|o5T= boolean
|o5N= toggle

|o6T= table
|o6N= unitTableDef

|o7N=

|r1D= is a UnitNameTable- a table of unit names that follow a special set of rules (see the entry
on UnitNameTables).
|r2D= is a table of map points that defines the polygon shape (indexed numerically). See [[pointInPolygon]] for a good explanation.
|r3D= is the flag number that will be set true if the conditions are met
|r4D= is the radius, in meters, of all the zones drawn around each unit in zone_units.
|r5D=
|r6D=

|o1D= is an optional variable that allows you to specify a flag number that, if set true, will
stop the process.
|o2D= is an optional variable that allows you to a specify a maximum altitude (above sea level)
for the polygon zone. Altitude above ground level will likely be added in a future version of
Mist.
|o3D= is an optional variable that allows you to specify the minimum number of units that
must be in one (or more) of the zones before flag is set true. <ins> If req_num is not specified, it
defaults to 1. </ins>
|o4D= is an optional variable that allows you to specify how often (in seconds) the in-zone
condition is checked; for lots of units in lots of zones (like hundreds of units in hundreds of
different zones), it might be desirable to increase the interval to save computer processing
time. <ins> If not specified, interval defaults to 1 </ins>
|o5D= is an optional variable that if present will switch the flag value to false when the
required conditions are not met. If not specified toggle defaults to false.
|o6D= is an optional table containing the a [[unitNameTables]] definition. If present this value will be used to modify the units checked if new units are dynamically added to the mission. This value and capability is also used if the units variable is given a unitNameTables definition.
|o7D=

}}

|rtnExamples= nothing

|example= <code>
do
mist.flagFunc.units_in_polygon{
units = {'[blue][vehicle]'},
zone = mist.getGroupPoints('forest1'),
flag = 11
}
end
</code>

|notes= Once this function is run, <ins>it will start a continuously evaluated process </ins>that will set flag flag true
once units listed in units are inside the polygon zone defined by the map points listed in zone.
This process will keep running, and flag will keep being set true as long as the unit(s)-in-zone
conditions persist, unless the process is stopped with stopflag.

'''Mist 3.5''' allows for strings to be used to define flags.

'''Mist 4.0''' has modified this function to better adapt to added any units dynamically spawned into the mission. If units or zone_units is passed as a unitNameTable definition table then that information will be added to the optional variables unitTableDef and zUnitTableDef. Once present there will be a check whenever dynamically added units are spawned into the mission, if those units fit into the unitNameTable definition then they will also be checked by the function.

|funcs= {{listOfMistFlagFuncs}}

}}
[[Category: MIST|units_in_polygon]]

@@ Line 54: / Line 54: @@
 |r1D= is a UnitNameTable- a table of unit names that follow a special set of rules (see the entry
 on UnitNameTables).
-|r2D= is a table of map points that defines the polygon shape (indexed numerically). See [[pointInPolygon]] for a good explanation.
+|r2D= is a table of map points that defines the polygon shape (indexed numerically). See [[MIST_pointInPolygon|pointInPolygon]] for a good explanation.
 |r3D= is the flag number that will be set true if the conditions are met
 |r4D= is the radius, in meters, of all the zones drawn around each unit in zone_units.

MIST units in polygon - Revision history

Grimes at 08:58, 8 November 2023

Grimes at 23:12, 13 April 2018