IsObjectInACLGroup: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:
This function is used to determine if an object is in a group.
This function is used to determine if an object is in a group.


{{Note_box|It's recommended '"not'' to use this function to limit features to users that belong to specific groups. Instead use [[hasObjectPermissionTo]]. Using this function forces the server owner to name their group a certain way, whereas using hasObjectPermissionTo allows the owner to give permission for whatever features you restrict to whatever groups they have set up in their ACL.}}
{{Note_box|It's recommended 'not'' to use this function to limit features to users that belong to specific groups. Instead use [[hasObjectPermissionTo]]. Using this function forces the server owner to name their group a certain way, whereas using hasObjectPermissionTo allows the owner to give permission for whatever features you restrict to whatever groups they have set up in their ACL.}}


==Syntax==  
==Syntax==  

Revision as of 01:36, 22 January 2011

This function is used to determine if an object is in a group.

This template is no longer in use as it results in poor readability.

Syntax

bool isObjectInACLGroup ( string theObject, aclgroup theGroup )

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 the player has a jetpack already, remove it
        if doesPedHaveJetPack ( thePlayer ) then
            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 ) )
        -- Does he have access to Admin functions?
        if isObjectInACLGroup ( "user." .. playerName, aclGetGroup ( "Admin" ) ) then
            -- He's an admin. Give him a jetpack
            givePedJetPack ( thePlayer )
        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


Retrieved from "https://wiki.multitheftauto.com/wiki/IsObjectInACLGroup?oldid=25239"