AclGroupRemoveObject: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}  
{{Server function}}  
{{Needs Example}}
<!-- 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 function removes the given object (string) from the given ACL group. The object can be a resource or a player. See [[aclGroupAddObject]] for more details.
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==  
Line 10: Line 9:
bool aclGroupRemoveObject ( aclgroup theGroup, string theObjectString )
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 -->
Line 25: 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">
--TODO
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)
</syntaxhighlight>
</syntaxhighlight>


Revision as of 09:41, 21 June 2019

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 remoevd, 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=63030"