godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-10-29 12:48:46 +01:00
parent bbc6682099
commit a72184300f
449 changed files with 14004 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
classes/class_upnp.rst
View File

@@ -216,6 +216,8 @@ Property Descriptions
If ``true``, IPv6 is used for :ref:`UPNPDevice<class_UPNPDevice>` discovery.
----
.. _class_UPNP_property_discover_local_port:
- :ref:`int<class_int>` **discover_local_port**
@@ -230,6 +232,8 @@ If ``true``, IPv6 is used for :ref:`UPNPDevice<class_UPNPDevice>` discovery.
If ``0``, the local port to use for discovery is chosen automatically by the system. If ``1``, discovery will be done from the source port 1900 (same as destination port). Otherwise, the value will be used as the port.
----
.. _class_UPNP_property_discover_multicast_if:
- :ref:`String<class_String>` **discover_multicast_if**
@@ -253,6 +257,8 @@ Method Descriptions
Adds the given :ref:`UPNPDevice<class_UPNPDevice>` to the list of discovered devices.
----
.. _class_UPNP_method_add_port_mapping:
- :ref:`int<class_int>` **add_port_mapping** **(** :ref:`int<class_int>` port, :ref:`int<class_int>` port_internal=0, :ref:`String<class_String>` desc="", :ref:`String<class_String>` proto="UDP", :ref:`int<class_int>` duration=0 **)** const
@@ -265,18 +271,24 @@ The description (``desc``) is shown in some router UIs and can be used to point
See :ref:`UPNPResult<enum_UPNP_UPNPResult>` for possible return values.
----
.. _class_UPNP_method_clear_devices:
- void **clear_devices** **(** **)**
Clears the list of discovered devices.
----
.. _class_UPNP_method_delete_port_mapping:
- :ref:`int<class_int>` **delete_port_mapping** **(** :ref:`int<class_int>` port, :ref:`String<class_String>` proto="UDP" **)** const
Deletes the port mapping for the given port and protocol combination on the default gateway (see :ref:`get_gateway<class_UPNP_method_get_gateway>`) if one exists. ``port`` must be a valid port between 1 and 65535, ``proto`` can be either ``TCP`` or ``UDP``. See :ref:`UPNPResult<enum_UPNP_UPNPResult>` for possible return values.
----
.. _class_UPNP_method_discover:
- :ref:`int<class_int>` **discover** **(** :ref:`int<class_int>` timeout=2000, :ref:`int<class_int>` ttl=2, :ref:`String<class_String>` device_filter="InternetGatewayDevice" **)**
@@ -287,36 +299,48 @@ Filters for IGD (InternetGatewayDevice) type devices by default, as those manage
See :ref:`UPNPResult<enum_UPNP_UPNPResult>` for possible return values.
----
.. _class_UPNP_method_get_device:
- :ref:`UPNPDevice<class_UPNPDevice>` **get_device** **(** :ref:`int<class_int>` index **)** const
Returns the :ref:`UPNPDevice<class_UPNPDevice>` at the given ``index``.
----
.. _class_UPNP_method_get_device_count:
- :ref:`int<class_int>` **get_device_count** **(** **)** const
Returns the number of discovered :ref:`UPNPDevice<class_UPNPDevice>`\ s.
----
.. _class_UPNP_method_get_gateway:
- :ref:`UPNPDevice<class_UPNPDevice>` **get_gateway** **(** **)** const
Returns the default gateway. That is the first discovered :ref:`UPNPDevice<class_UPNPDevice>` that is also a valid IGD (InternetGatewayDevice).
----
.. _class_UPNP_method_query_external_address:
- :ref:`String<class_String>` **query_external_address** **(** **)** const
Returns the external :ref:`IP<class_IP>` address of the default gateway (see :ref:`get_gateway<class_UPNP_method_get_gateway>`) as string. Returns an empty string on error.
----
.. _class_UPNP_method_remove_device:
- void **remove_device** **(** :ref:`int<class_int>` index **)**
Removes the device at ``index`` from the list of discovered devices.
----
.. _class_UPNP_method_set_device:
- void **set_device** **(** :ref:`int<class_int>` index, :ref:`UPNPDevice<class_UPNPDevice>` device **)**