From a78373ddc2c1123b13161da2037a16c40a3c4b26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sat, 29 Jun 2019 21:22:15 +0200 Subject: [PATCH] doc: Remove null default values that can't be determined Applying #30187. --- doc/classes/AnimationNode.xml | 2 +- doc/classes/AnimationNodeTransition.xml | 128 +++++++++--------- doc/classes/AnimationPlayer.xml | 8 +- doc/classes/AudioEffectChorus.xml | 24 ++-- doc/classes/CPUParticles.xml | 12 +- doc/classes/CPUParticles2D.xml | 10 +- doc/classes/Camera2D.xml | 2 +- doc/classes/CanvasItem.xml | 2 +- doc/classes/CanvasItemMaterial.xml | 6 +- doc/classes/CanvasLayer.xml | 2 +- doc/classes/Control.xml | 2 +- doc/classes/HTTPClient.xml | 2 +- doc/classes/JSONParseResult.xml | 6 +- doc/classes/KinematicCollision.xml | 2 +- doc/classes/KinematicCollision2D.xml | 2 +- doc/classes/MultiplayerAPI.xml | 2 +- doc/classes/NavigationMesh.xml | 2 +- doc/classes/Node.xml | 10 +- doc/classes/Node2D.xml | 12 +- doc/classes/OS.xml | 69 +--------- doc/classes/PacketPeerStream.xml | 2 +- doc/classes/Particles.xml | 6 +- doc/classes/ParticlesMaterial.xml | 18 +-- doc/classes/PhysicsBody2D.xml | 2 +- doc/classes/Polygon2D.xml | 2 +- doc/classes/ProjectSettings.xml | 2 + doc/classes/Range.xml | 2 +- doc/classes/RigidBody.xml | 4 +- doc/classes/RigidBody2D.xml | 6 +- doc/classes/SceneTree.xml | 10 +- doc/classes/Script.xml | 2 +- doc/classes/Spatial.xml | 6 +- doc/classes/SpatialMaterial.xml | 92 ++++++------- doc/classes/SpriteFrames.xml | 2 +- doc/classes/StaticBody.xml | 4 +- doc/classes/StaticBody2D.xml | 4 +- doc/classes/TileMap.xml | 4 +- doc/classes/Timer.xml | 4 +- doc/classes/VideoPlayer.xml | 4 +- doc/classes/Viewport.xml | 6 +- doc/classes/World.xml | 6 +- doc/classes/World2D.xml | 6 +- modules/csg/doc_classes/CSGPolygon.xml | 16 +-- .../gdnative/doc_classes/GDNativeLibrary.xml | 2 +- modules/gridmap/doc_classes/GridMap.xml | 2 +- .../VisualScriptBasicTypeConstant.xml | 2 +- .../doc_classes/VisualScriptConstant.xml | 2 +- .../doc_classes/VisualScriptFunctionCall.xml | 10 +- .../doc_classes/VisualScriptPropertyGet.xml | 8 +- .../doc_classes/VisualScriptPropertySet.xml | 8 +- .../doc_classes/VisualScriptYield.xml | 2 +- .../doc_classes/VisualScriptYieldSignal.xml | 2 +- .../websocket/doc_classes/WebSocketClient.xml | 2 +- 53 files changed, 246 insertions(+), 309 deletions(-) diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index d4a507b597d..7d5d8a2db1d 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -203,7 +203,7 @@ - + Returns whether filtering is enabled. diff --git a/doc/classes/AnimationNodeTransition.xml b/doc/classes/AnimationNodeTransition.xml index e4ee9e695a4..4d2a11578fd 100644 --- a/doc/classes/AnimationNodeTransition.xml +++ b/doc/classes/AnimationNodeTransition.xml @@ -9,133 +9,133 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 5a2ce1b5742..b4c44fe8ebd 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -223,7 +223,7 @@ - + If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also [member current_animation]. @@ -232,16 +232,16 @@ The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also [method play]. - + The length (in seconds) of the currently being played animation. - + The position (in seconds) of the currently playing animation. The call mode to use for Call Method tracks. - + If [code]true[/code], updates animations in response to process-related notifications. diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml index 7c252b27084..13bc6ac097f 100644 --- a/doc/classes/AudioEffectChorus.xml +++ b/doc/classes/AudioEffectChorus.xml @@ -50,40 +50,40 @@ The voice's filter rate. - + The voice's cutoff frequency. - + The voice's signal delay. - + The voice filter's depth. - + The voice's volume. - + The voice's pan level. - + The voice's filter rate. - + The voice's cutoff frequency. - + The voice's signal delay. - + The voice filter's depth. - + The voice's volume. - + The voice's pan level. - + The voice's filter rate. diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index f5336643ab7..bd59bdbf9ff 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -85,19 +85,19 @@ Particle draw order. Uses [enum DrawOrder] values. - + The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX]. - + Particles will be emitted inside this region. See [enum EmissionShape] for possible values. - + The sphere's radius if [enum EmissionShape] is set to [constant EMISSION_SHAPE_SPHERE]. @@ -163,14 +163,14 @@ 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. - + 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]. - + Orbital velocity randomness ratio. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 9c27d126c8a..5d159c169bc 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -86,19 +86,19 @@ Particle draw order. Uses [enum DrawOrder] values. - + - + - + - + The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_RECTANGLE]. Particles will be emitted inside this region. See [enum EmissionShape] for possible values. - + The sphere's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_SPHERE]. diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 8ae0346efbb..e9a9f22e825 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -68,7 +68,7 @@ If [code]true[/code], the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera [code]current[/code] will disable this one. - + The custom [Viewport] node attached to the [Camera2D]. If [code]null[/code] or not a [Viewport], uses the default viewport instead. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 881dbe0f686..5ac825ddcda 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -526,7 +526,7 @@ If [code]true[/code], the object draws behind its parent. - + If [code]true[/code], the object draws on top of its parent. diff --git a/doc/classes/CanvasItemMaterial.xml b/doc/classes/CanvasItemMaterial.xml index aaaea6b7f16..5963e00d9e2 100644 --- a/doc/classes/CanvasItemMaterial.xml +++ b/doc/classes/CanvasItemMaterial.xml @@ -17,11 +17,11 @@ The manner in which material reacts to lighting. - + - + - + diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index fc0dd210642..2e56009f50d 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -20,7 +20,7 @@ - + The custom [Viewport] node assigned to the [CanvasLayer]. If [code]null[/code], uses the default viewport instead. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index bdfd97932b9..d25c2b31eed 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -714,7 +714,7 @@ Enables whether rendering of children should be clipped to this control's rectangle. If [code]true[/code], parts of a child which would be visibly outside of this control's rectangle will not be rendered. - + The node's global position, relative to the world (usually to the top-left corner of the window). diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index ca7d57dbd08..c91ddccaa4b 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -183,7 +183,7 @@ If [code]true[/code], execution will block until all data is read from the response. - + The connection to use for this client. diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index 3b87150ccab..5d5d4924394 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -11,16 +11,16 @@ - + The error type if the JSON source was not successfully parsed. See the [@GlobalScope] [code]ERR_*[/code] constants. - + The line number where the error occurred if JSON source was not successfully parsed. The error message if JSON source was not successfully parsed. See the [@GlobalScope] [code]ERR_*[/code] constants. - + A [Variant] containing the parsed JSON. Use [method @GDScript.typeof] or the [code]is[/code] keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ([code]{}[/code]), a [Dictionary] will be returned. If the JSON source starts with braces ([code][][/code]), an [Array] will be returned. [b]Note:[/b] The JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types. [b]Note:[/b] JSON objects do not preserve key order like Godot dictionaries, thus, you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements: diff --git a/doc/classes/KinematicCollision.xml b/doc/classes/KinematicCollision.xml index 70d8106674a..4ce28b25c9c 100644 --- a/doc/classes/KinematicCollision.xml +++ b/doc/classes/KinematicCollision.xml @@ -18,7 +18,7 @@ The colliding body's unique [RID]. - + The colliding body's metadata. See [Object]. diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index cde87dd131c..91cee3d05a9 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -18,7 +18,7 @@ The colliding body's unique [RID]. - + The colliding body's metadata. See [Object]. diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index 6add0e2f1db..5f8c7ed1209 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -91,7 +91,7 @@ If [code]true[/code] (or if the [member network_peer] has [member PacketPeer.allow_object_decoding] set to [code]true[/code]), the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. - + The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with [method is_network_server]) and will set root node's network mode to master (see [code]NETWORK_MODE_*[/code] constants in [Node]), or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals. diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index eee8e5dcf25..f6c7a7d1b51 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -103,7 +103,7 @@ - + diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index fa79513baba..5a903541242 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -813,19 +813,19 @@ - + The override to the default [MultiplayerAPI]. Set to [code]null[/code] to use the default [SceneTree] one. - + When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. - + The [MultiplayerAPI] instance associated with this node. Either the [member custom_multiplayer], or the default SceneTree one (if inside tree). - + The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed. - + The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using [PackedScene]), all the nodes it owns will be saved with it. This allows for the creation of complex [SceneTree]s, with instancing and subinstancing. diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 9b37515b529..abdbfa09f71 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -115,19 +115,19 @@ - + Global position. - + Global rotation in radians. - + Global rotation in degrees. - + Global scale. - + Global [Transform2D]. @@ -142,7 +142,7 @@ The node's scale. Unscaled value: [code](1, 1)[/code]. - + Local [Transform2D]. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index e46f3956648..9854c2deade 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -800,74 +800,7 @@ - + The clipboard from the host OS. Might be unavailable on some platforms. diff --git a/doc/classes/PacketPeerStream.xml b/doc/classes/PacketPeerStream.xml index 18d7d941f2c..0376fea5925 100644 --- a/doc/classes/PacketPeerStream.xml +++ b/doc/classes/PacketPeerStream.xml @@ -15,7 +15,7 @@ - + The wrapped [StreamPeer] object. diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml index 3176e802317..7ff99ebb732 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -36,13 +36,13 @@ [Mesh] that is drawn for the first draw pass. - + [Mesh] that is drawn for the second draw pass. - + [Mesh] that is drawn for the third draw pass. - + [Mesh] that is drawn for the fourth draw pass. diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index bd31452737b..e0618a87c1e 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -66,25 +66,25 @@ Damping randomness ratio. - + The box's extents if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_BOX]. - + Particle color will be modulated by color determined by sampling this texture at the same point as the [member emission_point_texture]. - + Particle velocity and rotation will be set by sampling this texture at the same point as the [member emission_point_texture]. Used only in [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. - + The number of emission points if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. - + Particles will be emitted at positions determined by sampling this texture at a random position. Used with [constant EMISSION_SHAPE_POINTS] and [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. Particles will be emitted inside this region. Use [code]EMISSION_SHAPE_*[/code] constants for values. - + The sphere's radius if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_SPHERE]. @@ -126,14 +126,14 @@ Linear acceleration randomness ratio. - + Orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. Only available when [member flag_disable_z] is [code]true[/code]. - + Each particle's orbital velocity will vary along this [CurveTexture]. - + Orbital velocity randomness ratio. diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index 5f79e74b0bf..076131357bb 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -85,7 +85,7 @@ The physics layers this area scans for collisions. - + Both [member collision_layer] and [member collision_mask]. Returns [member collision_layer] when accessed. Updates [member collision_layer] and [member collision_mask] when modified. diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 14a21e26b5e..6fc0d76d027 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -110,7 +110,7 @@ Amount to offset the polygon's [code]texture[/code]. If [code](0, 0)[/code] the texture's origin (its top-left corner) will be placed at the polygon's [code]position[/code]. - + The texture's rotation in radians. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 590a610b235..3e9e063c0c6 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -748,6 +748,8 @@ What to use to separate node name from number. This is mostly an editor setting. + + diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index e3f449eed47..82fffd0cb82 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -45,7 +45,7 @@ Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code]. - + The value mapped between 0 and 1. diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index fe7c08aec09..dd9bcecfb33 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -125,7 +125,7 @@ Lock the body's movement in the Z axis. - + RigidBody's bounciness. @@ -144,7 +144,7 @@ If [code]true[/code], internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. - + The body's friction, from 0 (frictionless) to 1 (max friction). diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 7c0cf92d0db..43fc5704aa0 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -126,7 +126,7 @@ The body's total applied torque. - + The body's bounciness. @@ -145,13 +145,13 @@ If [code]true[/code], internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the [method _integrate_forces] function. - + The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). Multiplies the gravity applied to the body. The body's gravity is calculated from the [b]Default Gravity[/b] value in [b]Project > Project Settings > Physics > 2d[/b] and/or any additional gravity vector applied by [Area2D]s. - + The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it. diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 6b0218554fd..1302c1e6bf9 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -267,7 +267,7 @@ - + The current scene. @@ -276,17 +276,17 @@ If [code]true[/code], navigation polygons will be visible when running the game from the editor for debugging purposes. - + The root of the edited scene. - + The default [MultiplayerAPI] instance for this [SceneTree]. If [code]true[/code] (default value), enables automatic polling of the [MultiplayerAPI] for this SceneTree during [signal idle_frame]. If [code]false[/code], you need to manually call [method MultiplayerAPI.poll] to process network packets and deliver RPCs/RSETs. This allows running RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual [Mutex] protection when accessing the [MultiplayerAPI] from threads. - + The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the [SceneTree] will become a network server (check with [method is_network_server]) and will set the root node's network mode to master (see [code]NETWORK_MODE_*[/code] constants in [Node]), or it will become a regular peer with the root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to [SceneTree]'s signals. @@ -297,7 +297,7 @@ If [code]true[/code], the [SceneTree]'s [member network_peer] refuses new incoming connections. - + The [SceneTree]'s root [Viewport]. diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index ece6e3c5df1..fca73e3ea7d 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -75,7 +75,7 @@ - + The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically. diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 7b9add24e9c..9f4118aa7b9 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -293,13 +293,13 @@ - + The [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. - + World space (global) [Transform] of this node. - + Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). [b]Note:[/b] In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 26c23a3ef5a..5e18e72f907 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -17,83 +17,83 @@ - + The strength of the anisotropy effect. If [code]true[/code], anisotropy is enabled. Changes the shape of the specular blob and aligns it to tangent space. - + If [code]true[/code], ambient occlusion is enabled. - + - + - + - + - + If [code]true[/code], clearcoat rendering is enabled. Adds a secondary transparent pass to the material. - + - + - + If [code]true[/code], depth mapping is enabled (also called "parallax mapping" or "height mapping"). See also [member normal_enabled]. - + - + - + - + - + - + - + - + - + - + - + - + - + - + The emitted light's color. See [member emission_enabled]. If [code]true[/code], the body emits light. - + The emitted light's strength. See [member emission_enabled]. - + - + - + @@ -143,12 +143,12 @@ If [code]true[/code], normal mapping is enabled. - + The strength of the normal map's effect. - + - + @@ -171,7 +171,7 @@ If [code]true[/code], enables the vertex grow setting. See [member params_grow_amount]. - + Grows object vertices in the direction of their normals. @@ -184,16 +184,16 @@ - + The number of horizontal frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode]. - + If [code]true[/code], particle animations are looped. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode]. - + The number of vertical frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode]. - + If [code]true[/code], the proximity and distance fade effect is enabled. @@ -201,21 +201,21 @@ If [code]true[/code], the refraction effect is enabled. Distorts transparency based on light from behind the object. - + The strength of the refraction effect. - + - + - + If [code]true[/code], rim effect is enabled. - + - + The amount of to blend light and albedo color when rendering rim effect. If [code]0[/code] the light color is used, while [code]1[/code] means albedo color is used. An intermediate value generally works best. @@ -228,18 +228,18 @@ If [code]true[/code], subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. - + The strength of the subsurface scattering effect. - + - + The color used by the transmission effect. Represents the light passing through an object. If [code]true[/code], the transmission effect is enabled. - + diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index ef4a34b924c..f28192519e1 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -169,7 +169,7 @@ - + diff --git a/doc/classes/StaticBody.xml b/doc/classes/StaticBody.xml index e471107965c..b3243a4fca7 100644 --- a/doc/classes/StaticBody.xml +++ b/doc/classes/StaticBody.xml @@ -13,7 +13,7 @@ - + The body's bounciness. @@ -22,7 +22,7 @@ The body's constant linear velocity. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. - + The body's friction, from 0 (frictionless) to 1 (full friction). diff --git a/doc/classes/StaticBody2D.xml b/doc/classes/StaticBody2D.xml index b092c3a684a..c039b7888c2 100644 --- a/doc/classes/StaticBody2D.xml +++ b/doc/classes/StaticBody2D.xml @@ -12,7 +12,7 @@ - + The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). @@ -21,7 +21,7 @@ The body's constant linear velocity. This does not move the body, but affects colliding bodies, as if it were moving. - + The body's friction. Values range from [code]0[/code] (no friction) to [code]1[/code] (full friction). diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index c0c55ee6be9..ee5205efd71 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -286,9 +286,11 @@ The collision mask(s) for all colliders in the TileMap. - + If [code]true[/code], TileMap collisions will be handled as a kinematic body. If [code]false[/code], collisions will be handled as static body. + + The TileMap orientation mode. See [enum Mode] for possible values. diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 311a2caf89e..4f455fb3778 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -41,13 +41,13 @@ If [code]true[/code], the timer will stop when reaching 0. If [code]false[/code], it will restart. - + If [code]true[/code], the timer is paused and will not process until it is unpaused again, even if [method start] is called. Processing mode. See [enum TimerProcessMode]. - + The timer's remaining time in seconds. Returns 0 if the timer is inactive. [b]Note:[/b] You cannot set this value. To change the timer's remaining time, use [member wait_time]. diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 11ba843bb30..45341cee740 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -66,10 +66,10 @@ - + The current position of the stream, in seconds. - + Audio volume as a linear value. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index fbda2819b31..a9ffd9f66d4 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -219,7 +219,7 @@ If [code]true[/code], the viewport will process 3D audio streams. - + The canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport. @@ -228,7 +228,7 @@ If [code]true[/code], the viewport will disable 3D rendering. For actual disabling use [code]usage[/code]. - + The global canvas transform of the viewport. The canvas transform is relative to this. @@ -293,7 +293,7 @@ The custom [World] which can be used as 3D environment source. - + The custom [World2D] which can be used as 2D environment source. diff --git a/doc/classes/World.xml b/doc/classes/World.xml index a6600015654..adb3286c51b 100644 --- a/doc/classes/World.xml +++ b/doc/classes/World.xml @@ -12,7 +12,7 @@ - + The World's physics direct space state, used for making various queries. Might be used only during [code]_physics_process[/code]. @@ -21,10 +21,10 @@ The World's fallback_environment will be used if the World's [Environment] fails or is missing. - + The World's visual scenario. - + The World's physics space. diff --git a/doc/classes/World2D.xml b/doc/classes/World2D.xml index 69557f02212..66ef18f8f4c 100644 --- a/doc/classes/World2D.xml +++ b/doc/classes/World2D.xml @@ -12,13 +12,13 @@ - + The [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing. - + The state of this world's physics space. This allows arbitrary querying for collision. - + The [RID] of this world's physics space resource. Used by the [Physics2DServer] for 2D physics, treating it as both a space and an area. diff --git a/modules/csg/doc_classes/CSGPolygon.xml b/modules/csg/doc_classes/CSGPolygon.xml index a65a363a51e..48f5d730cce 100644 --- a/modules/csg/doc_classes/CSGPolygon.xml +++ b/modules/csg/doc_classes/CSGPolygon.xml @@ -20,22 +20,22 @@ Extrusion mode. - + If [code]true[/code] the u component of our uv will continuously increase in unison with the distance traveled along our path when [member mode] is [constant MODE_PATH]. - + Interval at which a new extrusion slice is added along the path when [member mode] is [constant MODE_PATH]. - + If [code]true[/code] the start and end of our path are joined together ensuring there is no seam when [member mode] is [constant MODE_PATH]. - + If [code]false[/code] we extrude centered on our path, if [code]true[/code] we extrude in relation to the position of our CSGPolygon when [member mode] is [constant MODE_PATH]. - + The [Shape] object containing the path along which we extrude when [member mode] is [constant MODE_PATH]. - + The method by which each slice is rotated along the path when [member mode] is [constant MODE_PATH]. @@ -44,10 +44,10 @@ Generates smooth normals so smooth shading is applied to our mesh. - + Degrees to rotate our extrusion for each slice when [member mode] is [constant MODE_SPIN]. - + Number of extrusion when [member mode] is [constant MODE_SPIN]. diff --git a/modules/gdnative/doc_classes/GDNativeLibrary.xml b/modules/gdnative/doc_classes/GDNativeLibrary.xml index ee1109c8474..7e1cac243a2 100644 --- a/modules/gdnative/doc_classes/GDNativeLibrary.xml +++ b/modules/gdnative/doc_classes/GDNativeLibrary.xml @@ -21,7 +21,7 @@ - + diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index e0ee52444d4..325432579f8 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -213,7 +213,7 @@ The assigned [MeshLibrary]. - + Deprecated, use [member mesh_library] instead. diff --git a/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml b/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml index a274ce84605..6dc54dbc03a 100644 --- a/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml +++ b/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml @@ -14,7 +14,7 @@ The type to get the constant from. - + The name of the constant to return. diff --git a/modules/visual_script/doc_classes/VisualScriptConstant.xml b/modules/visual_script/doc_classes/VisualScriptConstant.xml index 147b7501145..eb12fc37316 100644 --- a/modules/visual_script/doc_classes/VisualScriptConstant.xml +++ b/modules/visual_script/doc_classes/VisualScriptConstant.xml @@ -18,7 +18,7 @@ The constant's type. - + The constant's value. diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml b/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml index 447d23b09ae..f7f86e8c802 100644 --- a/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml +++ b/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml @@ -9,23 +9,23 @@ - + - + - + - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml index e45b439e18d..af1e8e68e8d 100644 --- a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml +++ b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml @@ -9,15 +9,15 @@ - + - + - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptPropertySet.xml b/modules/visual_script/doc_classes/VisualScriptPropertySet.xml index 4b6de758c37..380c196cafe 100644 --- a/modules/visual_script/doc_classes/VisualScriptPropertySet.xml +++ b/modules/visual_script/doc_classes/VisualScriptPropertySet.xml @@ -11,15 +11,15 @@ - + - + - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptYield.xml b/modules/visual_script/doc_classes/VisualScriptYield.xml index cdddf4c8e40..c506e6db01f 100644 --- a/modules/visual_script/doc_classes/VisualScriptYield.xml +++ b/modules/visual_script/doc_classes/VisualScriptYield.xml @@ -11,7 +11,7 @@ - + diff --git a/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml b/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml index 1160e78a131..b9d7aedaab2 100644 --- a/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml +++ b/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml @@ -13,7 +13,7 @@ - + diff --git a/modules/websocket/doc_classes/WebSocketClient.xml b/modules/websocket/doc_classes/WebSocketClient.xml index a47c7afc788..0d425ad1dd4 100644 --- a/modules/websocket/doc_classes/WebSocketClient.xml +++ b/modules/websocket/doc_classes/WebSocketClient.xml @@ -40,7 +40,7 @@ - + If [code]true[/code], SSL certificate verification is enabled. [b]Note:[/b] You must specify the certificates to be used in the Project Settings for it to work when exported.