AclGroupGetName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(13 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server function}}
{{Needs Example}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function is used to get the name of the given ACL group.
This function is used to get the name of the given ACL group.
Line 8: Line 7:
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string aclGroupGetName ( aclGroup )
string aclGroupGetName ( aclgroup aclGroup )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[aclgroup]]:getName|name|}}
===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''aclGroup:''' The ACl group to get the name of
*'''aclGroup:''' The ACL group to get the name of


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns the name of the given ACL group as a string if successfull, ''false''/''nil'' if the aclGroup is invalid or it fails for some other reason.
Returns the name of the given ACL group as a string if successful, otherwise ''false'' or ''nil'' if the aclGroup is invalid or it fails for some other reason.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example outputs to the console that "Admin's are ready to watch :)".  
This example does...
<syntaxhighlight lang="lua">addEventHandler("onResourceStart", resourceRoot, function()
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
outputConsole(aclGroupGetName(aclGetGroup("Admin")).."'s are ready to watch :)",root)
<syntaxhighlight lang="lua">
end)
--TODO
</syntaxhighlight>
</syntaxhighlight>


Line 30: Line 28:
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{ACL_functions}}
{{ACL_functions}}
[[zh-cn:aclGroupGetName]]

Latest revision as of 06:35, 6 February 2021

This function is used to get the name of the given ACL group.

Syntax

string aclGroupGetName ( aclgroup aclGroup )

OOP Syntax Help! I don't understand this!

Method: aclgroup:getName(...)
Variable: .name


Required Arguments

  • aclGroup: The ACL group to get the name of

Returns

Returns the name of the given ACL group as a string if successful, otherwise false or nil if the aclGroup is invalid or it fails for some other reason.

Example

This example outputs to the console that "Admin's are ready to watch :)". 

addEventHandler("onResourceStart", resourceRoot, function()
	outputConsole(aclGroupGetName(aclGetGroup("Admin")).."'s are ready to watch :)",root)
end)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/AclGroupGetName?oldid=68810"