From 64e399c49d2af12d5fc3c8af311bde8abcdbd8e0 Mon Sep 17 00:00:00 2001 From: F16Gaming Date: Mon, 24 Oct 2011 01:47:15 +0200 Subject: [PATCH] Updated PlayerManager documentation. --- docs/files/PlayerManager.html | 86 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 83 insertions(+), 3 deletions(-) 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 @@ + + + + + + + + + + @@ -137,7 +147,7 @@ - + @@ -264,6 +274,41 @@ +
PM:AllowInvites (player)
+
+Allow sending Command invites to player. + + +

Parameters:

+ + + + + + + +

Return values:

+
    + +
  1. String stating the result of the operation, false if error.
  2. + +
  3. Error message if unsuccessful, nil otherwise.
  4. + +
+ + + +
+ + + +
PM:BanUser (player)
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 +
PM:DenyInvites (player)
+
+Stop sending Command invites to player. + + +

Parameters:

+ + + + + + + +

Return values:

+
    + +
  1. String stating the result of the operation, false if error.
  2. + +
  3. Error message if unsuccessful, nil otherwise.
  4. + +
+ + + +
+ + + +
PM:GetAccess (player)
Get the current access level of supplied player. @@ -424,7 +504,7 @@ Initialize the player manager. -
PM:Invite (player, isSelf)
+
PM:Invite (player, sender)
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
  • - isSelf: True if player is inviting themselves, nil or false otherwise. + sender: Player object of the inviting player.
  • -- 1.7.9.5
    PM:AllowInvites (player)Allow sending Command invites to player.
    PM:BanUser (player) Ban player.
    PM:DenyInvites (player)Stop sending Command invites to player.
    PM:GetAccess (player) Get the current access level of supplied player.
    PM:Invite (player, isSelf)PM:Invite (player, sender) Invite a player to group.