asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Fix formatting, typos and some descriptions in new docstrings

Browse source
This commit is contained in:
Rémi Verschelde 2019-06-15 00:04:55 +02:00
parent 8e04aecb19
commit 9a173e5814
10 changed files with 50 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/@GlobalScope.xml
View file

@ -1013,7 +1013,7 @@
Trigger on a VR controller
</constant>
<constant name="JOY_OCULUS_AX" value="7" enum="JoystickList">
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)
</constant>
<constant name="JOY_OCULUS_BY" value="1" enum="JoystickList">
B button on the right Oculus Touch controller, Y button on the left controller (also when used in OpenVR)

4
doc/classes/Bone2D.xml
View file

@ -4,7 +4,7 @@
Joint used with [Skeleton2D] to control and animate other nodes.
</brief_description>
<description>
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.
</member>
<member name="rest" type="Transform2D" setter="set_rest" getter="get_rest">
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].
</member>
</members>
<constants>

13
doc/classes/CPUParticles.xml
View file

@ -68,10 +68,10 @@
Animation speed randomness ratio. Default value: [code]0[/code].
</member>
<member name="color" type="Color" setter="set_color" getter="get_color">
Each particle's initial color. If [member texture] is defined, it will be multiplied by this color.
Unused for 3D particles.
</member>
<member name="color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp">
Each particle's color will vary along this [Gradient].
Unused for 3D particles.
</member>
<member name="damping" type="float" setter="set_param" getter="get_param">
The rate at which particles lose velocity.
@ -86,7 +86,7 @@
Particle draw order. Uses [enum DrawOrder] values. Default value: [constant DRAW_ORDER_INDEX].
</member>
<member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents">
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].
</member>
<member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors">
</member>
@ -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].
</member>
<member name="orbit_velocity" type="float" setter="set_param" getter="get_param">
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].
</member>
<member name="orbit_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
Each particle's orbital velocity will vary along this [Curve].
@ -283,10 +284,10 @@
Particles will be emitted in the volume of a box.
</constant>
<constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape">
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].
</constant>
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape">
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].
</constant>
</constants>
</class>

14
doc/classes/CPUParticles2D.xml
View file

@ -93,13 +93,13 @@
<member name="emission_points" type="PoolVector2Array" setter="set_emission_points" getter="get_emission_points">
</member>
<member name="emission_rect_extents" type="Vector2" setter="set_emission_rect_extents" getter="get_emission_rect_extents">
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].
</member>
<member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles2D.EmissionShape">
Particles will be emitted inside this region. Use [enum EmissionShape] for values. Default value: [constant EMISSION_SHAPE_POINT].
</member>
<member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius">
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].
</member>
<member name="emitting" type="bool" setter="set_emitting" getter="is_emitting">
If [code]true[/code], particles are being emitted. Default value: [code]true[/code].
@ -215,7 +215,7 @@
</constant>
<constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder">
Particles are drawn in order of remaining lifetime.
</constant
</constant>
<constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set initial velocity properties.
</constant>
@ -259,10 +259,10 @@
Use with [method set_flag] to set [member flag_align_y].
</constant>
<constant name="FLAG_ROTATE_Y" value="1" enum="Flags">
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.
</constant>
<constant name="FLAG_DISABLE_Z" value="2" enum="Flags">
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.
</constant>
<constant name="FLAG_MAX" value="3" enum="Flags">
Represents the size of the [enum Flags] enum.
@ -277,10 +277,10 @@
Particles will be emitted in the area of a rectangle.
</constant>
<constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape">
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].
</constant>
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape">
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].
</constant>
</constants>
</class>

6
doc/classes/ClippedCamera.xml
View file

@ -29,6 +29,12 @@
<description>
</description>
</method>
<method name="get_clip_offset" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_collision_mask_bit" qualifiers="const">
<return type="bool">
</return>

2
doc/classes/FileDialog.xml
View file

@ -138,5 +138,7 @@
</theme_item>
<theme_item name="reload" type="Texture">
</theme_item>
<theme_item name="toggle_hidden" type="Texture">
</theme_item>
</theme_items>
</class>

6
doc/classes/MeshInstance2D.xml
View file

@ -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.
</member>
</members>
<signals>
<signal name="texture_changed">
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

6
doc/classes/MultiMeshInstance2D.xml
View file

@ -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.
</member>
</members>
<signals>
<signal name="texture_changed">
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

12
modules/webrtc/doc_classes/WebRTCDataChannel.xml
View file

@ -33,7 +33,7 @@
<return type="int">
</return>
<description>
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.
</description>
</method>
@ -41,7 +41,7 @@
<return type="int">
</return>
<description>
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.
</description>
</method>
@ -49,7 +49,7 @@
<return type="String">
</return>
<description>
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.
</description>
</method>
<method name="get_ready_state" qualifiers="const">
@ -84,7 +84,7 @@
<return type="bool">
</return>
<description>
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].
</description>
</method>
</methods>
@ -95,10 +95,10 @@
</members>
<constants>
<constant name="WRITE_MODE_TEXT" value="0" enum="WriteMode">
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.
</constant>
<constant name="WRITE_MODE_BINARY" value="1" enum="WriteMode">
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.
</constant>
<constant name="STATE_CONNECTING" value="0" enum="ChannelState">
The channel was created, but it's still trying to connect.

16
modules/webrtc/doc_classes/WebRTCPeerConnection.xml
View file

@ -5,12 +5,10 @@
</brief_description>
<description>
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.
</description>
<tutorials>
@ -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.
</description>
</method>
@ -90,7 +88,7 @@
<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:
[code]
[codeblock]
{
"iceServers": [
{
@ -103,14 +101,14 @@
}
]
}
[/code]
[/codeblock]
</description>
</method>
<method name="poll">
<return type="int" enum="Error">
</return>
<description>
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.
</description>
</method>
<method name="set_local_description">