serverCommand: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "server.cfg" to "server config")
 
(82 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.05


|1.05|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Executes [[Armed Assault: Multiplayer Server Commands|an admin command]] on the server. If used in singleplayer or in multiplayer, but without required privileges (player using the computer where command is executed is not an admin) nothing happens. This can be detected beforehand using [[serverCommandAvailable]]. |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''serverCommand''' command |= Syntax
|game4= arma3
|version4= 0.50


|p1= command : [[String]] |= Parameter 1
|gr1= Multiplayer


| [[Nothing]] |= Return value
|descr= Executes the given [[Multiplayer_Server_Commands|server command]].
____________________________________________________________________________________________
{{Feature|informative|
|x1 = <code> '''serverCommand''' "#logout" </code>
* Available commands for execution can be found with [[serverCommandAvailable]]
| [[serverCommandAvailable]] |= See also
* Commands that can be executed can be found with [[serverCommandExecutable]]
}}
 
{{Feature|important|If [[serverCommand]] is executed on a client, it must be executed from [[isUIContext|UI context]], such as [[User Interface Event Handlers#onButtonDown|"onButtonDown"]] or similar events (see [[User Interface Event Handlers]]).}}
 
|s1= [[serverCommand]] command
 
|p1= command : [[String]]
 
|r1= [[Boolean]] - [[false]] if a non valid command is used ("#blah"), false otherwise (was always [[true]] before {{GVI|arma3|1.40|size= 0.75}})
 
|s2= password [[serverCommand]] command
|s2exec= server
 
|s2since= arma3 1.40
 
|p21= password : [[String]] - case-sensitive password defined in [[Arma 3: Server Config File|server config]] with {{hl|serverCommandPassword}} param
 
|p22= command : [[String]] - server command
 
|r2= [[Boolean]] - [[false]] if command failed at some stage. [[true]] doesn't mean that command succeeded.


}}
|x1= <sqf>serverCommand "#logout";</sqf>
 
|x2= Create button on the main map which will show userlist to anyone who clicks on it:
<sqf>with uiNamespace do
{
private _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";
}];
};</sqf>
 
|x3= <sqf>serverCommand format ["#kick %1",_name];</sqf>


<h3 style="display:none">Notes</h3>
|x4= <sqf>private _passwordWasOK = "MyServerCommandPassword" serverCommand "#lock";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->
serverCommand format["#kick %1",_name];


<dd class="notedate">Posted on 9 June 2011
|seealso= [[serverCommandAvailable]] [[serverCommandExecutable]] [[admin]] [[isUIContext]]
<dt class="note>'''[[User:Piotr|Piotr]]'''
}}
<dd class="note">
serverCommand (probably) has been disabled in 1.59


<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands: Server Execution]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Introduced with Arma 3 version 1.40]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]

Latest revision as of 14:35, 17 May 2024

Hover & click on the images for description

Description

Description:
Executes the given server command.
If serverCommand is executed on a client, it must be executed from UI context, such as "onButtonDown" or similar events (see User Interface Event Handlers).
Groups:
Multiplayer

Syntax

Syntax:
serverCommand command
Parameters:
command : String
Return Value:
Boolean - false if a non valid command is used ("#blah"), false otherwise (was always true before Arma 3 logo black.png1.40)

Alternative Syntax

Syntax:
password serverCommand command
Parameters:
password : String - case-sensitive password defined in server config with serverCommandPassword param
command : String - server command
Return Value:
Boolean - false if command failed at some stage. true doesn't mean that command succeeded.

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 { private _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:
private _passwordWasOK = "MyServerCommandPassword" serverCommand "#lock";

Additional Information

See also:
serverCommandAvailable serverCommandExecutable admin isUIContext

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