AclGroupAddObject: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function adds an object to the given ACL group. An object can be a player, specified as:
  ''player.<accountname>''
 
Or a resource, specified as:
  ''resource.<resourcename>''
 
Objects are specified as strings. The ACL groups work for the players and the resources that are specified in them.


==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 -->
<!-- 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">
bool aclGroupAddObject ( aclgroup group, string object )
bool aclGroupAddObject ( aclgroup theGroup, string theObjectName )
</syntaxhighlight>  
</syntaxhighlight>  


===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 -->
<!-- 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 -->
*'''argumentName:''' description
*'''theGroup:''' The group to add the object name string too.
 
*'''theGroupName:''' The object string to add to the given ACL
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if blah, ''false'' otherwise.
Returns ''true'' if the object was successfully added to the ACL, ''false'' if it already existed in the list.


==Example==  
==Example==  
Line 28: Line 29:
<!-- 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 -->
<!-- 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">
--This line does...
--TODO
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>
</syntaxhighlight>


Revision as of 09:20, 26 November 2007

This function adds an object to the given ACL group. An object can be a player, specified as: 

 player.<accountname>

Or a resource, specified as: 

 resource.<resourcename>

Objects are specified as strings. The ACL groups work for the players and the resources that are specified in them.

Syntax

bool aclGroupAddObject ( aclgroup theGroup, string theObjectName )

Required Arguments

  • theGroup: The group to add the object name string too.
  • theGroupName: The object string to add to the given ACL

Returns

Returns true if the object was successfully added to the ACL, false if it already existed in the list.

Example

This example does... 

--TODO

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/AclGroupAddObject?oldid=13298"