Grimes at 23:09, 13 April 2018

2018-04-13T23:09:40Z

New page

{{Mission Scripting

|fName= mist.spawnRandomizedGroup

|vNum = Mist 3.5

|desc= Randomizes the contents of a group for further use in spawning or other purposes a designer could use it for. The optional variables define which units in the group will not be randomized. The lowerLimit and upperLimit variables respectively define the low and upper limits on which unit indexes can be randomized. The excludeNum table is a table of numbers, in no particular order, of which unit indexes will be ignored. The excludeType table defines the unitType name of units that will be ignored.

|rtnType= table

|reqType1= table

|reqName1= units

|reqType2=

|optType1= table

|optName1= vars

|optType2=

|varExamples=
<pre>
units = mist.getGroupData(groupName).units
</pre>
{{varsTable

|r1T=
|r1N=

|r2T=
|r2N=

|r3T=
|r3N=

|r4N=

|o1T= number
|o1N= lowerLimit

|o2T= number
|o2N= upperLimit

|o3T= table
|o3N= excludeNum

|o4T= table
|o4N= excludeType

|o5T=
|o5N=

|r1D=
|r2D=
|r3D=

|r4D=
|r5D=
|r6D=

|o1D= is an optional variable that defines the lower range of which unit indexes will be randomized.
|o2D= is an optional variable that defines the upper range of which unit indexes will be randomized.
|o3D= is an optional table that defines unit indexes that will not be randomized.
|o4D= is an optional table of strings that lists unitTypes that will not be randomized.
|o5D=

}}

|rtnExamples= units table

|example= <pre>
local newGroup = mist.getGroupData('myGroup')
newGroup.units = mist.randomizeGroupOrder(newGroup.units), {lowerLimit = 2, upperLimit = 9})

mist.dynAdd(newGroup)
</pre>

Groups will spawn in the following order with 'r' representing a random position:
1, 2, r, r, r, r, r, r, 9, 10

|notes=

|funcs= {{listOfMistGroupData}}

}}
[[Category: MIST|randomizeGroupOrder]]

MIST randomizeGroupOrder - Revision history

Grimes at 23:09, 13 April 2018