Difference between revisions of "serverCommandAvailable"

From Bohemia Interactive Community
Jump to navigation Jump to search
(full list of all commands and availability)
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
 
(28 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| arma2 |= Game name
+
| arma2
  
|1.05|= Game version
+
|1.05
____________________________________________________________________________________________
 
  
| Returns [[true]] if the [[serverCommand]] is available on current machine, [[false]] if not. Here is the general table of availability of server commands:
+
|gr1= Multiplayer
 +
 
 +
| Returns [[true]] if given [[serverCommand]] is available on current machine, [[false]] if not. Here is the general table of availability of Arma 3 server commands:
 
<br><br>
 
<br><br>
 
* '''Available to anyone'''
 
* '''Available to anyone'''
 
<blockquote><tt>#login</tt>, <tt>#userlist</tt>, <tt> #beclient</tt>, <tt> #vote</tt></blockquote>
 
<blockquote><tt>#login</tt>, <tt>#userlist</tt>, <tt> #beclient</tt>, <tt> #vote</tt></blockquote>
* '''Available to any (voted in or logged in) [[admin]] or [[isServer|server]]'''
+
* '''Available to any [[admin]] (voted in / logged in) or [[isServer|server]] host'''
 
<blockquote><tt>#kick</tt>, <tt>#debug</tt></blockquote>
 
<blockquote><tt>#kick</tt>, <tt>#debug</tt></blockquote>
* '''Available to logged in [[admin]] or [[isServer|server]]'''
+
* '''Available to logged in [[admin]] or [[isServer|server]] host'''
 
<blockquote><tt>#lock</tt>, <tt>#unlock</tt>, <tt>#maxping</tt>, <tt>#maxdesync</tt>, <tt>#maxpacketloss</tt></blockquote>
 
<blockquote><tt>#lock</tt>, <tt>#unlock</tt>, <tt>#maxping</tt>, <tt>#maxdesync</tt>, <tt>#maxpacketloss</tt></blockquote>
* '''Available to any (voted in or logged in) [[admin]]'''
+
* '''Available to any [[admin]] (voted in / logged in)'''
 
<blockquote><tt>#logout</tt>, <tt>#restart</tt>, <tt>#mission</tt>, <tt>#missions</tt>, <tt>#reassign</tt>, <tt>#monitor</tt>, <tt>#init</tt></blockquote>
 
<blockquote><tt>#logout</tt>, <tt>#restart</tt>, <tt>#mission</tt>, <tt>#missions</tt>, <tt>#reassign</tt>, <tt>#monitor</tt>, <tt>#init</tt></blockquote>
 
* '''Available to logged in [[admin]]'''
 
* '''Available to logged in [[admin]]'''
Line 21: Line 21:
 
* '''Available to logged in [[admin]] on certain game builds'''
 
* '''Available to logged in [[admin]] on certain game builds'''
 
<blockquote><tt>#captureframe</tt>, <tt>#enabletest</tt>, <tt>#disabletest</tt></blockquote>
 
<blockquote><tt>#captureframe</tt>, <tt>#enabletest</tt>, <tt>#disabletest</tt></blockquote>
To check if server command could be executed in current environment use [[serverCommandExecutable]] |= Description
+
To check if server command could be executed in current environment use [[serverCommandExecutable]]. For more information on what each server command does, see [[Multiplayer Server Commands]].<br><br>
____________________________________________________________________________________________
+
'''NOTE''': When password variant of [[serverCommand]] is used on dedicated server, the table above does not apply as everything is available to it.
  
| '''serverCommandAvailable''' command |= Syntax
+
| '''serverCommandAvailable''' command
  
|p1=  command: [[String]] |= Parameter 1
+
|p1=  command: [[String]]
  
| [[Boolean]] |= Return value
+
| [[Boolean]]
____________________________________________________________________________________________
 
 
|x1 = <code>_can = [[serverCommandAvailable]] "#kick";</code>
 
|x1 = <code>_can = [[serverCommandAvailable]] "#kick";</code>
|x2 = <code>[[if]] ([[serverCommandAvailable]] "#logout") [[then]] {
+
|x2 = <code>[[if]] ([[serverCommandAvailable]] "#logout") [[then]]  
[[hint]] "You are an admin";
+
{
 +
[[hint]] "You are a some sort of admin";
 
};</code>
 
};</code>
| [[serverCommand]], [[serverCommandExecutable]], [[admin]], [[Multiplayer Server Commands]] |= See also
+
|seealso= [[serverCommand]], [[serverCommandExecutable]], [[admin]], [[Multiplayer Server Commands]]
 
 
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<!-- Note Section END -->
 
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
 
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|arma2|Scripting Commands}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|tkoh|Scripting Commands}}
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 01:02, 17 February 2021

Hover & click on the images for descriptions

Description

Description:
Returns true if given serverCommand is available on current machine, false if not. Here is the general table of availability of Arma 3 server commands:

  • Available to anyone

#login, #userlist, #beclient, #vote

  • Available to any admin (voted in / logged in) or server host

#kick, #debug

#lock, #unlock, #maxping, #maxdesync, #maxpacketloss

  • Available to any admin (voted in / logged in)

#logout, #restart, #mission, #missions, #reassign, #monitor, #init

  • Available to logged in admin

#shutdown, #restartserver, #exec, #beserver, #monitords, #logentities, #exportjipqueue

  • Available to logged in admin on certain game builds

#captureframe, #enabletest, #disabletest

To check if server command could be executed in current environment use serverCommandExecutable. For more information on what each server command does, see Multiplayer Server Commands.

NOTE: When password variant of serverCommand is used on dedicated server, the table above does not apply as everything is available to it.

Syntax

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

Examples

Example 1:
_can = serverCommandAvailable "#kick";
Example 2:
if (serverCommandAvailable "#logout") then { hint "You are a some sort of admin"; };

Additional Information

See also:
serverCommandserverCommandExecutableadminMultiplayer Server Commands
Groups:
Multiplayer

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