Arma 3 Scripting

serverCommandExecutable

  • Arma 3 v1.34

Command · Markdown · JSON · original wiki page

Description

Returns true if the serverCommand can be performed on the machine and in this exact environment, otherwise false. serverCommand can be executed only from User Interface Event Handlers, and this command also checks if that's the case.

Syntax

serverCommandExecutable command

Parameters:

Returns: Boolean

Examples

Example 1

_canKick = serverCommandAvailable "#kick";

Example 2

Add button to the main map to lock server, which could only be activated by admin:

with uiNamespace do {
    ctrl = findDisplay 12 ctrlCreate ["RscButton", -1];
    ctrl ctrlSetPosition [0, 0, 0.5, 0.1];
    ctrl ctrlCommit 0;
    ctrl ctrlSetText "LOCK SERVER";
    ctrl ctrlAddEventHandler ["ButtonDown",
    {
        if (serverCommandExecutable "#lock") then {
            serverCommand "#lock";
        } else {
            hint "You need to be logged in as admin to do this";
        };
    }];
};

See also

serverCommand · serverCommandAvailable · Multiplayer Server Commands