AclList: Difference between revisions

Revision as of 21:36, 19 December 2007

This function returns a list of all the ACLs.

table aclList ()

Returns a table of all the ACLs. This table can be empty if no ACLs exist. It can also return false/nil if it failed for some reason.

This example does...

--TODO

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Server function}}
-<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
+This function returns a list of all the ACLs.
-This function returns a list over ACL's.
 ==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 -->
 <syntaxhighlight lang="lua">
-table of acl aclList ()
+table aclList ()
 </syntaxhighlight>
 ===Returns===
-<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
+Returns a table of all the ACLs. This table can be empty if no ACLs exist. It can also return ''false''/''nil'' if it failed for some reason.
-Returns a table over all the ACL's. This table can be empty if no ACL's exist. It can also return ''false''/''nil'' if it failed for some reason.
 ==Example==
@@ Line 23: / Line 20: @@
 ==See Also==
-<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
 {{ACL_functions}}
 [[Category:Needs_Example]]