MIST teleportToPoint - Revision history

Grimes at 10:17, 7 July 2021

2021-07-07T10:17:12Z

Grimes at 06:23, 2 November 2020

2020-11-02T06:23:58Z

Grimes at 06:23, 2 November 2020

2020-11-02T06:23:05Z

Grimes at 05:02, 29 May 2018

2018-05-29T05:02:54Z

Grimes at 23:07, 13 April 2018

2018-04-13T23:07:10Z

New page

{{Mission Scripting

|fName= mist.teleportToPoint

|vNum = Mist 3.0

|desc= Respawns/Clones/Teleports an group to a point and within a randomized radius of the point.

|rtnType= string

|reqType1= table

|reqName1= vars

|reqType2=

|optType1=

|varExamples= {{varsTable

|r1T= string
|r1N= groupName

|r2T= table
|r2N= point

|r3T= string
|r3N= action

|r4N=

|o1T= boolean
|o1N= disperse

|o2T= number
|o2N= maxDisp

|o3T= number
|o3N= radius

|o4T= number
|o4N= innerRadius

|o5T= table
|o5N= route

|r1D= is the name of the group the function will teleport
|r2D= is a vec3 coordinate that designates where the group will spawn
|r3D= is a string value which defines the what is done to the group. valid entries are:

'teleport' : Teleports the group in its current state (dead units will not respawn)
'respawn' : respawns the group
'clone' : creates a copy of the group

|r4D=
|r5D=
|r6D=

|o1D= is an optional variable that if present each unit of the group will spawn at a random location.
|o2D= is an optional variable that defines how far each unit will be from each other.
|o3D= is an optional variable that defines the max distance from the point that a group can spawn from
|o4D= is an optional variable that defines the minimum distance from the point that the group can spawn from
|o5D= is an optional variable that defines the route assigned to the group

}}

|rtnExamples= string of group's name

|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= 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|teleportToPoint]]

@@ Line 50: / Line 50: @@
 |o6N= newGroupName
-|o7T= table
+|o7T= boolean
-|o7N= validTerrain
+|o7N= anyTerrain
-|o8T=
+|o8T= table
-|o8N=
+|o8N= validTerrain
 |r1D= is the name of the group the function will teleport
@@ Line 75: / Line 85: @@
 |o5D=  is an optional variable that defines the route assigned to the group
 |o6D= is an optional variable for the new group name that is to be spawned.
-|o7D=  is an optional variable that defines the type of terrain that is checked, if not provided mist will assume any terrain type for aircraft and only ground for ground units.
+|o7D=  is an optional variable that if present will define any terrain type as valid.
 }}

← Older revision		Revision as of 06:23, 2 November 2020
Line 54:		Line 54:

	\|o8T=		\|o8T=
		+	\|o8N=
		+

	\|r1D= is the name of the group the function will teleport		\|r1D= is the name of the group the function will teleport

@@ Line 47: / Line 47: @@
 |o5N= route
-|o6T=
+|o6T= string
-|o6N=
+|o6N= newGroupName
 |r1D= is the name of the group the function will teleport
@@ Line 67: / Line 72: @@
 |o4D= is an optional variable that defines the minimum distance from the point that the group can spawn from
 |o5D=  is an optional variable that defines the route assigned to the group
 }}