From 9a173e5814a335e9aef1f919f8f7e3772df39c19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sat, 15 Jun 2019 00:04:55 +0200 Subject: [PATCH] doc: Fix formatting, typos and some descriptions in new docstrings --- doc/classes/@GlobalScope.xml | 2 +- doc/classes/Bone2D.xml | 4 ++-- doc/classes/CPUParticles.xml | 13 +++++++------ doc/classes/CPUParticles2D.xml | 14 +++++++------- doc/classes/ClippedCamera.xml | 6 ++++++ doc/classes/FileDialog.xml | 2 ++ doc/classes/MeshInstance2D.xml | 6 ++++++ doc/classes/MultiMeshInstance2D.xml | 6 ++++++ modules/webrtc/doc_classes/WebRTCDataChannel.xml | 12 ++++++------ .../webrtc/doc_classes/WebRTCPeerConnection.xml | 16 +++++++--------- 10 files changed, 50 insertions(+), 31 deletions(-) diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index eb612191e79..ba31a774fcc 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1013,7 +1013,7 @@ Trigger on a VR controller - A button on the right Oculus Touch controller, X button on the left controller (also when used in OpenVR) + A button on the right Oculus Touch controller, X button on the left controller (also when used in OpenVR) B button on the right Oculus Touch controller, Y button on the left controller (also when used in OpenVR) diff --git a/doc/classes/Bone2D.xml b/doc/classes/Bone2D.xml index 206853fe5f5..757c6c6a349 100644 --- a/doc/classes/Bone2D.xml +++ b/doc/classes/Bone2D.xml @@ -4,7 +4,7 @@ Joint used with [Skeleton2D] to control and animate other nodes. - Use a hierarchy of [code]Bone2D[/code] bound to a [Skeleton2D] to control, and animate other [class Node2D] nodes. + Use a hierarchy of [code]Bone2D[/code] bound to a [Skeleton2D] to control, and animate other [Node2D] nodes. You can use [code]Bone2D[/code] and [code]Skeleton2D[/code] nodes to animate 2D meshes created with the Polygon 2D UV editor. Each bone has a [member rest] transform that you can reset to with [method apply_rest]. These rest poses are relative to the bone's parent. If in the editor, you can set the rest pose of an entire skeleton using a menu option, from the code, you need to iterate over the bones to set their individual rest poses. @@ -39,7 +39,7 @@ Length of the bone's representation drawn in the editor's viewport in pixels. - Rest transform of the bone. You can reset the node's transforms to this value using [member apply_rest]. + Rest transform of the bone. You can reset the node's transforms to this value using [method apply_rest]. diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index 7ea9c61ff32..c9c92102f39 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -68,10 +68,10 @@ Animation speed randomness ratio. Default value: [code]0[/code]. - Each particle's initial color. If [member texture] is defined, it will be multiplied by this color. + Unused for 3D particles. - Each particle's color will vary along this [Gradient]. + Unused for 3D particles. The rate at which particles lose velocity. @@ -86,7 +86,7 @@ Particle draw order. Uses [enum DrawOrder] values. Default value: [constant DRAW_ORDER_INDEX]. - The rectangle's extents if [member emission_shape] is set to [const EMISSION_SHAPE_BOX]. + The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX]. @@ -164,7 +164,8 @@ If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end. Default value: [code]false[/code]. - Orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. + Orbital velocity applied to each particle. Makes the particles circle around origin in the local XY plane. Specified in number of full rotations around origin per second. + This property is only available when [member flag_disable_z] is [code]true[/code]. Each particle's orbital velocity will vary along this [Curve]. @@ -283,10 +284,10 @@ Particles will be emitted in the volume of a box. - Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle color will be modulated by [member emission_color_texture]. + Particles will be emitted at a position chosen randomly among [member emission_points]. Particle color will be modulated by [member emission_colors]. - Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle velocity and rotation will be set based on [member emission_normal_texture]. Particle color will be modulated by [member emission_color_texture]. + Particles will be emitted at a position chosen randomly among [member emission_points]. Particle velocity and rotation will be set based on [member emission_normals]. Particle color will be modulated by [member emission_colors]. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index e045dd850f3..4351a0b4d4d 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -93,13 +93,13 @@ - The rectangle's extents if [member emission_shape] is set to [const EMISSION_SHAPE_RECTANGLE]. + The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_RECTANGLE]. Particles will be emitted inside this region. Use [enum EmissionShape] for values. Default value: [constant EMISSION_SHAPE_POINT]. - The circle's radius if [member emission_shape] is set to [const EMISSION_SHAPE_CIRCLE]. + The circle's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_CIRCLE]. If [code]true[/code], particles are being emitted. Default value: [code]true[/code]. @@ -215,7 +215,7 @@ Particles are drawn in order of remaining lifetime. - Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set initial velocity properties. @@ -259,10 +259,10 @@ Use with [method set_flag] to set [member flag_align_y]. - Use with [method set_flag] to set [member flag_rotate_y]. Present for consistency with 3D particle nodes, not used in 2D. + Present for consistency with 3D particle nodes, not used in 2D. - Use with [method set_flag] to set [member flag_disable_z]. Present for consistency with 3D particle nodes, not used in 2D. + Present for consistency with 3D particle nodes, not used in 2D. Represents the size of the [enum Flags] enum. @@ -277,10 +277,10 @@ Particles will be emitted in the area of a rectangle. - Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle color will be modulated by [member emission_color_texture]. + Particles will be emitted at a position chosen randomly among [member emission_points]. Particle color will be modulated by [member emission_colors]. - Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle velocity and rotation will be set based on [member emission_normal_texture]. Particle color will be modulated by [member emission_color_texture]. + Particles will be emitted at a position chosen randomly among [member emission_points]. Particle velocity and rotation will be set based on [member emission_normals]. Particle color will be modulated by [member emission_colors]. diff --git a/doc/classes/ClippedCamera.xml b/doc/classes/ClippedCamera.xml index b7f158dd651..c6dcd6cd967 100644 --- a/doc/classes/ClippedCamera.xml +++ b/doc/classes/ClippedCamera.xml @@ -29,6 +29,12 @@ + + + + + + diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 953f364bdb7..908c017ac94 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -138,5 +138,7 @@ + + diff --git a/doc/classes/MeshInstance2D.xml b/doc/classes/MeshInstance2D.xml index 39a733fdb33..4b38b9aa96a 100644 --- a/doc/classes/MeshInstance2D.xml +++ b/doc/classes/MeshInstance2D.xml @@ -22,6 +22,12 @@ The [Texture] that will be used if using the default [CanvasItemMaterial]. Can be accessed as [code]TEXTURE[/code] in CanvasItem shader. + + + + + + diff --git a/doc/classes/MultiMeshInstance2D.xml b/doc/classes/MultiMeshInstance2D.xml index 0bf243ee247..8509986c3c8 100644 --- a/doc/classes/MultiMeshInstance2D.xml +++ b/doc/classes/MultiMeshInstance2D.xml @@ -22,6 +22,12 @@ The [Texture] that will be used if using the default [CanvasItemMaterial]. Can be accessed as [code]TEXTURE[/code] in CanvasItem shader. + + + + + + diff --git a/modules/webrtc/doc_classes/WebRTCDataChannel.xml b/modules/webrtc/doc_classes/WebRTCDataChannel.xml index f03ae864f8a..7cce97244de 100644 --- a/modules/webrtc/doc_classes/WebRTCDataChannel.xml +++ b/modules/webrtc/doc_classes/WebRTCDataChannel.xml @@ -33,7 +33,7 @@ - Returns the maxPacketLifeTime value 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. @@ -41,7 +41,7 @@ - Returns the maxRetransmits value assigned to this channel during creation. + Returns the [code]maxRetransmits[/code] value assigned to this channel during creation. Will be [code]65535[/code] if not specified. @@ -49,7 +49,7 @@ - Returns the sub-proctocol assigned to this channel during creation. An empty string if not specified. + Returns the sub-protocol assigned to this channel during creation. An empty string if not specified. @@ -84,7 +84,7 @@ - Returns [code]true[/code] if the last received packet was transfered as text. See [property write_mode]. + Returns [code]true[/code] if the last received packet was transferred as text. See [member write_mode]. @@ -95,10 +95,10 @@ - Tells the channel to send data over this channel as text. An external peer (non-godot) would receive this as a string. + Tells the channel to send data over this channel as text. An external peer (non-Godot) would receive this as a string. - Tells the channel to send data over this channel as binary. An external peer (non-godot) would receive this as arraybuffer or blob. + Tells the channel to send data over this channel as binary. An external peer (non-Godot) would receive this as array buffer or blob. The channel was created, but it's still trying to connect. diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml index aa2c856b6e4..ae709877f4a 100644 --- a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml +++ b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml @@ -5,12 +5,10 @@ A WebRTC connection between the local computer and a remote peer. Provides an interface to connect, maintain and monitor the connection. - - Setting up a WebRTC connection between two peers from now on) may not seem a trival task, but it can be broken down into 3 main steps: + Setting up a WebRTC connection between two peers from now on) may not seem a trivial task, but it can be broken down into 3 main steps: - The peer that wants to initiate the connection ([code]A[/code] from now on) creates an offer and send it to the other peer ([code]B[/code] from now on). - [code]B[/code] receives the offer, generate and answer, and sends it to [code]B[/code]). - - [code]A[/code] and [code]B[/code] then generates and exchange ICE candiates with each other. - + - [code]A[/code] and [code]B[/code] then generates and exchange ICE candidates with each other. After these steps, the connection should become connected. Keep on reading or look into the tutorial for more information. @@ -49,7 +47,7 @@ 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]. Valid [code]options[/code] are: - [code] + [codeblock] { "negotiated": true, # When set to true (default off), means the channel is negotiated out of band. "id" must be set too. data_channel_received will not be called. "id": 1, # When "negotiated" is true this value must also be set to the same value on both peer. @@ -61,7 +59,7 @@ "protocol": "my-custom-protocol", # A custom sub-protocol string for this channel. } - [/code] + [/codeblock] NOTE: You must keep a reference to channels created this way, or it will be closed. @@ -90,7 +88,7 @@ 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: - [code] + [codeblock] { "iceServers": [ { @@ -103,14 +101,14 @@ } ] } - [/code] + [/codeblock] - Call this method frequently (e.g. in [method Node._process] or [method Node._fixed_process]) to properly receive signals. + Call this method frequently (e.g. in [method Node._process] or [method Node._physics_process]) to properly receive signals.