Scripting/Squirrel/Functions/BanIP: 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
 
(7 intermediate revisions by 5 users not shown)
Line 2: Line 2:


== Syntax ==
== Syntax ==
 
<pre>BanIP(ip)</pre>
<pre>BanIP( ip )</pre>


== Arguments ==
== Arguments ==
* ''string'' '''ip''' - This is the IP address to be banned
* ''string'' '''ip''' - This is the IP address to be banned


== Example ==
== Example ==
<source lang=squirrel>
<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
function onPlayerCommand(player, cmd, text){
{
  if (cmd == "ban") {
    if ( cmd == "banip" )
     if (text) {
     {
      local params = split(text, " ");
         BanIP( text );
      local plr = FindPlayer(params[0]);
         MessagePlayer( "You have banned IP: " + text, player );
      if (plr != null) {
         if (params.len() >= 2) {
          local reason = params[1];
        } else {
          reason = "None";
        }
        Message("[#EE82EE]** Admin " + player.Name + " Banned " + plr.Name + " Reason: " + reason);
         MessagePlayer("You have been banned by: " + player.Name + ". Reason: " + reason, plr);
        BanIP(plr.IP);
        return 1;
      } else {
        MessagePlayer("[Error] - Player " + params[0] + " not found!", player);
        return 1;
      }
     }
     }
    MessagePlayer("[Syntax] - /ban <Nick/ID> <Reason>", player);
  }
  return 1;
}
}
</source>
</source>


=== Notes ===
=== Notes ===
 
Call [[onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] and function [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] were used in this example. More info about them in the corresponding pages.
 


== Related Functions ==
== Related Functions ==
{{Scripting/Squirrel/Functions/Administrative_Functions}}
{{Scripting/Squirrel/Functions/Administrative_Functions}}
[[Category:Scripting/Squirrel/Functions/Administrative_Functions]]

Latest revision as of 06:06, 2 May 2019

This function will ban an IP from the server.

Syntax

BanIP(ip)

Arguments

  • string ip - This is the IP address to be banned

Example

function onPlayerCommand(player, cmd, text){
  if (cmd == "ban") {
    if (text) {
      local params = split(text, " ");
      local plr = FindPlayer(params[0]);
      if (plr != null) {
        if (params.len() >= 2) {
          local reason = params[1];
        } else {
          reason = "None";
        }
        Message("[#EE82EE]** Admin " + player.Name + " Banned " + plr.Name + " Reason: " + reason);
        MessagePlayer("You have been banned by: " + player.Name + ". Reason: " + reason, plr);
        BanIP(plr.IP);
        return 1;
      } else {
        MessagePlayer("[Error] - Player " + params[0] + " not found!", player);
        return 1;
      }
    }
    MessagePlayer("[Syntax] - /ban <Nick/ID> <Reason>", player);
  }
  return 1;
}

Notes

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

Related Functions