Scripting/Squirrel/Functions/BanPlayer: 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
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This function bans any specified player.
== Syntax ==
== Syntax ==


<pre>BanPlayer( player )</pre>
<pre>BanPlayer( player )</pre>
== Example ==
== Example ==
The following example send a personal message saying '''Hey you, have fun here'''!:
 
<source lang=squirrel>
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "ban" )
if ( cmd == "ban" )
{
{
Line 13: Line 17:
             {
             {
      local plr = FindPlayer( text );
      local plr = FindPlayer( text );
              if ( plr )
              {
               BanPlayer( plr );
               BanPlayer( plr );
              }
              else MessagePlayer( "[#ffffff]Invalid Player " , player );
             }
             }
        else MessagePlayer( "[#ffffff]Type /ban <player> " , player );
        else MessagePlayer( "[#ffffff]Type /ban <player> " , player );
Line 19: Line 27:
    else MessagePlayer( "[#F02F0F] Your are not admin. " , player )
    else MessagePlayer( "[#F02F0F] Your are not admin. " , player )
}
}
}
</source>
</source>


=== Notes ===
=== Notes ===
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
== Related Functions ==
{{Scripting/Squirrel/Functions/Player Functions}}
[[Category:Scripting/Squirrel/Functions/Player_Functions]]

Latest revision as of 18:41, 30 January 2017

This function bans any specified player.

Syntax

BanPlayer( player )

Example

function onPlayerCommand( player, cmd, text )
{
if ( cmd == "ban" )
	{
	    if ( player.Name == "Your Name" )
	    {
	        if ( text )
            {
	       local plr = FindPlayer( text );
               if ( plr )
               {
               BanPlayer( plr );
               }
               else MessagePlayer( "[#ffffff]Invalid Player " , player );
            }
	        else MessagePlayer( "[#ffffff]Type /ban <player> " , player );
	    }
	    else MessagePlayer( "[#F02F0F] Your are not admin. " , player )
	}
}

Notes

Call onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Functions

Player Game Functions

These functions exist for compatibility with the R2 Squirrel server.