Grimes at 05:54, 19 April 2021

2021-04-19T05:54:42Z

Grimes at 23:02, 13 April 2018

2018-04-13T23:02:41Z

New page

{{Mission Scripting

|fName= mist.flagFunc.group_alive_less_than

|vNum = Mist 3.5

|desc= Sets a flag true if the specified group is alive less than the specified percentage.

|rtnType= nothing

|reqType1= table

|reqName1= vars

|reqType2=

|optType1=

|varExamples= {{varsTable

|r1T= string
|r1N= groupName

|r2T= number/string
|r2N= flag

|r3T= number
|r3N= percent

|r4T=
|r4N=

|r5T=
|r5N=

|r6N=

|o1T= number/string
|o1N= stopFlag

|o2T= number
|o2N= interval

|o3T= boolean
|o3N= toggle

|o4T=
|o4N=

|o5T=
|o5N=

|r1D= is the name of the group to check
|r2D= is the flag that will be set true if the conditions are true
|r3D= is the percentage of the group that must be alive for the flag to be set true. Value is 'out of 100'. The number (50) represents 50%.
|r4D=
|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 how often (in seconds) the function is checked. If not specified, interval defaults to 1 </ins>
|o3D= 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.

|o4D=
|o5D=
}}

|rtnExamples= nothing

|example= <code>
mist.flagFunc.group_alive_less_than {
units = 'myGroup,
flag = 100,
percent = 20,
toggle = true,
}

Mission Editor Trigger: Switched Condition> Flag 100 is True> Message To All('myGroup has less than 20 percent of its units remaining alive!')

</code>

|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.

|funcs= {{listOfMistFlagFuncs}}

}}
[[Category: MIST|group_alive_less_than]]

@@ Line 62: / Line 62: @@
 |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 how often (in seconds) the function is checked. If not specified, interval defaults to 1 </ins>
+|o2D= is an optional variable that allows you to specify how often (in seconds) the function is checked. If not specified, interval defaults to 1
 |o3D= 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.
@@ Line 72: / Line 72: @@
 |rtnExamples= nothing
-|example= <code>
+|example= The following will display a message when less than 20% of the group is alive.
    mist.flagFunc.group_alive_less_than {
-     units = 'myGroup,
+     groupName = "myGroup",
      flag = 100,
      percent = 20,
@@ Line 80: / Line 81: @@
+   }
-Mission Editor Trigger: Switched Condition> Flag 100 is True> Message To All('myGroup has less than 20 percent of its units remaining alive!')
+Mission Editor Trigger:
 |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.

MIST group alive less - Revision history

Grimes at 05:54, 19 April 2021

Grimes at 23:02, 13 April 2018