IsObjectInACLGroup: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(15 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}  
{{Server function}}  
{{Important Note|You must '''NOT''' to use this function to limit features to users that belong to specific groups. Instead you '''MUST''' 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.}}
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.}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool isObjectInACLGroup ( string theObject, aclgroup theGroup )
bool isObjectInACLGroup ( string theObjectName, aclgroup theGroup )
</syntaxhighlight>  
</syntaxhighlight>  
{{New feature/item|3.0141|1.4.0|6994|{{OOP||[[aclgroup]]:doesContainObject||}}}}
===Required Arguments===  
===Required Arguments===  
 
*'''theObjectName:''' 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 [[AclGroup|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.


===Returns===
===Returns===
Line 22: Line 21:
addCommandHandler ( "jetpack",
addCommandHandler ( "jetpack",
     function ( thePlayer )
     function ( thePlayer )
         -- If the player has a jetpack already, remove it
         if doesPedHaveJetPack ( thePlayer ) then -- If the player have a jetpack already, remove it
        if doesPedHaveJetPack ( thePlayer ) then
             removePedJetPack ( thePlayer ) -- Remove the jetpack
             removePedJetPack ( thePlayer ) -- Remove the jetpack
             return -- And stop the function here
             return -- And stop the function here
         end
         end
        -- Otherwise, give him one if he has access
    -- Otherwise, give him one if he has access
        local accName = getAccountName ( getPlayerAccount ( thePlayer ) )
 
        -- Does he have access to Admin functions?
    local accName = getAccountName ( getPlayerAccount ( thePlayer ) ) -- get his account name
        if isObjectInACLGroup ( "user." .. playerName, aclGetGroup ( "Admin" ) ) then
    if isObjectInACLGroup ("user."..accName, aclGetGroup ( "Admin" ) ) then -- Does he have access to Admin functions?
            -- He's an admin. Give him a jetpack
          if not doesPedHaveJetPack ( thePlayer ) then -- If the player doesn't have a jetpack give it.
            givePedJetPack ( thePlayer )
              givePedJetPack ( thePlayer ) -- Give the jetpack
        end
          end
    end
    end
end
)
)
</syntaxhighlight>
</syntaxhighlight>
Line 62: Line 61:
==See Also==
==See Also==
{{ACL_functions}}
{{ACL_functions}}
[[zh-cn:IsObjectInACLGroup]]

Latest revision as of 16:49, 21 September 2023

[[{{{image}}}|link=|]] Important Note: You must NOT to use this function to limit features to users that belong to specific groups. Instead you MUST 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.

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

Syntax

bool isObjectInACLGroup ( string theObjectName, aclgroup theGroup )

OOP Syntax Help! I don't understand this!

Method: aclgroup:doesContainObject(...)

Required Arguments

  • theObjectName: 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

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