Scripting/Squirrel/Functions/GetMaxPlayers: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
(Created page with "This function will get max players limit. == Syntax == <pre>GetMaxPlayers()</pre> == Arguments == '''N/A''' == Return value == * ''int'' '''maxplayers''' - The max playe...")
 
No edit summary
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This function will get max players limit.
This function will get max players limit.


Line 4: Line 5:


<pre>GetMaxPlayers()</pre>
<pre>GetMaxPlayers()</pre>
== Arguments ==
'''N/A'''


== Return value ==
== Return value ==
Line 14: Line 11:


== Example ==
== Example ==
 
The following example will return maxPlayers allotted for the server on command "maxplayers".
{{Scripting/Needs_Example}}
<source lang=squirrel>
function onPlayerCommand( player, cmd, parameters );
{
    if( cmd == "maxslots" ) 
    local maxSlots = GetMaxPlayers();
    MessagePlayer( "Max Slots: " + maxSlots, player );
}
</source>


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


== Related Functions ==
== Related Functions ==


{{Scripting/Squirrel/Functions/Server_Settings}}
{{Scripting/Squirrel/Functions/Server Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Latest revision as of 19:13, 30 January 2017

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

Retrieved from "http://wiki.vc-mp.org/index.php?title=Scripting/Squirrel/Functions/GetMaxPlayers&oldid=19770"