GetPlayerPing

From Multi Theft Auto: Wiki
Revision as of 14:50, 19 August 2007 by Arc (talk | contribs)
Jump to navigation Jump to search

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

int getPlayerPing ( player thePlayer )

Required Arguments

  • thePlayer: The player whose ping you want to determine.

Returns

Returns the ping as an int, or false if the player is invalid.

Example

Click to collapse [-]
Server

This example checks the ping of every player joining and warns him if it's over 100. 

function checkPing()
	local ping = getPlayerPing(source)    -- get the ping from the source element (the player who joined)
	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
	end
end
addEventHandler("onPlayerJoin", getRootElement(), checkPing) -- add the event handler
Click to collapse [-]
Client

This example checks the ping of every player entering the 'ping' command and warns him if it's over 100. 

function checkPing()
        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...
                outputChatBox("Your ping is pretty high! Please try to lower it if possible.") -- output a message to the player
        end
end
addCommandHandler("ping", checkPing)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerPing?oldid=10700"