From 24b3f07bf0c0211f3309046c97f0271a02877e4d Mon Sep 17 00:00:00 2001 From: F16Gaming Date: Fri, 28 Oct 2011 18:47:37 +0200 Subject: [PATCH] Updated documentation. --- EventHandler.lua | 2 +- docs/files/EventHandler.html | 4 +- docs/files/PlayerManager.html | 177 ++++++++++++++++++++++++++++++++++++++++- 3 files changed, 176 insertions(+), 7 deletions(-) diff --git a/EventHandler.lua b/EventHandler.lua index 8fcfb81..5201060 100644 --- a/EventHandler.lua +++ b/EventHandler.lua @@ -21,7 +21,7 @@ local C = Command local CES = C.Extensions.String --- Handles events. --- @name Command:OnEvent +-- @name Command.OnEvent -- @param frame The frame on which the event was registered. -- @param event Full name of the event. -- @param ... Event arguments. diff --git a/docs/files/EventHandler.html b/docs/files/EventHandler.html index 63db675..f391e44 100644 --- a/docs/files/EventHandler.html +++ b/docs/files/EventHandler.html @@ -107,7 +107,7 @@ - + @@ -129,7 +129,7 @@ -
Command:OnEvent (frame, event, ...)
+
Command.OnEvent (frame, event, ...)
Handles events. diff --git a/docs/files/PlayerManager.html b/docs/files/PlayerManager.html index becc68a..5c2e553 100644 --- a/docs/files/PlayerManager.html +++ b/docs/files/PlayerManager.html @@ -137,6 +137,16 @@
+ + + + + + + + + + @@ -167,11 +177,21 @@ + + + + + + + + + + @@ -457,6 +477,88 @@ Get or create a player. +
PM:GroupAccess (group, command, allow)
+
+Modify the access of a command for a specific group. + + +

Parameters:

+ + + + + + + +

Return values:

+
    + +
  1. String stating the result, or false if error.
    2. + +
  2. Error message if unsuccessful, otherwise nil.
    3. + +
+ + + +
+ + + + +
PM:GroupAccessRemove (group, command)
+
+Completely remove a command from a group's access list. Removed from both the allow and deny list. + + +

Parameters:

+ + + + + + + +

Return values:

+
    + +
  1. String stating that the command has been removed or false if error.
    2. + +
  2. Error message is unsuccessful, otherwise nil.
    3. + +
+ + + +
+ + + +
PM:HasAccess (player, command)
Check if player has access to command. @@ -548,7 +650,7 @@ Invite a player to group. Also sends a message to the invited player about the e
PM:IsBNFriend (player)
-Check if supplied player is on the player's BN friends list. Note: If the BN friend is currently offline, this will return false regardless. Which means, disconnected BN friends can be kicked. +Check if supplied player is on the player's BN friends list. Note: If the BN friend is currently offline while his character is online, this will return false regardless. Which means, BN friends that are disconnected from Battle.Net but still in the group are treated as normal users.

Parameters:

@@ -633,6 +735,32 @@ Check if the supplied player is in the player's guild. +
PM:IsListed (command)
+
+Check if a certain command is on the blacklist/whitelist. + + +

Parameters:

+ + + + + + + + + +
+ + + +
PM:Kick (player, sender)
Kick a player from the group. @@ -672,6 +800,32 @@ Kick a player from the group. +
PM:List (command)
+
+Dynamically add or remove an item from the list. + + +

Parameters:

+ + + + + + + + + +
+ + + +
PM:ListAdd (command)
Add a command to the blacklist/whitelist. @@ -681,7 +835,7 @@ Add a command to the blacklist/whitelist. @@ -691,6 +845,9 @@ Add a command to the blacklist/whitelist. +

Return value:

+ +
@@ -707,7 +864,7 @@ Remove a command from the blacklist/whitelist. @@ -717,6 +874,9 @@ Remove a command from the blacklist/whitelist. +

Return value:

+ + @@ -797,7 +957,7 @@ Completely remove a command from a player's access list. Removes from both the a
  • - command: Name of command to remove. + command: Name of command to remove.
    • @@ -807,6 +967,15 @@ Completely remove a command from a player's access list. Removes from both the a +

    Return values:

    +
      + +
    1. String stating that the command has been removed or false if error.
      2. + +
    2. Error message is unsuccessful, otherwise nil.
      3. + +
    + -- 1.7.9.5
    Command:OnEvent (frame, event, ...)Command.OnEvent (frame, event, ...) Handles events.
    PM:GroupAccess (group, command, allow)Modify the access of a command for a specific group.
    PM:GroupAccessRemove (group, command)Completely remove a command from a group's access list.
    PM:HasAccess (player, command) Check if player has access to command.
    PM:IsListed (command)Check if a certain command is on the blacklist/whitelist.
    PM:Kick (player, sender) Kick a player from the group.
    PM:List (command)Dynamically add or remove an item from the list.
    PM:ListAdd (command) Add a command to the blacklist/whitelist.