From 7adf4cc9b5de6701a41e27690a69b9892d5eed85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 30 Jul 2021 15:28:05 +0200 Subject: 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. --- modules/csg/doc_classes/CSGShape3D.xml | 36 +- modules/enet/doc_classes/ENetConnection.xml | 138 +++----- modules/enet/doc_classes/ENetMultiplayerPeer.xml | 72 ++-- modules/enet/doc_classes/ENetPacketPeer.xml | 81 ++--- modules/gdnative/doc_classes/GDNative.xml | 18 +- modules/gdnative/doc_classes/GDNativeLibrary.xml | 6 +- modules/gdnative/doc_classes/NativeScript.xml | 24 +- modules/gdnative/doc_classes/PluginScript.xml | 3 +- .../gdnative/doc_classes/VideoStreamGDNative.xml | 9 +- modules/gdscript/doc_classes/@GDScript.xml | 90 ++--- modules/gdscript/doc_classes/GDScript.xml | 6 +- modules/gltf/doc_classes/GLTFSkeleton.xml | 30 +- modules/gltf/doc_classes/GLTFSkin.xml | 27 +- modules/gltf/doc_classes/GLTFState.xml | 153 +++------ modules/gltf/doc_classes/PackedSceneGLTF.xml | 45 +-- modules/gridmap/doc_classes/GridMap.xml | 120 +++---- .../opensimplex/doc_classes/OpenSimplexNoise.xml | 72 ++-- modules/regex/doc_classes/RegEx.xml | 63 ++-- modules/regex/doc_classes/RegExMatch.xml | 21 +- modules/theora/doc_classes/VideoStreamTheora.xml | 9 +- modules/upnp/doc_classes/UPNP.xml | 78 ++--- modules/upnp/doc_classes/UPNPDevice.xml | 33 +- modules/visual_script/doc_classes/VisualScript.xml | 369 +++++++-------------- .../doc_classes/VisualScriptConstructor.xml | 18 +- .../doc_classes/VisualScriptCustomNode.xml | 93 ++---- .../doc_classes/VisualScriptEditor.xml | 21 +- .../doc_classes/VisualScriptFunctionState.xml | 21 +- .../doc_classes/VisualScriptLists.xml | 72 ++-- .../visual_script/doc_classes/VisualScriptNode.xml | 21 +- .../doc_classes/VisualScriptSubCall.xml | 6 +- modules/webm/doc_classes/VideoStreamWebm.xml | 9 +- modules/webrtc/doc_classes/WebRTCDataChannel.xml | 36 +- .../webrtc/doc_classes/WebRTCMultiplayerPeer.xml | 45 +-- .../webrtc/doc_classes/WebRTCPeerConnection.xml | 75 ++--- modules/websocket/doc_classes/WebSocketClient.xml | 42 +-- .../doc_classes/WebSocketMultiplayerPeer.xml | 24 +- modules/websocket/doc_classes/WebSocketPeer.xml | 36 +- modules/websocket/doc_classes/WebSocketServer.xml | 75 ++--- modules/webxr/doc_classes/WebXRInterface.xml | 39 +-- 39 files changed, 712 insertions(+), 1424 deletions(-) (limited to 'modules') diff --git a/modules/csg/doc_classes/CSGShape3D.xml b/modules/csg/doc_classes/CSGShape3D.xml index 01ec46e707..f42ce8c379 100644 --- a/modules/csg/doc_classes/CSGShape3D.xml +++ b/modules/csg/doc_classes/CSGShape3D.xml @@ -10,55 +10,43 @@ - - - - + + Returns an individual bit on the collision mask. - - - - + + Returns an individual bit on the collision mask. - - + Returns an [Array] with two elements, the first is the [Transform3D] of this node and the second is the root [Mesh] of this node. Only works when this node is the root shape. - - + Returns [code]true[/code] if this is a root shape and is thus the object that is rendered. - - - - - - + + + Sets individual bits on the layer mask. Use this if you only need to change one layer's value. - - - - - - + + + Sets individual bits on the collision mask. Use this if you only need to change one layer's value. diff --git a/modules/enet/doc_classes/ENetConnection.xml b/modules/enet/doc_classes/ENetConnection.xml index 523f2ad165..c2a85ffdf8 100644 --- a/modules/enet/doc_classes/ENetConnection.xml +++ b/modules/enet/doc_classes/ENetConnection.xml @@ -11,182 +11,136 @@ - - - - - - + + + Adjusts the bandwidth limits of a host. - - - - - - - - + + + + Queues a [code]packet[/code] to be sent to all peers associated with the host over the specified [code]channel[/code]. See [ENetPacketPeer] [code]FLAG_*[/code] constants for available packet flags. - - - - + + Limits the maximum allowed channels of future incoming connections. - - - - + + Sets the compression method used for network packets. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. [b]Note:[/b] Most games' network design involve sending many small packets frequently (smaller than 4 KB each). If in doubt, it is recommended to keep the default compression algorithm as it works best on these small packets. - - - - - - - - - - + + + + + Initiates a connection to a foreign [code]address[/code] using the specified [code]port[/code] and allocting the requested [code]channels[/code]. Optional [code]data[/code] can be passed during connection in the form of a 32 bit integer. Note: You must call either [method create_host] or [method create_host_bound] before calling this method. - - - - - - - - - - + + + + + Create an ENetHost that will allow up to [code]max_peers[/code] connected peers, each allocating up to [code]max_channels[/code] channels, optionally limiting bandwith to [code]in_bandwidth[/code] and [code]out_bandwidth[/code]. - - - - - - - - - - - - - - + + + + + + + Create an ENetHost like [method create_host] which is also bound to the given [code]bind_address[/code] and [code]bind_port[/code]. - - + Destroys the host and all resources associated with it. - - - - - - - - + + + + Configure this ENetHost to use the custom Godot extension allowing DTLS encryption for ENet clients. Call this before [method connect_to_host] to have ENet connect using DTLS with [code]certificate[/code] and [code]hostname[/code] verification. Verification can be optionally turned off via the [code]verify[/code] parameter. - - - - - - + + + Configure this ENetHost to use the custom Godot extension allowing DTLS encryption for ENet servers. Call this right after [method create_host_bound] to have ENet expect peers to connect using DTLS. - - + Sends any queued packets on the host specified to its designated peers. - - + Returns the local port to which this peer is bound. - - + Returns the maximum number of channels allowed for connected peers. - - + Returns the list of peers associated with this host. Note: This list might include some peers that are not fully connected or are still being disconnected. - - - - + + Returns and resets host statistics. See [enum HostStatistic] for more info. - - - - + + Configures the DTLS server to automatically drop new connections. Note: This method is only relevant after calling [method dtls_server_setup]. - - - - + + Waits for events on the host specified and shuttles packets between the host and its peers. The returned [Array] will have 4 elements. An [enum EventType], the [ENetPacketPeer] which generated the event, the event associated data (if any), the event associated channel (if any). If the generated event is [constant EVENT_RECEIVE], the received packet will be queued to the associated [ENetPacketPeer]. Call this function regularly to handle connections, disconnections, and to receive new packets. diff --git a/modules/enet/doc_classes/ENetMultiplayerPeer.xml b/modules/enet/doc_classes/ENetMultiplayerPeer.xml index 574010a4a2..3a37b396a4 100644 --- a/modules/enet/doc_classes/ENetMultiplayerPeer.xml +++ b/modules/enet/doc_classes/ENetMultiplayerPeer.xml @@ -13,85 +13,61 @@ - - - - - - + + + Add a new remote peer with the given [code]peer_id[/code] connected to the given [code]host[/code]. Note: The [code]host[/code] must have exactly one peer in the [constant ENetPacketPeer.STATE_CONNECTED] state. - - - - + + 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. - - - - - - - - - - - - - - + + + + + + + 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]channel_count[/code] parameter can be used to specify the number of ENet channels allocated for the connection. 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 ENetMultiplayerPeer 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]local_port[/code] is specified, the client will also listen to the given port; this is useful for some NAT traversal techniques. - - - - + + Initialize this [MultiplayerPeer] in mesh mode. The provided [code]unique_id[/code] will be used as the local peer network unique ID once assigned as the [member MultiplayerAPI.network_peer]. In the mesh configuration you will need to set up each new peer manually using [ENetConnection] before calling [method add_mesh_peer]. While this technique is more advanced, it allows for better control over the connection process (e.g. when dealing with NAT punch-through) and for better distribution of the network load (which would otherwise be more taxing on the server). - - - - - - - - - - - - + + + + + + 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 ENetMultiplayerPeer 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. - - - - + + Return the [ENetPacketPeer] associated to the given [code]id[/code]. - - - - + + 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]. diff --git a/modules/enet/doc_classes/ENetPacketPeer.xml b/modules/enet/doc_classes/ENetPacketPeer.xml index 5c9f692974..8f0693fb01 100644 --- a/modules/enet/doc_classes/ENetPacketPeer.xml +++ b/modules/enet/doc_classes/ENetPacketPeer.xml @@ -12,121 +12,94 @@ - - + Returns the number of channels allocated for communication with peer. - - + Returns the current peer state. See [enum PeerState]. - - - - + + Returns the requested [code]statistic[/code] for this peer. See [enum PeerStatistic]. - - + Returns [code]true[/code] if the peer is currently active (i.e. the associated [ENetConnection] is still valid). - - - - + + Request a disconnection from a peer. An [constant ENetConnection.EVENT_DISCONNECT] will be generated during [method ENetConnection.service] once the disconnection is complete. - - - - + + Request a disconnection from a peer, but only after all queued outgoing packets are sent. An [constant ENetConnection.EVENT_DISCONNECT] will be generated during [method ENetConnection.service] once the disconnection is complete. - - - - + + Force an immediate disconnection from a peer. No [constant ENetConnection.EVENT_DISCONNECT] will be generated. The foreign peer is not guaranteed to receive the disconnect notification, and is reset immediately upon return from this function. - - + Sends a ping request to a peer. ENet automatically pings all connected peers at regular intervals, however, this function may be called to ensure more frequent ping requests. - - - - + + Sets the [code]ping_interval[/code] in milliseconds at which pings will be sent to a peer. Pings are used both to monitor the liveness of the connection and also to dynamically adjust the throttle during periods of low traffic so that the throttle has reasonable responsiveness during traffic spikes. - - + Forcefully disconnects a peer. The foreign host represented by the peer is not notified of the disconnection and will timeout on its connection to the local host. - - - - - - - - + + + + Queues a [code]packet[/code] to be sent over the specified [code]channel[/code]. See [code]FLAG_*[/code] constants for available packet flags. - - - - - - - - + + + + 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. - - - - - - - - + + + + Configures throttle parameter for a peer. Unreliable packets are dropped by ENet in response to the varying conditions of the Internet connection to the peer. The throttle represents a probability that an unreliable packet should not be dropped and thus sent by ENet to the peer. By measuring fluctuations in round trip times of reliable packets over the specified [code]interval[/code], ENet will either increase the probably by the amount specified in the [code]acceleration[/code] parameter, or decrease it by the amount specified in the [code]deceleration[/code] parameter (both are ratios to [constant PACKET_THROTTLE_SCALE]). diff --git a/modules/gdnative/doc_classes/GDNative.xml b/modules/gdnative/doc_classes/GDNative.xml index 4f1530598c..e4c5d34a2c 100644 --- a/modules/gdnative/doc_classes/GDNative.xml +++ b/modules/gdnative/doc_classes/GDNative.xml @@ -8,26 +8,20 @@ - - - - - - - - + + + + - - + - - + diff --git a/modules/gdnative/doc_classes/GDNativeLibrary.xml b/modules/gdnative/doc_classes/GDNativeLibrary.xml index 05cda05f9f..f84d4e60f3 100644 --- a/modules/gdnative/doc_classes/GDNativeLibrary.xml +++ b/modules/gdnative/doc_classes/GDNativeLibrary.xml @@ -12,15 +12,13 @@ - - + Returns paths to all dependency libraries for the current platform and architecture. - - + Returns the path to the dynamic library file for the current platform and architecture. diff --git a/modules/gdnative/doc_classes/NativeScript.xml b/modules/gdnative/doc_classes/NativeScript.xml index f2e9cac6dc..397d12a3a9 100644 --- a/modules/gdnative/doc_classes/NativeScript.xml +++ b/modules/gdnative/doc_classes/NativeScript.xml @@ -8,42 +8,34 @@ - - + Returns the documentation string that was previously set with [code]godot_nativescript_set_class_documentation[/code]. - - - - + + Returns the documentation string that was previously set with [code]godot_nativescript_set_method_documentation[/code]. - - - - + + Returns the documentation string that was previously set with [code]godot_nativescript_set_property_documentation[/code]. - - - - + + Returns the documentation string that was previously set with [code]godot_nativescript_set_signal_documentation[/code]. - - + 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. diff --git a/modules/gdnative/doc_classes/PluginScript.xml b/modules/gdnative/doc_classes/PluginScript.xml index 9616101090..8e28187482 100644 --- a/modules/gdnative/doc_classes/PluginScript.xml +++ b/modules/gdnative/doc_classes/PluginScript.xml @@ -8,8 +8,7 @@ - - + Returns a new instance of the script. diff --git a/modules/gdnative/doc_classes/VideoStreamGDNative.xml b/modules/gdnative/doc_classes/VideoStreamGDNative.xml index 153988bad8..8b1a3210df 100644 --- a/modules/gdnative/doc_classes/VideoStreamGDNative.xml +++ b/modules/gdnative/doc_classes/VideoStreamGDNative.xml @@ -11,17 +11,14 @@ - - + Returns the video file handled by this [VideoStreamGDNative]. - - - - + + Sets the video file that this [VideoStreamGDNative] resource handles. The supported extensions depend on the GDNative plugins used to expose video formats. diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index e68deb070d..51b3452a3a 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -11,16 +11,11 @@ - - - - - - - - - - + + + + + Returns a color constructed from integer red, green, blue, and alpha channels. Each channel should have 8 bits of information ranging from 0 to 255. [code]r8[/code] red channel @@ -33,12 +28,9 @@ - - - - - - + + + Asserts that the [code]condition[/code] is [code]true[/code]. If the [code]condition[/code] is [code]false[/code], an error is generated. When running from the editor, the running project will also be paused until you resume it. This can be used as a stronger form of [method @GlobalScope.push_error] for reporting errors to project developers or add-on users. [b]Note:[/b] For performance reasons, the code inside [method assert] is only executed in debug builds or when running the project from the editor. Don't include code that has side effects in an [method assert] call. Otherwise, the project will behave differently when exported in release mode. @@ -54,10 +46,8 @@ - - - - + + Returns a character as a String of the given Unicode code point (which is compatible with ASCII code). [codeblock] @@ -68,12 +58,9 @@ - - - - - - + + + Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the [enum Variant.Type] values. [codeblock] @@ -87,17 +74,14 @@ - - - - + + Converts a dictionary (previously created with [method inst2dict]) back to an instance. Useful for deserializing. - - + Returns an array of dictionaries representing the current call stack. [codeblock] @@ -117,10 +101,8 @@ - - - - + + Returns the passed instance converted to a dictionary (useful for serializing). [codeblock] @@ -138,10 +120,8 @@ - - - - + + Returns length of Variant [code]var[/code]. Length is the character count of String, element count of Array, size of Dictionary, etc. [b]Note:[/b] Generates a fatal error if Variant can not provide a length. @@ -152,10 +132,8 @@ - - - - + + Loads a resource from the filesystem located at [code]path[/code]. The resource is loaded on the method call (unless it's referenced already elsewhere, e.g. in another script or in the scene), which might cause slight delay, especially when loading scenes. To avoid unnecessary delays when loading something multiple times, either store the resource in a variable or use [method preload]. [b]Note:[/b] Resource paths can be obtained by right-clicking on a resource in the FileSystem dock and choosing "Copy Path" or by dragging the file from the FileSystem dock into the script. @@ -168,10 +146,8 @@ - - - - + + Returns a [Resource] from the filesystem located at [code]path[/code]. The resource is loaded during script parsing, i.e. is loaded with the script and [method preload] effectively acts as a reference to that resource. Note that the method requires a constant path. If you want to load a resource from a dynamic/variable path, use [method load]. [b]Note:[/b] Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path" or by dragging the file from the FileSystem dock into the script. @@ -182,15 +158,13 @@ - - + Like [method @GlobalScope.print], but prints only when used in debug mode. - - + Prints a stack track at code location, only works when running with debugger turned on. Output in the console would look something like this: @@ -200,8 +174,7 @@ - - + Returns an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). [codeblock] @@ -218,8 +191,7 @@ - - + Converts one or more arguments to string in the best way possible. [codeblock] @@ -231,10 +203,8 @@ - - - - + + diff --git a/modules/gdscript/doc_classes/GDScript.xml b/modules/gdscript/doc_classes/GDScript.xml index 631a102130..72738f027a 100644 --- a/modules/gdscript/doc_classes/GDScript.xml +++ b/modules/gdscript/doc_classes/GDScript.xml @@ -12,15 +12,13 @@ - - + Returns byte code for the script source code. - - + Returns a new instance of the script. For example: diff --git a/modules/gltf/doc_classes/GLTFSkeleton.xml b/modules/gltf/doc_classes/GLTFSkeleton.xml index 40563c9ac6..6e83cec252 100644 --- a/modules/gltf/doc_classes/GLTFSkeleton.xml +++ b/modules/gltf/doc_classes/GLTFSkeleton.xml @@ -8,50 +8,40 @@ - - - - + + - - + - - + - - + - - + - - - - + + - - - - + + diff --git a/modules/gltf/doc_classes/GLTFSkin.xml b/modules/gltf/doc_classes/GLTFSkin.xml index e20e127e52..107ca960cd 100644 --- a/modules/gltf/doc_classes/GLTFSkin.xml +++ b/modules/gltf/doc_classes/GLTFSkin.xml @@ -8,44 +8,35 @@ - - + - - + - - + - - - - + + - - - - + + - - - - + + diff --git a/modules/gltf/doc_classes/GLTFState.xml b/modules/gltf/doc_classes/GLTFState.xml index a7b5b7b43e..ae976fc04c 100644 --- a/modules/gltf/doc_classes/GLTFState.xml +++ b/modules/gltf/doc_classes/GLTFState.xml @@ -8,236 +8,185 @@ - - + - - - - + + - - - - + + - - + - - + - - + - - + - - + - - + - - + - - + - - - - + + - - + - - + - - + - - + - - + - - + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + diff --git a/modules/gltf/doc_classes/PackedSceneGLTF.xml b/modules/gltf/doc_classes/PackedSceneGLTF.xml index a22111e9b7..d0136c6402 100644 --- a/modules/gltf/doc_classes/PackedSceneGLTF.xml +++ b/modules/gltf/doc_classes/PackedSceneGLTF.xml @@ -8,44 +8,29 @@ - - - - - - - - - - + + + + + - - - - - - - - - - + + + + + - - - - - - - - - - + + + + + diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index a2c8e8eabf..8ea7384658 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -17,119 +17,93 @@ - - + Clear all cells. - - + - - - - + + - - + Returns an array of [ArrayMesh]es and [Transform3D] references of all bake meshes that exist within the current GridMap. - - - - + + The [MeshLibrary] item index located at the given grid coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned. - - - - + + The orientation of the cell at the given grid coordinates. [code]-1[/code] is returned if the cell is empty. - - - - + + Returns an individual bit on the [member collision_layer]. - - - - + + Returns an individual bit on the [member collision_mask]. - - + Returns an array of [Transform3D] and [Mesh] references corresponding to the non-empty cells in the grid. The transforms are specified in world space. - - + Returns an array of [Vector3] with the non-empty cell coordinates in the grid map. - - - - - - + + + - - - - + + Returns the position of a grid cell in the GridMap's local coordinate space. - - - - + + - - - - - - - - + + + + Sets the mesh index for the cell referenced by its grid coordinates. A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell. @@ -137,46 +111,33 @@ - - - - - - - - - - + + + + + - - - - - - + + + Sets an individual bit on the [member collision_layer]. - - - - - - + + + Sets an individual bit on the [member collision_mask]. - - - - + + Returns the coordinates of the grid cell containing the given point. [code]pos[/code] should be in the GridMap's local coordinate space. @@ -223,8 +184,7 @@ - - + Emitted when [member cell_size] changes. diff --git a/modules/opensimplex/doc_classes/OpenSimplexNoise.xml b/modules/opensimplex/doc_classes/OpenSimplexNoise.xml index 4d45e41cc3..c470f3e1ab 100644 --- a/modules/opensimplex/doc_classes/OpenSimplexNoise.xml +++ b/modules/opensimplex/doc_classes/OpenSimplexNoise.xml @@ -25,90 +25,66 @@ - - - - - - - - + + + + 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. If [code]noise_offset[/code] is specified, then the offset value is used as the coordinates of the top-left corner of the generated noise. - - - - + + 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. - - - - - - + + + Returns the 2D noise value [code][-1,1][/code] at the given position. - - - - + + Returns the 2D noise value [code][-1,1][/code] at the given position. - - - - - - - - + + + + Returns the 3D noise value [code][-1,1][/code] at the given position. - - - - + + Returns the 3D noise value [code][-1,1][/code] at the given position. - - - - - - - - - - + + + + + Returns the 4D noise value [code][-1,1][/code] at the given position. - - - - + + 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. diff --git a/modules/regex/doc_classes/RegEx.xml b/modules/regex/doc_classes/RegEx.xml index 7f5a0dfecb..9c84974ff6 100644 --- a/modules/regex/doc_classes/RegEx.xml +++ b/modules/regex/doc_classes/RegEx.xml @@ -50,88 +50,67 @@ - - + This method resets the state of the object, as if it was freshly created. Namely, it unassigns the regular expression of this object. - - - - + + 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. - - + Returns the number of capturing groups in compiled pattern. - - + Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance. - - + Returns the original search pattern that was compiled. - - + Returns whether this object has a valid search pattern assigned. - - - - - - - - + + + + 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. - - - - - - - - + + + + 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. - - - - - - - - - - - - + + + + + + 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. diff --git a/modules/regex/doc_classes/RegExMatch.xml b/modules/regex/doc_classes/RegExMatch.xml index 492519d3d9..3cde2836cc 100644 --- a/modules/regex/doc_classes/RegExMatch.xml +++ b/modules/regex/doc_classes/RegExMatch.xml @@ -10,37 +10,30 @@ - - - - + + 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. - - + Returns the number of capturing groups. - - - - + + 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. - - - - + + 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. diff --git a/modules/theora/doc_classes/VideoStreamTheora.xml b/modules/theora/doc_classes/VideoStreamTheora.xml index cb8852d5ef..e7bf9b202d 100644 --- a/modules/theora/doc_classes/VideoStreamTheora.xml +++ b/modules/theora/doc_classes/VideoStreamTheora.xml @@ -11,17 +11,14 @@ - - + Returns the Ogg Theora video file handled by this [VideoStreamTheora]. - - - - + + Sets the Ogg Theora video file that this [VideoStreamTheora] resource handles. The [code]file[/code] name should have the [code].ogv[/code] extension. diff --git a/modules/upnp/doc_classes/UPNP.xml b/modules/upnp/doc_classes/UPNP.xml index 09a2c8a88c..5b1d9dbfd1 100644 --- a/modules/upnp/doc_classes/UPNP.xml +++ b/modules/upnp/doc_classes/UPNP.xml @@ -21,27 +21,19 @@ - - - - + + Adds the given [UPNPDevice] to the list of discovered devices. - - - - - - - - - - - - + + + + + + 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 @@ - - + Clears the list of discovered devices. - - - - - - + + + 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. - - - - - - - - + + + + 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 @@ - - - - + + Returns the [UPNPDevice] at the given [code]index[/code]. - - + Returns the number of discovered [UPNPDevice]s. - - + Returns the default gateway. That is the first discovered [UPNPDevice] that is also a valid IGD (InternetGatewayDevice). - - + Returns the external [IP] address of the default gateway (see [method get_gateway]) as string. Returns an empty string on error. - - - - + + Removes the device at [code]index[/code] from the list of discovered devices. - - - - - - + + + Sets the device at [code]index[/code] from the list of discovered devices to [code]device[/code]. diff --git a/modules/upnp/doc_classes/UPNPDevice.xml b/modules/upnp/doc_classes/UPNPDevice.xml index f7b5386d86..b7c2ff7dd7 100644 --- a/modules/upnp/doc_classes/UPNPDevice.xml +++ b/modules/upnp/doc_classes/UPNPDevice.xml @@ -10,43 +10,32 @@ - - - - - - - - - - - - + + + + + + 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]. - - - - - - + + + Deletes the port mapping identified by the given port and protocol combination on this device. See [method UPNP.delete_port_mapping]. - - + Returns [code]true[/code] if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding. - - + Returns the external IP address of this [UPNPDevice] or an empty string. diff --git a/modules/visual_script/doc_classes/VisualScript.xml b/modules/visual_script/doc_classes/VisualScript.xml index 9d51bd86a2..2327fc0009 100644 --- a/modules/visual_script/doc_classes/VisualScript.xml +++ b/modules/visual_script/doc_classes/VisualScript.xml @@ -13,456 +13,334 @@ - - - - + + Add a custom signal with the specified name to the VisualScript. - - - - - - + + + Add a function with the specified name to the VisualScript, and assign the root [VisualScriptFunction] node's id as [code]func_node_id[/code]. - - - - - - - - + + + + Add a node to the VisualScript. - - - - - - - - + + + + Add a variable to the VisualScript, optionally giving it a default value or marking it as exported. - - - - - - - - - - + + + + + Add an argument to a custom signal added with [method add_custom_signal]. - - - - + + Get the count of a custom signal's arguments. - - - - - - + + + Get the name of a custom signal's argument. - - - - - - + + + Get the type of a custom signal's argument. - - - - - - + + + Remove a specific custom signal's argument. - - - - - - - - + + + + Rename a custom signal's argument. - - - - - - - - + + + + Change the type of a custom signal's argument. - - - - - - - - + + + + Swap two of the arguments of a custom signal. - - - - - - - - - - + + + + + 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]. - - - - - - - - - - + + + + + Disconnect two data ports previously connected with [method data_connect]. - - - - + + Returns the id of a function's entry point node. - - - - + + Returns a node given its id. - - - - + + Returns a node's position in pixels. - - + Returns the current position of the center of the screen. - - - - + + Returns the default (initial) value of a variable. - - - - + + Returns whether a variable is exported. - - - - + + Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage. - - - - + + Returns whether a signal exists with the specified name. - - - - - - - - - - + + + + + Returns whether the specified data ports are connected. - - - - + + Returns whether a function exists with the specified name. - - - - + + Returns whether a node exists with the given id. - - - - - - - - + + + + Returns whether the specified sequence ports are connected. - - - - + + Returns whether a variable exists with the specified name. - - - - + + Remove a custom signal with the given name. - - - - + + Remove a specific function and its nodes from the script. - - - - + + Remove the node with the specified id. - - - - + + Remove a variable with the given name. - - - - - - + + + Change the name of a custom signal. - - - - - - + + + Change the name of a function. - - - - - - + + + Change the name of a variable. - - - - - - - - + + + + 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. - - - - - - - - + + + + Disconnect two sequence ports previously connected with [method sequence_connect]. - - - - + + Set the base type of the script. - - - - - - + + + Set the node position in the VisualScript graph. - - - - + + Set the screen center to the given position. - - - - - - + + + Change the default (initial) value of a variable. - - - - - - + + + Change whether a variable is exported. - - - - - - + + + Set a variable's info, using the same format as [method get_variable_info]. @@ -470,8 +348,7 @@ - - + Emitted when the ports of a node are changed. diff --git a/modules/visual_script/doc_classes/VisualScriptConstructor.xml b/modules/visual_script/doc_classes/VisualScriptConstructor.xml index 2f162e78b6..4743594ec3 100644 --- a/modules/visual_script/doc_classes/VisualScriptConstructor.xml +++ b/modules/visual_script/doc_classes/VisualScriptConstructor.xml @@ -10,30 +10,24 @@ - - + - - + - - - - + + - - - - + + diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml index ba4eba26fd..8aa34f8cae 100644 --- a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml @@ -10,153 +10,122 @@ - - + Return the node's title. - - + Return the node's category. - - + Return the count of input value ports. - - - - + + Return the specified input port's hint. See the [enum @GlobalScope.PropertyHint] hints. - - - - + + Return the specified input port's hint string. - - - - + + Return the specified input port's name. - - - - + + Return the specified input port's type. See the [enum Variant.Type] values. - - + Return the amount of output [b]sequence[/b] ports. - - - - + + Return the specified [b]sequence[/b] output's name. - - + Return the amount of output value ports. - - - - + + Return the specified output port's hint. See the [enum @GlobalScope.PropertyHint] hints. - - - - + + Return the specified output port's hint string. - - - - + + Return the specified output port's name. - - - - + + Return the specified output port's type. See the [enum Variant.Type] values. - - + 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). - - + Return the size of the custom node's working memory. See [method _step] for more details. - - + Return whether the custom node has an input [b]sequence[/b] port. - - - - - - - - - - + + + + + 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. diff --git a/modules/visual_script/doc_classes/VisualScriptEditor.xml b/modules/visual_script/doc_classes/VisualScriptEditor.xml index 186cd21239..9ea889c77b 100644 --- a/modules/visual_script/doc_classes/VisualScriptEditor.xml +++ b/modules/visual_script/doc_classes/VisualScriptEditor.xml @@ -8,25 +8,18 @@ - - - - - - - - + + + + Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the [code]category[/code] as the parameter. - - - - - - + + + Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed. diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml index 54a02bf270..18c3826df8 100644 --- a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml +++ b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml @@ -10,30 +10,23 @@ - - - - - - - - + + + + Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted. - - + Returns whether the function state is valid. - - - - + + Resumes the function to run from the point it was yielded. diff --git a/modules/visual_script/doc_classes/VisualScriptLists.xml b/modules/visual_script/doc_classes/VisualScriptLists.xml index 671c427228..d5bff1341a 100644 --- a/modules/visual_script/doc_classes/VisualScriptLists.xml +++ b/modules/visual_script/doc_classes/VisualScriptLists.xml @@ -10,89 +10,65 @@ - - - - - - - - + + + + Adds an input port to the Visual Script node. - - - - - - - - + + + + Adds an output port to the Visual Script node. - - - - + + Removes an input port from the Visual Script node. - - - - + + Removes an output port from the Visual Script node. - - - - - - + + + Sets the name of an input port. - - - - - - + + + Sets the type of an input port. - - - - - - + + + Sets the name of an output port. - - - - - - + + + Sets the type of an output port. diff --git a/modules/visual_script/doc_classes/VisualScriptNode.xml b/modules/visual_script/doc_classes/VisualScriptNode.xml index 82a023f3e4..23574a5ea8 100644 --- a/modules/visual_script/doc_classes/VisualScriptNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptNode.xml @@ -10,35 +10,28 @@ - - - - + + Returns the default value of a given port. The default value is used when nothing is connected to the port. - - + Returns the [VisualScript] instance the node is bound to. - - + Notify that the node's ports have changed. Usually used in conjunction with [VisualScriptCustomNode] . - - - - - - + + + Change the default value of a given port. diff --git a/modules/visual_script/doc_classes/VisualScriptSubCall.xml b/modules/visual_script/doc_classes/VisualScriptSubCall.xml index 89a10edde4..374e7d0f35 100644 --- a/modules/visual_script/doc_classes/VisualScriptSubCall.xml +++ b/modules/visual_script/doc_classes/VisualScriptSubCall.xml @@ -10,10 +10,8 @@ - - - - + + Called by this node. diff --git a/modules/webm/doc_classes/VideoStreamWebm.xml b/modules/webm/doc_classes/VideoStreamWebm.xml index f3e13ba31a..3b9acfd873 100644 --- a/modules/webm/doc_classes/VideoStreamWebm.xml +++ b/modules/webm/doc_classes/VideoStreamWebm.xml @@ -12,17 +12,14 @@ - - + Returns the WebM video file handled by this [VideoStreamWebm]. - - - - + + Sets the WebM video file that this [VideoStreamWebm] resource handles. The [code]file[/code] name should have the [code].webm[/code] extension. diff --git a/modules/webrtc/doc_classes/WebRTCDataChannel.xml b/modules/webrtc/doc_classes/WebRTCDataChannel.xml index 3435dda982..cf5735bab5 100644 --- a/modules/webrtc/doc_classes/WebRTCDataChannel.xml +++ b/modules/webrtc/doc_classes/WebRTCDataChannel.xml @@ -8,88 +8,76 @@ - - + Closes this data channel, notifying the other peer. - - + Returns the number of bytes currently queued to be sent over this channel. - - + 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). - - + Returns the label assigned to this channel during creation. - - + Returns the [code]maxPacketLifeTime[/code] value assigned to this channel during creation. Will be [code]65535[/code] if not specified. - - + Returns the [code]maxRetransmits[/code] value assigned to this channel during creation. Will be [code]65535[/code] if not specified. - - + Returns the sub-protocol assigned to this channel during creation. An empty string if not specified. - - + Returns the current state of this channel, see [enum ChannelState]. - - + Returns [code]true[/code] if this channel was created with out-of-band configuration. - - + Returns [code]true[/code] if this channel was created with ordering enabled (default). - - + Reserved, but not used for now. - - + Returns [code]true[/code] if the last received packet was transferred as text. See [member write_mode]. diff --git a/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml b/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml index 26c5bfa6ce..0c4a0d4ea0 100644 --- a/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml +++ b/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml @@ -12,58 +12,45 @@ - - - - - - - - + + + + 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]). - - + Close all the add peer connections and channels, freeing all resources. - - - - + + 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). - - + Returns a dictionary which keys are the peer ids and values the peer representation as in [method get_peer]. - - - - + + Returns [code]true[/code] if the given [code]peer_id[/code] is in the peers map (it might not be connected though). - - - - - - + + + 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 MultiplayerPeer.CONNECTION_CONNECTED] and [signal MultiplayerPeer.connection_succeeded] will not be emitted. @@ -71,10 +58,8 @@ - - - - + + Remove the peer with given [code]peer_id[/code] from the mesh. If the peer was connected, and [signal MultiplayerPeer.peer_connected] was emitted for it, then [signal MultiplayerPeer.peer_disconnected] will be emitted. diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml index 62e524825d..f6f360503f 100644 --- a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml +++ b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml @@ -15,33 +15,25 @@ - - - - - - - - + + + + Add an ice candidate generated by a remote peer (and received over the signaling server). See [signal ice_candidate_created]. - - + 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]. - - - - + + - +}" /> 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 @@ - - + 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. - - + Returns the connection state. See [enum ConnectionState]. - - + - +}" /> 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 @@ - - + Call this method frequently (e.g. in [method Node._process] or [method Node._physics_process]) to properly receive signals. - - - - - - + + + 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). - - - - - - + + + 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 @@ - - + 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]. - - - - - - + + + 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. - - - - + + 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. diff --git a/modules/websocket/doc_classes/WebSocketClient.xml b/modules/websocket/doc_classes/WebSocketClient.xml index 40c0ad17ad..1549a907b4 100644 --- a/modules/websocket/doc_classes/WebSocketClient.xml +++ b/modules/websocket/doc_classes/WebSocketClient.xml @@ -13,16 +13,11 @@ - - - - - - - - - - + + + + + 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 @@ - - - - - - + + + Disconnects this client from the connected host. See [method WebSocketPeer.close] for more information. - - + Return the IP address of the currently connected host. - - + Return the IP port of the currently connected host. @@ -70,8 +60,7 @@ - - + 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. @@ -82,8 +71,7 @@ - - + Emitted when a connection with the server is established, [code]protocol[/code] will contain the sub-protocol agreed with the server. @@ -95,10 +83,8 @@ - - - - + + 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. diff --git a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml index ee1b60f739..cd41e9a1fb 100644 --- a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml +++ b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml @@ -10,25 +10,18 @@ - - - - + + Returns the [WebSocketPeer] associated to the given [code]peer_id[/code]. - - - - - - - - - - + + + + + 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 @@ - - + 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. diff --git a/modules/websocket/doc_classes/WebSocketPeer.xml b/modules/websocket/doc_classes/WebSocketPeer.xml index 5125956416..0e4cc7cfb6 100644 --- a/modules/websocket/doc_classes/WebSocketPeer.xml +++ b/modules/websocket/doc_classes/WebSocketPeer.xml @@ -11,12 +11,9 @@ - - - - - - + + + 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,57 +21,48 @@ - - + Returns the IP address of the connected peer. [b]Note:[/b] Not available in the HTML5 export. - - + Returns the remote port of the connected peer. [b]Note:[/b] Not available in the HTML5 export. - - + Gets the current selected write mode. See [enum WriteMode]. - - + Returns [code]true[/code] if this peer is currently connected. - - - - + + 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. - - - - + + Sets the socket to use the given [enum WriteMode]. - - + Returns [code]true[/code] if the last received packet was sent as a text payload. See [enum WriteMode]. diff --git a/modules/websocket/doc_classes/WebSocketServer.xml b/modules/websocket/doc_classes/WebSocketServer.xml index 5491f7de15..90182de4c2 100644 --- a/modules/websocket/doc_classes/WebSocketServer.xml +++ b/modules/websocket/doc_classes/WebSocketServer.xml @@ -12,61 +12,46 @@ - - - - - - - - + + + + Disconnects the peer identified by [code]id[/code] from the server. See [method WebSocketPeer.close] for more information. - - - - + + Returns the IP address of the given peer. - - - - + + Returns the remote port of the given peer. - - - - + + Returns [code]true[/code] if a peer with the given ID is connected. - - + Returns [code]true[/code] if the server is actively listening on a port. - - - - - - - - + + + + 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 @@ - - + Stops the server and clear its state. @@ -101,40 +85,31 @@ - - - - - - + + + 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. - - - - - - + + + Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client, and "resource_name" will be the resource name of the URI the peer used. "resource_name" is a path (at the very least a single forward slash) and potentially a query string. - - - - + + Emitted when a client disconnects. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly. - - + Emitted when a new message is received. [b]Note:[/b] This signal is [i]not[/i] emitted when used as high-level multiplayer peer. diff --git a/modules/webxr/doc_classes/WebXRInterface.xml b/modules/webxr/doc_classes/WebXRInterface.xml index 67b2b866f3..ff7c46bbae 100644 --- a/modules/webxr/doc_classes/WebXRInterface.xml +++ b/modules/webxr/doc_classes/WebXRInterface.xml @@ -95,10 +95,8 @@ - - - - + + Gets an [XRPositionalTracker] 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 [XRPositionalTracker] as a ray pointing at the object the user wishes to interact with. @@ -112,10 +110,8 @@ - - - - + + 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 @@ - - + Emitted after one of the "controllers" has finished its "primary action". Use [method get_controller] to get more information about the controller. - - + Emitted when one of the "controllers" has finished its "primary action". Use [method get_controller] to get more information about the controller. - - + 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 @@ - - + Emitted by [method XRInterface.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 @@ - - - - + + Emitted by [method is_session_supported] to indicate if the given [code]session_mode[/code] is supported or not. - - + Emitted after one of the "controllers" has finished its "primary squeeze action". Use [method get_controller] to get more information about the controller. - - + Emitted when one of the "controllers" has finished its "primary squeeze action". Use [method get_controller] to get more information about the controller. - - + Emitted when one of the "controllers" has started its "primary squeeze action". Use [method get_controller] to get more information about the controller. -- cgit v1.2.3