MIST cloneInZone - Revision history

Grimes at 09:20, 11 February 2022

2022-02-11T09:20:13Z

Grimes at 10:12, 7 July 2021

2021-07-07T10:12:43Z

Grimes at 22:50, 13 April 2018

2018-04-13T22:50:50Z

New page

{{Mission Scripting

|fName= mist.cloneInZone|

|vNum = Mist 3.0

|desc= Clones a group of the name groupName to a randomized point within a trigger zone. |

|rtnType= string

|reqType1= string

|reqName1= groupName

|reqType2= string/table

|reqName2= zoneName/tableOfZoneNames

|reqType3=

|reqName3=

|reqType4=

|reqName4=

|reqType5=

|reqName5=

|optType1= boolean

|optName1= disperse

|optType2= number

|optName2= radius

|optType3=

|optName3=

|optType4=

|optName4=

|optType5=

|optName5=

|vars=

|varExamples=
groupName= name of the group that is to be cloned inside a zone

zoneName= Name of the zone as placed in the editor to that the group will randomly spawn inside of.

or

tableOfZoneNames= If numerous zone names are given, a single zone will be chosen at random for the group to spawn inside of.

disperse= if this variable is present each unit of the group will be randomly dispersed in the zone. If not present, the group will remain in its default formation

radius= if this variable is present in addition to disperse, this radius will specify the maximum distance each unit will be from the first unit of the group.

|rtnExamples= string of group's name

|example= The following code will clone 10 groups inside of a number of zones
<pre>
for i = 1, 10 do
mist.cloneInZone('zues', {'myZone1', 'myZone2', 'LowCalCalzoneZone'})
end
</pre>
|notes= As of mist 3.3 this function supports the use of static objects.

This function limits where groups of certain types can spawn. Ground groups can only spawn on the ground and roads. Ships can only spawn on water. And aircraft can be spawned anywhere. Note that for ground groups any part of the airbase like the runway, ramp, or taxiway is '''not a valid spawning''' location. This is done so ground units won't accidentally block AI aircraft paths when at an airbase.
|funcs= {{listOfMistDynAddFuncs}}

}}
[[Category: MIST|cloneInZone]]

@@ Line 101: / Line 101: @@
    end
 </pre>
 |notes= As of mist 3.3 this function supports the use of static objects.

@@ Line 37: / Line 37: @@
 |optName2= radius
-|optType3=
+|optType3= table
-|optName3=
+|optName3= vars
 |optType4=
@@ Line 63: / Line 63: @@
 radius= if this variable is present in addition to disperse, this radius will specify the maximum distance each unit will be from the first unit of the group.
 |rtnExamples= string of group's name