AclGroupGetName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added arg type in syntax)
(One intermediate revision by the same user not shown)
Line 16: Line 16:
===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==  
This example outputs to the console that "Admin's are ready to watch".  
This example outputs to the console that "Admin's are ready to watch :)".  
<syntaxhighlight lang="lua">addEventHandler("onResourceStart",resourceRoot,function()
<syntaxhighlight lang="lua">addEventHandler("onResourceStart", resourceRoot, function()
outputConsole(aclGroupGetName(aclGetGroup("Admin")).."'s are ready to watch :)",root)
outputConsole(aclGroupGetName(aclGetGroup("Admin")).."'s are ready to watch :)",root)
end)
end)

Revision as of 14:28, 22 May 2017

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