BIS fnc admin: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 2/7)
m (Text replacement - "[[server.cfg#" to "[[Arma 3: Server Config File#")
 
(23 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3dev |= Game name
|game1= arma3
|version1= 1.70


|1.69|= Game version
|gr1= Multiplayer
____________________________________________________________________________________________


| Returns the admin state of a client the function is called on. Compliments [[admin]] script command and used for self check on a local client.|= Description
|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.
____________________________________________________________________________________________


| call '''BIS_fnc_admin''' |= Syntax
|s1= call [[BIS_fnc_admin]]


|p1= |= Parameter 1
|r1= [[Number]]  - admin state of current client:
|p2=  |= Parameter 2
 
| [[Number]]  - admin state of current client:
* 0 - client is not an admin
* 0 - client is not an admin
* 1 - client is admin that is [[server.cfg#Voted_In_Admin|voted in]]
* 1 - client is admin that is [[Arma 3: Server Config File#Voted_In_Admin|voted in]]
* 2 - client is admin that is [[server.cfg#Logged_In_Admin|logged in]] |= Return value
* 2 - client is admin that is [[Arma 3: Server Config File#Logged_In_Admin|logged in]]
 
|exec= call |= Execution By (defaults to [[call]] if omitted)
__________________________________________________________________________
 
|x1= <code>_adminState = [[call]] [[BIS_fnc_admin]];</code> |= Example 1
____________________________________________________________________________________________
 


| [[admin]] |= See also
|x1= <sqf>private _adminState = call BIS_fnc_admin;</sqf>


|seealso= [[admin]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here e.g. [[Category:Arma 3: Functions|{{uc:{{PAGENAME}}}}]] -->
[[Category:Function Group: MP|{{uc:admin}}]]
[[Category:Functions|{{uc:admin}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:spawn}}]]

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"