Quantcast

Updated PlayerManager and ChatManager documentation.

F16Gaming [10-24-11 - 01:13]
Updated PlayerManager and ChatManager documentation.
Filename
PlayerManager.lua
docs/files/ChatManager.html
docs/files/PlayerManager.html
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
 	</li>

 	<li>
-	  <code><em>Default</em></code>: Table containing default settings (used at initial setup)
+	  <code><em>Default</em></code>: Table containing default settings (used at initial setup)
+	</li>
+
+	<li>
+	  <code><em>LastChannel</em></code>: Last channel argument passed to HandleMessage.
+	</li>
+
+	<li>
+	  <code><em>LastTarget</em></code>: Last target argument passed to HandleMessage.
 	</li>

 </ul>
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 @@
 	</tr>

 	<tr>
-	<td class="name" nowrap><a href="#PM:Kick">PM:Kick</a>&nbsp;(player)</td>
+	<td class="name" nowrap><a href="#PM:Kick">PM:Kick</a>&nbsp;(player, sender)</td>
 	<td class="summary">Kick a player from the group.</td>
 	</tr>

@@ -548,7 +548,7 @@ Invite a player to group. Also sends a message to the invited player about the e

 <dt><a name="PM:IsBNFriend"></a><strong>PM:IsBNFriend</strong>&nbsp;(player)</dt>
 <dd>
-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.


 <h3>Parameters:</h3>
@@ -633,7 +633,7 @@ Check if the supplied player is in the player's guild.



-<dt><a name="PM:Kick"></a><strong>PM:Kick</strong>&nbsp;(player)</dt>
+<dt><a name="PM:Kick"></a><strong>PM:Kick</strong>&nbsp;(player, sender)</dt>
 <dd>
 Kick a player from the group.

@@ -645,6 +645,10 @@ Kick a player from the group.
 	  <code><em>player</em></code>: Player object of the player to kick.
 	</li>

+	<li>
+	  <code><em>sender</em></code>: Player object of the player who requested the kick.
+	</li>
+
 </ul>