Scripting/Squirrel/Functions/GetMaxPlayers

From Vice City Multiplayer
Revision as of 19:13, 30 January 2017 by Thijn (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing

This function will get max players limit.

Syntax

GetMaxPlayers()

Return value

  • int maxplayers - The max players limit

Example

The following example will return maxPlayers allotted for the server on command "maxplayers".

function onPlayerCommand( player, cmd, parameters );
{
     if( cmd == "maxslots" )  
     local maxSlots = GetMaxPlayers();
     MessagePlayer( "Max Slots: " + maxSlots, player );
}

Notes

Event onPlayerCommand and Function MessagePlayer were used in this example. More info about them in the corresponding pages.

Related Functions