mirror of
https://github.com/godotengine/godot.git
synced 2026-01-03 18:11:19 +03:00
doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
@@ -10,55 +10,43 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_collision_layer_bit" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<description>
|
||||
Returns an individual bit on the collision mask.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_collision_mask_bit" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<description>
|
||||
Returns an individual bit on the collision mask.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_meshes" qualifiers="const">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<return type="Array" />
|
||||
<description>
|
||||
Returns an [Array] with two elements, the first is the [Transform] of this node and the second is the root [Mesh] of this node. Only works when this node is the root shape.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_root_shape" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this is a root shape and is thus the object that is rendered.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_collision_layer_bit">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="bool">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<argument index="1" name="value" type="bool" />
|
||||
<description>
|
||||
Sets individual bits on the layer mask. Use this if you only need to change one layer's value.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_collision_mask_bit">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="bool">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<argument index="1" name="value" type="bool" />
|
||||
<description>
|
||||
Sets individual bits on the collision mask. Use this if you only need to change one layer's value.
|
||||
</description>
|
||||
|
||||
@@ -14,127 +14,94 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="close_connection">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="wait_usec" type="int" default="100">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="wait_usec" type="int" default="100" />
|
||||
<description>
|
||||
Closes the connection. Ignored if no connection is currently established. If this is a server it tries to notify all clients before forcibly disconnecting them. If this is a client it simply closes the connection to the server.
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_client">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="address" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="port" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="in_bandwidth" type="int" default="0">
|
||||
</argument>
|
||||
<argument index="3" name="out_bandwidth" type="int" default="0">
|
||||
</argument>
|
||||
<argument index="4" name="client_port" type="int" default="0">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="address" type="String" />
|
||||
<argument index="1" name="port" type="int" />
|
||||
<argument index="2" name="in_bandwidth" type="int" default="0" />
|
||||
<argument index="3" name="out_bandwidth" type="int" default="0" />
|
||||
<argument index="4" name="client_port" type="int" default="0" />
|
||||
<description>
|
||||
Create client that connects to a server at [code]address[/code] using specified [code]port[/code]. The given address needs to be either a fully qualified domain name (e.g. [code]"www.example.com"[/code]) or an IP address in IPv4 or IPv6 format (e.g. [code]"192.168.1.1"[/code]). The [code]port[/code] is the port the server is listening on. The [code]in_bandwidth[/code] and [code]out_bandwidth[/code] parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns [constant OK] if a client was created, [constant ERR_ALREADY_IN_USE] if this NetworkedMultiplayerENet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the client could not be created. If [code]client_port[/code] is specified, the client will also listen to the given port; this is useful for some NAT traversal techniques.
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_server">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="port" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="max_clients" type="int" default="32">
|
||||
</argument>
|
||||
<argument index="2" name="in_bandwidth" type="int" default="0">
|
||||
</argument>
|
||||
<argument index="3" name="out_bandwidth" type="int" default="0">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="port" type="int" />
|
||||
<argument index="1" name="max_clients" type="int" default="32" />
|
||||
<argument index="2" name="in_bandwidth" type="int" default="0" />
|
||||
<argument index="3" name="out_bandwidth" type="int" default="0" />
|
||||
<description>
|
||||
Create server that listens to connections via [code]port[/code]. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use [method set_bind_ip]. The default IP is the wildcard [code]"*"[/code], which listens on all available interfaces. [code]max_clients[/code] is the maximum number of clients that are allowed at once, any number up to 4095 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see [method create_client]. Returns [constant OK] if a server was created, [constant ERR_ALREADY_IN_USE] if this NetworkedMultiplayerENet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the server could not be created.
|
||||
</description>
|
||||
</method>
|
||||
<method name="disconnect_peer">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="now" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<argument index="1" name="now" type="bool" default="false" />
|
||||
<description>
|
||||
Disconnect the given peer. If "now" is set to [code]true[/code], the connection will be closed immediately without flushing queued messages.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_last_packet_channel" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the channel of the last packet fetched via [method PacketPeer.get_packet].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_packet_channel" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the channel of the next packet that will be retrieved via [method PacketPeer.get_packet].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_peer_address" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
Returns the IP address of the given peer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_peer_port" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
Returns the remote port of the given peer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_bind_ip">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="ip" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="ip" type="String" />
|
||||
<description>
|
||||
The IP used when creating a server. This is set to the wildcard [code]"*"[/code] by default, which binds to all available interfaces. The given IP needs to be in IPv4 or IPv6 address format, for example: [code]"192.168.1.1"[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_dtls_certificate">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="certificate" type="X509Certificate">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="certificate" type="X509Certificate" />
|
||||
<description>
|
||||
Configure the [X509Certificate] to use when [member use_dtls] is [code]true[/code]. For servers, you must also setup the [CryptoKey] via [method set_dtls_key].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_dtls_key">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="key" type="CryptoKey">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="key" type="CryptoKey" />
|
||||
<description>
|
||||
Configure the [CryptoKey] to use when [member use_dtls] is [code]true[/code]. Remember to also call [method set_dtls_certificate] to setup your [X509Certificate].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_peer_timeout">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="timeout_limit" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="timeout_min" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="timeout_max" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<argument index="1" name="timeout_limit" type="int" />
|
||||
<argument index="2" name="timeout_min" type="int" />
|
||||
<argument index="3" name="timeout_max" type="int" />
|
||||
<description>
|
||||
Sets the timeout parameters for a peer. The timeout parameters control how and when a peer will timeout from a failure to acknowledge reliable traffic. Timeout values are expressed in milliseconds.
|
||||
The [code]timeout_limit[/code] is a factor that, multiplied by a value based on the average round trip time, will determine the timeout limit for a reliable packet. When that limit is reached, the timeout will be doubled, and the peer will be disconnected if that limit has reached [code]timeout_min[/code]. The [code]timeout_max[/code] parameter, on the other hand, defines a fixed timeout for which any packet must be acknowledged or the peer will be dropped.
|
||||
|
||||
@@ -8,26 +8,20 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="call_native">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="calling_type" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="procedure_name" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="arguments" type="Array">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="calling_type" type="String" />
|
||||
<argument index="1" name="procedure_name" type="String" />
|
||||
<argument index="2" name="arguments" type="Array" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="initialize">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="terminate">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@@ -12,15 +12,13 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_current_dependencies" qualifiers="const">
|
||||
<return type="PoolStringArray">
|
||||
</return>
|
||||
<return type="PoolStringArray" />
|
||||
<description>
|
||||
Returns paths to all dependency libraries for the current platform and architecture.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_current_library_path" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the path to the dynamic library file for the current platform and architecture.
|
||||
</description>
|
||||
|
||||
@@ -8,42 +8,34 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_class_documentation" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the documentation string that was previously set with [code]godot_nativescript_set_class_documentation[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_method_documentation" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="method" type="String">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="method" type="String" />
|
||||
<description>
|
||||
Returns the documentation string that was previously set with [code]godot_nativescript_set_method_documentation[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_property_documentation" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="path" type="String">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<description>
|
||||
Returns the documentation string that was previously set with [code]godot_nativescript_set_property_documentation[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_signal_documentation" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="signal_name" type="String">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="signal_name" type="String" />
|
||||
<description>
|
||||
Returns the documentation string that was previously set with [code]godot_nativescript_set_signal_documentation[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="new" qualifiers="vararg">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<return type="Variant" />
|
||||
<description>
|
||||
Constructs a new object of the base type with a script of this type already attached.
|
||||
[i]Note[/i]: Any arguments passed to this function will be ignored and not passed to the native constructor function. This will change with in a future API extension.
|
||||
|
||||
@@ -8,8 +8,7 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="new" qualifiers="vararg">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<return type="Variant" />
|
||||
<description>
|
||||
Returns a new instance of the script.
|
||||
</description>
|
||||
|
||||
@@ -11,17 +11,14 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_file">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the video file handled by this [VideoStreamGDNative].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_file">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="file" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="file" type="String" />
|
||||
<description>
|
||||
Sets the video file that this [VideoStreamGDNative] resource handles. The supported extensions depend on the GDNative plugins used to expose video formats.
|
||||
</description>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -12,15 +12,13 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_as_byte_code" qualifiers="const">
|
||||
<return type="PoolByteArray">
|
||||
</return>
|
||||
<return type="PoolByteArray" />
|
||||
<description>
|
||||
Returns byte code for the script source code.
|
||||
</description>
|
||||
</method>
|
||||
<method name="new" qualifiers="vararg">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<return type="Variant" />
|
||||
<description>
|
||||
Returns a new instance of the script.
|
||||
For example:
|
||||
|
||||
@@ -10,20 +10,16 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="is_valid" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="extended_check" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="extended_check" type="bool" default="false" />
|
||||
<description>
|
||||
Check whether the function call may be resumed. This is not the case if the function state was already resumed.
|
||||
If [code]extended_check[/code] is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of [method GDScriptFunctionState.resume], but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point.
|
||||
</description>
|
||||
</method>
|
||||
<method name="resume">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="arg" type="Variant" default="null">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="arg" type="Variant" default="null" />
|
||||
<description>
|
||||
Resume execution of the yielded function call.
|
||||
If handed an argument, return the argument from the [method @GDScript.yield] call in the yielded function call. You can pass e.g. an [Array] to hand multiple arguments.
|
||||
@@ -33,8 +29,7 @@
|
||||
</methods>
|
||||
<signals>
|
||||
<signal name="completed">
|
||||
<argument index="0" name="result" type="Variant">
|
||||
</argument>
|
||||
<argument index="0" name="result" type="Variant" />
|
||||
<description>
|
||||
</description>
|
||||
</signal>
|
||||
|
||||
@@ -17,135 +17,101 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="clear">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
Clear all cells.
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_baked_meshes">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_bake_mesh_instance">
|
||||
<return type="RID">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="RID" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_bake_meshes">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<return type="Array" />
|
||||
<description>
|
||||
Returns an array of [ArrayMesh]es and [Transform] references of all bake meshes that exist within the current GridMap.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_cell_item" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="x" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="y" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="z" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="x" type="int" />
|
||||
<argument index="1" name="y" type="int" />
|
||||
<argument index="2" name="z" type="int" />
|
||||
<description>
|
||||
The [MeshLibrary] item index located at the grid-based X, Y and Z coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_cell_item_orientation" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="x" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="y" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="z" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="x" type="int" />
|
||||
<argument index="1" name="y" type="int" />
|
||||
<argument index="2" name="z" type="int" />
|
||||
<description>
|
||||
The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is returned if the cell is empty.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_collision_layer_bit" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<description>
|
||||
Returns an individual bit on the [member collision_layer].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_collision_mask_bit" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<description>
|
||||
Returns an individual bit on the [member collision_mask].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_meshes">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<return type="Array" />
|
||||
<description>
|
||||
Returns an array of [Transform] and [Mesh] references corresponding to the non-empty cells in the grid. The transforms are specified in world space.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_used_cells" qualifiers="const">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<return type="Array" />
|
||||
<description>
|
||||
Returns an array of [Vector3] with the non-empty cell coordinates in the grid map.
|
||||
</description>
|
||||
</method>
|
||||
<method name="make_baked_meshes">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="gen_lightmap_uv" type="bool" default="false">
|
||||
</argument>
|
||||
<argument index="1" name="lightmap_uv_texel_size" type="float" default="0.1">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="gen_lightmap_uv" type="bool" default="false" />
|
||||
<argument index="1" name="lightmap_uv_texel_size" type="float" default="0.1" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="map_to_world" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="x" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="y" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="z" type="int">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="x" type="int" />
|
||||
<argument index="1" name="y" type="int" />
|
||||
<argument index="2" name="z" type="int" />
|
||||
<description>
|
||||
Returns the position of a grid cell in the GridMap's local coordinate space.
|
||||
</description>
|
||||
</method>
|
||||
<method name="resource_changed">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="resource" type="Resource">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="resource" type="Resource" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_cell_item">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="x" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="y" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="z" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="item" type="int">
|
||||
</argument>
|
||||
<argument index="4" name="orientation" type="int" default="0">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="x" type="int" />
|
||||
<argument index="1" name="y" type="int" />
|
||||
<argument index="2" name="z" type="int" />
|
||||
<argument index="3" name="item" type="int" />
|
||||
<argument index="4" name="orientation" type="int" default="0" />
|
||||
<description>
|
||||
Sets the mesh index for the cell referenced by its grid-based X, Y and Z coordinates.
|
||||
A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell.
|
||||
@@ -153,46 +119,33 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_clip">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="enabled" type="bool">
|
||||
</argument>
|
||||
<argument index="1" name="clipabove" type="bool" default="true">
|
||||
</argument>
|
||||
<argument index="2" name="floor" type="int" default="0">
|
||||
</argument>
|
||||
<argument index="3" name="axis" type="int" enum="Vector3.Axis" default="0">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="enabled" type="bool" />
|
||||
<argument index="1" name="clipabove" type="bool" default="true" />
|
||||
<argument index="2" name="floor" type="int" default="0" />
|
||||
<argument index="3" name="axis" type="int" enum="Vector3.Axis" default="0" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_collision_layer_bit">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="bool">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<argument index="1" name="value" type="bool" />
|
||||
<description>
|
||||
Sets an individual bit on the [member collision_layer].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_collision_mask_bit">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="bool">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<argument index="1" name="value" type="bool" />
|
||||
<description>
|
||||
Sets an individual bit on the [member collision_mask].
|
||||
</description>
|
||||
</method>
|
||||
<method name="world_to_map" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="pos" type="Vector3">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="pos" type="Vector3" />
|
||||
<description>
|
||||
Returns the coordinates of the grid cell containing the given point.
|
||||
[code]pos[/code] should be in the GridMap's local coordinate space.
|
||||
@@ -236,8 +189,7 @@
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="cell_size_changed">
|
||||
<argument index="0" name="cell_size" type="Vector3">
|
||||
</argument>
|
||||
<argument index="0" name="cell_size" type="Vector3" />
|
||||
<description>
|
||||
Emitted when [member cell_size] changes.
|
||||
</description>
|
||||
|
||||
@@ -25,88 +25,65 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_image" qualifiers="const">
|
||||
<return type="Image">
|
||||
</return>
|
||||
<argument index="0" name="width" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="height" type="int">
|
||||
</argument>
|
||||
<return type="Image" />
|
||||
<argument index="0" name="width" type="int" />
|
||||
<argument index="1" name="height" type="int" />
|
||||
<description>
|
||||
Generate a noise image in [constant Image.FORMAT_L8] format with the requested [code]width[/code] and [code]height[/code], based on the current noise parameters.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_noise_1d" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="x" type="float">
|
||||
</argument>
|
||||
<return type="float" />
|
||||
<argument index="0" name="x" type="float" />
|
||||
<description>
|
||||
Returns the 1D noise value [code][-1,1][/code] at the given x-coordinate.
|
||||
[b]Note:[/b] This method actually returns the 2D noise value [code][-1,1][/code] with fixed y-coordinate value 0.0.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_noise_2d" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="x" type="float">
|
||||
</argument>
|
||||
<argument index="1" name="y" type="float">
|
||||
</argument>
|
||||
<return type="float" />
|
||||
<argument index="0" name="x" type="float" />
|
||||
<argument index="1" name="y" type="float" />
|
||||
<description>
|
||||
Returns the 2D noise value [code][-1,1][/code] at the given position.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_noise_2dv" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="pos" type="Vector2">
|
||||
</argument>
|
||||
<return type="float" />
|
||||
<argument index="0" name="pos" type="Vector2" />
|
||||
<description>
|
||||
Returns the 2D noise value [code][-1,1][/code] at the given position.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_noise_3d" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="x" type="float">
|
||||
</argument>
|
||||
<argument index="1" name="y" type="float">
|
||||
</argument>
|
||||
<argument index="2" name="z" type="float">
|
||||
</argument>
|
||||
<return type="float" />
|
||||
<argument index="0" name="x" type="float" />
|
||||
<argument index="1" name="y" type="float" />
|
||||
<argument index="2" name="z" type="float" />
|
||||
<description>
|
||||
Returns the 3D noise value [code][-1,1][/code] at the given position.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_noise_3dv" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="pos" type="Vector3">
|
||||
</argument>
|
||||
<return type="float" />
|
||||
<argument index="0" name="pos" type="Vector3" />
|
||||
<description>
|
||||
Returns the 3D noise value [code][-1,1][/code] at the given position.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_noise_4d" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="x" type="float">
|
||||
</argument>
|
||||
<argument index="1" name="y" type="float">
|
||||
</argument>
|
||||
<argument index="2" name="z" type="float">
|
||||
</argument>
|
||||
<argument index="3" name="w" type="float">
|
||||
</argument>
|
||||
<return type="float" />
|
||||
<argument index="0" name="x" type="float" />
|
||||
<argument index="1" name="y" type="float" />
|
||||
<argument index="2" name="z" type="float" />
|
||||
<argument index="3" name="w" type="float" />
|
||||
<description>
|
||||
Returns the 4D noise value [code][-1,1][/code] at the given position.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_seamless_image" qualifiers="const">
|
||||
<return type="Image">
|
||||
</return>
|
||||
<argument index="0" name="size" type="int">
|
||||
</argument>
|
||||
<return type="Image" />
|
||||
<argument index="0" name="size" type="int" />
|
||||
<description>
|
||||
Generate a tileable noise image in [constant Image.FORMAT_L8] format, based on the current noise parameters. Generated seamless images are always square ([code]size[/code] × [code]size[/code]).
|
||||
[b]Note:[/b] Seamless noise has a lower contrast compared to non-seamless noise. This is due to the way noise uses higher dimensions for generating seamless noise.
|
||||
|
||||
@@ -50,88 +50,67 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="clear">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
This method resets the state of the object, as if it was freshly created. Namely, it unassigns the regular expression of this object.
|
||||
</description>
|
||||
</method>
|
||||
<method name="compile">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="pattern" type="String">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="pattern" type="String" />
|
||||
<description>
|
||||
Compiles and assign the search pattern to use. Returns [constant OK] if the compilation is successful. If an error is encountered, details are printed to standard output and an error is returned.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_group_count" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the number of capturing groups in compiled pattern.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_names" qualifiers="const">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<return type="Array" />
|
||||
<description>
|
||||
Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_pattern" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the original search pattern that was compiled.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_valid" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns whether this object has a valid search pattern assigned.
|
||||
</description>
|
||||
</method>
|
||||
<method name="search" qualifiers="const">
|
||||
<return type="RegExMatch">
|
||||
</return>
|
||||
<argument index="0" name="subject" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="offset" type="int" default="0">
|
||||
</argument>
|
||||
<argument index="2" name="end" type="int" default="-1">
|
||||
</argument>
|
||||
<return type="RegExMatch" />
|
||||
<argument index="0" name="subject" type="String" />
|
||||
<argument index="1" name="offset" type="int" default="0" />
|
||||
<argument index="2" name="end" type="int" default="-1" />
|
||||
<description>
|
||||
Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching result if found, otherwise [code]null[/code]. The region to search within can be specified without modifying where the start and end anchor would be.
|
||||
</description>
|
||||
</method>
|
||||
<method name="search_all" qualifiers="const">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<argument index="0" name="subject" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="offset" type="int" default="0">
|
||||
</argument>
|
||||
<argument index="2" name="end" type="int" default="-1">
|
||||
</argument>
|
||||
<return type="Array" />
|
||||
<argument index="0" name="subject" type="String" />
|
||||
<argument index="1" name="offset" type="int" default="0" />
|
||||
<argument index="2" name="end" type="int" default="-1" />
|
||||
<description>
|
||||
Searches the text for the compiled pattern. Returns an array of [RegExMatch] containers for each non-overlapping result. If no results were found, an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be.
|
||||
</description>
|
||||
</method>
|
||||
<method name="sub" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="subject" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="replacement" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="all" type="bool" default="false">
|
||||
</argument>
|
||||
<argument index="3" name="offset" type="int" default="0">
|
||||
</argument>
|
||||
<argument index="4" name="end" type="int" default="-1">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="subject" type="String" />
|
||||
<argument index="1" name="replacement" type="String" />
|
||||
<argument index="2" name="all" type="bool" default="false" />
|
||||
<argument index="3" name="offset" type="int" default="0" />
|
||||
<argument index="4" name="end" type="int" default="-1" />
|
||||
<description>
|
||||
Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as [code]$1[/code] and [code]$name[/code] are expanded and resolved. By default, only the first instance is replaced, but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be.
|
||||
</description>
|
||||
|
||||
@@ -10,37 +10,30 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_end" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="name" type="Variant" default="0">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="Variant" default="0" />
|
||||
<description>
|
||||
Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.
|
||||
Returns -1 if the group did not match or doesn't exist.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_group_count" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the number of capturing groups.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_start" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="name" type="Variant" default="0">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="Variant" default="0" />
|
||||
<description>
|
||||
Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.
|
||||
Returns -1 if the group did not match or doesn't exist.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_string" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="name" type="Variant" default="0">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="name" type="Variant" default="0" />
|
||||
<description>
|
||||
Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.
|
||||
Returns an empty string if the group did not match or doesn't exist.
|
||||
|
||||
@@ -11,17 +11,14 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_file">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the Ogg Theora video file handled by this [VideoStreamTheora].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_file">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="file" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="file" type="String" />
|
||||
<description>
|
||||
Sets the Ogg Theora video file that this [VideoStreamTheora] resource handles. The [code]file[/code] name should have the [code].ogv[/code] extension.
|
||||
</description>
|
||||
|
||||
@@ -21,27 +21,19 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_device">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="device" type="UPNPDevice">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="device" type="UPNPDevice" />
|
||||
<description>
|
||||
Adds the given [UPNPDevice] to the list of discovered devices.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_port_mapping" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="port" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="port_internal" type="int" default="0">
|
||||
</argument>
|
||||
<argument index="2" name="desc" type="String" default="""">
|
||||
</argument>
|
||||
<argument index="3" name="proto" type="String" default=""UDP"">
|
||||
</argument>
|
||||
<argument index="4" name="duration" type="int" default="0">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="port" type="int" />
|
||||
<argument index="1" name="port_internal" type="int" default="0" />
|
||||
<argument index="2" name="desc" type="String" default="""" />
|
||||
<argument index="3" name="proto" type="String" default=""UDP"" />
|
||||
<argument index="4" name="duration" type="int" default="0" />
|
||||
<description>
|
||||
Adds a mapping to forward the external [code]port[/code] (between 1 and 65535) on the default gateway (see [method get_gateway]) to the [code]internal_port[/code] on the local machine for the given protocol [code]proto[/code] (either [code]TCP[/code] or [code]UDP[/code], with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with [method get_gateway] and call [method add_port_mapping] on it, if any.
|
||||
If [code]internal_port[/code] is [code]0[/code] (the default), the same port number is used for both the external and the internal port (the [code]port[/code] value).
|
||||
@@ -50,32 +42,24 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_devices">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
Clears the list of discovered devices.
|
||||
</description>
|
||||
</method>
|
||||
<method name="delete_port_mapping" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="port" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="proto" type="String" default=""UDP"">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="port" type="int" />
|
||||
<argument index="1" name="proto" type="String" default=""UDP"" />
|
||||
<description>
|
||||
Deletes the port mapping for the given port and protocol combination on the default gateway (see [method get_gateway]) if one exists. [code]port[/code] must be a valid port between 1 and 65535, [code]proto[/code] can be either [code]TCP[/code] or [code]UDP[/code]. See [enum UPNPResult] for possible return values.
|
||||
</description>
|
||||
</method>
|
||||
<method name="discover">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="timeout" type="int" default="2000">
|
||||
</argument>
|
||||
<argument index="1" name="ttl" type="int" default="2">
|
||||
</argument>
|
||||
<argument index="2" name="device_filter" type="String" default=""InternetGatewayDevice"">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="timeout" type="int" default="2000" />
|
||||
<argument index="1" name="ttl" type="int" default="2" />
|
||||
<argument index="2" name="device_filter" type="String" default=""InternetGatewayDevice"" />
|
||||
<description>
|
||||
Discovers local [UPNPDevice]s. Clears the list of previously discovered devices.
|
||||
Filters for IGD (InternetGatewayDevice) type devices by default, as those manage port forwarding. [code]timeout[/code] is the time to wait for responses in milliseconds. [code]ttl[/code] is the time-to-live; only touch this if you know what you're doing.
|
||||
@@ -83,51 +67,41 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_device" qualifiers="const">
|
||||
<return type="UPNPDevice">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<return type="UPNPDevice" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
Returns the [UPNPDevice] at the given [code]index[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_device_count" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the number of discovered [UPNPDevice]s.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_gateway" qualifiers="const">
|
||||
<return type="UPNPDevice">
|
||||
</return>
|
||||
<return type="UPNPDevice" />
|
||||
<description>
|
||||
Returns the default gateway. That is the first discovered [UPNPDevice] that is also a valid IGD (InternetGatewayDevice).
|
||||
</description>
|
||||
</method>
|
||||
<method name="query_external_address" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the external [IP] address of the default gateway (see [method get_gateway]) as string. Returns an empty string on error.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_device">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
Removes the device at [code]index[/code] from the list of discovered devices.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_device">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="device" type="UPNPDevice">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="device" type="UPNPDevice" />
|
||||
<description>
|
||||
Sets the device at [code]index[/code] from the list of discovered devices to [code]device[/code].
|
||||
</description>
|
||||
|
||||
@@ -10,43 +10,32 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_port_mapping" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="port" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="port_internal" type="int" default="0">
|
||||
</argument>
|
||||
<argument index="2" name="desc" type="String" default="""">
|
||||
</argument>
|
||||
<argument index="3" name="proto" type="String" default=""UDP"">
|
||||
</argument>
|
||||
<argument index="4" name="duration" type="int" default="0">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="port" type="int" />
|
||||
<argument index="1" name="port_internal" type="int" default="0" />
|
||||
<argument index="2" name="desc" type="String" default="""" />
|
||||
<argument index="3" name="proto" type="String" default=""UDP"" />
|
||||
<argument index="4" name="duration" type="int" default="0" />
|
||||
<description>
|
||||
Adds a port mapping to forward the given external port on this [UPNPDevice] for the given protocol to the local machine. See [method UPNP.add_port_mapping].
|
||||
</description>
|
||||
</method>
|
||||
<method name="delete_port_mapping" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="port" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="proto" type="String" default=""UDP"">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="port" type="int" />
|
||||
<argument index="1" name="proto" type="String" default=""UDP"" />
|
||||
<description>
|
||||
Deletes the port mapping identified by the given port and protocol combination on this device. See [method UPNP.delete_port_mapping].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_valid_gateway" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding.
|
||||
</description>
|
||||
</method>
|
||||
<method name="query_external_address" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the external IP address of this [UPNPDevice] or an empty string.
|
||||
</description>
|
||||
|
||||
@@ -13,482 +13,347 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_custom_signal">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Add a custom signal with the specified name to the VisualScript.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_function">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Add a function with the specified name to the VisualScript.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_node">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="node" type="VisualScriptNode">
|
||||
</argument>
|
||||
<argument index="3" name="position" type="Vector2" default="Vector2( 0, 0 )">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<argument index="2" name="node" type="VisualScriptNode" />
|
||||
<argument index="3" name="position" type="Vector2" default="Vector2( 0, 0 )" />
|
||||
<description>
|
||||
Add a node to a function of the VisualScript.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_variable">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="default_value" type="Variant" default="null">
|
||||
</argument>
|
||||
<argument index="2" name="export" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="default_value" type="Variant" default="null" />
|
||||
<argument index="2" name="export" type="bool" default="false" />
|
||||
<description>
|
||||
Add a variable to the VisualScript, optionally giving it a default value or marking it as exported.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_add_argument">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<argument index="2" name="argname" type="String">
|
||||
</argument>
|
||||
<argument index="3" name="index" type="int" default="-1">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type" />
|
||||
<argument index="2" name="argname" type="String" />
|
||||
<argument index="3" name="index" type="int" default="-1" />
|
||||
<description>
|
||||
Add an argument to a custom signal added with [method add_custom_signal].
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_get_argument_count" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Get the count of a custom signal's arguments.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_get_argument_name" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<description>
|
||||
Get the name of a custom signal's argument.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_get_argument_type" qualifiers="const">
|
||||
<return type="int" enum="Variant.Type">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<return type="int" enum="Variant.Type" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<description>
|
||||
Get the type of a custom signal's argument.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_remove_argument">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<description>
|
||||
Remove a specific custom signal's argument.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_set_argument_name">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="argname" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<argument index="2" name="argname" type="String" />
|
||||
<description>
|
||||
Rename a custom signal's argument.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_set_argument_type">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<argument index="2" name="type" type="int" enum="Variant.Type" />
|
||||
<description>
|
||||
Change the type of a custom signal's argument.
|
||||
</description>
|
||||
</method>
|
||||
<method name="custom_signal_swap_argument">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="argidx" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="withidx" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="argidx" type="int" />
|
||||
<argument index="2" name="withidx" type="int" />
|
||||
<description>
|
||||
Swap two of the arguments of a custom signal.
|
||||
</description>
|
||||
</method>
|
||||
<method name="data_connect">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_port" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<argument index="4" name="to_port" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_port" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<argument index="4" name="to_port" type="int" />
|
||||
<description>
|
||||
Connect two data ports. The value of [code]from_node[/code]'s [code]from_port[/code] would be fed into [code]to_node[/code]'s [code]to_port[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="data_disconnect">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_port" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<argument index="4" name="to_port" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_port" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<argument index="4" name="to_port" type="int" />
|
||||
<description>
|
||||
Disconnect two data ports previously connected with [method data_connect].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_function_node_id" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns the id of a function's entry point node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_function_scroll" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns the position of the center of the screen for a given function.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node" qualifiers="const">
|
||||
<return type="VisualScriptNode">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<return type="VisualScriptNode" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<description>
|
||||
Returns a node given its id and its function.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node_position" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<description>
|
||||
Returns a node's position in pixels.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_variable_default_value" qualifiers="const">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns the default (initial) value of a variable.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_variable_export" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns whether a variable is exported.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_variable_info" qualifiers="const">
|
||||
<return type="Dictionary">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="Dictionary" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_custom_signal" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns whether a signal exists with the specified name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_data_connection" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_port" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<argument index="4" name="to_port" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_port" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<argument index="4" name="to_port" type="int" />
|
||||
<description>
|
||||
Returns whether the specified data ports are connected.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_function" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns whether a function exists with the specified name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_node" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<description>
|
||||
Returns whether a node exists with the given id.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_sequence_connection" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_output" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_output" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<description>
|
||||
Returns whether the specified sequence ports are connected.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_variable" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Returns whether a variable exists with the specified name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_custom_signal">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Remove a custom signal with the given name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_function">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Remove a specific function and its nodes from the script.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_node">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<description>
|
||||
Remove a specific node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_variable">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<description>
|
||||
Remove a variable with the given name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_custom_signal">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="new_name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="new_name" type="String" />
|
||||
<description>
|
||||
Change the name of a custom signal.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_function">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="new_name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="new_name" type="String" />
|
||||
<description>
|
||||
Change the name of a function.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_variable">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="new_name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="new_name" type="String" />
|
||||
<description>
|
||||
Change the name of a variable.
|
||||
</description>
|
||||
</method>
|
||||
<method name="sequence_connect">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_output" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_output" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<description>
|
||||
Connect two sequence ports. The execution will flow from of [code]from_node[/code]'s [code]from_output[/code] into [code]to_node[/code].
|
||||
Unlike [method data_connect], there isn't a [code]to_port[/code], since the target node can have only one sequence port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="sequence_disconnect">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="from_node" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="from_output" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="to_node" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="from_node" type="int" />
|
||||
<argument index="2" name="from_output" type="int" />
|
||||
<argument index="3" name="to_node" type="int" />
|
||||
<description>
|
||||
Disconnect two sequence ports previously connected with [method sequence_connect].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_function_scroll">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="ofs" type="Vector2">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="ofs" type="Vector2" />
|
||||
<description>
|
||||
Position the center of the screen for a function.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_instance_base_type">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="type" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="type" type="String" />
|
||||
<description>
|
||||
Set the base type of the script.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_node_position">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="func" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="position" type="Vector2">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="func" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<argument index="2" name="position" type="Vector2" />
|
||||
<description>
|
||||
Position a node on the screen.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_variable_default_value">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="Variant">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Change the default (initial) value of a variable.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_variable_export">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="enable" type="bool">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="enable" type="bool" />
|
||||
<description>
|
||||
Change whether a variable is exported.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_variable_info">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="Dictionary">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="value" type="Dictionary" />
|
||||
<description>
|
||||
Set a variable's info, using the same format as [method get_variable_info].
|
||||
</description>
|
||||
@@ -496,10 +361,8 @@
|
||||
</methods>
|
||||
<signals>
|
||||
<signal name="node_ports_changed">
|
||||
<argument index="0" name="function" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="function" type="String" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<description>
|
||||
Emitted when the ports of a node are changed.
|
||||
</description>
|
||||
|
||||
@@ -10,30 +10,24 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_constructor" qualifiers="const">
|
||||
<return type="Dictionary">
|
||||
</return>
|
||||
<return type="Dictionary" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_constructor_type" qualifiers="const">
|
||||
<return type="int" enum="Variant.Type">
|
||||
</return>
|
||||
<return type="int" enum="Variant.Type" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_constructor">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="constructor" type="Dictionary">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="constructor" type="Dictionary" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_constructor_type">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@@ -10,117 +10,94 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="_get_caption" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Return the node's title.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_category" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Return the node's category.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_input_value_port_count" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Return the count of input value ports.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_input_value_port_name" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified input port's name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_input_value_port_type" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified input port's type. See the [enum Variant.Type] values.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_sequence_port_count" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Return the amount of output [b]sequence[/b] ports.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_sequence_port_text" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified [b]sequence[/b] output's name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_value_port_count" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Return the amount of output value ports.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_value_port_name" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified output's name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_output_value_port_type" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Return the specified output's type. See the [enum Variant.Type] values.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_text" qualifiers="virtual">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Return the custom node's text, which is shown right next to the input [b]sequence[/b] port (if there is none, on the place that is usually taken by it).
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_working_memory_size" qualifiers="virtual">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Return the size of the custom node's working memory. See [method _step] for more details.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_has_input_sequence_port" qualifiers="virtual">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Return whether the custom node has an input [b]sequence[/b] port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_step" qualifiers="virtual">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="inputs" type="Array">
|
||||
</argument>
|
||||
<argument index="1" name="outputs" type="Array">
|
||||
</argument>
|
||||
<argument index="2" name="start_mode" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="working_mem" type="Array">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="inputs" type="Array" />
|
||||
<argument index="1" name="outputs" type="Array" />
|
||||
<argument index="2" name="start_mode" type="int" />
|
||||
<argument index="3" name="working_mem" type="Array" />
|
||||
<description>
|
||||
Execute the custom node's logic, returning the index of the output sequence port to use or a [String] when there is an error.
|
||||
The [code]inputs[/code] array contains the values of the input ports.
|
||||
|
||||
@@ -8,25 +8,18 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_custom_node">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="category" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="script" type="Script">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="category" type="String" />
|
||||
<argument index="2" name="script" type="Script" />
|
||||
<description>
|
||||
Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the [code]category[/code] as the parameter.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_custom_node">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="category" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="category" type="String" />
|
||||
<description>
|
||||
Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed.
|
||||
</description>
|
||||
|
||||
@@ -8,28 +8,21 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="connect_to_signal">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="obj" type="Object">
|
||||
</argument>
|
||||
<argument index="1" name="signals" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="args" type="Array">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="obj" type="Object" />
|
||||
<argument index="1" name="signals" type="String" />
|
||||
<argument index="2" name="args" type="Array" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_valid" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="resume">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="args" type="Array" default="null">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="args" type="Array" default="null" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@@ -10,82 +10,58 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_input_data_port">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<argument index="1" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="index" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_output_data_port">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<argument index="1" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="index" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="type" type="int" enum="Variant.Type" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_input_data_port">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_output_data_port">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_input_data_port_name">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_input_data_port_type">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_output_data_port_name">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="name" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_output_data_port_type">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="type" type="int" enum="Variant.Type" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@@ -10,35 +10,28 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_default_input_value" qualifiers="const">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="port_idx" type="int">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="port_idx" type="int" />
|
||||
<description>
|
||||
Returns the default value of a given port. The default value is used when nothing is connected to the port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_visual_script" qualifiers="const">
|
||||
<return type="VisualScript">
|
||||
</return>
|
||||
<return type="VisualScript" />
|
||||
<description>
|
||||
Returns the [VisualScript] instance the node is bound to.
|
||||
</description>
|
||||
</method>
|
||||
<method name="ports_changed_notify">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
Notify that the node's ports have changed. Usually used in conjunction with [VisualScriptCustomNode] .
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_default_input_value">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="port_idx" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="Variant">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="port_idx" type="int" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Change the default value of a given port.
|
||||
</description>
|
||||
|
||||
@@ -8,10 +8,8 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="_subcall" qualifiers="virtual">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="arguments" type="Variant">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="arguments" type="Variant" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@@ -12,17 +12,14 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_file">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the WebM video file handled by this [VideoStreamWebm].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_file">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="file" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="file" type="String" />
|
||||
<description>
|
||||
Sets the WebM video file that this [VideoStreamWebm] resource handles. The [code]file[/code] name should have the [code].webm[/code] extension.
|
||||
</description>
|
||||
|
||||
@@ -8,81 +8,70 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="close">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
Closes this data channel, notifying the other peer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_id" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the id assigned to this channel during creation (or auto-assigned during negotiation).
|
||||
If the channel is not negotiated out-of-band the id will only be available after the connection is established (will return [code]65535[/code] until then).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_label" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the label assigned to this channel during creation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_max_packet_life_time" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the [code]maxPacketLifeTime[/code] value assigned to this channel during creation.
|
||||
Will be [code]65535[/code] if not specified.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_max_retransmits" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the [code]maxRetransmits[/code] value assigned to this channel during creation.
|
||||
Will be [code]65535[/code] if not specified.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_protocol" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the sub-protocol assigned to this channel during creation. An empty string if not specified.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_ready_state" qualifiers="const">
|
||||
<return type="int" enum="WebRTCDataChannel.ChannelState">
|
||||
</return>
|
||||
<return type="int" enum="WebRTCDataChannel.ChannelState" />
|
||||
<description>
|
||||
Returns the current state of this channel, see [enum ChannelState].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_negotiated" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this channel was created with out-of-band configuration.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_ordered" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this channel was created with ordering enabled (default).
|
||||
</description>
|
||||
</method>
|
||||
<method name="poll">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
Reserved, but not used for now.
|
||||
</description>
|
||||
</method>
|
||||
<method name="was_string_packet" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the last received packet was transferred as text. See [member write_mode].
|
||||
</description>
|
||||
|
||||
@@ -12,58 +12,45 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_peer">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="peer" type="WebRTCPeerConnection">
|
||||
</argument>
|
||||
<argument index="1" name="peer_id" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="unreliable_lifetime" type="int" default="1">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="peer" type="WebRTCPeerConnection" />
|
||||
<argument index="1" name="peer_id" type="int" />
|
||||
<argument index="2" name="unreliable_lifetime" type="int" default="1" />
|
||||
<description>
|
||||
Add a new peer to the mesh with the given [code]peer_id[/code]. The [WebRTCPeerConnection] must be in state [constant WebRTCPeerConnection.STATE_NEW].
|
||||
Three channels will be created for reliable, unreliable, and ordered transport. The value of [code]unreliable_lifetime[/code] will be passed to the [code]maxPacketLifetime[/code] option when creating unreliable and ordered channels (see [method WebRTCPeerConnection.create_data_channel]).
|
||||
</description>
|
||||
</method>
|
||||
<method name="close">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
Close all the add peer connections and channels, freeing all resources.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_peer">
|
||||
<return type="Dictionary">
|
||||
</return>
|
||||
<argument index="0" name="peer_id" type="int">
|
||||
</argument>
|
||||
<return type="Dictionary" />
|
||||
<argument index="0" name="peer_id" type="int" />
|
||||
<description>
|
||||
Return a dictionary representation of the peer with given [code]peer_id[/code] with three keys. [code]connection[/code] containing the [WebRTCPeerConnection] to this peer, [code]channels[/code] an array of three [WebRTCDataChannel], and [code]connected[/code] a boolean representing if the peer connection is currently connected (all three channels are open).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_peers">
|
||||
<return type="Dictionary">
|
||||
</return>
|
||||
<return type="Dictionary" />
|
||||
<description>
|
||||
Returns a dictionary which keys are the peer ids and values the peer representation as in [method get_peer].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_peer">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="peer_id" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="peer_id" type="int" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the given [code]peer_id[/code] is in the peers map (it might not be connected though).
|
||||
</description>
|
||||
</method>
|
||||
<method name="initialize">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="peer_id" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="server_compatibility" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="peer_id" type="int" />
|
||||
<argument index="1" name="server_compatibility" type="bool" default="false" />
|
||||
<description>
|
||||
Initialize the multiplayer peer with the given [code]peer_id[/code] (must be between 1 and 2147483647).
|
||||
If [code]server_compatibilty[/code] is [code]false[/code] (default), the multiplayer peer will be immediately in state [constant NetworkedMultiplayerPeer.CONNECTION_CONNECTED] and [signal NetworkedMultiplayerPeer.connection_succeeded] will not be emitted.
|
||||
@@ -71,10 +58,8 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_peer">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="peer_id" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="peer_id" type="int" />
|
||||
<description>
|
||||
Remove the peer with given [code]peer_id[/code] from the mesh. If the peer was connected, and [signal NetworkedMultiplayerPeer.peer_connected] was emitted for it, then [signal NetworkedMultiplayerPeer.peer_disconnected] will be emitted.
|
||||
</description>
|
||||
|
||||
@@ -15,33 +15,25 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_ice_candidate">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="media" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="index" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="name" type="String">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="media" type="String" />
|
||||
<argument index="1" name="index" type="int" />
|
||||
<argument index="2" name="name" type="String" />
|
||||
<description>
|
||||
Add an ice candidate generated by a remote peer (and received over the signaling server). See [signal ice_candidate_created].
|
||||
</description>
|
||||
</method>
|
||||
<method name="close">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
Close the peer connection and all data channels associated with it. Note, you cannot reuse this object for a new connection unless you call [method initialize].
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_data_channel">
|
||||
<return type="WebRTCDataChannel">
|
||||
</return>
|
||||
<argument index="0" name="label" type="String">
|
||||
</argument>
|
||||
<return type="WebRTCDataChannel" />
|
||||
<argument index="0" name="label" type="String" />
|
||||
<argument index="1" name="options" type="Dictionary" default="{
|
||||
}">
|
||||
</argument>
|
||||
}" />
|
||||
<description>
|
||||
Returns a new [WebRTCDataChannel] (or [code]null[/code] on failure) with given [code]label[/code] and optionally configured via the [code]options[/code] dictionary. This method can only be called when the connection is in state [constant STATE_NEW].
|
||||
There are two ways to create a working data channel: either call [method create_data_channel] on only one of the peer and listen to [signal data_channel_received] on the other, or call [method create_data_channel] on both peers, with the same values, and the [code]negotiated[/code] option set to [code]true[/code].
|
||||
@@ -63,26 +55,22 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_offer">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
Creates a new SDP offer to start a WebRTC connection with a remote peer. At least one [WebRTCDataChannel] must have been created before calling this method.
|
||||
If this functions returns [constant OK], [signal session_description_created] will be called when the session is ready to be sent.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_connection_state" qualifiers="const">
|
||||
<return type="int" enum="WebRTCPeerConnection.ConnectionState">
|
||||
</return>
|
||||
<return type="int" enum="WebRTCPeerConnection.ConnectionState" />
|
||||
<description>
|
||||
Returns the connection state. See [enum ConnectionState].
|
||||
</description>
|
||||
</method>
|
||||
<method name="initialize">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="configuration" type="Dictionary" default="{
|
||||
}">
|
||||
</argument>
|
||||
}" />
|
||||
<description>
|
||||
Re-initialize this peer connection, closing any previously active connection, and going back to state [constant STATE_NEW]. A dictionary of [code]options[/code] can be passed to configure the peer connection.
|
||||
Valid [code]options[/code] are:
|
||||
@@ -103,31 +91,24 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="poll">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
Call this method frequently (e.g. in [method Node._process] or [method Node._physics_process]) to properly receive signals.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_local_description">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="type" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="sdp" type="String">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="type" type="String" />
|
||||
<argument index="1" name="sdp" type="String" />
|
||||
<description>
|
||||
Sets the SDP description of the local peer. This should be called in response to [signal session_description_created].
|
||||
After calling this function the peer will start emitting [signal ice_candidate_created] (unless an [enum Error] different from [constant OK] is returned).
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_remote_description">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="type" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="sdp" type="String">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="type" type="String" />
|
||||
<argument index="1" name="sdp" type="String" />
|
||||
<description>
|
||||
Sets the SDP description of the remote peer. This should be called with the values generated by a remote peer and received over the signaling server.
|
||||
If [code]type[/code] is [code]offer[/code] the peer will emit [signal session_description_created] with the appropriate answer.
|
||||
@@ -137,29 +118,23 @@
|
||||
</methods>
|
||||
<signals>
|
||||
<signal name="data_channel_received">
|
||||
<argument index="0" name="channel" type="Object">
|
||||
</argument>
|
||||
<argument index="0" name="channel" type="Object" />
|
||||
<description>
|
||||
Emitted when a new in-band channel is received, i.e. when the channel was created with [code]negotiated: false[/code] (default).
|
||||
The object will be an instance of [WebRTCDataChannel]. You must keep a reference of it or it will be closed automatically. See [method create_data_channel].
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="ice_candidate_created">
|
||||
<argument index="0" name="media" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="index" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="name" type="String">
|
||||
</argument>
|
||||
<argument index="0" name="media" type="String" />
|
||||
<argument index="1" name="index" type="int" />
|
||||
<argument index="2" name="name" type="String" />
|
||||
<description>
|
||||
Emitted when a new ICE candidate has been created. The three parameters are meant to be passed to the remote peer over the signaling server.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="session_description_created">
|
||||
<argument index="0" name="type" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="sdp" type="String">
|
||||
</argument>
|
||||
<argument index="0" name="type" type="String" />
|
||||
<argument index="1" name="sdp" type="String" />
|
||||
<description>
|
||||
Emitted after a successful call to [method create_offer] or [method set_remote_description] (when it generates an answer). The parameters are meant to be passed to [method set_local_description] on this object, and sent to the remote peer over the signaling server.
|
||||
</description>
|
||||
|
||||
@@ -13,16 +13,11 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="connect_to_url">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="url" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="protocols" type="PoolStringArray" default="PoolStringArray( )">
|
||||
</argument>
|
||||
<argument index="2" name="gd_mp_api" type="bool" default="false">
|
||||
</argument>
|
||||
<argument index="3" name="custom_headers" type="PoolStringArray" default="PoolStringArray( )">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="url" type="String" />
|
||||
<argument index="1" name="protocols" type="PoolStringArray" default="PoolStringArray( )" />
|
||||
<argument index="2" name="gd_mp_api" type="bool" default="false" />
|
||||
<argument index="3" name="custom_headers" type="PoolStringArray" default="PoolStringArray( )" />
|
||||
<description>
|
||||
Connects to the given URL requesting one of the given [code]protocols[/code] as sub-protocol. If the list empty (default), no sub-protocol will be requested.
|
||||
If [code]true[/code] is passed as [code]gd_mp_api[/code], the client will behave like a network peer for the [MultiplayerAPI], connections to non-Godot servers will not work, and [signal data_received] will not be emitted.
|
||||
@@ -33,26 +28,21 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="disconnect_from_host">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="code" type="int" default="1000">
|
||||
</argument>
|
||||
<argument index="1" name="reason" type="String" default="""">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="code" type="int" default="1000" />
|
||||
<argument index="1" name="reason" type="String" default="""" />
|
||||
<description>
|
||||
Disconnects this client from the connected host. See [method WebSocketPeer.close] for more information.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_connected_host" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Return the IP address of the currently connected host.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_connected_port" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Return the IP port of the currently connected host.
|
||||
</description>
|
||||
@@ -70,8 +60,7 @@
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="connection_closed">
|
||||
<argument index="0" name="was_clean_close" type="bool">
|
||||
</argument>
|
||||
<argument index="0" name="was_clean_close" type="bool" />
|
||||
<description>
|
||||
Emitted when the connection to the server is closed. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly.
|
||||
</description>
|
||||
@@ -82,8 +71,7 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="connection_established">
|
||||
<argument index="0" name="protocol" type="String">
|
||||
</argument>
|
||||
<argument index="0" name="protocol" type="String" />
|
||||
<description>
|
||||
Emitted when a connection with the server is established, [code]protocol[/code] will contain the sub-protocol agreed with the server.
|
||||
</description>
|
||||
@@ -95,10 +83,8 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="server_close_request">
|
||||
<argument index="0" name="code" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="reason" type="String">
|
||||
</argument>
|
||||
<argument index="0" name="code" type="int" />
|
||||
<argument index="1" name="reason" type="String" />
|
||||
<description>
|
||||
Emitted when the server requests a clean close. You should keep polling until you get a [signal connection_closed] signal to achieve the clean close. See [method WebSocketPeer.close] for more details.
|
||||
</description>
|
||||
|
||||
@@ -10,25 +10,18 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_peer" qualifiers="const">
|
||||
<return type="WebSocketPeer">
|
||||
</return>
|
||||
<argument index="0" name="peer_id" type="int">
|
||||
</argument>
|
||||
<return type="WebSocketPeer" />
|
||||
<argument index="0" name="peer_id" type="int" />
|
||||
<description>
|
||||
Returns the [WebSocketPeer] associated to the given [code]peer_id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_buffers">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="input_buffer_size_kb" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="input_max_packets" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="output_buffer_size_kb" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="output_max_packets" type="int">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="input_buffer_size_kb" type="int" />
|
||||
<argument index="1" name="input_max_packets" type="int" />
|
||||
<argument index="2" name="output_buffer_size_kb" type="int" />
|
||||
<argument index="3" name="output_max_packets" type="int" />
|
||||
<description>
|
||||
Configures the buffer sizes for this WebSocket peer. Default values can be specified in the Project Settings under [code]network/limits[/code]. For server, values are meant per connected peer.
|
||||
The first two parameters define the size and queued packets limits of the input buffer, the last two of the output buffer.
|
||||
@@ -43,8 +36,7 @@
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="peer_packet">
|
||||
<argument index="0" name="peer_source" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="peer_source" type="int" />
|
||||
<description>
|
||||
Emitted when a packet is received from a peer.
|
||||
[b]Note:[/b] This signal is only emitted when the client or server is configured to use Godot multiplayer API.
|
||||
|
||||
@@ -11,12 +11,9 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="close">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="code" type="int" default="1000">
|
||||
</argument>
|
||||
<argument index="1" name="reason" type="String" default="""">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="code" type="int" default="1000" />
|
||||
<argument index="1" name="reason" type="String" default="""" />
|
||||
<description>
|
||||
Closes this WebSocket connection. [code]code[/code] is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). [code]reason[/code] is the human readable reason for closing the connection (can be any UTF-8 string that's smaller than 123 bytes).
|
||||
[b]Note:[/b] To achieve a clean close, you will need to keep polling until either [signal WebSocketClient.connection_closed] or [signal WebSocketServer.client_disconnected] is received.
|
||||
@@ -24,64 +21,54 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_connected_host" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the IP address of the connected peer.
|
||||
[b]Note:[/b] Not available in the HTML5 export.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_connected_port" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the remote port of the connected peer.
|
||||
[b]Note:[/b] Not available in the HTML5 export.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_current_outbound_buffered_amount" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the current amount of data in the outbound websocket buffer. [b]Note:[/b] HTML5 exports use WebSocket.bufferedAmount, while other platforms use an internal buffer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_write_mode" qualifiers="const">
|
||||
<return type="int" enum="WebSocketPeer.WriteMode">
|
||||
</return>
|
||||
<return type="int" enum="WebSocketPeer.WriteMode" />
|
||||
<description>
|
||||
Gets the current selected write mode. See [enum WriteMode].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_connected_to_host" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this peer is currently connected.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_no_delay">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="enabled" type="bool">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="enabled" type="bool" />
|
||||
<description>
|
||||
Disable Nagle's algorithm on the underling TCP socket (default). See [method StreamPeerTCP.set_no_delay] for more information.
|
||||
[b]Note:[/b] Not available in the HTML5 export.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_write_mode">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode" />
|
||||
<description>
|
||||
Sets the socket to use the given [enum WriteMode].
|
||||
</description>
|
||||
</method>
|
||||
<method name="was_string_packet" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the last received packet was sent as a text payload. See [enum WriteMode].
|
||||
</description>
|
||||
|
||||
@@ -12,61 +12,46 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="disconnect_peer">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="code" type="int" default="1000">
|
||||
</argument>
|
||||
<argument index="2" name="reason" type="String" default="""">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<argument index="1" name="code" type="int" default="1000" />
|
||||
<argument index="2" name="reason" type="String" default="""" />
|
||||
<description>
|
||||
Disconnects the peer identified by [code]id[/code] from the server. See [method WebSocketPeer.close] for more information.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_peer_address" qualifiers="const">
|
||||
<return type="String">
|
||||
</return>
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<return type="String" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
Returns the IP address of the given peer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_peer_port" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
Returns the remote port of the given peer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_peer" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
Returns [code]true[/code] if a peer with the given ID is connected.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_listening" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the server is actively listening on a port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="listen">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="port" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="protocols" type="PoolStringArray" default="PoolStringArray( )">
|
||||
</argument>
|
||||
<argument index="2" name="gd_mp_api" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="port" type="int" />
|
||||
<argument index="1" name="protocols" type="PoolStringArray" default="PoolStringArray( )" />
|
||||
<argument index="2" name="gd_mp_api" type="bool" default="false" />
|
||||
<description>
|
||||
Starts listening on the given port.
|
||||
You can specify the desired subprotocols via the "protocols" array. If the list empty (default), no sub-protocol will be requested.
|
||||
@@ -75,8 +60,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="stop">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
Stops the server and clear its state.
|
||||
</description>
|
||||
@@ -98,37 +82,29 @@
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="client_close_request">
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="code" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="reason" type="String">
|
||||
</argument>
|
||||
<argument index="0" name="id" type="int" />
|
||||
<argument index="1" name="code" type="int" />
|
||||
<argument index="2" name="reason" type="String" />
|
||||
<description>
|
||||
Emitted when a client requests a clean close. You should keep polling until you get a [signal client_disconnected] signal with the same [code]id[/code] to achieve the clean close. See [method WebSocketPeer.close] for more details.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="client_connected">
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="protocol" type="String">
|
||||
</argument>
|
||||
<argument index="0" name="id" type="int" />
|
||||
<argument index="1" name="protocol" type="String" />
|
||||
<description>
|
||||
Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="client_disconnected">
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="was_clean_close" type="bool">
|
||||
</argument>
|
||||
<argument index="0" name="id" type="int" />
|
||||
<argument index="1" name="was_clean_close" type="bool" />
|
||||
<description>
|
||||
Emitted when a client disconnects. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="data_received">
|
||||
<argument index="0" name="id" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
Emitted when a new message is received.
|
||||
[b]Note:[/b] This signal is [i]not[/i] emitted when used as high-level multiplayer peer.
|
||||
|
||||
@@ -95,10 +95,8 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="get_controller" qualifiers="const">
|
||||
<return type="ARVRPositionalTracker">
|
||||
</return>
|
||||
<argument index="0" name="controller_id" type="int">
|
||||
</argument>
|
||||
<return type="ARVRPositionalTracker" />
|
||||
<argument index="0" name="controller_id" type="int" />
|
||||
<description>
|
||||
Gets an [ARVRPositionalTracker] for the given [code]controller_id[/code].
|
||||
In the context of WebXR, a "controller" can be an advanced VR controller like the Oculus Touch or Index controllers, or even a tap on the screen, a spoken voice command or a button press on the device itself. When a non-traditional controller is used, interpret the position and orientation of the [ARVRPositionalTracker] as a ray pointing at the object the user wishes to interact with.
|
||||
@@ -112,10 +110,8 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_session_supported">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="session_mode" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="session_mode" type="String" />
|
||||
<description>
|
||||
Checks if the given [code]session_mode[/code] is supported by the user's browser.
|
||||
Possible values come from [url=https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode]WebXR's XRSessionMode[/url], including: [code]"immersive-vr"[/code], [code]"immersive-ar"[/code], and [code]"inline"[/code].
|
||||
@@ -170,24 +166,21 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="select">
|
||||
<argument index="0" name="controller_id" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="controller_id" type="int" />
|
||||
<description>
|
||||
Emitted after one of the "controllers" has finished its "primary action".
|
||||
Use [method get_controller] to get more information about the controller.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="selectend">
|
||||
<argument index="0" name="controller_id" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="controller_id" type="int" />
|
||||
<description>
|
||||
Emitted when one of the "controllers" has finished its "primary action".
|
||||
Use [method get_controller] to get more information about the controller.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="selectstart">
|
||||
<argument index="0" name="controller_id" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="controller_id" type="int" />
|
||||
<description>
|
||||
Emitted when one of the "controllers" has started its "primary action".
|
||||
Use [method get_controller] to get more information about the controller.
|
||||
@@ -200,8 +193,7 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="session_failed">
|
||||
<argument index="0" name="message" type="String">
|
||||
</argument>
|
||||
<argument index="0" name="message" type="String" />
|
||||
<description>
|
||||
Emitted by [method ARVRInterface.initialize] if the session fails to start.
|
||||
[code]message[/code] may optionally contain an error message from WebXR, or an empty string if no message is available.
|
||||
@@ -214,33 +206,28 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="session_supported">
|
||||
<argument index="0" name="session_mode" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="supported" type="bool">
|
||||
</argument>
|
||||
<argument index="0" name="session_mode" type="String" />
|
||||
<argument index="1" name="supported" type="bool" />
|
||||
<description>
|
||||
Emitted by [method is_session_supported] to indicate if the given [code]session_mode[/code] is supported or not.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="squeeze">
|
||||
<argument index="0" name="controller_id" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="controller_id" type="int" />
|
||||
<description>
|
||||
Emitted after one of the "controllers" has finished its "primary squeeze action".
|
||||
Use [method get_controller] to get more information about the controller.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="squeezeend">
|
||||
<argument index="0" name="controller_id" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="controller_id" type="int" />
|
||||
<description>
|
||||
Emitted when one of the "controllers" has finished its "primary squeeze action".
|
||||
Use [method get_controller] to get more information about the controller.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="squeezestart">
|
||||
<argument index="0" name="controller_id" type="int">
|
||||
</argument>
|
||||
<argument index="0" name="controller_id" type="int" />
|
||||
<description>
|
||||
Emitted when one of the "controllers" has started its "primary squeeze action".
|
||||
Use [method get_controller] to get more information about the controller.
|
||||
|
||||
Reference in New Issue
Block a user