Updated PlayerManager documentation.
F16Gaming [10-23-11 - 23:47]
Updated PlayerManager documentation.
diff --git a/docs/files/PlayerManager.html b/docs/files/PlayerManager.html
index aa616cc..c027297 100644
--- a/docs/files/PlayerManager.html
+++ b/docs/files/PlayerManager.html
@@ -107,11 +107,21 @@
<table class="function_list">
<tr>
+ <td class="name" nowrap><a href="#PM:AllowInvites">PM:AllowInvites</a> (player)</td>
+ <td class="summary">Allow sending Command invites to player.</td>
+ </tr>
+
+ <tr>
<td class="name" nowrap><a href="#PM:BanUser">PM:BanUser</a> (player)</td>
<td class="summary">Ban player.</td>
</tr>
<tr>
+ <td class="name" nowrap><a href="#PM:DenyInvites">PM:DenyInvites</a> (player)</td>
+ <td class="summary">Stop sending Command invites to player.</td>
+ </tr>
+
+ <tr>
<td class="name" nowrap><a href="#PM:GetAccess">PM:GetAccess</a> (player)</td>
<td class="summary">Get the current access level of supplied player.</td>
</tr>
@@ -137,7 +147,7 @@
</tr>
<tr>
- <td class="name" nowrap><a href="#PM:Invite">PM:Invite</a> (player, isSelf)</td>
+ <td class="name" nowrap><a href="#PM:Invite">PM:Invite</a> (player, sender)</td>
<td class="summary">Invite a player to group.</td>
</tr>
@@ -264,6 +274,41 @@
+<dt><a name="PM:AllowInvites"></a><strong>PM:AllowInvites</strong> (player)</dt>
+<dd>
+Allow sending Command invites to player.
+
+
+<h3>Parameters:</h3>
+<ul>
+
+ <li>
+ <code><em>player</em></code>: Player object of the player.
+ </li>
+
+</ul>
+
+
+
+
+
+
+<h3>Return values:</h3>
+<ol>
+
+ <li>String stating the result of the operation, false if error.</li>
+
+ <li>Error message if unsuccessful, nil otherwise. </li>
+
+</ol>
+
+
+
+</dd>
+
+
+
+
<dt><a name="PM:BanUser"></a><strong>PM:BanUser</strong> (player)</dt>
<dd>
Ban player. What this really does is set the access level to "Banned", effectively blocking the player from using any commands. Unless there is a command that requires access level "Banned". (Could be used for appeal commands).
@@ -299,6 +344,41 @@ Ban player. What this really does is set the access level to "Banned", effective
+<dt><a name="PM:DenyInvites"></a><strong>PM:DenyInvites</strong> (player)</dt>
+<dd>
+Stop sending Command invites to player.
+
+
+<h3>Parameters:</h3>
+<ul>
+
+ <li>
+ <code><em>player</em></code>: Player object of the player.
+ </li>
+
+</ul>
+
+
+
+
+
+
+<h3>Return values:</h3>
+<ol>
+
+ <li>String stating the result of the operation, false if error.</li>
+
+ <li>Error message if unsuccessful, nil otherwise. </li>
+
+</ol>
+
+
+
+</dd>
+
+
+
+
<dt><a name="PM:GetAccess"></a><strong>PM:GetAccess</strong> (player)</dt>
<dd>
Get the current access level of supplied player.
@@ -424,7 +504,7 @@ Initialize the player manager.
-<dt><a name="PM:Invite"></a><strong>PM:Invite</strong> (player, isSelf)</dt>
+<dt><a name="PM:Invite"></a><strong>PM:Invite</strong> (player, sender)</dt>
<dd>
Invite a player to group. Also sends a message to the invited player about the event.
@@ -437,7 +517,7 @@ Invite a player to group. Also sends a message to the invited player about the e
</li>
<li>
- <code><em>isSelf</em></code>: True if player is inviting themselves, nil or false otherwise.
+ <code><em>sender</em></code>: Player object of the inviting player.
</li>
</ul>