Skip to content

Commit 8cdf36e

Browse files
committed
Minor fixes
- Examples errors - Formatting for lua codes - Typos
1 parent 4a2f71e commit 8cdf36e

File tree

170 files changed

+795
-804
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

170 files changed

+795
-804
lines changed

functions/ACL/aclCreate.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ server:
1212
values:
1313
- type: acl|false
1414
name: acl object
15-
description: Returns the created [[ACL]] object if successful. Returns false if an ACL of the given name could not be created.
15+
description: Returns the created [[ACL]] object if successful. Returns **false** if an ACL of the given name could not be created.
1616
examples:
1717
- path: examples/aclCreate-1.lua
1818
description: This example adds a command <code>setaclright</code> with which you can easily add new rights to specified access control lists.

functions/ACL/aclCreateGroup.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ server:
1212
values:
1313
- type: aclgroup|false
1414
name: acl group
15-
description: Returns the pointer to the created aclgroup if successful. Returns false if failed.
15+
description: Returns the created [[aclgroup]] if successful. Returns **false** if failed.
1616
examples:
1717
- path: examples/aclCreateGroup-1.lua
1818
description: This example adds a command <code>addobjecttogroup</code> with which you can easily add new objects to specified access control list groups.

functions/ACL/aclDestroy.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ server:
1212
values:
1313
- type: bool
1414
name: resullt
15-
description: Returns true if successfully destroyed and false if it could not be deleted (ie. it's not valid).
15+
description: Returns **true** if successfully destroyed and **false** if it could not be deleted (ie. it's not valid).
1616
examples:
1717
- path: examples/aclDestroy-1.lua
1818
description: This example shows you a command to delete an ACL.

functions/ACL/aclDestroyGroup.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ server:
1212
values:
1313
- type: bool
1414
name: result
15-
description: Returns true if the ACL group was successfully deleted, false if it could not be deleted for some reason (ie. invalid argument).
15+
description: Returns **true** if the ACL group was successfully deleted, **false** if it could not be deleted for some reason (ie. invalid argument).
1616
examples:
1717
- path: examples/aclDestroyGroup-1.lua
1818
description: This example allows admins to remove an ACL group they specify.

functions/ACL/aclGet.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ server:
1313
values:
1414
- type: acl|false
1515
name: acl
16-
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.
16+
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.
1717
examples:
1818
- path: examples/aclGet-1.lua
1919
description: This example adds a command <code>setaclright</code> with which you can easily add new rights to specified access control lists.

functions/ACL/aclGetGroup.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ server:
1313
values:
1414
- type: aclgroup|false
1515
name: acl group
16-
description: Returns the [[aclgroup]] if it could be found. Returns false/nil if it did not exist or failed for some reason.
16+
description: Returns the [[aclgroup]] if it could be found. Returns **false/nil** if it did not exist or failed for some reason.
1717
examples:
1818
- path: examples/aclGetGroup-1.lua
1919
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.

functions/ACL/aclGetName.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ server:
1313
values:
1414
- type: string|false
1515
name: acl name
16-
description: Returns the name of the given [[ACL]] as a string if successful. Returns false/nil if unsuccessful, ie the ACL is invalid.
16+
description: Returns the name of the given [[ACL]] as a [[string]] if successful. Returns **false/nil** if unsuccessful, ie the ACL is invalid.
1717
examples:
1818
- path: examples/aclGetName-1.lua
19-
description: This example adds a command listacls which prints out a name list of all ACLs to the console.
19+
description: This example adds a command <code>listacls</code> which prints out a name list of all ACLs to the console.
2020
- path: examples/aclGetName_OOP-1.lua
21-
description: This example adds a command listacls which prints out a name list of all ACLs to the console.
21+
description: This example adds a command <code>listacls</code> which prints out a name list of all ACLs to the console.
2222
oop: true

functions/ACL/aclGetRight.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ server:
1616
values:
1717
- type: bool
1818
name: result
19-
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.
19+
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.
2020
examples:
2121
- path: examples/aclGetRight-1.lua
2222
description: This example lets players check if an ACL group has access to something or not.

functions/ACL/aclGroupAddACL.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ server:
1616
values:
1717
- type: bool
1818
name: result
19-
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.
19+
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.
2020
examples:
2121
- path: examples/aclGroupAddACL-1.lua
2222
description: This example adds a command <code>addAclGroup</code> with which you can easily add new access control lists to specified acl Groups.

functions/ACL/aclGroupAddObject.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ server:
1717
values:
1818
- type: bool
1919
name: result
20-
description: Returns true if the object was successfully added to the [[ACL]], false if it already existed in the list.
20+
description: Returns **true** if the object was successfully added to the [[ACL]], **false** if it already existed in the list.
2121
examples:
2222
- path: examples/aclGroupAddObject-1.lua
2323
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.

0 commit comments

Comments
 (0)