plugins/include/clients.inc
changeset 3696 9588d737efe0
parent 3418 b0e93f5101ef
child 3808 b5f4ea4d3736
     1.1 --- a/plugins/include/clients.inc	Sat Dec 01 13:41:00 2012 -0500
     1.2 +++ b/plugins/include/clients.inc	Sun Dec 02 11:03:27 2012 -0500
     1.3 @@ -210,6 +210,21 @@
     1.4  native GetMaxClients();
     1.5  
     1.6  /**
     1.7 + * Returns the maximum number of human players allowed on the server.  This is 
     1.8 + * a game-specific function used on newer games to limit the number of humans
     1.9 + * that can join a game and can be lower than MaxClients. It is the number often
    1.10 + * reflected in the server browser or when viewing the output of the status command.
    1.11 + * On unsupported games or modes without overrides, it will return the same value
    1.12 + * as MaxClients.
    1.13 + *
    1.14 + * You should not globally cache the value to GetMaxHumanPlayers() because it can change across
    1.15 + * game modes. You may still cache it locally.
    1.16 + *
    1.17 + * @return				Maximum number of humans allowed.
    1.18 + */
    1.19 +native GetMaxHumanPlayers();
    1.20 +
    1.21 +/**
    1.22   * Returns the client count put in the server.
    1.23   *
    1.24   * @param inGameOnly	If false connecting players are also counted.