Difference between revisions of "serverCommandAvailable"

From Bohemia Interactive Community
Jump to navigation Jump to search
(description example)
Line 7: Line 7:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Returns [[true]] if the [[Multiplayer_Server_Commands|admin command]] can be performed on the machine, [[false]] if not. Used in connection with [[serverCommand]]. |= Description
+
| Returns [[true]] if the [[Multiplayer_Server_Commands|server command]] can be performed on the machine, [[false]] if not. Used in connection with [[serverCommand]].
 +
<br><br>
 +
'''NOTE:''' This command must be executed from UI event handler ([[ctrlAddEventHandler]], [[displayAddEventHandler]]), such as ''onButtonDown'' or other [[User_Interface_Event_Handlers]]. |= Description
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[Boolean]] <nowiki>=</nowiki> '''serverCommandAvailable''' command |= Syntax
+
| '''serverCommandAvailable''' command |= Syntax
  
 
|p1=  command: [[String]] |= Parameter 1
 
|p1=  command: [[String]] |= Parameter 1
Line 16: Line 18:
 
| [[Boolean]] |= Return value
 
| [[Boolean]] |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
|x1 = <code> _can <nowiki>=</nowiki> '''serverCommandAvailable''' "#kick" </code>
+
|x1 = <code>_can = [[serverCommandAvailable]] "#kick";</code>
 +
|x2 = Add button to the main map to lock server, which could only be activated by admin:
 +
<code>[[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]] ([[serverCommandAvailable]] "#lock") [[then]] {
 +
[[serverCommand]] "#lock";
 +
} [[else]] {
 +
[[hint]] "You need to be logged in as admin to do this";
 +
};
 +
}];
 +
};</code>
 
| [[serverCommand]] |= See also
 
| [[serverCommand]] |= See also
  

Revision as of 20:13, 14 October 2014

Introduced with Arma 2 version 1.05
  

Click on the images for descriptions

Introduced in

Game:
Arma 2
Version:
1.05

Description

Description:
Returns true if the server command can be performed on the machine, false if not. Used in connection with serverCommand.

NOTE: This command must be executed from UI event handler (ctrlAddEventHandler, displayAddEventHandler), such as onButtonDown or other User_Interface_Event_Handlers.

Syntax

Syntax:
serverCommandAvailable command
Parameters:
command: String
Return Value:
Boolean

Examples

Example 1:
_can = 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 (serverCommandAvailable "#lock") then { serverCommand "#lock"; } else { hint "You need to be logged in as admin to do this"; }; }]; };

Additional Information

Multiplayer:
-
See also:
serverCommand

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section