Player::kick

From RAGE Multiplayer Wiki
Server-Side

Description

Kicks a player from the server.


JavaScript Syntax

Syntax

player.kick(reason);

Parameters

  • reason: string

Example

mp.events.addCommand('kick', (player, target) => {
	let newTarget = mp.players.at(target);
	if(!target || isNaN(target)) return player.outputChatBox("Syntax: /kick [playerID]");
	if(newTarget === null) return player.outputChatBox("There is no player online with the ID given.")
	newTarget.outputChatBox("You have been kicked from the server.");
	newTarget.kick('Kicked.');
});


C# Syntax

Syntax

player.Kick(reason);

Parameters

  • reason: string (optional)

Example

[Command("kick")]
public void KickCommand(Player player, string targetName, string reason)
{
    Player targetPlayer = NAPI.Player.GetPlayerFromName(targetName);
    if (targetPlayer != null) target.Kick(reason);
}