Difference between revisions of "ClientObject:setPing"

(Created page with 'Connect to a server. == Function == === Synopsis === <source lang="lua"> clientobject:init( sockettype ) </source> === Arguments === {{param|SocketType|string|"tcp", "udp" or use…')
 
(Correcting the description)
 
Line 1: Line 1:
Connect to a server.
+
Sets the ping for the client.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
clientobject:init( sockettype )
+
client:setPing(enabled, time, msg)
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|SocketType|string|"tcp", "udp" or user-defined.}}
+
{{param|boolean|enabled|Is enabled (True/False).}}
 +
{{param|number|time|How many seconds between pings.}}
 +
{{param|string|msg|Ping package content.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
Line 12: Line 14:
 
* [[parent::ClientObject]]
 
* [[parent::ClientObject]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Connect to a server.}}
+
{{#set:Description=Sets the ping for the client.}}
 
== Other Languages ==
 
== Other Languages ==
{{i18n|ClientObject:init}}
+
{{i18n|ClientObject:setPing}}

Latest revision as of 22:25, 6 March 2011

Sets the ping for the client.

Function

Synopsis

client:setPing(enabled, time, msg)

Arguments

boolean enabled
Is enabled (True/False).
number time
How many seconds between pings.
string msg
Ping package content.

Returns

Nothing.

See Also

Other Languages