AclList: 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 7: Line 7:
table aclList ()
table aclList ()
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP|This function is a static function underneath the ACL class.|[[ACL]].list||}}
===Returns===
===Returns===
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 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.
Line 20: Line 20:
     if #allACLs == 0 then
     if #allACLs == 0 then
         -- print out a message to console and exit function
         -- print out a message to console and exit function
         outputConsole ( "There are no ACLs!", thePlayer )
         return outputConsole ( "There are no ACLs!", thePlayer )
        return
     else
     else
         -- print out a list of the names
         -- print out a list of the names
Line 36: Line 35:
==See Also==
==See Also==
{{ACL_functions}}
{{ACL_functions}}
[[zh-cn:aclList]]

Latest revision as of 08:36, 5 February 2021

This function returns a list of all the ACLs.

Syntax

table aclList ()

OOP Syntax Help! I don't understand this!

Note: This function is a static function underneath the ACL class.
Method: ACL.list(...)


Returns

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.

Example

This example adds a command listacls which prints out a name list of all ACLs to the console.

function printOutAllACLs ( thePlayer )
    -- get a table over all the ACLs
    local allACLs = aclList()
    -- if the table is empty (there are no ACLs)
    if #allACLs == 0 then
        -- print out a message to console and exit function
        return outputConsole ( "There are no ACLs!", thePlayer )
    else
        -- print out a list of the names
        outputConsole ( "List of all ACLs:", thePlayer )
        for key, singleACL in ipairs ( allACLs ) do
            local ACLName = aclGetName ( singleACL )
            outputConsole ( "- " .. tostring ( ACLName ), thePlayer )
        end
   end
end
addCommandHandler ( "listacls", printOutAllACLs )

See Also