Difference between revisions of "enet.peer:state"

(Created page with "Returns the state of the peer as a string. == Function == === Synopsis === <source lang="lua"> peer:state() </source> === Arguments === None === Returns === {...")
 
m (stylistic edit.)
 
(One intermediate revision by one other user not shown)
Line 6: Line 6:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
None
+
None.
 
=== Returns ===
 
=== Returns ===
 
{{param|string|state|The [[enet.peer | peer's]] current state. It can be any of the following:
 
{{param|string|state|The [[enet.peer | peer's]] current state. It can be any of the following:
Line 26: Line 26:
 
* [[enet.peer]]
 
* [[enet.peer]]
 
== Other Languages ==
 
== Other Languages ==
{{i18n|enet.peer:disconnect_now}}
+
{{i18n|enet.peer:state}}

Latest revision as of 02:13, 30 October 2016

Returns the state of the peer as a string.

Function

Synopsis

peer:state()

Arguments

None.

Returns

string state
The peer's current state. It can be any of the following:
  • "disconnected"
  • "connecting"
  • "acknowledging_connect"
  • "connection_pending"
  • "connection_succeeded"
  • "connected"
  • "disconnect_later"
  • "disconnecting"
  • "acknowledging_disconnect"
  • "zombie"
  • "unknown"


See Also

Other Languages