GetPlayerPing: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 14: Line 14:
==Example==
==Example==
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()
Line 23: Line 24:
addEventHandler("onPlayerJoin",getRootElement(),checkPing) -- add the event handler
addEventHandler("onPlayerJoin",getRootElement(),checkPing) -- add the event handler
</syntaxhighlight>
</syntaxhighlight>
</section>
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">
function checkPing()
        local ping = getPlayerPing(getLocalPlayer()) -- 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.") -- output a message to the player
        end
end
addCommandHandler("ping",checkPing)
</syntaxhighlight>
</section>


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

Revision as of 11:51, 7 August 2007

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.

Syntax

int getPlayerPing ( player thePlayer )

Required Arguments

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

Returns

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

Example

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

Click to collapse [-]
Server
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

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

Click to expand [+]
Client

See Also


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