From 27440f7043ec361475cd2e9934514217ae877f94 Mon Sep 17 00:00:00 2001 From: F16Gaming Date: Mon, 24 Oct 2011 03:13:46 +0200 Subject: [PATCH] Updated PlayerManager and ChatManager documentation. --- PlayerManager.lua | 1 + docs/files/ChatManager.html | 10 +++++++++- docs/files/PlayerManager.html | 10 +++++++--- 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/PlayerManager.lua b/PlayerManager.lua index d76680a..76051cf 100644 --- a/PlayerManager.lua +++ b/PlayerManager.lua @@ -434,6 +434,7 @@ end --- Kick a player from the group. -- @param player Player object of the player to kick. +-- @param sender Player object of the player who requested the kick. -- @return String stating the result of the kick, false if error. -- @return Error message if unsuccessful, nil otherwise. -- diff --git a/docs/files/ChatManager.html b/docs/files/ChatManager.html index cfbf363..cc96f88 100644 --- a/docs/files/ChatManager.html +++ b/docs/files/ChatManager.html @@ -418,7 +418,15 @@ Send a chat message. Will echo the msg param locally if LOCAL_ONLY setting is tr
  • - Default: Table containing default settings (used at initial setup) + Default: Table containing default settings (used at initial setup) +
    • + +
  • + LastChannel: Last channel argument passed to HandleMessage. +
    • + +
  • + LastTarget: Last target argument passed to HandleMessage.
    • diff --git a/docs/files/PlayerManager.html b/docs/files/PlayerManager.html index 0ce81af..becc68a 100644 --- a/docs/files/PlayerManager.html +++ b/docs/files/PlayerManager.html @@ -167,7 +167,7 @@ - PM:Kick (player) + PM:Kick (player, sender) Kick a player from the group. @@ -548,7 +548,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. +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.

    Parameters:

    @@ -633,7 +633,7 @@ Check if the supplied player is in the player's guild. -
    PM:Kick (player)
    +
    PM:Kick (player, sender)
    Kick a player from the group. @@ -645,6 +645,10 @@ Kick a player from the group. player: Player object of the player to kick. +
  • + sender: Player object of the player who requested the kick. +
    • + -- 1.7.9.5