AclDestroyGroup: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Syntax: OOP)
m (fix oop syntax)
Line 9: Line 9:
bool aclDestroyGroup ( aclgroup aclGroup )
bool aclDestroyGroup ( aclgroup aclGroup )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP|This function is also a static function underneath the ACL Group class.|[[aclgroup]]:destroy||}}
{{OOP||[[aclgroup]]:destroy||}}
===Required Arguments===  
===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 -->
<!-- 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 -->

Revision as of 14:40, 1 January 2015

This function destroys the given ACL group. The destroyed ACL group will no longer be valid.

Syntax

bool aclDestroyGroup ( aclgroup aclGroup )

OOP Syntax Help! I don't understand this!

Method: aclgroup:destroy(...)


Required Arguments

  • aclGroup: The aclgroup element to destroy

Returns

Returns true if the ACL group was successfully deleted, false if it could not be deleted for some reason (ie. invalid argument).

Example

This example allows admins to remove an ACL group they specify. 

function removeACLGroup ( source, command, groupName )
-- Check if they're an admin...
	if ( isObjectInACLGroup ( "user." .. getAccountName ( getPlayerAccount ( source )), aclGetGroup ( "Admin" ) ) ) then
		if ( groupName ) then -- Check if they specified the group name
			local group = aclGetGroup ( groupName ) -- Return any groups matching the name
				if ( group ) then -- If any were returned then...
					aclDestroyGroup ( group ) -- Destroy that group
				else
					-- Tell them if no groups with that name were found...
					outputChatBox ( "No group with that name was found.", source, 255, 0, 0 )
				end
	
		else -- If they didn't specify the group
			outputChatBox ( "Please specify the group name.", source, 255, 0, 0 ) -- Tell them that they must
		end
	else -- If they're not an admin....
		outputChatBox ( "You must be an admin to use this command", source, 255, 0, 0 ) -- Tell them it's restricted
	end
end
addCommandHandler ( "removeACL", removeACLGroup ) -- Make it happen when somebody types "/removeACL"

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/AclDestroyGroup?oldid=43663"