ACL functions

Author: FileEX

functions/ACL/aclCreate.yaml

@@ -1,5 +1,21 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/aclCreate
 server:
   name: aclCreate
-  description: TODO
-  incomplete: true
+  description: This function creates an [[ACL]] entry in the Access Control List system with the specified name.
+  oop:
+    element: ACL
+    constructorclass: ACL
+  parameters:
+    - name: aclName
+      type: string
+      description: The name of the [[ACL]] entry to add.
+  returns:
+    values:
+      - type: acl|false
+        name: acl object
+    description: Returns the created [[ACL]] object if successful. Returns false if an ACL of the given name could not be created.
+  examples:
+    - path: examples/aclCreate-1.lua
+      description: This example adds a command <code>setaclright</code> with which you can easily add new rights to specified access control lists.
+    - path: examples/aclCreate_OOP-1.lua
+      description: This example adds a command <code>setaclright</code> with which you can easily add new rights to specified access control lists.
+      oop: true

functions/ACL/aclCreateGroup.yaml

@@ -1,5 +1,22 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/aclCreateGroup
 server:
   name: aclCreateGroup
-  description: TODO
-  incomplete: true
+  description: 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.
+  oop:
+    element: ACLGroup
+    constructorclass: ACLGroup
+  parameters:
+    - name: groupName
+      type: string
+      description: The name of the group to create.
+  returns:
+    values:
+      - type: aclgroup|false
+        name: acl group
+    description: Returns the pointer to the created aclgroup if successful. Returns false if failed.
+  examples:
+    - path: examples/aclCreateGroup-1.lua
+      description: This example adds a command <code>addobjecttogroup</code> with which you can easily add new objects to specified access control list groups.
+    - path: examples/aclCreateGroup_OOP-1.lua
+      description: This example adds a command <code>addobjecttogroup</code> with which you can easily add new objects to specified access control list groups.
+      oop: true
+    

functions/ACL/aclDestroy.yaml

@@ -1,5 +1,21 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/aclDestroy
 server:
   name: aclDestroy
-  description: TODO
-  incomplete: true
+  description: This function destroys the [[ACL]] passed. The destroyed ACL will no longer be valid.
+  oop:
+    element: acl
+    method: destroy
+  parameters:
+    - name: theACL
+      type: acl
+      description: The ACL to destroy.
+  returns:
+    values:
+      - type: bool
+        name: resullt
+    description: Returns true if successfully destroyed and false if it could not be deleted (ie. it's not valid).
+  examples:
+    - path: examples/aclDestroy-1.lua
+      description: This example shows you a command to delete an ACL.
+    - path: examples/aclDestroy_OOP-1.lua
+      description: This example shows you a command to delete an ACL.
+      oop: true

functions/ACL/aclDestroyGroup.yaml

@@ -1,5 +1,21 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/aclDestroyGroup
 server:
   name: aclDestroyGroup
-  description: TODO
-  incomplete: true
+  description: This function destroys the given [[ACL]] group. The destroyed ACL group will no longer be valid.
+  oop:
+    element: aclgroup
+    method: destroy
+  parameters:
+    - name: aclGroup
+      type: aclgroup
+      description: The [[aclgroup]] element to destroy.
+  returns:
+    values:
+      - type: bool
+        name: result
+    description: Returns true if the ACL group was successfully deleted, false if it could not be deleted for some reason (ie. invalid argument).
+  examples:
+    - path: examples/aclDestroyGroup-1.lua
+      description: This example allows admins to remove an ACL group they specify.
+    - path: examples/aclDestroyGroup_OOP-1.lua
+      description: This example allows admins to remove an ACL group they specify.
+      oop: true

functions/ACL/aclGet.yaml

@@ -1,5 +1,23 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/aclGet
 server:
   name: aclGet
-  description: TODO
-  incomplete: true
+  description: Get the [[ACL]] with the given name. If need to get most of the ACL's, you should consider using [[aclList]] to get a table of them all.
+  oop:
+    element: ACL
+    method: get
+    static: true
+  parameters:
+    - name: aclName
+      type: string
+      description: The name to get the ACL belonging to.
+  returns:
+    values:
+      - type: acl|false
+        name: acl
+    description: Returns the [[ACL]] with that name if it could be retrieved, false/nil if the ACL does not exist or it fails for some other reason.
+  examples:
+    - path: examples/aclGet-1.lua
+      description: This example adds a command <code>setaclright</code> with which you can easily add new rights to specified access control lists.
+    - path: examples/aclGet_OOP-1.lua
+      description: This example adds a command <code>setaclright</code> with which you can easily add new rights to specified access control lists.
+      oop: true
+

functions/ACL/aclGetGroup.yaml

@@ -1,5 +1,27 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/aclGetGroup
 server:
   name: aclGetGroup
-  description: TODO
-  incomplete: true
+  description: This function is used to get the [[ACL]] group with the given name. If you need most of the groups you should consider using [[aclGroupList]] instead to get a [[table]] containing them all.
+  oop:
+    element: ACLGroup
+    method: get
+    static: true
+  parameters:
+    - name: groupName
+      type: string
+      description: The name to get the ACL group from.
+  returns:
+    values:
+      - type: aclgroup|false
+        name: acl group
+    description: Returns the [[aclgroup]] if it could be found. Returns false/nil if it did not exist or failed for some reason.
+  examples:
+    - path: examples/aclGetGroup-1.lua
+      description: This example makes every player able to use a command named <code>giveAccountAdminRights</code> that will add a specific accountname as an ACL object to the <code>Admin</code> group.
+    - path: examples/aclGetGroup_OOP-1.lua
+      description: This example makes every player able to use a command named <code>giveAccountAdminRights</code> that will add a specific accountname as an ACL object to the <code>Admin</code> group.
+      oop: true
+    - path: examples/aclGetGroup-2.lua
+      description: 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').
+    - path: examples/aclGetGroup_OOP-2.lua
+      description: 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').
+      oop: true

functions/ACL/aclGetName.yaml

@@ -1,5 +1,22 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/aclGetName
 server:
   name: aclGetName
-  description: TODO
-  incomplete: true
+  description: Get the name of given [[ACL]].
+  oop:
+    element: acl
+    method: getName
+    variable: name
+  parameters:
+    - name: theAcl
+      type: acl
+      description: The [[ACL]] to get the name of.
+  returns:
+    values:
+      - type: string|false
+        name: acl name
+    description: Returns the name of the given [[ACL]] as a string if successful. Returns false/nil if unsuccessful, ie the ACL is invalid.
+  examples:
+    - path: examples/aclGetName-1.lua
+      description: This example adds a command listacls which prints out a name list of all ACLs to the console.
+    - path: examples/aclGetName_OOP-1.lua
+      description: This example adds a command listacls which prints out a name list of all ACLs to the console.
+      oop: true

functions/ACL/aclGetRight.yaml

@@ -1,5 +1,25 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/aclGetRight
 server:
   name: aclGetRight
-  description: TODO
-  incomplete: true
+  pair: aclSetRight
+  description: This function returns whether the access for the given right is set to true or false in the [[ACL]].
+  oop:
+    element: acl
+    method: getRight
+  parameters:
+    - name: theAcl
+      type: acl
+      description: The [[ACL]] to get the right from.
+    - name: rightName
+      type: string
+      description: The right name to return the access value of.
+  returns:
+    values:
+      - type: bool
+        name: result
+    description: Returns true or false if the [[ACL]] gives access or not to the given function. Returns nil if it failed for some reason, e.g. an invalid ACL was specified or the right specified does not exist in the ACL.
+  examples:
+    - path: examples/aclGetRight-1.lua
+      description: This example lets players check if an ACL group has access to something or not.
+    - path: examples/aclGetRight_OOP-1.lua
+      description: This example lets players check if an ACL group has access to something or not.
+      oop: true

functions/ACL/aclGroupAddACL.yaml

@@ -1,5 +1,25 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/aclGroupAddACL
 server:
   name: aclGroupAddACL
-  description: TODO
-  incomplete: true
+  description: |
+    This function adds the given [[ACL]] to the given [ACL group](/reference/aclgroup). This makes the resources and players in the given ACL group have access to what's specified in the given ACL. The rights for something in the different ACL's in a group are OR-ed together, which means if one ACL gives access to something, this ACL group will have access to that.
+  oop:
+    element: aclgroup
+    method: addACL
+  parameters:
+    - name: theGroup
+      type: aclgroup
+      description: The group to add the [[ACL]] to.
+    - name: theAcl
+      type: acl
+      description: The [[ACL]] to add to the group.
+  returns:
+    values:
+      - type: bool
+        name: result
+    description: Returns true if the [[ACL]] could be successfully added to the [ACL group](/reference/aclgroup), false/nil if either of the elements are invalid, the ACL is already in that group or if something else goes wrong.
+  examples:
+    - path: examples/aclGroupAddACL-1.lua
+      description: This example adds a command <code>addAclGroup</code> with which you can easily add new access control lists to specified acl Groups.
+    - path: examples/aclGroupAddACL_OOP-1.lua
+      description: This example adds a command <code>addAclGroup</code> with which you can easily add new access control lists to specified acl Groups.
+      oop: true

functions/ACL/aclGroupAddObject.yaml

@@ -1,5 +1,26 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/aclGroupAddObject
 server:
   name: aclGroupAddObject
-  description: TODO
-  incomplete: true
+  description: |
+    This function adds an object to the given [ACL group](/reference/aclgroup). An object can be a player's account, specified as <code>user.<accountname></code>. Or a resource, specified as <code>resource.<resourcename></code>.
+    Objects are specified as strings. The ACL groups work for the user accounts and the resources that are specified in them.
+  oop:
+    element: aclgroup
+    method: addObject
+  parameters:
+    - name: theGroup
+      type: aclgroup
+      description: The group to add the object name string too.
+    - name: theObject
+      type: string
+      description: The object string to add to the given [[ACL]].
+  returns:
+    values:
+      - type: bool
+        name: result
+    description: Returns true if the object was successfully added to the [[ACL]], false if it already existed in the list.
+  examples:
+    - path: examples/aclGroupAddObject-1.lua
+      description: This example makes every player able to use a command named <code>giveAccountAdminRights</code> that will add a specific accountname as an ACL object to the <code>Admin</code> group.
+    - path: examples/aclGroupAddObject_OOP-1.lua
+      description: This example makes every player able to use a command named <code>giveAccountAdminRights</code> that will add a specific accountname as an ACL object to the <code>Admin</code> group.
+      oop: true