serverCommand

1.05

Hover & click on the images for description

Description

Description:

Executes a server command. Which command is available can be detected with serverCommandAvailable and whether or not it can be executed with serverCommandExecutable.

If the command is executed on client, it must be executed from UI event handler (ctrlAddEventHandler, displayAddEventHandler), such as onButtonDown or other User_Interface_Event_Handlers.

As of Arma 3 v1.39 serverCommand can be used on dedicated server and headless clients. This requires a password, both set in server.cfg and passed to the command itself. See Alt Syntax for more information.

Groups:

Uncategorised

Syntax

Syntax:

serverCommand command

Parameters:

command : String

Return Value:

Boolean - always true for some reason (since A3 v1.39 also false if a non valid command is used ("#blah"))

Alternative Syntax

Syntax:

password serverCommand command      (since Arma 3 v1.39) Template:ServerExec

Parameters:

password : String - password defined in server.cfg with serverCommandPassword param

command : String

Return Value:

Boolean - true if password is correct

Examples

Example 1:

serverCommand "#logout";

Example 2:

Create button on the main map which will show userlist to anyone who clicks on it: with uiNamespace do { ctrl = findDisplay 12 ctrlCreate ["RscButton", -1]; ctrl ctrlSetPosition [0,0,0.5,0.1]; ctrl ctrlSetText "USERLIST"; ctrl ctrlCommit 0; ctrl ctrlAddEventHandler [ "ButtonDown", {serverCommand "#userlist"} ]; };

Example 3:

serverCommand format ["#kick %1",_name];

Example 4:

_isOK = "MyServerCommandPassword" serverCommand "#lock";

Additional Information

See also:

serverCommandAvailableserverCommandExecutableadmin

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note