Grimes at 23:12, 13 April 2018

2018-04-13T23:12:10Z

New page

{{Mission Scripting

|fName= mist.flagFunc.units_in_moving_zones

|vNum = Mist 1.0

|desc= Sets a flag true when the a required number of units are inside of the specified zones which are attached to the specified zone_units.

|rtnType= nothing

|reqType1= table

|reqName1= vars

|reqType2=

|optType1=

|varExamples= {{varsTable

|r1T= UnitNameTable
|r1N= units

|r2T= UnitNameTable
|r2N= zone_units

|r3T= number/string
|r3N= flag

|r4T= number
|r4N= radius

|r5T=
|r5N=

|r6T=
|r6N=

|o1T= number/string
|o1N= stopFlag

|o2T= string
|o2N= zone_type

|o3T= number
|o3N= req_num

|o4T= number
|o4N= interval

|o5T= boolean
|o5N= toggle

|o6T= table
|o6N= unitTableDef

|o7T= table
|o7N= zUnitTableDef

|o8N=

|r1D= is a UnitNameTable- a table of unit names that follow a special set of rules (see the entry
on [[unitNameTables]]).
|r2D= is a UnitNameTable- a table of unit names that follow a special set of rules (see the
entry on [[unitNameTables]]).
|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 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>
|o3D= is an optional variable that defines the shape of the zones. The following are the
allowed values for zone_type:
'cylinder' - cylindrical shaped zone extending to +/- infinity in altitude.
'sphere' - spherical zone.

If not specified, it defaults to 'cylinder'.
|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 used to define the units value.
|o7D= is an optional table containing the a [[unitNameTables]] definition used to define the zone_units value.
|o8D=
}}

|rtnExamples= nothing

|example= <code>
do
mist.flagFunc.units_in_moving_zones{
units = {'[blue]'},
zone_units = {'[red]'},
flag = 500,
radius = 10000,
stopflag = 9999,
req_num = 4,
zone_type = 'sphere',
interval = 10,
}
end
</code>

|notes= Once this function is run, it will start a continuously evaluated process that will set flag true
once units listed in units are inside any of the moving zones around the units listed in
16

zone_units. This process will keep running, and flag will keep being set true as long as the
unit(s)-in-zone(s) 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_moving_zones]]

MIST units in moving zones - Revision history

Grimes at 23:12, 13 April 2018