AclGroupRemoveObject: 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...)
 
(fix small typo)
 
(11 intermediate revisions by 8 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 removes the given object from the given ACL group. The object can be a resource or a player. See [[aclGroupAddObject]] for more details.


==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 aclGroupRemoveObject ( aclgroup group, string object )
bool aclGroupRemoveObject ( aclgroup theGroup, string theObjectString )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[aclgroup]]:removeObject||}}
===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
*'''theGroup:''' The ACL group to remove the object string from
 
*'''theObjectString:''' The object to remove from the ACL group
<!-- 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 object existed in the ACL and could be removed, ''false'' if it could not be removed for some reason, ie. it did not exist in the given ACL group.


==Example==  
==Example==  
Line 28: Line 24:
<!-- 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 deladm (playerSource, commandName, accountName)
blabhalbalhb --abababa
if accountName then --Make the script able to detect if a user is given.
--This line does this...
aclGroupRemoveObject (aclGetGroup("Admin"), "user."..accountName) --Removing the admin.
mooo
outputChatBox ("ACL: Account '"..accountName.."' succesfully removed as admin.", playerSource) -- Giving you a messsage.
outputChatBox ("ACL: Someone have removed you as admin.", accountName) -- giving the poor removed guy a message.
else --Make the Syntax display.
outputChatBox ("ACL: No account name specified.", playerSource)
outputChatBox ("ACL: Syntax: /deladmin [accountName]", playerSource)
end
end
addCommandHandler ("deladmin", deladm)
</syntaxhighlight>
</syntaxhighlight>


Line 37: Line 40:
<!-- 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:aclGroupRemoveObject]]

Latest revision as of 19:17, 29 November 2023

This function removes the given object from the given ACL group. The object can be a resource or a player. See aclGroupAddObject for more details.

Syntax

bool aclGroupRemoveObject ( aclgroup theGroup, string theObjectString )

OOP Syntax Help! I don't understand this!

Method: aclgroup:removeObject(...)


Required Arguments

  • theGroup: The ACL group to remove the object string from
  • theObjectString: The object to remove from the ACL group

Returns

Returns true if the object existed in the ACL and could be removed, false if it could not be removed for some reason, ie. it did not exist in the given ACL group.

Example

This example does... 

function deladm (playerSource, commandName, accountName)
	if accountName then --Make the script able to detect if a user is given.
		aclGroupRemoveObject (aclGetGroup("Admin"), "user."..accountName) --Removing the admin.
		outputChatBox ("ACL: Account '"..accountName.."' succesfully removed as admin.", playerSource) -- Giving you a messsage.
		outputChatBox ("ACL: Someone have removed you as admin.", accountName) -- giving the poor removed guy a message.
	else --Make the Syntax display.
		outputChatBox ("ACL: No account name specified.", playerSource)
		outputChatBox ("ACL: Syntax: /deladmin [accountName]", playerSource)
	end
end
addCommandHandler ("deladmin", deladm)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/AclGroupRemoveObject?oldid=78640"