niod-core › Globals › “dcs/functions”
Module: “dcs/functions”
Index
Type aliases
Functions
Type aliases
GetGroupsPayload
Ƭ GetGroupsPayload: object
Defined in dcs/functions.ts:4
Type declaration:
-
coalitionId: number
-
groupCategory? : *undefined number*
GetGroupsReturn
Ƭ GetGroupsReturn: object
Defined in dcs/functions.ts:8
Type declaration:
-
category: number
-
coalition: number
-
id: number
-
initialSize: number
-
name: string
-
size: number
GetUnitsPayload
Ƭ GetUnitsPayload: object
Defined in dcs/functions.ts:28
Type declaration:
- groupName: string
GetUnitsReturn
Ƭ GetUnitsReturn: object
Defined in dcs/functions.ts:32
Type declaration:
-
ammo: object[]
-
callsign: string
-
desc(): object
-
fuel: number
-
hasRadar: boolean
-
id: number
-
inAir: boolean
-
isActive: boolean
-
life: number
-
life0: number
-
name: string
-
position: Vector3
-
sensors: object[]
-
type: string
-
velocity: Vector3
Functions
Const executeFunction
▸ executeFunction‹T, R›(functionName: string, args: T): Promise‹R›
Defined in dcs/functions.ts:69
Allows to execute any function in the lua niod.function table
Type parameters:
▪ T
The type of the arguments you want to pass to the function.
▪ R
The type of the result you expect.
Parameters:
| Name | Type | Description |
|---|---|---|
functionName |
string | The name of the function you want to execute |
args |
T | The arguments you want to pass to the function |
Returns: Promise‹R›
Const getGroups
▸ getGroups(coalitionId: number, groupCategory?: undefined |
number): Promise‹object[]› |
Defined in dcs/functions.ts:22
Allows to retrieve informations about groups from a coalition
Parameters:
| Name | Type | Description |
|---|---|---|
coalitionId |
number | The id of the coalition you want to retrieve the groups from. Note: you should use the constants in the COALITIONS object |
groupCategory? |
undefined | number | The category of the group, I’m not sure what it corresponds to |
Returns: Promise‹object[]›
Const getUnits
▸ getUnits(groupName: string): Promise‹object[]›
Defined in dcs/functions.ts:59
Allows to retrieve informations about units from a group
Parameters:
| Name | Type | Description |
|---|---|---|
groupName |
string | The name of the group you want to retrieve the units from |
Returns: Promise‹object[]›