DCS World Wiki - Hoggitworld.com - User contributions [en]

DCS func addGroup

2018-05-25T23:28:48Z

Rurounijones:

{{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. See [[DCS_Class_Group|here]] for the list of possible group categories.

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

DCS func getGroups

2018-05-25T23:25:23Z

Rurounijones:

{{Template:dcs_funcs

|fName= getGroups

|vNum= 1.2.4

|par1= [[DCS_singleton_coalition|coalition]]

|par2=

|par3=

|par4=

|desc= Returns a table of [[DCS_Class_Group|group objects]] belonging to the specified coalition. If the groupCategory enumerator is provided the table will only contain groups that belong to the specified category. If this optional variable is not provided, all group types will be returned. See [[DCS_Class_Group|here]] for the list of possible group categories.

|rtnType= table

|rtnExample=

|reqType1= enum

|reqName1= coalitionId

|reqType2=

|reqName2=

|reqType3=

|reqName3=

|reqType4=

|optType1= enum

|optName1= GroupCategory

|optType2=

|examples= The following will print each groups name belonging to the blue coalition to dcs.log
for i, gp in pairs(coalition.getGroups(2)) do
env.info(Group.getName(gp))
end

|related=
[[DCS_singleton_coalition|'''Coalition Functions:''']] {{ListOfCoalitionFuncs}}

|notes= Due to a bug this function is returning dead groups in addition to the alive groups. You must

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

DCS singleton world

2018-05-25T23:13:54Z

Rurounijones: minor formatting fix

{{Template:DCSscriptingSingleton

|cName= world

|vNum= 1.2.0

|desc= The world singleton contains functions centered around two different but extremely useful functions.
1. Events and event handlers are all governed within world.
2. A number of functions to get information about the game world.

|funcs= {{listOfWorldFuncs}}

|enums= The event enumerator defines all of the types of events that can occur.

world.event = {
S_EVENT_INVALID = 0,
S_EVENT_SHOT = 1,
S_EVENT_HIT = 2,
S_EVENT_TAKEOFF = 3,
S_EVENT_LAND = 4,
S_EVENT_CRASH = 5,
S_EVENT_EJECTION = 6,
S_EVENT_REFUELING = 7,
S_EVENT_DEAD = 8,
S_EVENT_PILOT_DEAD = 9,
S_EVENT_BASE_CAPTURED = 10,
S_EVENT_MISSION_START = 11,
S_EVENT_MISSION_END = 12,
S_EVENT_TOOK_CONTROL = 13,
S_EVENT_REFUELING_STOP = 14,
S_EVENT_BIRTH = 15,
S_EVENT_HUMAN_FAILURE = 16,
S_EVENT_ENGINE_STARTUP = 17,
S_EVENT_ENGINE_SHUTDOWN = 18,
S_EVENT_PLAYER_ENTER_UNIT = 19,
S_EVENT_PLAYER_LEAVE_UNIT = 20,
S_EVENT_PLAYER_COMMENT = 21,
S_EVENT_SHOOTING_START = 22,
S_EVENT_SHOOTING_END = 23,
S_EVENT_MARK_ADDED = 24,
S_EVENT_MARK_CHANGE = 25,
S_EVENT_MARK_REMOVED =26,
S_EVENT_MAX = 27
}

The birthplace enumerator is used to define where an aircraft or helicopter has spawned in association with [[DCS_event_birth|birth]]

world.BirthPlace = {
wsBirthPlace_Air,
wsBirthPlace_RunWay,
wsBirthPlace_Park,
wsBirthPlace_Heliport_Hot,
wsBirthPlace_Heliport_Cold,
}

The volumeType enumerator defines the types of 3d geometery used within the [[DCS_func_searchObjects|world.searchObjects]] function
world.VolumeType = {
SEGMENT,
BOX,
SPHERE,
PYRAMID
}

|notes=

}}

DCS enum country

2018-05-25T22:47:56Z

Rurounijones: Change the constants list to a YAML formatted one for easy import into programming languages of choice

{{Template:DCSenumertorTables

|name= country

|vNum= 1.2.0

|desc= The country enumerator contains the constant countryIds and strings for each country present in DCS World. Country ids are indexed starting at 0.

|uses=

|format= The country enumerator contains 3 nested tables within. id, name, and names. These tables are formatted in the following manner with indexes corresponding to their constant values.
country = {
id = {
['RUSSIA'] = 0,
['UKRAINE'] = 1,
['USA'] = 2,
...
},
name = {
[0] = 'RUSSIA',
[1] = 'UKRAINE',
[2] = 'USA',
...
},
names = {
[0] = 'RUSSIA',
[1] = 'UKRAINE',
[2] = 'USA',
...
},
}

|constants= Below is a full listing of countries and their corresponding ids in YAML format
<pre>
---
1: UKRAINE
2: USA
3: TURKEY
4: UK
5: FRANCE
6: GERMANY
7: AGGRESSORS
8: CANADA
9: SPAIN
10: THE_NETHERLANDS
11: BELGIUM
12: NORWAY
13: DENMARK
15: ISRAEL
16: GEORGIA
17: INSURGENTS
18: ABKHAZIA
19: SOUTH_OSETIA
20: ITALY
21: AUSTRALIA
22: SWITZERLAND
23: AUSTRIA
24: BELARUS
25: BULGARIA
26: CHEZH_REPUBLIC
27: CHINA
28: CROATIA
29: EGYPT
30: FINLAND
31: GREECE
32: HUNGARY
33: INDIA
34: IRAN
35: IRAQ
36: JAPAN
37: KAZAKHSTAN
38: NORTH_KOREA
39: PAKISTAN
40: POLAND
41: ROMANIA
42: SAUDI_ARABIA
43: SERBIA
44: SLOVAKIA
45: SOUTH_KOREA
46: SWEDEN
47: SYRIA
48: YEMEN
49: VIETNAM
50: VENEZUELA
51: TUNISIA
52: THAILAND
53: SUDAN
54: PHILIPPINES
55: MOROCCO
56: MEXICO
57: MALAYSIA
58: LIBYA
59: JORDAN
60: INDONESIA
61: HONDURAS
62: ETHIOPIA
63: CHILE
64: BRAZIL
65: BAHRAIN
66: THIRDREICH
67: YUGOSLAVIA
68: USSR
69: ITALIAN_SOCIAL_REPUBLIC
70: ALGERIA
71: KUWAIT
72: QATAR
73: OMAN
74: UNITED_ARAB_EMIRATES
</pre>
|notes= Yes index 14 doesn't exist. No you aren't crazy. No I don't know what happened to it. Some say it has been missing since Lock-on.

DCS 1.5 has doubled the list of countries available, not all countries are populated with assets yet.

Countries 48-65 were added at or around 1.5.4/2.0.4.

DCS 2.1 added 4 countries (66-69) associated with the World War 2 setting.

DCS 2.5 added 70-74
}}