serverCommandExecutable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1= Multiplayer |GROUP1=
|gr1= Multiplayer |GROUP1=
____________________________________________________________________________________________


| 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.
| 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.
  |DESCRIPTION=
  |DESCRIPTION=
____________________________________________________________________________________________


| [[serverCommandExecutable]] command |SYNTAX=
| [[serverCommandExecutable]] command |SYNTAX=
Line 18: Line 15:


| [[Boolean]] |RETURNVALUE=
| [[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________


|x1 = <code>_canKick = [[serverCommandAvailable]] "#kick";</code>
|x1 = <code>_canKick = [[serverCommandAvailable]] "#kick";</code>

Revision as of 02:55, 17 January 2021

Hover & click on the images for description

Description

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.
Groups:
Multiplayer

Syntax

Syntax:
serverCommandExecutable command
Parameters:
command: String - see Multiplayer Server Commands for all available commands
Return Value:
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"; }; }]; };

Additional Information

See also:
serverCommandserverCommandAvailableMultiplayer Server Commands

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

Notes

Bottom Section