diff options
| author | João Marcos P. Bezerra <marcospb19@hotmail.com> | 2024-07-04 05:29:30 -0300 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2024-07-04 22:20:44 +0200 |
| commit | 0a822af3332a8c0b6aed11d0e9b29fd333239392 (patch) | |
| tree | 4033fa013df3e476476ef7bba350a64b01469903 | |
| parent | 6a13fdcae3662975c101213d47a1eb3a7db63cb3 (diff) | |
| download | redot-engine-0a822af3332a8c0b6aed11d0e9b29fd333239392.tar.gz | |
Mention timeout unit in ENetConnection::service docs
| -rw-r--r-- | modules/enet/doc_classes/ENetConnection.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/modules/enet/doc_classes/ENetConnection.xml b/modules/enet/doc_classes/ENetConnection.xml index 5795dd8976..ebd1577172 100644 --- a/modules/enet/doc_classes/ENetConnection.xml +++ b/modules/enet/doc_classes/ENetConnection.xml @@ -141,7 +141,7 @@ <return type="Array" /> <param index="0" name="timeout" type="int" default="0" /> <description> - Waits for events on the host specified and shuttles packets between the host and its peers. The returned [Array] will have 4 elements. An [enum EventType], the [ENetPacketPeer] which generated the event, the event associated data (if any), the event associated channel (if any). If the generated event is [constant EVENT_RECEIVE], the received packet will be queued to the associated [ENetPacketPeer]. + Waits for events on the specified host and shuttles packets between the host and its peers, with the given [param timeout] (in milliseconds). The returned [Array] will have 4 elements. An [enum EventType], the [ENetPacketPeer] which generated the event, the event associated data (if any), the event associated channel (if any). If the generated event is [constant EVENT_RECEIVE], the received packet will be queued to the associated [ENetPacketPeer]. Call this function regularly to handle connections, disconnections, and to receive new packets. </description> </method> |