MIST group dead

mist.flagFunc.group_dead

Added with: Mist 3.5

Description

Sets a flag true if the specified group is dead.

Syntax

nothing mist.flagFunc.group_dead(table vars )

Valid Input Values:

vars tables have the following recognized fields( required entries in blue, optional in green): vars = { groupName = string groupName, flag = number/string flag, stopFlag = number/string stopFlag, interval = number interval, toggle = boolean toggle, } groupName is the name of the group to check flag is the flag that will be set true if the conditions are true stopFlag is an optional variable that allows you to specify a flag number that, if set true, will stop the process. interval is an optional variable that allows you to specify how often (in seconds) the function is checked. If not specified, interval defaults to 1 </ins> toggle 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.

Return value:

nothing

Return example:

nothing

Usage Examples:

Example will respawn the group if the group is killed. mist.flagFunc.group_dead { groupName = 'myGroup, flag = 100, toggle = true, } Mission Editor Trigger: Switched Condition> Flag 100 is True> Do Script(mist.respawnGroup('myGroup'))

Notes:

The mission editor triggers does not "see" dynamically spawned groups, while the simulator scripting engine does. The purpose of this function is to create a mission editor like condition that works with dynamically spawned AI.

Related Functions

mapobjs_dead_polygon, Mapobjs_dead_zones, units_in_zones, units_in_moving_zones, units_in_polygon, units_LOS, group_alive, group_dead, group_alive_more_than, group_alive_less_than

Scripting Engine

MIST Root Page