Vice City Multiplayer - User contributions [en]

Scripting/Squirrel/Functions/GetMaxPlayers

2015-12-06T19:20:58Z

Skbyt:

This function will get max players limit.

== Syntax ==

<pre>GetMaxPlayers()</pre>

== Return value ==

* ''int'' '''maxplayers''' - The max players limit

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

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/GetMaxPlayers

2015-12-06T19:19:33Z

Skbyt:

This function will get max players limit.

== Syntax ==

<pre>GetMaxPlayers()</pre>

== Return value ==

* ''int'' '''maxplayers''' - The max players limit

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

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

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}

Scripting/Squirrel/Functions/Player.Kick

2015-12-06T18:47:24Z

Skbyt:

This function will kick Player defined.

== Syntax ==

<pre>player.Kick();</pre>

== Example ==

This example kicks player on move if the ping is >/= to 300.

<source lang="squirrel">
function onPlayerMove( player, x1, y1, z1, x2, y2, z2 )
{
if( player.Ping >= 300 )
ClientMessageToAll( player.Name + " has been kicked for high ping." , 255, 0, 0 );
player.Kick();
}
</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/ClientMessageToAll|ClientMessageToAll]] and event [[Scripting/Squirrel/Events/onPlayerMove|onPlayerMove]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Functions/Player Functions}}

Scripting/Squirrel/Functions/UnbanIP

2015-12-06T17:52:35Z

Skbyt: /* Example */

This function will unban an IP from the server.

== Syntax ==

<pre>UnbanIP( ip )</pre>

== Arguments ==

* ''string'' '''ip''' - The IP to be unbanned

== Example ==

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "unbanip" )
{
if ( !IsIPBanned( text ) == true ) MessagePlayer( "Provided IP '" + text + "' was not banned previously", player );
else
UnbanIP( text );
MessagePlayer( "IP: " + text + " has been unbanned", player );
}
}
</source>

=== Notes ===
Checks if [[Scripting/Squirrel/Functions/IsIPBanned|IsIPBanned]]( ..provided ip.. ), if returns true then triggers [[Scripting/Squirrel/Functions/UnbanIP|UnbanIP]]( ..provided ip.. ) when on event [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]].

== Related Functions ==

{{Scripting/Squirrel/Functions/Administrative_Functions}}