Interface l_net

Network API available when DCS enables it for mission scripting.

No Self

See

%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:286

interface l_net {
    CHAT_ALL: number;
    CHAT_TEAM: number;
    ERR_BAD_CALLSIGN: number;
    ERR_BANNED: number;
    ERR_CONNECT_FAILED: number;
    ERR_DENIED_TRIAL_ONLY: number;
    ERR_INVALID_ADDRESS: number;
    ERR_INVALID_PASSWORD: number;
    ERR_KICKED: number;
    ERR_NOT_ALLOWED: number;
    ERR_PROTOCOL_ERROR: number;
    ERR_REFUSED: number;
    ERR_SERVER_FULL: number;
    ERR_TAINTED_CLIENT: number;
    ERR_THATS_OKAY: number;
    ERR_TIMEOUT: number;
    ERR_WRONG_VERSION: number;
    GAME_MODE_CONQUEST: number;
    GAME_MODE_LAST_MAN_STANDING: number;
    GAME_MODE_MISSION: number;
    GAME_MODE_TEAM_DEATH_MATCH: number;
    PS_CAR: number;
    PS_CRASH: number;
    PS_EJECT: number;
    PS_LAND: number;
    PS_PING: number;
    PS_PLANE: number;
    PS_SCORE: number;
    PS_SHIP: number;
    RESUME_MANUAL: number;
    RESUME_ON_LOAD: number;
    RESUME_WITH_CLIENTS: number;
    dostring_in(state: string, luaSource: string): string | undefined;
    force_player_slot(
        playerId: number,
        sideId: number,
        slotId: string | number,
    ): boolean;
    get_coalition(playerId: number): number;
    get_my_player_id(): number;
    get_name(playerId: number): string | undefined;
    get_player_info(playerId: number): NetPlayerInfo | undefined;
    get_player_info(playerId: number, attribute: keyof NetPlayerInfo): unknown;
    get_player_list(): number[];
    get_server_host(): string;
    get_server_id(): number;
    get_slot(playerId: number): LuaMultiReturn<[number, string | number]>;
    get_stat(playerId: number, statisticId: number): number;
    is_loopback_address(address: string): boolean;
    is_private_address(address: string): boolean;
    json2lua(json: string): unknown;
    kick(playerId: number, message?: string): boolean;
    log(message: string): void;
    lua2json(value: unknown): string;
    recv_chat(message: string, fromPlayerId?: number): void;
    resetJoinCooldownEndForAll(): boolean;
    resetJoinCooldownEndForPlayer(id: number): boolean;
    send_chat(message: string, all: boolean): void;
    send_chat_to(message: string, playerId: number): void;
    set_coalition(sideId: number, password?: string): boolean | undefined;
    set_name(playerId: number, name: string): void;
    set_slot(
        sideId: number,
        slotId: string | number,
        coalitionPassword?: string,
        slotPassword?: string,
    ): boolean | undefined;
    trace(message: string): void;
}

Hierarchy

Omit<_net, NetFunction>
- l_net

Index

Properties

CHAT_ALL

CHAT_ALL: number

CHAT_TEAM

CHAT_TEAM: number

ERR_BAD_CALLSIGN

ERR_BAD_CALLSIGN: number

ERR_BANNED

ERR_BANNED: number

ERR_CONNECT_FAILED

ERR_CONNECT_FAILED: number

ERR_DENIED_TRIAL_ONLY

ERR_DENIED_TRIAL_ONLY: number

ERR_INVALID_ADDRESS

ERR_INVALID_ADDRESS: number

ERR_INVALID_PASSWORD

ERR_INVALID_PASSWORD: number

ERR_KICKED

ERR_KICKED: number

ERR_NOT_ALLOWED

ERR_NOT_ALLOWED: number

ERR_PROTOCOL_ERROR

ERR_PROTOCOL_ERROR: number

ERR_REFUSED

ERR_REFUSED: number

ERR_SERVER_FULL

ERR_SERVER_FULL: number

ERR_TAINTED_CLIENT

ERR_TAINTED_CLIENT: number

ERR_THATS_OKAY

ERR_THATS_OKAY: number

ERR_TIMEOUT

ERR_TIMEOUT: number

ERR_WRONG_VERSION

ERR_WRONG_VERSION: number

GAME_MODE_CONQUEST

GAME_MODE_CONQUEST: number

GAME_MODE_LAST_MAN_STANDING

GAME_MODE_LAST_MAN_STANDING: number

GAME_MODE_MISSION

GAME_MODE_MISSION: number

GAME_MODE_TEAM_DEATH_MATCH

GAME_MODE_TEAM_DEATH_MATCH: number

PS_CAR

PS_CAR: number

PS_CRASH

PS_CRASH: number

PS_EJECT

PS_EJECT: number

PS_LAND

PS_LAND: number

PS_PING

PS_PING: number

PS_PLANE

PS_PLANE: number

PS_SCORE

PS_SCORE: number

PS_SHIP

PS_SHIP: number

RESUME_MANUAL

RESUME_MANUAL: number

RESUME_ON_LOAD

RESUME_ON_LOAD: number

RESUME_WITH_CLIENTS

RESUME_WITH_CLIENTS: number

Methods

dostring_in

dostring_in(state: string, luaSource: string): string | undefined
Executes trusted Lua in an allowed DCS state. This API is obsolete and unsafe.
Parameters
- state: string
- luaSource: string
Returns string | undefined
Example
```
`const result = net.dostring_in("mission", "return 2 + 2");`
```
See
- %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:309
- https://wiki.hoggitworld.com/view/DCS_func_dostring_in
- Defined in net.ts:55

force_player_slot

force_player_slot(
    playerId: number,
    sideId: number,
    slotId: string | number,
): boolean
Forces a player into a coalition/slot. Empty slot moves to spectators.
Parameters
- playerId: number
- sideId: number
- slotId: string | number
Returns boolean
Example
```
`net.force_player_slot(id, 0, "");`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:422
- Defined in net.ts:200

get_coalition

get_coalition(playerId: number): number
Returns a player's coalition.
Parameters
- playerId: number
Returns number
Example
```
`const side = net.get_coalition(id);`
```
See
%DCS_INSTALL_DIR%/MissionEditor/modules/MultiplayerSelectRoleMap/MultiplayerSelectRole.lua:454
- Defined in net.ts:153

get_my_player_id

get_my_player_id(): number
Returns the local player ID.

Returns number
Example
```
`const me = net.get_my_player_id();`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:365
- Defined in net.ts:104

get_name

get_name(playerId: number): string | undefined
Returns a player's display name.
Parameters
- playerId: number
Returns string | undefined
Example
```
`const name = net.get_name(id);`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:408
- Defined in net.ts:132

get_player_info

get_player_info(playerId: number): NetPlayerInfo | undefined
Returns all player attributes, or nothing for an invalid ID.
Parameters
- playerId: number
Returns NetPlayerInfo | undefined
Example
```
`const player = net.get_player_info(id);`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:373
- Defined in net.ts:118
get_player_info(playerId: number, attribute: keyof NetPlayerInfo): unknown
Returns one named player attribute.
Parameters
- playerId: number
- attribute: keyof NetPlayerInfo
Returns unknown
Example
```
`const ucid = net.get_player_info(id, "ucid");`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:377
- Defined in net.ts:125

get_player_list

get_player_list(): number[]
Returns connected player IDs.

Returns number[]
Example
```
`const players = net.get_player_list();`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:361
- Defined in net.ts:97

get_server_host

get_server_host(): string
Returns the connected server host/address.

Returns string
Example
```
`const host = net.get_server_host();`
```
See
%DCS_INSTALL_DIR%/MissionEditor/modules/mul_select_role.lua:1932
- Defined in net.ts:160

get_server_id

get_server_id(): number
Returns the server player ID.

Returns number
Example
```
`const server = net.get_server_id();`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:369
- Defined in net.ts:111

get_slot

get_slot(playerId: number): LuaMultiReturn<[number, string | number]>
Returns player coalition and slot.
Parameters
- playerId: number
Returns LuaMultiReturn<[number, string | number]>
Example
```
`const [side, slot] = net.get_slot(id);`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:412
- Defined in net.ts:139

get_stat

get_stat(playerId: number, statisticId: number): number
Returns a player statistic selected by a net.PS_* constant.
Parameters
- playerId: number
- statisticId: number
Returns number
Example
```
`const ping = net.get_stat(id, net.PS_PING);`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:395
- Defined in net.ts:146

is_loopback_address

is_loopback_address(address: string): boolean
Tests an address for loopback scope.
Parameters
- address: string
Returns boolean
Example
```
`const localOnly = net.is_loopback_address("127.0.0.1");`
```
- Defined in net.ts:166

is_private_address

is_private_address(address: string): boolean
Tests an address for private-network scope.
Parameters
- address: string
Returns boolean
Example
```
`const privateAddress = net.is_private_address("192.168.1.1");`
```
- Defined in net.ts:172

json2lua

json2lua(json: string): unknown
Parses JSON to a Lua value.
Parameters
- json: string
Returns unknown
Example
```
`const value = net.json2lua("{\"ready\":true}");`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:434
- Defined in net.ts:186

kick

kick(playerId: number, message?: string): boolean
Kicks a player with an optional explanation. Server only.
Parameters
- playerId: number
- Optionalmessage: string
Returns boolean
Example
```
`net.kick(id, "mission restart");`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:387
- Defined in net.ts:193

log

log(message: string): void
Writes to the normal LuaNET log stream.
Parameters
- message: string
Returns void
Example
```
`net.log("hook connected");`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:290
- Defined in net.ts:62

lua2json

lua2json(value: unknown): string
Serializes a Lua value as JSON.
Parameters
- value: unknown
Returns string
Example
```
`const json = net.lua2json({ ready: true });`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:430
- Defined in net.ts:179

recv_chat

recv_chat(message: string, fromPlayerId?: number): void
Injects a chat message locally, optionally pretending it came from a player.
Parameters
- message: string
- OptionalfromPlayerId: number
Returns void
Example
```
`net.recv_chat("Server notice", 0);`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:336
- Defined in net.ts:90

resetJoinCooldownEndForAll

resetJoinCooldownEndForAll(): boolean
Resets join cooldowns globally.

Returns boolean
Example
```
`net.resetJoinCooldownEndForAll();`
```
See
%DCS_INSTALL_DIR%/Scripts/Hooks/webGUI.lua:152
- Defined in net.ts:244

resetJoinCooldownEndForPlayer

resetJoinCooldownEndForPlayer(id: number): boolean
Resets the join cooldown for one unit/player identifier.
Parameters
- id: number
Returns boolean
Example
```
`net.resetJoinCooldownEndForPlayer(unitId);`
```
See
%DCS_INSTALL_DIR%/MissionEditor/modules/mul_playersPool.lua:316
- Defined in net.ts:237

send_chat

send_chat(message: string, all: boolean): void
Sends chat globally or to the local coalition.
Parameters
- message: string
- all: boolean
Returns void
Example
```
`net.send_chat("Ready", true);`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:327
- Defined in net.ts:76

send_chat_to

send_chat_to(message: string, playerId: number): void
Sends direct chat to a player ID or net.CHAT_ALL/CHAT_TEAM.
Parameters
- message: string
- playerId: number
Returns void
Example
```
`net.send_chat_to("Ready", net.CHAT_TEAM);`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:331
- Defined in net.ts:83

set_coalition

set_coalition(sideId: number, password?: string): boolean | undefined
Changes the local player's coalition.
Parameters
- sideId: number
- Optionalpassword: string
Returns boolean | undefined
Example
```
`net.set_coalition(coalition.side.BLUE, password);`
```
See
%DCS_INSTALL_DIR%/MissionEditor/modules/MultiplayerSelectRoleMap/MultiplayerSelectRole.lua:461
- Defined in net.ts:223

set_name

set_name(playerId: number, name: string): void
Obsolete local-only player rename.
Parameters
- playerId: number
- name: string
Returns void
Example
```
`net.set_name(id, "Pilot");`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:426
- Defined in net.ts:230

set_slot

set_slot(
    sideId: number,
    slotId: string | number,
    coalitionPassword?: string,
    slotPassword?: string,
): boolean | undefined
Attempts to change the local player's slot. Password parameters are DCS UI extensions.
Parameters
- sideId: number
- slotId: string | number
- OptionalcoalitionPassword: string
- OptionalslotPassword: string
Returns boolean | undefined
Example
```
`net.set_slot(0, "");`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:418
- Defined in net.ts:211

trace

trace(message: string): void
Writes to the lossless LuaNET trace stream.
Parameters
- message: string
Returns void
Example
```
`net.trace("packet received");`
```
See
%DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:291
- Defined in net.ts:69

Interface l_net

No Self

See

Hierarchy

Index

Properties

Methods

Properties

CHAT_ALL

CHAT_TEAM

ERR_BAD_CALLSIGN

ERR_BANNED

ERR_CONNECT_FAILED

ERR_DENIED_TRIAL_ONLY

ERR_INVALID_ADDRESS

ERR_INVALID_PASSWORD

ERR_KICKED

ERR_NOT_ALLOWED

ERR_PROTOCOL_ERROR

ERR_REFUSED

ERR_SERVER_FULL

ERR_TAINTED_CLIENT

ERR_THATS_OKAY

ERR_TIMEOUT

ERR_WRONG_VERSION

GAME_MODE_CONQUEST

GAME_MODE_LAST_MAN_STANDING

GAME_MODE_MISSION

GAME_MODE_TEAM_DEATH_MATCH

PS_CAR

PS_CRASH

PS_EJECT

PS_LAND

PS_PING

PS_PLANE

PS_SCORE

PS_SHIP

RESUME_MANUAL

RESUME_ON_LOAD

RESUME_WITH_CLIENTS

Methods

dostring_in

Parameters

Returns string | undefined

Example

See

force_player_slot

Parameters

Returns boolean

Example

See

get_coalition

Parameters

Returns number

Example

See

get_my_player_id

Returns number

Example

See

get_name

Parameters

Returns string | undefined

Example

See

get_player_info

Parameters

Returns NetPlayerInfo | undefined

Example

See

Parameters

Returns unknown

Example

See

get_player_list

Returns number[]

Example

See

get_server_host

Returns string