AclGetName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP syntax added)
m (→‎Syntax: OOP)
Line 7: Line 7:
string aclGetName ( acl theAcl )
string aclGetName ( acl theAcl )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[acl]]:getName|name|}}
{{OOP|This function is also a static function underneath the ACL class.|[[acl]]:getName|name|}}
===Required Arguments===  
===Required Arguments===  
*'''theACL:''' The ACL to get the name of
*'''theACL:''' The ACL to get the name of

Revision as of 14:27, 22 August 2014

Get the name of given ACL.

Syntax

string aclGetName ( acl theAcl )

OOP Syntax Help! I don't understand this!

Note: This function is also a static function underneath the ACL class.
Method: acl:getName(...)
Variable: .name


Required Arguments

  • theACL: The ACL to get the name of

Returns

Returns the name of the given ACL as a string if successful. Returns false/nil if unsuccessful, ie the ACL is invalid.

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


Retrieved from "https://wiki.multitheftauto.com/wiki/AclGetName?oldid=41563"