AclRemoveRight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ <!-- Describe in plain english what this function does. Don't go into details, just give an overview --> This fake function is for use with blah & blah and does blahblahblabhalb...)
 
No edit summary
 
(11 intermediate revisions by 7 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 fake function is for use with blah & blah and does blahblahblabhalbhl
This function removes the given right (string) from the given ACL.


==Syntax==  
==Syntax==  
<!-- 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">
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 -->
*'''argumentName:''' description
*'''theAcl:''' The ACL to remove the right from
 
*'''rightName:''' The ACL name to remove from the right from
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===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 ''true'' if blah, ''false'' otherwise.
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==  
==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">
--This line does...
addEventHandler("onResourceStart",resourceRoot,function()
blabhalbalhb --abababa
  aclRemoveRight(aclGet("Admin"),"function.setServerPassword")
--This line does this...
end)
mooo
</syntaxhighlight>
</syntaxhighlight>


Line 37: 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]] -- leave this unless you complete the function
[[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

Retrieved from "https://wiki.multitheftauto.com/wiki/AclRemoveRight?oldid=68741"