serverCommand: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (returns boolean) |
Killzone Kid (talk | contribs) (description example) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Executes [[Multiplayer_Server_Commands| | | Executes [[Multiplayer_Server_Commands|a server command]] on the server. In order to be able to execute admin command the user must be logged in as admin. Commands available for non-admin users are: #login, #vote and #userlist. Which command is available can be detected with [[serverCommandAvailable]].<br><br>'''NOTE:''' This command must be executed from UI event handler ([[ctrlAddEventHandler]], [[displayAddEventHandler]]), such as ''onButtonDown'' or other [[User_Interface_Event_Handlers]]. |= Description | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 16: | Line 16: | ||
| [[Boolean]] - always [[true]] for some reason |= Return value | | [[Boolean]] - always [[true]] for some reason |= Return value | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1 = <code> | |x1 = <code>[[serverCommand]] "#logout";</code> | ||
|x2 = Create button on the main map which will show userlist to anyone who clicks on it: | |||
<code>[[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"} | |||
]; | |||
};</code> | |||
|x3 = <code>[[serverCommand]] [[format]] ["#kick %1",_name];</code> | |||
| [[serverCommandAvailable]] |= See also | | [[serverCommandAvailable]] |= See also | ||
| Line 23: | Line 36: | ||
<h3 style="display:none">Notes</h3> | <h3 style="display:none">Notes</h3> | ||
<dl class="command_description"> | <dl class="command_description"> | ||
</dl> | </dl> | ||
Revision as of 19:03, 14 October 2014
Description
- Description:
- Executes a server command on the server. In order to be able to execute admin command the user must be logged in as admin. Commands available for non-admin users are: #login, #vote and #userlist. Which command is available can be detected with serverCommandAvailable.
NOTE: This command must be executed from UI event handler (ctrlAddEventHandler, displayAddEventHandler), such as onButtonDown or other User_Interface_Event_Handlers. - Groups:
- Uncategorised
Syntax
- Syntax:
- serverCommand command
- Parameters:
- command : String
- Return Value:
- Boolean - always true for some reason
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];
Additional Information
- See also:
- serverCommandAvailable
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