GetPlayerPing: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetPlayerPing(player)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{FuncReturnValue|__E..."
 
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Get the ping of the specified player.}}


{{FuncSyntax|GetPlayerPing(player)}}
{{FuncSyntax|GetPlayerPing(playerid)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|playerid|The player identifier.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns the player ping in integer.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
CreateTimer(function()
local ping = 400
for k, v in ipairs(GetAllPlayers()) do
if GetPlayerPing(v) > ping then
KickPlayer(v, "You were kicked for high ping.")
end
end
end, 10000)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{ServerPlayerFunctions}}

Latest revision as of 20:42, 27 May 2021

GetPlayerPing

Type: Function
Context: Server
Introduced: v1.0

Description

Get the ping of the specified player.

Syntax

GetPlayerPing(playerid)

Parameters

  • playerid
    The player identifier.

Return Value

  • Returns the player ping in integer.

Example

CreateTimer(function()
	local ping = 400
	for k, v in ipairs(GetAllPlayers()) do
		if GetPlayerPing(v) > ping then
			KickPlayer(v, "You were kicked for high ping.")
		end
	end
end, 10000)

See also

Retrieved from "https://dev.playonset.com/index.php?title=GetPlayerPing&oldid=4779"