AclCreateGroup: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server function}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function creates a group in the ACL. An ACL group can contain objects like players and resources. They specify who has access to the ACL's in this group.
This function creates a group in the ACL. An ACL group can contain objects like players and resources. They specify who has access to the ACL's in this group.


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
aclgroup aclCreateGroup ( string groupName )
aclgroup aclCreateGroup ( string groupName )
Line 11: Line 9:


===Required Arguments===  
===Required Arguments===  
<!-- 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 -->
*'''groupName:''' The name of the group to create
*'''groupName:''' The name of the group to create


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns the pointer to the created aclgroup if successful. Returns false if failed.
Returns the pointer to the created aclgroup if successful. Returns false if failed.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example adds a command ''addobjecttogroup'' with which you can easily add new objects to specified access control list groups.
This example does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function addACLGroupObject ( thePlayer, commandName, groupName, objectName )
    local ourGroup = aclGetGroup ( groupName )
    -- if there is no previous group with this name, we need to create one
    if not ourGroup then
        ourGroup = aclCreateGroup ( groupName )
    end
 
    -- if object name wasn't given
    if not objectName then
        -- print out message to chatbox
        outputChatBox ( "You need to specify the object!", thePlayer )
        -- exit function
return
    end
 
    -- and finally let's add the object to it's group
    aclGroupAddObject ( ourGroup, objectName )
    -- don't forget to save the ACL after it has been modified
    aclSave ()
end
addCommandHandler ( "addobjecttogroup", addACLGroupObject )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{ACL_functions}}
{{ACL_functions}}
[[Category:Needs_Example]]

Revision as of 18:31, 22 June 2009

This function creates a group in the ACL. An ACL group can contain objects like players and resources. They specify who has access to the ACL's in this group.

Syntax

aclgroup aclCreateGroup ( string groupName )

Required Arguments

  • groupName: The name of the group to create

Returns

Returns the pointer to the created aclgroup if successful. Returns false if failed.

Example

This example adds a command addobjecttogroup with which you can easily add new objects to specified access control list groups. 

function addACLGroupObject ( thePlayer, commandName, groupName, objectName )
    local ourGroup = aclGetGroup ( groupName )
    -- if there is no previous group with this name, we need to create one
    if not ourGroup then
        ourGroup = aclCreateGroup ( groupName )
    end

    -- if object name wasn't given
    if not objectName then
        -- print out message to chatbox
        outputChatBox ( "You need to specify the object!", thePlayer )
        -- exit function
	return
    end

    -- and finally let's add the object to it's group
    aclGroupAddObject ( ourGroup, objectName )
    -- don't forget to save the ACL after it has been modified
    aclSave ()
end
addCommandHandler ( "addobjecttogroup", addACLGroupObject )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/AclCreateGroup?oldid=20163"