plugins/include/clients.inc
changeset 1813 372939c88bc7
parent 1621 ac5d4c68a99a
child 1831 af5c93c936d7
     1.1 --- a/plugins/include/clients.inc	Sat Dec 22 05:16:18 2007 +0000
     1.2 +++ b/plugins/include/clients.inc	Sat Dec 22 08:57:08 2007 +0000
     1.3 @@ -56,10 +56,15 @@
     1.4  forward bool:OnClientConnect(client, String:rejectmsg[], maxlen);
     1.5  
     1.6  /**
     1.7 - * Called when a client is entering to the game.
     1.8 + * Called when a client is entering the game.
     1.9   *
    1.10 - * @note Whether a client has a steamid is undefined until OnClientAuthorized
    1.11 + * Whether a client has a steamid is undefined until OnClientAuthorized
    1.12   * is called, which may occur either before or after OnClientPutInServer.
    1.13 + * Similarly, use OnClientPostAdminCheck() if you need to verify whether 
    1.14 + * connecting players are admins.
    1.15 + *
    1.16 + * GetClientCount() will include clients as they are passed through this 
    1.17 + * function, as clients are already in game at this point.
    1.18   *
    1.19   * @param client		Client index.
    1.20   * @noreturn
    1.21 @@ -100,9 +105,11 @@
    1.22  forward OnClientSettingsChanged(client);
    1.23  
    1.24  /**
    1.25 - * Called when a client receives a Steam ID.
    1.26 - 
    1.27 - * Admin properties are not assigned here, but on OnClientPostAdminCheck().
    1.28 + * Called when a client receives a Steam ID.  The state of a client's 
    1.29 + * authorization via Steam or as an admin is not guaranteed here.  
    1.30 + * Use OnClientAuthorized() or OnClientPostAdminCheck() for those, 
    1.31 + * respectively.
    1.32 + *
    1.33   * This is called by bots, but the ID will be "BOT".
    1.34   *
    1.35   * @param client		Client index.
    1.36 @@ -114,11 +121,16 @@
    1.37  /**
    1.38   * Called once a client is authorized and fully in-game, but 
    1.39   * before admin checks are done.  This can be used to override 
    1.40 - * the default admin checks for a client.
    1.41 + * the default admin checks for a client.  You should only use 
    1.42 + * this for overriding; use OnClientPostAdminCheck() instead 
    1.43 + * if you want notification.
    1.44   *
    1.45   * Note: If handled/blocked, PostAdminCheck must be signalled 
    1.46   * manually via NotifyPostAdminCheck().
    1.47   *
    1.48 + * This callback is gauranteed to occur on all clients, and always 
    1.49 + * after each OnClientPutInServer() call.
    1.50 + *
    1.51   * @param client		Client index.
    1.52   * @return				Plugin_Handled to block admin checks.
    1.53   */
    1.54 @@ -126,7 +138,10 @@
    1.55  
    1.56  /**
    1.57   * Called once a client is authorized and fully in-game, and 
    1.58 - * after all post-connection authorizations have been performed.
    1.59 + * after all post-connection authorizations have been performed.  
    1.60 + *
    1.61 + * This callback is gauranteed to occur on all clients, and always 
    1.62 + * after each OnClientPutInServer() call.
    1.63   *
    1.64   * @param client		Client index.
    1.65   * @noreturn