Andrew/redot-engine
1
0
Fork 0
mirror of https://github.com/Redot-Engine/redot-engine.git synced 2025-12-06 15:21:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

Mention timeout unit in ENetConnection::service docs

Browse Source
This commit is contained in:
João Marcos P. Bezerra
2024-07-04 05:29:30 -03:00
committed by Rémi Verschelde
parent 6a13fdcae3
commit 0a822af333
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
modules/enet/doc_classes/ENetConnection.xml
View File

@@ -141,7 +141,7 @@
<return type="Array" /> <return type="Array" />
<param index="0" name="timeout" type="int" default="0" /> <param index="0" name="timeout" type="int" default="0" />
<description> <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. Call this function regularly to handle connections, disconnections, and to receive new packets.
</description> </description>
</method> </method>