Scripting/Squirrel/Functions/Player.Ping: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
No edit summary
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Scripting/Needs_Text}}
Use this function to get a player's ping. '''(Read only)'''


== Syntax ==
== Syntax ==


<pre>player.Ping</pre>
<pre>int player.Ping
</pre>
 
== Example ==
== Example ==
<source lang=squirrel>
<source lang=squirrel>
function OnPlayerCommand( player , cmd , text )
function OnPlayerCommand(player, cmd, text)
    if ( cmd == "ping" )
{
    if ( cmd == "ping" )
     {
     {
    MessagePlayer( " Your Ping: " + player.Ping , player );
        MessagePlayer("Your Ping: " + player.Ping, player);
     }
     }
}
</source>
</source>


=== Notes ===
=== Notes ===
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
== Related Functions ==
{{Scripting/Squirrel/Functions/Player_Functions}}
[[Category:Scripting/Squirrel/Functions/Player_Functions]]

Latest revision as of 18:50, 30 January 2017

Use this function to get a player's ping. (Read only)

Syntax

int player.Ping

Example

function OnPlayerCommand(player, cmd, text)
{
    if ( cmd == "ping" )
    {
        MessagePlayer("Your Ping: " + player.Ping, player);
    }
}

Notes

Call onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Functions

Player Game Functions

These functions exist for compatibility with the R2 Squirrel server.