diff options
| author | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2022-03-27 16:31:56 +0200 |
|---|---|---|
| committer | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2022-03-27 16:36:44 +0200 |
| commit | 331f1662df41b4e7afff30d2fe4019a413499c1c (patch) | |
| tree | fe6d6777ae686494caf08be2f2f2272a81d7260f /doc/classes | |
| parent | 0e528676683a0df96751fd0daa018e0818baa0e2 (diff) | |
[Net] Drop is_connected_to_host for TCP and UDP.
The UDP method is now called `is_socket_connected` to limit confusion
with the actual host connection status which doesn't make sense in UDP.
The TCP method is completly dropped, use get_status instead.
The only one left is the WebSocketPeer one, which should be fine as is
for now.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/PacketPeerUDP.xml | 2 | ||||
| -rw-r--r-- | doc/classes/StreamPeerTCP.xml | 6 |
2 files changed, 1 insertions, 7 deletions
diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 580bf60518..7c6622be3c 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -61,7 +61,7 @@ Returns whether this [PacketPeerUDP] is bound to an address and can receive packets. </description> </method> - <method name="is_connected_to_host" qualifiers="const"> + <method name="is_socket_connected" qualifiers="const"> <return type="bool" /> <description> Returns [code]true[/code] if the UDP socket is open and has been connected to a remote address. See [method connect_to_host]. diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 033982ea40..f06cf5c7a2 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -57,12 +57,6 @@ Returns the status of the connection, see [enum Status]. </description> </method> - <method name="is_connected_to_host" qualifiers="const"> - <return type="bool" /> - <description> - Returns [code]true[/code] if this peer is currently connected or is connecting to a host, [code]false[/code] otherwise. - </description> - </method> <method name="poll"> <return type="int" enum="Error" /> <description> |