IsObjectInACLGroup: Difference between revisions
Jump to navigation
Jump to search
m (→Syntax: OOP) |
|||
| Line 8: | Line 8: | ||
bool isObjectInACLGroup ( string theObject, aclgroup theGroup ) | bool isObjectInACLGroup ( string theObject, aclgroup theGroup ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP|This function is also a static function underneath the ACL Group class.|[[aclgroup]]:doesContainObject||}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theObject:''' the name of the object to check. Examples: "resource.ctf", "user.Jim". | *'''theObject:''' the name of the object to check. Examples: "resource.ctf", "user.Jim". | ||
*'''theGroup:''' the [[ACL group]] pointer of the group from which the object should be found. | *'''theGroup:''' the [[ACL group]] pointer of the group from which the object should be found. | ||
Revision as of 15:34, 22 August 2014
This template is no longer in use as it results in poor readability. This function is used to determine if an object is in a group.
Syntax
bool isObjectInACLGroup ( string theObject, aclgroup theGroup )
OOP Syntax Help! I don't understand this!
- Note: This function is also a static function underneath the ACL Group class.
- Method: aclgroup:doesContainObject(...)
Required Arguments
- theObject: the name of the object to check. Examples: "resource.ctf", "user.Jim".
- theGroup: the ACL group pointer of the group from which the object should be found.
Returns
Returns true if the object is in the specified group, false otherwise.
Example
Example 1: This example adds a jetpack command that is only available to admins. When entering the command, it will toggle the player's jetpack.
addCommandHandler ( "jetpack",
function ( thePlayer )
if doesPedHaveJetPack ( thePlayer ) then -- If the player have a jetpack already, remove it
removePedJetPack ( thePlayer ) -- Remove the jetpack
return -- And stop the function here
end
-- Otherwise, give him one if he has access
local accName = getAccountName ( getPlayerAccount ( thePlayer ) ) -- get his account name
if isObjectInACLGroup ("user."..accName, aclGetGroup ( "Admin" ) ) then -- Does he have access to Admin functions?
if not doesPedHaveJetPack ( thePlayer ) then -- If the player doesn't have a jetpack give it.
givePedJetPack ( thePlayer ) -- Give the jetpack
end
end
end
)
Example 2: This example displays a list of all the online admins in the chat box (assuming your administrator's group in your ACL is called 'admin'):
players = getElementsByType ( "player" )
admins = ""
for k,v in ipairs(players) do
local accountname = ""
if (isGuestAccount(getPlayerAccount(v)) == false) then
accountname = getAccountName (getPlayerAccount(v))
if isObjectInACLGroup ( "user." .. accountname, aclGetGroup ( "admin" ) ) then
if (admins == "") then
admins = getPlayerName(v)
else
admins = admins .. ", " .. getPlayerName(v)
end
end
end
end
outputChatBox( "Online Admins:", getRootElement(), 255, 255, 0)
outputChatBox( " " .. tostring ( admins ), getRootElement(), 255, 255, 0)
See Also
- aclCreate
- aclCreateGroup
- aclDestroy
- aclDestroyGroup
- aclGet
- aclGetGroup
- aclGetName
- aclGetRight
- aclGroupAddACL
- aclGroupAddObject
- aclGroupGetName
- aclGroupList
- aclGroupListACL
- aclGroupListObjects
- aclGroupRemoveACL
- aclGroupRemoveObject
- aclList
- aclListRights
- aclReload
- aclRemoveRight
- aclSave
- aclSetRight
- hasObjectPermissionTo
- isObjectInACLGroup