Player::kick - Revision history

Xabi at 13:05, 13 October 2022

2022-10-13T13:05:47Z

← Older revision		Revision as of 13:05, 13 October 2022
Line 34:		Line 34:
	<pre>		<pre>
	[Command("kick")]		[Command("kick")]
	public void KickCommand(Player player, string reason)		public void KickCommand(Player player, string targetName, string reason)
	{		{
	~~player~~.Kick(reason);		Player targetPlayer = NAPI.Player.GetPlayerFromName(targetName);
			if (targetPlayer != null) target.Kick(reason);
	}		}
	</pre>		</pre>

2022-10-13T13:01:31Z

← Older revision		Revision as of 13:01, 13 October 2022
Line 1:		Line 1:
			{{ServersideCode\|}}
			==Description==
	Kicks a player from the server.		Kicks a player from the server.

	== Syntax ==
			{{JSContainer\|
			==Syntax==
	<pre>		<pre>
	player.kick(reason);		player.kick(reason);
	</pre>		</pre>
			{{Parameters}}
	~~===~~ Parameters ~~===~~		*'''reason:''' string
	*'''reason'''~~: {{RageType\|String}} (This message does not show up for the player being kicked)~~

	== ~~Examples~~ ==		==Example==
	~~{{ServersideCode\|~~
	<pre>		<pre>
	mp.events.addCommand('kick', (player, target) => {		mp.events.addCommand('kick', (player, target) => {
Line 21:		Line 23:
	</pre>		</pre>
	}}		}}
			{{CSharpContainer\|
			==Syntax==
			<pre>
			player.Kick(reason);
			</pre>
			{{Parameters}}
			*'''reason:''' string (optional)

	==~~See Also~~==		==Example==
	{~~{Player_block~~}}		<pre>
			[Command("kick")]
			public void KickCommand(Player player, string reason)
			{
			player.Kick(reason);
			}
			</pre>
			}}

	[[Category:~~Player~~ API]]		[[Category:Entity API]]
	~~[[Category:Server-side Function~~]]

2019-05-17T17:00:25Z

2019-04-30T12:48:22Z

2018-10-26T11:15:15Z

Replaced HTML with template

← Older revision		Revision as of 11:15, 26 October 2018
Line 11:		Line 11:

	== Examples ==		== Examples ==
	~~<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">~~		{{ServersideCode\|
	~~<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>~~
	<pre>		<pre>
	mp.events.addCommand('kick', (player, target) => {		mp.events.addCommand('kick', (player, target) => {
Line 22:		Line 21:
	});		});
	</pre>		</pre>
	~~</div>~~		}}

	==See Also==		==See Also==
	{{Player_block}}		{{Player_block}}

2018-09-29T12:42:36Z

Cleaned up, added an example.

← Older revision		Revision as of 12:42, 29 September 2018
Line 1:		Line 1:
	~~This function kicks~~ a player.		__NOTOC__
			Kicks a player from the server.

	==Syntax==		== Syntax ==
	<~~syntaxhighlight lang~~="~~javascript~~">		<pre>
	player.kick(~~String reason~~);		player.kick(reason);
	</~~syntaxhighlight~~>		</pre>

			=== Parameters ===
			*'''reason''': {{RageType\|String}} (This message does not show up for the player being kicked)

			== Examples ==
			<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
			<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
			<pre>
			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>
			</div>

	==See Also==		==See Also==
	{{Player_block}}		{{Player_block}}

2017-04-17T13:41:06Z

2017-01-04T16:32:58Z

@@ Line 4: / Line 4: @@
 <syntaxhighlight lang="javascript">
 player.kick(String reason);
 </syntaxhighlight>

2017-01-04T16:31:56Z

Syntax

← Older revision		Revision as of 16:31, 4 January 2017
Line 4:		Line 4:
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	player.kick(String reason);		player.kick(String reason);
	</syntaxhighlight>		</syntaxhighlight>

	==Example==		==Example==

2017-01-04T16:31:17Z

← Older revision		Revision as of 16:31, 4 January 2017
Line 3:		Line 3:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	player.kick(~~string~~ reason);		player.kick(String reason);
	</syntaxhighlight>		</syntaxhighlight>

← Older revision		Revision as of 17:00, 17 May 2019
Line 1:		Line 1:
	~~__NOTOC__~~
	Kicks a player from the server.		Kicks a player from the server.

Line 26:		Line 25:
	{{Player_block}}		{{Player_block}}

	[[Category:Player]]		[[Category:Player API]]
	[[Category:Server-side Function]]		[[Category:Server-side Function]]

← Older revision		Revision as of 12:48, 30 April 2019
Line 25:		Line 25:
	==See Also==		==See Also==
	{{Player_block}}		{{Player_block}}

			[[Category:Player]]
			[[Category:Server-side Function]]