BanEx

BanEx

Description:

Function BanEx ban a player with a reason.

As of SA-MP 0.3x, any action taken directly before BanEx() (such as sending a message with SendClientMessage) will not reach the player. A timer must be used to delay the ban.

Parameters:

(playerid, reason[])

int

playerid

The ID of the player to ban.

string

reason

The reason for the ban.

Return Values:

• 1: The function was executed successfully.
• 0: The function failed to execute. This means the player specified does not exist.

Examples:

Example 1

public OnPlayerCommandText( playerid, cmdtext[] )
{
    if(!strcmp(cmdtext, "/banme", true))
    {
        // Bans the player who executed this command and includes a reason ("Request")
        BanEx(playerid, "Request");
        return 1;
    }
}
// For example, this code would add this line to samp.ban:
// 127.0.0.1 [15/01/09 | 13:05:23] Name - Request

// The following code snippet shows a way of displaying a message for the player before they are banned:
/*In order to display a message (eg. reason) for the player before the connection is closed
you have to use a timer to create a delay. This delay needs only to be a few milliseconds long,
but this example uses a full second just to be on the safe side.*/
 
forward BanExPublic(playerid, reason[]);
 
public BanExPublic(playerid, reason[])
{
    BanEx(playerid, reason);
}
 
stock BanExWithMessage(playerid, color, message[], reason[])
{
    //reason - The ban reason to be used for BanEx.
    SendClientMessage(playerid, color, message);
    SetTimerEx("BanExPublic", 1000, false, "ds", playerid, reason);
}
 
public OnPlayerCommandText(playerid, cmdtext[])
{
    if(strcmp(cmdtext, "/banme", true) == 0)
    {
        //Bans the player who executed this command.
        BanExWithMessage(playerid, 0xFF0000FF, "You have been banned!", "Request");
        return 1;
    }
    return 0;
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.

• Ban: Ban a player from playing on the server.
• Kick: Kick a player from the server.