AclGroupAddObject: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (fix oop syntax)
m (Fixed arg name in "Required Arguments")
Line 19: Line 19:
<!-- 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 -->
*'''theGroup:''' The group to add the object name string too.
*'''theGroup:''' The group to add the object name string too.
*'''theGroupName:''' The object string to add to the given ACL
*'''theObjectName:''' The object string to add to the given ACL


===Returns===
===Returns===

Revision as of 10:06, 3 January 2015

This function adds an object to the given ACL group. An object can be a player's account, specified as: 

 user.<accountname>

Or a resource, specified as: 

 resource.<resourcename>

Objects are specified as strings. The ACL groups work for the user accounts and the resources that are specified in them.

Syntax

bool aclGroupAddObject ( aclgroup theGroup, string theObjectName )

OOP Syntax Help! I don't understand this!

Method: aclgroup:addObject(...)


Required Arguments

  • theGroup: The group to add the object name string too.
  • theObjectName: The object string to add to the given ACL

Returns

Returns true if the object was successfully added to the ACL, false if it already existed in the list.

Example

This example makes every player able to use a command named "giveAccountAdminRights" that will add a specific accountname as an ACL object to the "Admin" group. 

function giveAdminRights (playerSource, commandName, accountName) --add the function giveAdminRights and specify its arguments
	if accountName then --if there was an accountName entered then
		aclGroupAddObject (aclGetGroup("Admin"), "user."..accountName) --add an ACL object using the form "user.[accountName]" to the ACL group "Admin"
		outputChatBox ("Account '"..accountName.."' succesfully added to the admin group", playerSource) --output a notification to the player who entered the command that the acocunt was successfully added
	else --else output an error message and the correct syntax of the command to the player who entered it
		outputChatBox ("No account name specified.", playerSource)
		outputChatBox ("Correct syntax: /giveAccountAdminRights [accountName]", playerSource)
	end
end

addCommandHandler ("giveAccountAdminRights", giveAdminRights) --add a command "giveAccountAdminRights" and attch the function "giveAdminRights" to it

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/AclGroupAddObject?oldid=43860"