AclCreate: Difference between revisions

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

Revision as of 02:35, 22 August 2014

This function creates an ACL entry in the Access Control List system with the specified name.

Syntax

acl aclCreate ( string aclName )

OOP Syntax Help! I don't understand this!

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


Required Arguments

  • aclName: The name of the ACL entry to add.

Returns

Returns the created ACL object if successful. Returns false if an ACL of the given name could not be created.

Example

This example adds a command setaclright with which you can easily add new rights to specified access control lists.

function setACLRight ( thePlayer, commandName, aclName, rightName, access )
    -- turn the boolean string to lower case
    access = string.lower ( access )
    -- access has to be either true or false (booleans)
    if not (access == "true" or access == "false") then
        -- print out error message to debug window
        return outputDebugString ( "Invalid access; true and false are only accepted", 1 )
    end

    -- change the access to boolean
    if access == "true" then
        access = true
    else 
        access = false
    end

    local ourACL = aclGet ( aclName )
    -- if there is no previous ACL with this name, we need to create one
    if not ourACL then
        ourACL = aclCreate ( aclName )
    end

    -- and finally let's set the right
    aclSetRight ( ourACL, rightName, access )
    -- don't forget to save the ACL after it has been modified
    aclSave ()
end
addCommandHandler ( "setaclright", setACLRight )

See Also