Difference between revisions of "enet.event"
m (→Description: - fixed minor word error. One can be weary after an exhausting day, but one should be wary of wherewolfes...) |
m (Fixed typo) |
||
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
| − | An [[enet.event | event]] is a table generated by [[enet.host:service | host:service()]] or [[enet.peer:receive | peer: | + | An [[enet.event | event]] is a table generated by [[enet.host:service | host:service()]] or [[enet.peer:receive | peer:receive()]] which will '''always''' contain a [[string]] named ''type'', a [[enet.peer]] named ''peer'', and a [[string]] or [[number]] named ''data'' depending on the kind of event. |
Though be wary that [[enet.host:service | host:service()]] and [[enet.peer:receive | peer:recieve()]] can return [[nil]] if no events are in the queue. | Though be wary that [[enet.host:service | host:service()]] and [[enet.peer:receive | peer:recieve()]] can return [[nil]] if no events are in the queue. | ||
Revision as of 14:43, 4 May 2019
Description
An event is a table generated by host:service() or peer:receive() which will always contain a string named type, a enet.peer named peer, and a string or number named data depending on the kind of event.
Though be wary that host:service() and peer:recieve() can return nil if no events are in the queue.
Structure
| event.type | event.peer | event.data |
|---|---|---|
| "receive" | peer | string |
| "disconnect" | peer | number |
| "connect" | peer | number |
