AclGetRight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
<!-- 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 -->
{{Needs_Checking|The function name doesn't really make sense. Perhaps come up with something else as this doesn't really check if the ACL has rights to do that. It just checks if an entry like that exists and returns it's right tag.}}
This function returns whether the access for the given right is set to true or false in the ACL.
This fake function is for use with blah & blah and does blahblahblabhalbhl


==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 aclGetRight ( acl theAcl, string rightname )
bool aclGetRight ( acl theAcl, string rightName )
</syntaxhighlight>  
</syntaxhighlight>  


===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 get the right from
 
*'''rightName:''' The right name to return the access value of.
<!-- 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'' or ''false'' if the ACL gives access or not to the given function. Returns ''nil'' if it failed for some reasno, ie. invalid ACL or the right name does not exist.


==Example==  
==Example==  
Line 29: Line 23:
<!-- 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 -->
<!-- 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...
--TODO
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>
</syntaxhighlight>


Revision as of 09:54, 26 November 2007

This function returns whether the access for the given right is set to true or false in the ACL.

Syntax

bool aclGetRight ( acl theAcl, string rightName )

Required Arguments

  • theAcl: The ACL to get the right from
  • rightName: The right name to return the access value of.

Returns

Returns true or false if the ACL gives access or not to the given function. Returns nil if it failed for some reasno, ie. invalid ACL or the right name does not exist.

Example

This example does... 

--TODO

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/AclGetRight?oldid=13310"