diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2024-07-04 23:27:16 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2024-07-04 23:27:16 +0200 |
| commit | f9a58be51bfc596ac94de58e5e03fa28b53f765a (patch) | |
| tree | 5ef87b566641f193338eb45a3c64ff70a3f6c3b9 | |
| parent | 099b9b2e85b0749cf5de546dbdc40975238a7c3d (diff) | |
| parent | 0a822af3332a8c0b6aed11d0e9b29fd333239392 (diff) | |
| download | redot-engine-f9a58be51bfc596ac94de58e5e03fa28b53f765a.tar.gz | |
Merge pull request #93927 from marcospb19/tweak-enetconnection-doc
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> |