BIS fnc admin: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "[[server.cfg#" to "[[Arma 3: Server Config File#")
 
(26 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.70


| arma3 |= Game name
|gr1= Multiplayer


|1.00|= Game version
|descr= Returns the admin state of a client the function is called on. Complements [[admin]] script command and used for self check on a local client.
____________________________________________________________________________________________


| <pre>/*
|s1= call [[BIS_fnc_admin]]
Author:
Killzone_Kid


Description:
|r1= [[Number]]  - admin state of current client:
Returns the admin state of a client the function is called on.
* 0 - client is not an admin
Compliments "admin" script command and used for self check on a local client.
* 1 - client is admin that is [[Arma 3: Server Config File#Voted_In_Admin|voted in]]
* 2 - client is admin that is [[Arma 3: Server Config File#Logged_In_Admin|logged in]]


Parameter(s):
|x1= <sqf>private _adminState = call BIS_fnc_admin;</sqf>
NONE
 
Returns:
NUMBER
0 - this client is not an admin
1 - this client is voted in admin
2 - this client is logged in admin
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_admin]]; --> |= Syntax
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[admin]]
}}
}}
<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:Function Group: MP|{{uc:admin}}]]
[[Category:Functions|{{uc:admin}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:admin}}]]

Latest revision as of 13:40, 17 May 2024

Arma 3 logo black.png1.70
Hover & click on the images for description

Description

Description:
Returns the admin state of a client the function is called on. Complements admin script command and used for self check on a local client.
Execution:
call
Groups:
Multiplayer

Syntax

Syntax:
call BIS_fnc_admin
Return Value:
Number - admin state of current client:
  • 0 - client is not an admin
  • 1 - client is admin that is voted in
  • 2 - client is admin that is logged in

Examples

Example 1:
private _adminState = call BIS_fnc_admin;

Additional Information

See also:
admin

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_admin&oldid=364585"