AclGetRight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 17: Line 17:
===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'' 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.
Returns ''true'' or ''false'' if the ACL gives access or not to the given function. Returns ''nil'' if it failed for some reason, e.g. an invalid ACL was specified or the right specified does not exist in the ACL.


==Example==  
==Example==  

Revision as of 21:45, 19 December 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 reason, e.g. an invalid ACL was specified or the right specified does not exist in the ACL.

Example

This example does...

--TODO

See Also