AclDestroyGroup: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ <!-- 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 blahblahblabhalb...)
 
mNo edit summary
 
(12 intermediate revisions by 9 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 destroys the given ACL group. The destroyed ACL group will no longer be valid.


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool aclDestroyGroup ( aclgroup group )
bool aclDestroyGroup ( aclgroup aclGroup )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{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 -->
*'''argumentName:''' description
*'''aclGroup:''' The [[aclgroup]] element to destroy
 
<!-- 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 ACL group was successfully deleted, ''false'' if it could not be deleted for some reason (ie. invalid argument).


==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 admins to remove an ACL group they specify.
<!-- 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 removeACLGroup ( source, command, groupName )
blabhalbalhb --abababa
-- Check if they're an admin...
--This line does this...
if ( isObjectInACLGroup ( "user." .. getAccountName ( getPlayerAccount ( source )), aclGetGroup ( "Admin" ) ) ) then
mooo
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"
</syntaxhighlight>
</syntaxhighlight>


Line 37: Line 48:
<!-- 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]] -- leave this unless you complete the function
 
[[ar:aclDestroyGroup]]
[[en:AclDestroyGroup]]
[[zh-cn:AclDestroyGroup]]

Latest revision as of 18:17, 21 February 2021

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=69155"