DCS func addGroup - Revision history

Grimes at 07:52, 20 March 2024

2024-03-20T07:52:04Z

Grimes at 02:22, 12 December 2023

2023-12-12T02:22:28Z

Grimes at 01:08, 9 March 2023

2023-03-09T01:08:24Z

Grimes at 07:24, 17 March 2022

2022-03-17T07:24:52Z

Grimes at 07:42, 14 June 2021

2021-06-14T07:42:39Z

Grimes at 08:46, 4 June 2021

2021-06-04T08:46:27Z

Gillogical at 07:11, 19 November 2020

2020-11-19T07:11:08Z

Rurounijones at 23:28, 25 May 2018

2018-05-25T23:28:48Z

Grimes: 1 revision imported

2018-04-12T00:12:17Z

1 revision imported

New page

{{Template:dcs_funcs

|fName= addGroup

|vNum= 1.2.4

|par1= [[DCS_singleton_coalition|coalition]]

|par2=

|par3=

|par4=

|desc= Dynamically spawns a group of the specified category for the specified country. Group data table is in the same format as created by the mission editor.

The coalition of the group is defined by the coalition its country belongs to.

If the group or any unit within shares a name of an existing group or unit, the existing group or unit will be destroyed when the new group is created.

Function can NOT spawn new aircraft with a skill level of "client". However in single player a group can be spawned with the skill level of "Player". When this occurs the existing player aircraft will be destroyed.

If no groupId or unitId is specified or the Ids are shared with existing groups or units, a new Id will be created for the new group.

|rtnType= Group

|rtnExample= none

|reqType1= enum

|reqName1= countryId

|reqType2= enum

|reqName2= groupCategory

|reqType3= table

|reqName3= groupData

|reqType4=

|optType1=

|optType2=

|examples= Basic table for a ground unit
<pre>
local groupData = {
["visible"] = false,
["taskSelected"] = true,
["route"] =
{
}, -- end of ["route"]
["groupId"] = 2,
["tasks"] =
{
}, -- end of ["tasks"]
["hidden"] = false,
["units"] =
{
[1] =
{
["type"] = "LAV-25",
["transportable"] =
{
["randomTransportable"] = false,
}, -- end of ["transportable"]
["unitId"] = 2,
["skill"] = "Average",
["y"] = 616314.28571429,
["x"] = -288585.71428572,
["name"] = "Ground Unit1",
["playerCanDrive"] = true,
["heading"] = 0.28605144170571,
}, -- end of [1]
}, -- end of ["units"]
["y"] = 616314.28571429,
["x"] = -288585.71428572,
["name"] = "Ground Group",
["start_time"] = 0,
["task"] = "Ground Nothing",
} -- end of [1]

coalition.addGroup(country.id.USA, Group.Category.GROUND, groupData)
</pre>

Required Group values
name string for the group name
task string for the master task that will dictate core AI behavior

Optional Group Values
groupId number groupId
start_time number time in seconds after mission start time that the group will spawn in. If 0 the group will spawn immediately.
lateActivation boolean value that can override start_time to force the group to spawn in via trigger
hidden boolean whether or not the group is visible on the F10 map view
route table complex table defining the route and tasks assigned to the group

Optional Group Values (Aircraft and Helicopters)
uncontrolled boolean for ground starts, whether or not the aircraft will be visible but not active
modulation number (0 or 1) for AM or FM radio
frequency number of the radio frequency the unit will broadcast to
communication boolean for whether or not the group will communicate over the radio

Optional Group Values (Ground and Ships)
visible boolean For whether or not the group is visible before its start time

Required Unit values
name name for the type of object
type string for the type of object
x number for x coordinate
y number for y coordinate

Required Unit Values for Aircraft and Helicopters
alt number altitude in meters
alt_type string "BARO" or "RADIO" for Above sea level or above ground level
speed number velocity the aircraft will spawn at measured in meters per second
payload table of the aircrafts payload including fuel, weapons, and countermeasures
callsign table/number of the callsign for the unit. NATO countries use a table to define callsigns while the Russian style uses a number

Optional Unit Values
unitId number unitId
heading number heading of the object in radians
skill string of the units skill level. Can be "Excellent", "High", "Good", "Average", "Random", "Player"

Aircraft and Helicopter values
livery_id string name of the livery for the aircraft
psi number
onboard_num string of the tail number on the aircraft

Helicopter Values
ropeLength number length of a rope used for sling loading, default is 15
|related=
[[DCS_singleton_coalition|'''Coalition Functions:''']] {{ListOfCoalitionFuncs}}

|notes= You '''''MUST''''' have a built in delay before accessing the group or units controllers and issuing tasks, commands or options of the group spawned. Otherwise the you are likely to cause a game crash.

Route table can be empty or assigned to the group after spawning using [[DCS_func_getController|getController]] and [[DCS_func_pushTask|pushTask]] functions.
See [[DCS_task_mission|page on mission task]] for more information regarding the route table.

Payload table

}}
[[Category:Singleton Functions|addGroup]]

← Older revision		Revision as of 07:24, 17 March 2022
Line 155:		Line 155:
	}}		}}
	[[Category:Singleton Functions\|addGroup]]		[[Category:Singleton Functions\|addGroup]]
		+	[[Category:Game Patch 1.2.4\|addGroup]]

@@ Line 147: / Line 147: @@
 Aircraft and Helicopter values
-   livery_id   string name of the livery for the aircraft
+  AddPropAircraft       table additional aircraft properties for some contains the datalink ID information for that unit.
-   psi         number
+   livery_id             string name of the livery for the aircraft
-   onboard_num string of the tail number on the aircraft
+   psi                   number
+   onboard_num           string of the tail number on the aircraft
 Helicopter Values
    ropeLength  number length of a rope used for sling loading, default is 15

@@ Line 117: / Line 117: @@
    visible         boolean For whether or not the group is visible before its start time
    uncontrollable  boolean corresponds to "Game Master Only" setting in editor. Dictates whether or not ground commanders can give orders to the group.
 Required Unit values

@@ Line 104: / Line 104: @@
    lateActivation  boolean value that can override start_time to force the group to spawn in via trigger
    hidden          boolean whether or not the group is visible on the F10 map view
    route           table complex table defining the route and tasks assigned to the group
@@ Line 114: / Line 116: @@
 Optional Group Values (Ground and Ships)
    visible         boolean For whether or not the group is visible before its start time
 Required Unit values
@@ Line 132: / Line 135: @@
   heading      number heading of the object in radians
   skill        string of the units skill level. Can be "Excellent", "High", "Good", "Average", "Random", "Player"

@@ Line 13: / Line 13: @@
 |par4=
-|desc= Dynamically spawns a group of the specified category for the specified country. Group data table is in the same format as created by the mission editor. See [[DCS_Class_Group|here]] for the list of possible group categories.
+|desc= Dynamically spawns a group of the specified category for the specified country. Group data table is in the same format as created by the mission editor.
 The coalition of the group is defined by the coalition its country belongs to.

@@ Line 45: / Line 45: @@
 |optType2=
-|examples= Basic table for a ground unit
+|examples= Detailed Examples Linked Below:
 <pre>
    local groupData = {

@@ Line 139: / Line 139: @@
 Route table can be empty or assigned to the group after spawning using [[DCS_func_getController|getController]] and [[DCS_func_pushTask|pushTask]] functions.
 See [[DCS_task_mission|page on mission task]] for more information regarding the route table.
 Payload table