DCS World Typescript
    Preparing search index...
    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;
        banlist_add(
            playerId: number,
            periodSeconds: number,
            reason?: string,
        ): boolean;
        banlist_add_by_ucid(
            ucid: string,
            periodSeconds: number,
            reason?: string,
        ): boolean;
        banlist_get(): NetBanRecord[];
        banlist_remove(ucid: string): boolean;
        check_ic_requirements(requirements: unknown): unknown;
        check_password(password: string, hash: string): boolean;
        dostring_in(env: string, luaScript: string): string | undefined;
        force_player_slot(
            playerId: number,
            sideId: number,
            slotId: string | number,
        ): boolean;
        get_chat_history(fromIndex: number): LuaMultiReturn<[unknown[], number]>;
        get_coalition(playerId: number): number;
        get_default_server_settings(): Record<string, unknown>;
        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 | undefined;
        get_server_id(): number;
        get_server_settings(): Record<string, unknown>;
        get_server_uptime(): number;
        get_session_history(): unknown[];
        get_slot(playerId: number): LuaMultiReturn<[number, string | number]>;
        get_stat(playerId: number, statisticId: number): number;
        hash_password(password: string): string;
        is_loopback_address(address: string): boolean;
        is_private_address(address: string): boolean;
        json2lua(json: string): unknown;
        kick(playerId: number, message?: string): boolean;
        load_mission(fileName: string): boolean;
        load_next_mission(): boolean;
        log(message: string): void;
        lua2json(value: unknown): string;
        missionlist_append(fileName: string): boolean;
        missionlist_clear(): boolean;
        missionlist_delete(index: number): boolean;
        missionlist_get(): NetMissionList;
        missionlist_get_installed_theatres(): string[];
        missionlist_move(oldIndex: number, newIndex: number): boolean;
        missionlist_run(index: number): boolean;
        missionlist_set_loop(enabled: boolean): void;
        missionlist_set_shuffle(enabled: boolean): void;
        recv_chat(message: string, fromPlayerId?: number): void;
        resetJoinCooldownEndForAll(): boolean;
        resetJoinCooldownEndForPlayer(id: number): boolean;
        restart(): void;
        screenshot_del(...arguments_: unknown[]): unknown;
        screenshot_request(...arguments_: unknown[]): unknown;
        send_chat(message: string, all: boolean): void;
        send_chat_to(message: string, playerId: number): void;
        send_rpc_error(...arguments_: unknown[]): unknown;
        send_rpc_request(...arguments_: unknown[]): unknown;
        send_rpc_result(...arguments_: unknown[]): unknown;
        serverinfo_get(...arguments_: unknown[]): unknown;
        serverinfo_request(...arguments_: unknown[]): unknown;
        serverlist_get(...arguments_: unknown[]): unknown;
        serverlist_reset(): void;
        serverlist_search(...arguments_: unknown[]): unknown;
        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;
        spawn_player(...arguments_: unknown[]): unknown;
        start_client(...arguments_: unknown[]): unknown;
        start_server(...arguments_: unknown[]): unknown;
        stop_game(): void;
        stop_network(): void;
        trace(message: string): void;
    }

    Hierarchy

    • Omit<_net, NetFunction>
      • l_net
    Index
    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
    • Bans and kicks a player for periodSeconds.

      Parameters

      • playerId: number
      • periodSeconds: number
      • Optionalreason: string

      Returns boolean

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:449

    • Bans a UCID directly. TODO: optional address/name ordering is native and not in the public API.

      Parameters

      • ucid: string
      • periodSeconds: number
      • Optionalreason: string

      Returns boolean

    • Removes a ban by UCID.

      Parameters

      • ucid: string

      Returns boolean

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:453

    • Checks whether a client satisfies integrity-check requirements. TODO: requirement/result schemas are native and version-dependent.

      Parameters

      • requirements: unknown

      Returns unknown

    • Checks a password against a native password hash.

      Parameters

      • password: string
      • hash: string

      Returns boolean

      `const valid = net.check_password(password, hash);`
      
    • Executes Lua source in another DCS scripting environment and returns the value converted to text. This crosses sandbox boundaries, so only execute trusted source and expect an unavailable environment or Lua error to return undefined.

      Common environment names include "mission", "export", "config", and "gui"; availability depends on the current DCS context.

      Parameters

      • env: string

        Name of the destination DCS Lua environment.

      • luaScript: string

        Lua source to evaluate in that environment.

      Returns string | undefined

      String representation returned by DCS, or undefined on failure.

      const missionName = net.dostring_in("mission", "return env.mission.name");
      
    • Forces a player into a coalition/slot.

      Parameters

      • playerId: number
      • sideId: number
      • slotId: string | number

      Returns boolean

      `net.force_player_slot(id, 0, "");`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:422

    • Returns chat records from fromIndex and the new last index. Record schema is controlled by DCS.

      Parameters

      • fromIndex: number

      Returns LuaMultiReturn<[unknown[], number]>

      `const [history, last] = net.get_chat_history(0);`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:342

    • Returns a player's coalition.

      Parameters

      • playerId: number

      Returns number

      `const side = net.get_coalition(id);`
      

      %DCS_INSTALL_DIR%/Scripts/UI/MultiplayerSelectRoleMap/MultiplayerSelectRole.lua:454

    • Returns default server settings. Fields are version-dependent.

      Returns Record<string, unknown>

    • Returns the local player ID.

      Returns number

      `const me = net.get_my_player_id();`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:365

    • Returns a player's name.

      Parameters

      • playerId: number

      Returns string | undefined

      `const name = net.get_name(id);`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:408

    • Returns all attributes for a player.

      Parameters

      • playerId: number

      Returns NetPlayerInfo | undefined

      `const player = net.get_player_info(id);`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:373

    • Returns one named player attribute.

      Parameters

      Returns unknown

      `const ucid = net.get_player_info(id, "ucid");`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:377

    • Returns connected player IDs.

      Returns number[]

      `const players = net.get_player_list();`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:361

    • Returns the connected server host/address.

      Returns string | undefined

      `const host = net.get_server_host();`
      

      %DCS_INSTALL_DIR%/MissionEditor/modules/mul_select_role.lua:1932

    • Returns the server player ID.

      Returns number

      `const server = net.get_server_id();`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:369

    • Returns current server settings. Fields are version-dependent.

      Returns Record<string, unknown>

    • Returns server uptime in seconds.

      Returns number

      `const seconds = net.get_server_uptime();`
      
    • Returns session history records. Their native schema is version-dependent.

      Returns unknown[]

    • Returns player coalition and slot.

      Parameters

      • playerId: number

      Returns LuaMultiReturn<[number, string | number]>

      `const [side, slot] = net.get_slot(id);`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:412

    • Returns a statistic selected by a net.PS_* constant.

      Parameters

      • playerId: number
      • statisticId: number

      Returns number

      `const ping = net.get_stat(id, net.PS_PING);`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:395

    • Hashes a server password using DCS's native format.

      Parameters

      • password: string

      Returns string

      `const hash = net.hash_password(password);`
      
    • Tests an address for loopback scope.

      Parameters

      • address: string

      Returns boolean

      `net.is_loopback_address("127.0.0.1");`
      
    • Tests an address for private-network scope.

      Parameters

      • address: string

      Returns boolean

      `net.is_private_address("192.168.1.1");`
      
    • Parses JSON to a Lua value.

      Parameters

      • json: string

      Returns unknown

      `const value = net.json2lua("{\"ready\":true}");`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:434

    • Kicks a player. Server only.

      Parameters

      • playerId: number
      • Optionalmessage: string

      Returns boolean

      `net.kick(id, "mission restart");`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:387

    • Loads a mission, temporarily overriding the server list. Server only.

      Parameters

      • fileName: string

      Returns boolean

      `net.load_mission(fileName);`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:351

    • Loads the next mission in the server list.

      Returns boolean

      `const loaded = net.load_next_mission();`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:355

    • Writes to the normal LuaNET log stream.

      Parameters

      • message: string

      Returns void

      `net.log("hook connected");`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:290

    • Serializes a Lua value as JSON.

      Parameters

      • value: unknown

      Returns string

      `const json = net.lua2json({ ready: true });`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:430

    • Appends a mission file.

      Parameters

      • fileName: string

      Returns boolean

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:466

    • Clears the server mission list.

      Returns boolean

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:478

    • Deletes a one-based mission-list entry.

      Parameters

      • index: number

      Returns boolean

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:468

    • Returns the server mission list.

      Returns NetMissionList

      `const missions = net.missionlist_get();`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:456

    • Returns installed theatre identifiers accepted by the mission list.

      Returns string[]

    • Moves a mission-list entry.

      Parameters

      • oldIndex: number
      • newIndex: number

      Returns boolean

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:470

    • Runs a mission-list entry.

      Parameters

      • index: number

      Returns boolean

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:476

    • Enables/disables mission-list looping.

      Parameters

      • enabled: boolean

      Returns void

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:474

    • Enables/disables mission-list shuffling.

      Parameters

      • enabled: boolean

      Returns void

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:472

    • Injects a local chat message.

      Parameters

      • message: string
      • OptionalfromPlayerId: number

      Returns void

      `net.recv_chat("Server notice", 0);`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:336

    • Resets all join cooldowns.

      Returns boolean

      %DCS_INSTALL_DIR%/Scripts/Hooks/webGUI.lua:152

    • Resets one join cooldown.

      Parameters

      • id: number

      Returns boolean

      %DCS_INSTALL_DIR%/MissionEditor/modules/mul_playersPool.lua:316

    • Restarts the active multiplayer game.

      Returns void

    • TODO: native screenshot deletion identifiers/schema are undocumented.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • TODO: native screenshot request identifiers/schema are undocumented.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Sends chat globally or to the local coalition.

      Parameters

      • message: string
      • all: boolean

      Returns void

      `net.send_chat("Ready", true);`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:327

    • Sends direct chat to a player ID or CHAT_ALL/CHAT_TEAM.

      Parameters

      • message: string
      • playerId: number

      Returns void

      `net.send_chat_to("Ready", net.CHAT_TEAM);`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:331

    • TODO: native RPC error payload is not documented in the installed API.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • TODO: native RPC request payload and return identifier are not documented in the installed API.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • TODO: native RPC result payload is not documented in the installed API.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • TODO: native server-browser result schema is version-dependent.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • TODO: native server-browser request; installed public docs do not expose the callback/result schema.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • TODO: native server-list result schema is version-dependent.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Resets native server-browser search state.

      Returns void

    • TODO: native server-list search request schema is version-dependent.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Changes the local player's coalition.

      Parameters

      • sideId: number
      • Optionalpassword: string

      Returns boolean | undefined

      `net.set_coalition(2, password);`
      

      %DCS_INSTALL_DIR%/Scripts/UI/MultiplayerSelectRoleMap/MultiplayerSelectRole.lua:461

    • Obsolete local-only player rename.

      Parameters

      • playerId: number
      • name: string

      Returns void

      `net.set_name(id, "Pilot");`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:426

    • Attempts to change the local player's slot.

      Parameters

      • sideId: number
      • slotId: string | number
      • OptionalcoalitionPassword: string
      • OptionalslotPassword: string

      Returns boolean | undefined

      `net.set_slot(0, "");`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:418

    • TODO: native dynamic-player spawn payload is version-dependent.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • TODO: native client-start connection options are version-dependent.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • TODO: native server-start options are version-dependent; prefer documented server settings files.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Stops the active multiplayer game.

      Returns void

    • Stops active network services.

      Returns void

    • Writes to the lossless LuaNET trace stream.

      Parameters

      • message: string

      Returns void

      `net.trace("packet received");`
      

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:291