.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/modules/upnp/doc_classes/UPNP.xml. .. _class_UPNP: UPNP ==== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+-------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`discover_ipv6` | ``false`` | +-----------------------------+-------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`discover_local_port` | ``0`` | +-----------------------------+-------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`discover_multicast_if` | ``""`` | +-----------------------------+-------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_device` **(** :ref:`UPNPDevice` device **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_devices` **(** **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`discover` **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`UPNPDevice` | :ref:`get_device` **(** :ref:`int` index **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_device_count` **(** **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`UPNPDevice` | :ref:`get_gateway` **(** **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`query_external_address` **(** **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_device` **(** :ref:`int` index **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_device` **(** :ref:`int` index, :ref:`UPNPDevice` device **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_UPNP_UPNPResult: .. rst-class:: classref-enumeration enum **UPNPResult**: .. _class_UPNP_constant_UPNP_RESULT_SUCCESS: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_SUCCESS** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_NOT_AUTHORIZED: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_NOT_AUTHORIZED** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_PORT_MAPPING_NOT_FOUND: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_PORT_MAPPING_NOT_FOUND** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_INCONSISTENT_PARAMETERS: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_INCONSISTENT_PARAMETERS** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_NO_SUCH_ENTRY_IN_ARRAY: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_NO_SUCH_ENTRY_IN_ARRAY** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_ACTION_FAILED: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_ACTION_FAILED** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_SRC_IP_WILDCARD_NOT_PERMITTED: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_SRC_IP_WILDCARD_NOT_PERMITTED** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_EXT_PORT_WILDCARD_NOT_PERMITTED: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_EXT_PORT_WILDCARD_NOT_PERMITTED** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_INT_PORT_WILDCARD_NOT_PERMITTED: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_INT_PORT_WILDCARD_NOT_PERMITTED** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_REMOTE_HOST_MUST_BE_WILDCARD: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_REMOTE_HOST_MUST_BE_WILDCARD** = ``9`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_EXT_PORT_MUST_BE_WILDCARD: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_EXT_PORT_MUST_BE_WILDCARD** = ``10`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_NO_PORT_MAPS_AVAILABLE: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_NO_PORT_MAPS_AVAILABLE** = ``11`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_CONFLICT_WITH_OTHER_MECHANISM: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_CONFLICT_WITH_OTHER_MECHANISM** = ``12`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_CONFLICT_WITH_OTHER_MAPPING: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_CONFLICT_WITH_OTHER_MAPPING** = ``13`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_SAME_PORT_VALUES_REQUIRED: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_SAME_PORT_VALUES_REQUIRED** = ``14`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_ONLY_PERMANENT_LEASE_SUPPORTED: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_ONLY_PERMANENT_LEASE_SUPPORTED** = ``15`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_INVALID_GATEWAY: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_INVALID_GATEWAY** = ``16`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_INVALID_PORT: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_INVALID_PORT** = ``17`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_INVALID_PROTOCOL: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_INVALID_PROTOCOL** = ``18`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_INVALID_DURATION: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_INVALID_DURATION** = ``19`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_INVALID_ARGS: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_INVALID_ARGS** = ``20`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_INVALID_RESPONSE: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_INVALID_RESPONSE** = ``21`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_INVALID_PARAM: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_INVALID_PARAM** = ``22`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_HTTP_ERROR: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_HTTP_ERROR** = ``23`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_SOCKET_ERROR: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_SOCKET_ERROR** = ``24`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_MEM_ALLOC_ERROR: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_MEM_ALLOC_ERROR** = ``25`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_NO_GATEWAY: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_NO_GATEWAY** = ``26`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_NO_DEVICES: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_NO_DEVICES** = ``27`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_UPNP_constant_UPNP_RESULT_UNKNOWN_ERROR: .. rst-class:: classref-enumeration-constant :ref:`UPNPResult` **UPNP_RESULT_UNKNOWN_ERROR** = ``28`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_UPNP_property_discover_ipv6: .. rst-class:: classref-property :ref:`bool` **discover_ipv6** = ``false`` .. rst-class:: classref-property-setget - void **set_discover_ipv6** **(** :ref:`bool` value **)** - :ref:`bool` **is_discover_ipv6** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_property_discover_local_port: .. rst-class:: classref-property :ref:`int` **discover_local_port** = ``0`` .. rst-class:: classref-property-setget - void **set_discover_local_port** **(** :ref:`int` value **)** - :ref:`int` **get_discover_local_port** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_property_discover_multicast_if: .. rst-class:: classref-property :ref:`String` **discover_multicast_if** = ``""`` .. rst-class:: classref-property-setget - void **set_discover_multicast_if** **(** :ref:`String` value **)** - :ref:`String` **get_discover_multicast_if** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_UPNP_method_add_device: .. rst-class:: classref-method void **add_device** **(** :ref:`UPNPDevice` device **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_method_add_port_mapping: .. rst-class:: classref-method :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_method_clear_devices: .. rst-class:: classref-method void **clear_devices** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_method_delete_port_mapping: .. rst-class:: classref-method :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_method_discover: .. rst-class:: classref-method :ref:`int` **discover** **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_method_get_device: .. rst-class:: classref-method :ref:`UPNPDevice` **get_device** **(** :ref:`int` index **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_method_get_device_count: .. rst-class:: classref-method :ref:`int` **get_device_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_method_get_gateway: .. rst-class:: classref-method :ref:`UPNPDevice` **get_gateway** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_method_query_external_address: .. rst-class:: classref-method :ref:`String` **query_external_address** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_method_remove_device: .. rst-class:: classref-method void **remove_device** **(** :ref:`int` index **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_UPNP_method_set_device: .. rst-class:: classref-method void **set_device** **(** :ref:`int` index, :ref:`UPNPDevice` device **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`