IsObjectInACLGroup: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Updated both examples to look nicer (didn't change what they do) and not display bad practices (like global variables) so new devs can learn with good code)
 
(34 intermediate revisions by 16 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.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool isObjectInACLGroup (string ObjectName, string GroupName)
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".
*'''ObjectName:''' The Object name of the Object you wish to check is in the group for example resource.race or user.Jim
*'''theGroup:''' the [[AclGroup|ACL group]] pointer of the group from which the object should be found.
*'''GroupName:''' The Group name of the group you wish to check the Object is in for example Admin


===Returns===
===Returns===
Returns ''true'' if the ObjectName is in the specified GroupName. ''false'' if it is not or invalid arguments where passed.
Returns ''true'' if the object is in the specified group, ''false'' otherwise.


==Example==  
==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.
<syntaxhighlight lang="lua">
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)
</syntaxhighlight>
'''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'):
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
local admins = ""
local players = getElementsByType("player")
for k, v in ipairs(players) do
  if not isGuestAccount(getPlayerAccount(v)) then
      local 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(" " .. admins, getRootElement(), 255, 255, 0)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{ACL_functions}}
{{ACL_functions}}
[[Category:Needs_Example]]
[[zh-cn:IsObjectInACLGroup]]

Latest revision as of 20:48, 13 May 2024

[[{{{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'): 

local admins = ""
local players = getElementsByType("player")
for k, v in ipairs(players) do
   if not isGuestAccount(getPlayerAccount(v)) then
      local 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(" " .. admins, getRootElement(), 255, 255, 0)

See Also

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