AclReload: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Removed from "Needs Example" category.)
(OOP syntax added)
Line 9: Line 9:
bool aclReload ()
bool aclReload ()
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||ACL.reload||}}
===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 -->

Revision as of 17:37, 12 July 2014

This function reloads the ACL's and the ACL groups from the ACL XML file. All ACL and ACL group elements are invalid after a call to this and should not be used anymore.

Syntax

bool aclReload ()

OOP Syntax Help! I don't understand this!

Method: ACL.reload(...)


Returns

Returns true if the XML was successfully reloaded from the file, false or nil if the XML was invalid, didn't exist or could not be loaded for some other reason.

Example

This example allows an admin to reload the ACL by typing "/reloadACL".

function reloadACL ( source, command )
-- Check if they're an admin...
	if ( isObjectInACLGroup ( "user." .. getAccountName ( getPlayerAccount ( source )), aclGetGroup ( "Admin" ) ) ) then
		local reload = aclReload() -- Reload the ACL
			if ( reload ) then -- Check it was reloaded successfully
				outputChatBox ( "ACL was successfully reloaded.", source, 255, 0, 0 ) -- If so, output it
			else -- If not, output it (line below)
				outputChatBox ( "An unknown error occured. Please check the ACL file exists.", source, 255, 0, 0 )
			end
	else -- If they're not an admin, output it (below)
		outputChatBox ( "You must be an admin to use this command!", source, 255, 0, 0 )
	end
end
addCommandHandler ( "reloadACL", reloadACL )

See Also