瀏覽代碼

Merge pull request #93927 from marcospb19/tweak-enetconnection-doc

Mention `timeout` unit in `ENetConnection::service` docs
Rémi Verschelde 1 年之前
父節點
當前提交
f9a58be51b
共有 1 個文件被更改,包括 1 次插入1 次删除
  1. 1 1
      modules/enet/doc_classes/ENetConnection.xml

+ 1 - 1
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>