AclReload: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This fake function is for use with blah & blah and does blahblahblabhalbhl
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==  
==Syntax==  
Line 8: Line 9:
bool aclReload ()
bool aclReload ()
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP|This function is a static function underneath the ACL class.|[[ACL]].reload||}}
===Required Arguments===
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''argumentName:''' description
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}  
*'''argumentName2:''' description
*'''argumentName3:''' description
 
===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 -->
Returns ''true'' if blah, ''false'' otherwise.
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==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<!-- Explain what the example is in a single sentance -->
This example does...
This example allows an admin to reload the ACL by typing "/reloadACL".
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function reloadACL ( source, command )
blabhalbalhb --abababa
-- Check if they're an admin...
--This line does this...
if ( isObjectInACLGroup ( "user." .. getAccountName ( getPlayerAccount ( source )), aclGetGroup ( "Admin" ) ) ) then
mooo
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 )
</syntaxhighlight>
</syntaxhighlight>


Line 37: Line 38:
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{ACL_functions}}
{{ACL_functions}}
[[Category:Incomplete]]
[[zh-cn:aclReload]]

Latest revision as of 08:37, 5 February 2021

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!

Note: This function is a static function underneath the ACL class.
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

Retrieved from "https://wiki.multitheftauto.com/wiki/AclReload?oldid=68740"