Latest revision as of 13:05, 13 October 2022

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);
}

@@ Line 1: / Line 1: @@
-This function kicks a player.
+{{ServersideCode|}}
+==Description==
+Kicks a player from the server.
+{{JSContainer|
 ==Syntax==
-<syntaxhighlight lang="javascript">
+<pre>
-player.kick(String reason);
+player.kick(reason);
-</syntaxhighlight>
+</pre>
+{{Parameters}}
+*'''reason:''' string
 ==Example==
-<syntaxhighlight lang="javascript">
+<pre>
-mp.events.add(
+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.');
+});
+</pre>
+}}
+{{CSharpContainer|
+==Syntax==
+<pre>
+player.Kick(reason);
+</pre>
+{{Parameters}}
+*'''reason:''' string (optional)
+==Example==
+<pre>
+[Command("kick")]
+public void KickCommand(Player player, string targetName, string reason)
 {
-     "playerDeath" : (player, reason, killer) =>
+     Player targetPlayer = NAPI.Player.GetPlayerFromName(targetName);
-     {
+     if (targetPlayer != null) target.Kick(reason);
-        if(killer)
+}
-            killer.kick("hack1!11");
+</pre>
-    }
+}}
-});
-</syntaxhighlight>
+[[Category:Entity API]]