Grimes at 23:13, 13 April 2018

2018-04-13T23:13:11Z

New page

{{Mission Scripting

|fName= mist.flagFunc.units_LOS

|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= unitSet1

|r2T= number
|r2N= altOffSet1

|r3T= UnitNameTable
|r3N= unitSet2

|r4T= number
|r4N= altOffSet2

|r5T= number/string
|r5N= flag

|r6N=

|o6T= table
|o6N= unitTableDef1

|o7T= table
|o7N= UnitTableDef2

|o8N=

|o1T= number/string
|o1N= stopFlag

|o2T= number
|o2N= radius

|o3T= number
|o3N= req_num

|o4T= number
|o4N= interval

|o5T= boolean
|o5N= toggle

|r1D= UnitNameTables- a tables of unit names that follow a special set of rules (see the entry on UnitNameTables).
|r2D= is the number of meters above the position of each unit from unitset1 that Line of Sight is checked from, cannot be 0.
|r3D= UnitNameTables- a tables of unit names that follow a special set of rules (see the entry on UnitNameTables).
|r4D= is the number of meters above the position of each unit from unitset2 that Line of Sight is checked from, cannot be 0.
|r5D= is the flag that will be set true if the conditions are true
|o6D= is an optional table containing the a [[unitNameTables]] definition used to define the unitset1 value.
|o7D= is an optional table containing the a [[unitNameTables]] definition used to define the unitset2 value.
|o8D=

|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 radius, in meters, out to which the
LOS check occurs; beyond this radius, units will not be considered LOS.
|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.

}}

|rtnExamples= nothing

|example= <code>
do
mist.flagFunc.units_LOS{
unitset1 = {'[g]M1 PLT1', '[g]M1 PLT2', '[g]M2 PLT1'},
altoffset1 = 3,
unitset2 = {'[red][vehicle]'},
altoffset2 = 3,
flag = 10,
interval = 20
}
end
</code>

|notes= nce this function is run, it will start a continuously evaluated process that will set flag flag true
once units listed in unitset1 are line-of-sight (LOS) to units listed in unitset2. This process will
keep running, and flag will keep being set true as long as the line-of-sight 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 unitset1 or unitset2 is passed as a unitNameTable definition table then that information will be added to the optional variables unitTableDef1 and unitTableDef2. 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|unts_LOS]]

MIST units LOS - Revision history

Grimes at 23:13, 13 April 2018