Grimes at 08:58, 4 June 2021

2021-06-04T08:58:30Z

Grimes: Created page with "{{Mission Scripting |fName= mist.dynAdd |vNum = Mist 3.0 |desc= With valid data, this function will dynamically spawn a group consisting of unitsTable within the categoryNa..."

2018-04-12T06:36:02Z

Created page with "{{Mission Scripting |fName= mist.dynAdd |vNum = Mist 3.0 |desc= With valid data, this function will dynamically spawn a group consisting of unitsTable within the categoryNa..."

New page

{{Mission Scripting

|fName= mist.dynAdd

|vNum = Mist 3.0

|desc= With valid data, this function will dynamically spawn a group consisting of unitsTable within the categoryName for countryName using the built in scripting function coalition.addGroup.

|rtnType= table

|reqType1= table

|reqName1= vars

|reqType2=

|optType1=

|varExamples= {{varsTable

|r1T= table
|r1N= units

|r2T= string/number
|r2N= country

|r3T= string/number
|r3N= category

|r4N=

|o1T= string
|o1N= groupName/name

|o2T= number
|o2N= groupId

|o3T= boolean
|o3N= clone

|o4T= table
|o4N= route

|o5T=
|o5N=

|r1D= is a unitTable as formatted in the mission editor
|r2D= is the country name the group will spawn for
|r3D= is the category of the group to spawn
|r4D=
|r5D=
|r6D=

|o1D= is an optional variable that defines the group name. If not present the function will generate a new name based on country, category, and groupId. '''If it is the same as a pre-existing group, this function will overwrite and remove that group existing from the mission.'''
|o2D= is an optional variable that defines the group Id. If not present the function will generate a new group Id based off of the number of existing groups. '''If it is the same as a pre-existing groups Id, this function will overwrite and remove that existing group from the mission.'''
|o3D= is an optional variable that defines whether or not it should treat the passed group data as a clone. If present it will create a new group Id and groupName regardless if you passed a custom name or Id.
|o4D= is an optional variable that defines the default route assigned to the group. Function is overloaded to accept it as either:
<pre>
route.points = {
[1] = {pointTable},
[2] = {pointTable},
...
},

or

route = {
[1] = {pointTable},
[2] = {pointTable},
...
}
</pre>
|o5D=

}}

|rtnExamples= groupDataTable

|example= <pre>
local vars = {}
vars.gpName = ‘group1’
vars.action = 'clone'
vars.point = vec3
vars.radius = 1000
vars.disperse = ‘disp’
vars.maxDisp = 500
mist.teleportToPoint(vars)
</pre>

|notes=

|funcs= {{listOfMistDynAddFuncs}}

}}
[[Category:MIST|dynAdd]]

@@ Line 5: / Line 5: @@
 |vNum = Mist 3.0
-|desc= With valid data, this function will dynamically spawn a group consisting of unitsTable within the categoryName for countryName using the built in scripting function coalition.addGroup.
+|desc= With valid data, this function will dynamically spawn a group consisting of unitsTable within the categoryName for countryName using the built in scripting function coalition.addGroup. See examples for different group types here:
 |rtnType= table
@@ Line 79: / Line 84: @@
 |rtnExamples= groupDataTable
-|example= <pre>
+|example= The following would get the current information pertaining to a ground group that is currently on the red coalition country of East Germany and changes the country of it to "Germany". Due to the ids and names of the units being identical the original units will disappear and be replaced by the same units but simply belonging to a different country and coalition as a result.
-   local vars = {}
+<pre>
-  vars.gpName = ‘group1’
+   local gp = mist.getCurrentGroupData('HasselhoffTankPlatoon2')
-   vars.action = 'clone'
+   gp.country = 'Germany'
-  vars.point = vec3
+   mist.dynAdd(gp)
 </pre>

MIST dynAdd - Revision history

Grimes at 08:58, 4 June 2021

Grimes: Created page with "{{Mission Scripting |fName= mist.dynAdd |vNum = Mist 3.0 |desc= With valid data, this function will dynamically spawn a group consisting of unitsTable within the categoryNa..."