AclRemoveRight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
<!-- 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 removes the given right (string) from the given ACL.
This function removes the given right (string) from the given ACL.
Line 8: Line 9:
bool aclRemoveRight ( acl theAcl, string rightName )  
bool aclRemoveRight ( acl theAcl, string rightName )  
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[acl]]:removeRight||}}
===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 -->
Line 19: Line 20:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example removes an acl right on resource start.
This example does...
<!-- 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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
addEventHandler("onResourceStart",resourceRoot,function()
  aclRemoveRight(aclGet("Admin"),"function.setServerPassword")
end)
</syntaxhighlight>
</syntaxhighlight>


Line 29: Line 30:
<!-- 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}}
[[Category:Incomplete]]
[[zh-cn:aclRemoveRight]]

Latest revision as of 08:37, 5 February 2021

This function removes the given right (string) from the given ACL.

Syntax

bool aclRemoveRight ( acl theAcl, string rightName ) 

OOP Syntax Help! I don't understand this!

Method: acl:removeRight(...)


Required Arguments

  • theAcl: The ACL to remove the right from
  • rightName: The ACL name to remove from the right from

Returns

Returns true if the given right was successfully removed from the given ACL, false or nil if it could not be removed for some reason, ie. it didn't exist in the ACL.

Example

This example removes an acl right on resource start.

addEventHandler("onResourceStart",resourceRoot,function()
   aclRemoveRight(aclGet("Admin"),"function.setServerPassword")
end)

See Also