GetPlayerPing - Revision history

Arran Fortuna: Added clarification that VPN usage won't give incorrect ping (tested)

2021-09-15T13:31:48Z

Added clarification that VPN usage won't give incorrect ping (tested)

← Older revision		Revision as of 13:31, 15 September 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function returns the ping of a specified [[player]]. The ping is the number of milliseconds that data takes to travel from the player's client to the server or vice versa.		This function returns the ping of a specified [[player]]. The ping is the number of milliseconds that data takes to travel from the player's client to the server or vice versa. If a player is using a VPN their ping will still be returned correctly.

	==Syntax==		==Syntax==

XLive at 16:35, 3 August 2020

2020-08-03T16:35:37Z

← Older revision		Revision as of 16:35, 3 August 2020
Line 31:		Line 31:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function checkPing()		function checkPing()
	local ping = getPlayerPing(~~getLocalPlayer()~~) -- get the ping from the source element (the player who joined)		local ping = getPlayerPing(localPlayer) -- get the ping from the source element (the player who joined)
	if (ping > 100) then -- if it's higher than 100...		if (ping > 100) then -- if it's higher than 100...
	outputChatBox("Your ping is pretty high! Please try to lower it if possible.") -- output a message to the player		outputChatBox("Your ping is pretty high! Please try to lower it if possible.") -- output a message to the player

Dmitry7zip: Link to russian page

2015-01-01T14:32:50Z

Link to russian page

← Older revision		Revision as of 14:32, 1 January 2015
Line 42:		Line 42:
	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}

			[[ru:getPlayerPing]]

MarioKart: /* Syntax */ OOP syntax added

2014-07-15T05:22:03Z

Syntax: OOP syntax added

← Older revision		Revision as of 05:22, 15 July 2014
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">int getPlayerPing ( player thePlayer )</syntaxhighlight>		<syntaxhighlight lang="lua">int getPlayerPing ( player thePlayer )</syntaxhighlight>
			{{OOP\|\|[[player]]:getPing\|ping\|}}
	===Required Arguments===		===Required Arguments===
	*'''thePlayer''': The [[player]] whose ping you want to determine.		*'''thePlayer''': The [[player]] whose ping you want to determine.

Arran Fortuna: If you can't script stop editing examples...

2014-04-14T10:31:39Z

If you can't script stop editing examples...

← Older revision		Revision as of 10:31, 14 April 2014
Line 14:		Line 14:
	==Example==		==Example==
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	This example checks ~~thePlayer's~~ ping, and if it's over 500~~, kicks him/her~~.		This example checks every players ping every 5 seconds and if it's over 500 they get kicked.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function kickPing() -- Creates a function called kickPing		function kickPing() -- Creates a function called kickPing
	if (getPlayerPing(~~thePlayer~~) >= 500) then -- If ~~thePlayer's~~ ping is over 500		for i, player in ipairs(getElementsByType("player")) do -- Loop every player
	kickPlayer(~~thePlayer~~, "Ping over 500!") -- Kick them		if (getPlayerPing(player) >= 500) then -- If their ping is over 500
			kickPlayer(player, "Ping over 500!") -- Kick them
			end
	end		end
	end		end

NOki: /* Example */

2014-04-14T02:24:12Z

Example

← Older revision		Revision as of 02:24, 14 April 2014
Line 14:		Line 14:
	==Example==		==Example==
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	This example checks ~~the~~ ping ~~of every player joining~~ and ~~warns him~~ if it's over ~~100~~.		This example checks thePlayer's ping, and if it's over 500, kicks him/her.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~checkPing~~()		function kickPing() -- Creates a function called kickPing
	~~local ping = getPlayerPing(source)~~ -- ~~get the ping from the source element (the player who joined)~~		if (getPlayerPing(thePlayer) >= 500) then -- If thePlayer's ping is over 500
	if (~~ping~~ > ~~100~~) then -- ~~if it~~'s ~~higher than 100...~~		kickPlayer(thePlayer, "Ping over 500!") -- Kick them
	~~outputChatBox~~("~~Your ping is pretty high~~! ~~Please try to lower it if possible.~~"~~, source~~) -- ~~output a message to the player~~
	end		end
	end		end
	~~addEventHandler~~(~~"onPlayerJoin"~~, ~~getRootElement()~~, ~~checkPing~~) -- ~~add~~ the ~~event handler~~		setTimer(kickPing, 5000, 0) -- Every 5 seconds, the kickPing function is called.
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Arc at 14:50, 19 August 2007

2007-08-19T14:50:17Z

← Older revision		Revision as of 14:50, 19 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function returns the ping of a specified [[player]]. The ping is the number of milliseconds that data takes to travel from the player's client to the server or ~~the reverse~~.		This function returns the ping of a specified [[player]]. The ping is the number of milliseconds that data takes to travel from the player's client to the server or vice versa.

	==Syntax==		==Syntax==
Line 10:		Line 10:

	===Returns===		===Returns===
	Returns an ''int~~'' with the ping~~, or ''false'' if the player is invalid.		Returns the ping as an [[int]], or ''false'' if the player is invalid.

	==Example==		==Example==
			<section name="Server" class="server" show="true">
	This example checks the ping of every player joining and warns him if it's over 100.		This example checks the ping of every player joining and warns him if it's over 100.
	~~<section name="Server" class="server" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function checkPing()		function checkPing()
	local ping = getPlayerPing(source) -- get the ping from the source element (the player who joined)		local ping = getPlayerPing(source) -- get the ping from the source element (the player who joined)
	if (ping > 100) then -- if ~~its~~ higher than 100..		if (ping > 100) then -- if it's higher than 100...
	outputChatBox("Your ping is pretty high! Please try to lower it if possible.",source) -- output a message to the player		outputChatBox("Your ping is pretty high! Please try to lower it if possible.", source) -- output a message to the player
	end		end
	end		end
	addEventHandler("onPlayerJoin",getRootElement(),checkPing) -- add the event handler		addEventHandler("onPlayerJoin", getRootElement(), checkPing) -- add the event handler
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

			<section name="Client" class="client" show="true">
	This example checks the ping of every player entering the 'ping' command and warns him if it's over 100.		This example checks the ping of every player entering the 'ping' command and warns him if it's over 100.
	~~<section name="Client" class="client">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function checkPing()		function checkPing()
			local ping = getPlayerPing(getLocalPlayer()) -- get the ping from the source element (the player who joined)
	local ping = getPlayerPing(getLocalPlayer()) -- get the ping from the source element (the player who joined)		if (ping > 100) then -- if it's higher than 100...
	if (ping > 100) then -- if ~~its~~ higher than 100..
	outputChatBox("Your ping is pretty high! Please try to lower it if possible.") -- output a message to the player		outputChatBox("Your ping is pretty high! Please try to lower it if possible.") -- output a message to the player
	end		end
	end		end
	addCommandHandler("ping",checkPing)		addCommandHandler("ping", checkPing)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Driver2 at 11:51, 7 August 2007

2007-08-07T11:51:57Z

@@ Line 14: / Line 14: @@
 ==Example==
 This example checks the ping of every player joining and warns him if it's over 100.
 <syntaxhighlight lang="lua">
 function checkPing()
@@ Line 23: / Line 24: @@
 addEventHandler("onPlayerJoin",getRootElement(),checkPing) -- add the event handler
 </syntaxhighlight>
 ==See Also==
 {{Player functions}}

Driver2 at 11:32, 7 August 2007

2007-08-07T11:32:00Z

← Older revision		Revision as of 11:32, 7 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server client function}}
	This function returns the ping of a specified [[player]]. The ping is the number of milliseconds that data takes to travel from the player's client to the server or the reverse.		This function returns the ping of a specified [[player]]. The ping is the number of milliseconds that data takes to travel from the player's client to the server or the reverse.

Driver2 at 13:35, 27 July 2007

2007-07-27T13:35:38Z

← Older revision		Revision as of 13:35, 27 July 2007
Line 7:		Line 7:
	===Required Arguments===		===Required Arguments===
	*'''thePlayer''': The [[player]] whose ping you want to determine.		*'''thePlayer''': The [[player]] whose ping you want to determine.

			===Returns===
			Returns an ''int'' with the ping, or ''false'' if the player is invalid.

	==Example==		==Example==
	<syntaxhighlight lang="lua">~~intPing~~ = getPlayerPing ( ~~findPlayer~~ ( ~~"Someguy"~~ ) )		This example checks the ping of every player joining and warns him if it's over 100.
	outputChatBox ( "~~Someguy's~~ ping is " ~~.. intPing ..~~ "." )</syntaxhighlight>		<syntaxhighlight lang="lua">
			function checkPing()
			local ping = getPlayerPing(source) -- get the ping from the source element (the player who joined)
			if (ping > 100) then -- if its higher than 100..
			outputChatBox("Your ping is pretty high! Please try to lower it if possible.",source) -- output a message to the player
			end
			end
			addEventHandler("onPlayerJoin",getRootElement(),checkPing) -- add the event handler
			</syntaxhighlight>

	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}