AclGroupRemoveObject: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(fix small typo)
 
Line 17: Line 17:
===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 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.
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==  

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