diff --git a/core/bind/core_bind.cpp b/core/bind/core_bind.cpp index 44573a0d978..da7b15da946 100644 --- a/core/bind/core_bind.cpp +++ b/core/bind/core_bind.cpp @@ -1317,6 +1317,26 @@ void _OS::_bind_methods() { ADD_PROPERTY(PropertyInfo(Variant::VECTOR2, "window_position"), "set_window_position", "get_window_position"); ADD_PROPERTY(PropertyInfo(Variant::VECTOR2, "window_size"), "set_window_size", "get_window_size"); + // Those default values need to be specified for the docs generator, + // to avoid using values from the documentation writer's own OS instance. + ADD_PROPERTY_DEFAULT("clipboard", ""); + ADD_PROPERTY_DEFAULT("current_screen", 0); + ADD_PROPERTY_DEFAULT("exit_code", 0); + ADD_PROPERTY_DEFAULT("vsync_enabled", true); + ADD_PROPERTY_DEFAULT("low_processor_usage_mode", false); + ADD_PROPERTY_DEFAULT("keep_screen_on", true); + ADD_PROPERTY_DEFAULT("min_window_size", Vector2()); + ADD_PROPERTY_DEFAULT("max_window_size", Vector2()); + ADD_PROPERTY_DEFAULT("screen_orientation", 0); + ADD_PROPERTY_DEFAULT("window_borderless", false); + ADD_PROPERTY_DEFAULT("window_per_pixel_transparency_enabled", false); + ADD_PROPERTY_DEFAULT("window_fullscreen", false); + ADD_PROPERTY_DEFAULT("window_maximized", false); + ADD_PROPERTY_DEFAULT("window_minimized", false); + ADD_PROPERTY_DEFAULT("window_resizable", true); + ADD_PROPERTY_DEFAULT("window_position", Vector2()); + ADD_PROPERTY_DEFAULT("window_size", Vector2()); + BIND_ENUM_CONSTANT(VIDEO_DRIVER_GLES2); BIND_ENUM_CONSTANT(VIDEO_DRIVER_GLES3); diff --git a/core/bind/core_bind.h b/core/bind/core_bind.h index 2885e7c0e03..3be5a087528 100644 --- a/core/bind/core_bind.h +++ b/core/bind/core_bind.h @@ -805,6 +805,9 @@ public: void set_result(const Variant &p_result); Variant get_result() const; + + JSONParseResult() : + error_line(-1) {} }; class _JSON : public Object { diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index 8ec07e4d5cc..7dcfa5345d0 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -187,13 +187,13 @@ - + Ending corner. - + Beginning corner. - + Size from position to end. diff --git a/doc/classes/ARVRAnchor.xml b/doc/classes/ARVRAnchor.xml index 453a0b3a02a..2177ed89305 100644 --- a/doc/classes/ARVRAnchor.xml +++ b/doc/classes/ARVRAnchor.xml @@ -48,7 +48,7 @@ - + The anchor's ID. You can set this before the anchor itself exists. The first anchor gets an ID of [code]1[/code], the second an ID of [code]2[/code], etc. When anchors get removed, the engine can then assign the corresponding ID to new anchors. The most common situation where anchors "disappear" is when the AR server identifies that two anchors represent different parts of the same plane and merges them. diff --git a/doc/classes/ARVRController.xml b/doc/classes/ARVRController.xml index e79e18f44fd..9c6cfc1d7d2 100644 --- a/doc/classes/ARVRController.xml +++ b/doc/classes/ARVRController.xml @@ -66,13 +66,13 @@ - + The controller's ID. A controller ID of 0 is unbound and will always result in an inactive node. Controller ID 1 is reserved for the first controller that identifies itself as the left-hand controller and ID 2 is reserved for the first controller that identifies itself as the right-hand controller. For any other controller that the [ARVRServer] detects, we continue with controller ID 3. When a controller is turned off, its slot is freed. This ensures controllers will keep the same ID even when controllers with lower IDs are turned off. - + The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. If changed, updates [member ARVRPositionalTracker.rumble] accordingly. diff --git a/doc/classes/ARVRInterface.xml b/doc/classes/ARVRInterface.xml index a9715809249..1da1351e499 100644 --- a/doc/classes/ARVRInterface.xml +++ b/doc/classes/ARVRInterface.xml @@ -72,13 +72,13 @@ - + On an AR interface, is our anchor detection enabled? - + Has this interface been initialized? - + Is this our primary interface? diff --git a/doc/classes/ARVROrigin.xml b/doc/classes/ARVROrigin.xml index cd0e6169770..b6b55741aaf 100644 --- a/doc/classes/ARVROrigin.xml +++ b/doc/classes/ARVROrigin.xml @@ -14,7 +14,7 @@ - + Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter. [b]Note:[/b] This method is a passthrough to the [ARVRServer] itself. diff --git a/doc/classes/ARVRPositionalTracker.xml b/doc/classes/ARVRPositionalTracker.xml index 94661c6db7a..5551d48a08f 100644 --- a/doc/classes/ARVRPositionalTracker.xml +++ b/doc/classes/ARVRPositionalTracker.xml @@ -85,7 +85,7 @@ - + The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index 1d90437395b..af1a1b0fff0 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -107,9 +107,9 @@ - + - + Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter. diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 6701e3cbbd4..980adb4fca9 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -20,7 +20,7 @@ Adds a button with label [code]text[/code] and a custom [code]action[/code] to the dialog and returns the created button. [code]action[/code] will be passed to the [signal custom_action] signal when pressed. - If [code]true[/code], [code]right[/code] will place the button to the right of any sibling buttons. Default value: [code]false[/code]. + If [code]true[/code], [code]right[/code] will place the button to the right of any sibling buttons. @@ -57,14 +57,14 @@ - + Sets autowrapping for the text in the dialog. - - If [code]true[/code], the dialog is hidden when the OK button is pressed. You can set it to [code]false[/code] if you want to do e.g. input validation when receiving the [signal confirmed] signal, and handle hiding the dialog in your own logic. Default value: [code]true[/code]. + + If [code]true[/code], the dialog is hidden when the OK button is pressed. You can set it to [code]false[/code] if you want to do e.g. input validation when receiving the [signal confirmed] signal, and handle hiding the dialog in your own logic. [b]Note:[/b] Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example [FileDialog] defaults to [code]false[/code], and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such, this property can't be used in [FileDialog] to disable hiding the dialog when pressing OK. - + The text displayed by the dialog. diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml index f7dc794d93c..72d1fa48819 100644 --- a/doc/classes/AnimatedSprite.xml +++ b/doc/classes/AnimatedSprite.xml @@ -36,31 +36,31 @@ - + The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset. - - If [code]true[/code], texture will be centered. Default value: [code]true[/code]. + + If [code]true[/code], texture will be centered. - - If [code]true[/code], texture is flipped horizontally. Default value: [code]false[/code]. + + If [code]true[/code], texture is flipped horizontally. - - If [code]true[/code], texture is flipped vertically. Default value: [code]false[/code]. + + If [code]true[/code], texture is flipped vertically. - + The displayed animation frame's index. - + The [SpriteFrames] resource containing the animation(s). - + The texture's drawing offset. - + If [code]true[/code], the [member animation] is currently playing. - + The animation speed is multiplied by this value. diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index e4223d21f80..ff7d2fb9eb8 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -34,16 +34,16 @@ - + The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset. - + The displayed animation frame's index. - + The [SpriteFrames] resource containing the animation(s). - + If [code]true[/code], the [member animation] is currently playing. diff --git a/doc/classes/AnimatedTexture.xml b/doc/classes/AnimatedTexture.xml index 2009139474c..7e32db1bb86 100644 --- a/doc/classes/AnimatedTexture.xml +++ b/doc/classes/AnimatedTexture.xml @@ -61,12 +61,12 @@ - - Animation speed in frames per second. This value defines the default time interval between two frames of the animation, and thus the overall duration of the animation loop based on the [member frames] property. A value of 0 means no predefined number of frames per second, the animation will play according to each frame's frame delay (see [method set_frame_delay]). Default value: 4. + + Animation speed in frames per second. This value defines the default time interval between two frames of the animation, and thus the overall duration of the animation loop based on the [member frames] property. A value of 0 means no predefined number of frames per second, the animation will play according to each frame's frame delay (see [method set_frame_delay]). For example, an animation with 8 frames, no frame delay and a [code]fps[/code] value of 2 will run for 4 seconds, with each frame lasting 0.5 seconds. - - Number of frames to use in the animation. While you can create the frames independently with [method set_frame_texture], you need to set this value for the animation to take new frames into account. The maximum number of frames is [constant MAX_FRAMES]. Default value: 1. + + Number of frames to use in the animation. While you can create the frames independently with [method set_frame_texture], you need to set this value for the animation to take new frames into account. The maximum number of frames is [constant MAX_FRAMES]. diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 16db993cd74..bc64cfbb196 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -336,7 +336,7 @@ - Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. Default value: [code]true[/code]. + Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. New tracks wrap the interpolation loop by default. @@ -661,14 +661,14 @@ - + The total length of the animation (in seconds). [b]Note:[/b] Length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. - + A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. - + The animation step value. diff --git a/doc/classes/AnimationNodeAdd2.xml b/doc/classes/AnimationNodeAdd2.xml index 890d6f8b499..bb7857717d0 100644 --- a/doc/classes/AnimationNodeAdd2.xml +++ b/doc/classes/AnimationNodeAdd2.xml @@ -11,7 +11,7 @@ - + If [code]true[/code], sets the [code]optimization[/code] to [code]false[/code] when calling [method AnimationNode.blend_input], forcing the blended animations to update every frame. diff --git a/doc/classes/AnimationNodeAdd3.xml b/doc/classes/AnimationNodeAdd3.xml index 7747c333bf1..d338c2cf9e7 100644 --- a/doc/classes/AnimationNodeAdd3.xml +++ b/doc/classes/AnimationNodeAdd3.xml @@ -15,7 +15,7 @@ - + If [code]true[/code], sets the [code]optimization[/code] to [code]false[/code] when calling [method AnimationNode.blend_input], forcing the blended animations to update every frame. diff --git a/doc/classes/AnimationNodeAnimation.xml b/doc/classes/AnimationNodeAnimation.xml index 420a702d38d..a964877068a 100644 --- a/doc/classes/AnimationNodeAnimation.xml +++ b/doc/classes/AnimationNodeAnimation.xml @@ -11,7 +11,7 @@ - + Animation to use as an output. It is one of the animations provided by [member AnimationTree.anim_player]. diff --git a/doc/classes/AnimationNodeBlend2.xml b/doc/classes/AnimationNodeBlend2.xml index 9358c5eeef3..cac97b9ee77 100644 --- a/doc/classes/AnimationNodeBlend2.xml +++ b/doc/classes/AnimationNodeBlend2.xml @@ -11,7 +11,7 @@ - + If [code]true[/code], sets the [code]optimization[/code] to [code]false[/code] when calling [method AnimationNode.blend_input], forcing the blended animations to update every frame. diff --git a/doc/classes/AnimationNodeBlend3.xml b/doc/classes/AnimationNodeBlend3.xml index f4a108f9305..3b5c1f0b992 100644 --- a/doc/classes/AnimationNodeBlend3.xml +++ b/doc/classes/AnimationNodeBlend3.xml @@ -15,7 +15,7 @@ - + If [code]true[/code], sets the [code]optimization[/code] to [code]false[/code] when calling [method AnimationNode.blend_input], forcing the blended animations to update every frame. diff --git a/doc/classes/AnimationNodeBlendSpace1D.xml b/doc/classes/AnimationNodeBlendSpace1D.xml index c6a1d47c2df..82d5716ee3a 100644 --- a/doc/classes/AnimationNodeBlendSpace1D.xml +++ b/doc/classes/AnimationNodeBlendSpace1D.xml @@ -83,16 +83,16 @@ - + The blend space's axis's upper limit for the points' position. See [method add_blend_point]. - + The blend space's axis's lower limit for the points' position. See [method add_blend_point]. - + Position increment to snap to when moving a point on the axis. - + Label of the virtual axis of the blend space. diff --git a/doc/classes/AnimationNodeBlendSpace2D.xml b/doc/classes/AnimationNodeBlendSpace2D.xml index ba3635793c1..c71a06d9319 100644 --- a/doc/classes/AnimationNodeBlendSpace2D.xml +++ b/doc/classes/AnimationNodeBlendSpace2D.xml @@ -124,25 +124,25 @@ - + If true, the blend space is triangulated automatically. The mesh updates every time you add or remove points with [method add_blend_point] and [method remove_blend_point]. - + Controls the interpolation between animations. See [enum BlendMode] constants. - + The blend space's X and Y axes' upper limit for the points' position. See [method add_blend_point]. - + The blend space's X and Y axes' lower limit for the points' position. See [method add_blend_point]. - + Position increment to snap to when moving a point. - + Name of the blend space's X axis. - + Name of the blend space's Y axis. diff --git a/doc/classes/AnimationNodeBlendTree.xml b/doc/classes/AnimationNodeBlendTree.xml index 6454a26a041..76a0d65920e 100644 --- a/doc/classes/AnimationNodeBlendTree.xml +++ b/doc/classes/AnimationNodeBlendTree.xml @@ -95,7 +95,7 @@ - + diff --git a/doc/classes/AnimationNodeOneShot.xml b/doc/classes/AnimationNodeOneShot.xml index b6a6459c9e5..099548f60a6 100644 --- a/doc/classes/AnimationNodeOneShot.xml +++ b/doc/classes/AnimationNodeOneShot.xml @@ -23,17 +23,17 @@ - + - + - + - + - + - + diff --git a/doc/classes/AnimationNodeStateMachineTransition.xml b/doc/classes/AnimationNodeStateMachineTransition.xml index 0ba3e7057ed..08ff9997cf6 100644 --- a/doc/classes/AnimationNodeStateMachineTransition.xml +++ b/doc/classes/AnimationNodeStateMachineTransition.xml @@ -9,25 +9,25 @@ - + Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the [AnimationTree] that can be controlled from code (see [url=https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html#controlling-from-code][/url]). For example, if [member AnimationTree.tree_root] is an [AnimationNodeStateMachine] and [member advance_condition] is set to "idle": [codeblock] $animation_tree["parameters/conditions/idle"] = is_on_floor and linear_velocity.x == 0 [/codeblock] - + Turn on the transition automatically when this state is reached. This works best with [constant SWITCH_MODE_AT_END]. - + Don't use this transition during [method AnimationNodeStateMachinePlayback.travel] or [member auto_advance]. - + Lower priority transitions are preferred when travelling through the tree via [method AnimationNodeStateMachinePlayback.travel] or [member auto_advance]. - + The transition type. - + The time to cross-fade between this state and the next. diff --git a/doc/classes/AnimationNodeTransition.xml b/doc/classes/AnimationNodeTransition.xml index 311d0e84866..4d2a11578fd 100644 --- a/doc/classes/AnimationNodeTransition.xml +++ b/doc/classes/AnimationNodeTransition.xml @@ -137,9 +137,9 @@ - + - + diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 759787c26e2..b4c44fe8ebd 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -226,11 +226,11 @@ 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]. - - The name of the animation to play when the scene loads. Default value: [code]""[/code]. + + The name of the animation to play when the scene loads. - - The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also [method play]. Default value: [code]""[/code]. + + 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. @@ -238,23 +238,23 @@ The position (in seconds) of the currently playing animation. - - The call mode to use for Call Method tracks. Default value: [constant ANIMATION_METHOD_CALL_DEFERRED]. + + The call mode to use for Call Method tracks. - If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code]. + If [code]true[/code], updates animations in response to process-related notifications. - - The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: [code]0[/code]. + + The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. - - The process notification in which to update animations. Default value: [constant ANIMATION_PROCESS_IDLE]. + + The process notification in which to update animations. - - The speed scaling ratio. For instance, if this value is 1, then the animation plays at normal speed. If it's 0.5, then it plays at half speed. If it's 2, then it plays at double speed. Default value: [code]1[/code]. + + The speed scaling ratio. For instance, if this value is 1, then the animation plays at normal speed. If it's 0.5, then it plays at half speed. If it's 2, then it plays at double speed. - - The node from which node path references will travel. Default value: [code]".."[/code]. + + The node from which node path references will travel. diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index f3dc1ecc1e4..70c1b783df3 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -35,15 +35,15 @@ - + - + - + - + - + diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index 41dfd69fb7e..3b6003b4789 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -604,19 +604,19 @@ - - If [code]true[/code], the [AnimationTreePlayer] is able to play animations. Default value: [code]false[/code]. + + If [code]true[/code], the [AnimationTreePlayer] is able to play animations. - - The node from which to relatively access other nodes. Default value: [code]".."[/code]. + + The node from which to relatively access other nodes. It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at. - + The path to the [AnimationPlayer] from which this [AnimationTreePlayer] binds animations to animation nodes. Once set, Animation nodes can be added to the AnimationTreePlayer. - - The thread in which to update animations. Default value: [constant ANIMATION_PROCESS_IDLE]. + + The thread in which to update animations. diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index d23e8567aaa..6bd13824880 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -86,58 +86,58 @@ - + The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping). - + The name of the area's audio bus. - - If [code]true[/code], the area's audio bus overrides the default audio bus. Default value: [code]false[/code]. + + If [code]true[/code], the area's audio bus overrides the default audio bus. - + The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask]. - + The physics layers this area scans to determine collision detection. - + The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. - + The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. - - If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. Default value: [code]false[/code]. + + If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. - + The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction. - + The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping). - - If [code]true[/code], other monitoring areas can detect this area. Default value: [code]true[/code]. + + If [code]true[/code], other monitoring areas can detect this area. - - If [code]true[/code], the area detects bodies or areas entering and exiting it. Default value: [code]true[/code]. + + If [code]true[/code], the area detects bodies or areas entering and exiting it. - - The area's priority. Higher priority areas are processed first. Default value: 0. + + The area's priority. Higher priority areas are processed first. - + The degree to which this area applies reverb to its associated audio. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision. - + If [code]true[/code], the area applies reverb to its associated audio. - + The reverb bus name to use for this area's associated audio. - + The degree to which this area's reverb is a uniform effect. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision. - + Override mode for gravity and damping calculations within this area. See [enum SpaceOverride] for possible values. diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 950166a0e27..e1cb9056da4 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -86,46 +86,46 @@ - + The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping). - + The name of the area's audio bus. - - If [code]true[/code], the area's audio bus overrides the default audio bus. Default value: [code]false[/code]. + + If [code]true[/code], the area's audio bus overrides the default audio bus. - + The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask]. - + The physics layers this area scans to determine collision detection. - + The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. - + The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. - - If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. Default value: [code]false[/code]. + + If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. - + The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction. - + The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping). - - If [code]true[/code], other monitoring areas can detect this area. Default value: [code]true[/code]. + + If [code]true[/code], other monitoring areas can detect this area. - - If [code]true[/code], the area detects bodies or areas entering and exiting it. Default value: [code]true[/code]. + + If [code]true[/code], the area detects bodies or areas entering and exiting it. - - The area's priority. Higher priority areas are processed first. Default value: 0. + + The area's priority. Higher priority areas are processed first. - + Override mode for gravity and damping calculations within this area. See [enum SpaceOverride] for possible values. diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 96bcadc9396..9f32691e577 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -184,10 +184,10 @@ - + - - Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unnexpected culling when using a shader to offset vertices. + + Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unexpected culling when using a shader to offset vertices. diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index 834f066bdbd..1363287dc1f 100644 --- a/doc/classes/AtlasTexture.xml +++ b/doc/classes/AtlasTexture.xml @@ -12,16 +12,16 @@ - + The texture that contains the atlas. Can be any [Texture] subtype. - + If [code]true[/code], clips the area outside of the region to avoid bleeding of the surrounding texture pixels. - + The margin around the region. The [Rect2]'s [member Rect2.size] parameter ("w" and "h" in the editor) resizes the texture so it fits within the margin. - + The AtlasTexture's used region. diff --git a/doc/classes/AudioEffectAmplify.xml b/doc/classes/AudioEffectAmplify.xml index 52f7afad766..3003238eb92 100644 --- a/doc/classes/AudioEffectAmplify.xml +++ b/doc/classes/AudioEffectAmplify.xml @@ -12,8 +12,8 @@ - - Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: [code]0[/code]. + + Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml index f85755df083..13bc6ac097f 100644 --- a/doc/classes/AudioEffectChorus.xml +++ b/doc/classes/AudioEffectChorus.xml @@ -11,43 +11,43 @@ - + The effect's raw signal. - + 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. @@ -86,10 +86,10 @@ The voice's filter rate. - + The amount of voices in the effect. - + The effect's processed signal. diff --git a/doc/classes/AudioEffectCompressor.xml b/doc/classes/AudioEffectCompressor.xml index 191f7339561..6834804ea7e 100644 --- a/doc/classes/AudioEffectCompressor.xml +++ b/doc/classes/AudioEffectCompressor.xml @@ -17,26 +17,26 @@ - - Compressor's reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000. Default value: [code]20us[/code]. + + Compressor's reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000. - + Gain applied to the output signal. - - Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: [code]1[/code]. + + Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). - - Amount of compression applied to the audio once it passes the threshold level. The higher the ratio, the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: [code]4[/code]. + + Amount of compression applied to the audio once it passes the threshold level. The higher the ratio, the more the loud parts of the audio will be compressed. Value can range from 1 to 48. - - Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000. Default value: [code]250ms[/code]. + + Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000. - + Reduce the sound level using another audio bus for threshold detection. - - The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: [code]0[/code]. + + The level above which compression is applied to the audio. Value can range from -60 to 0. diff --git a/doc/classes/AudioEffectDelay.xml b/doc/classes/AudioEffectDelay.xml index e838998d706..aea6ead983c 100644 --- a/doc/classes/AudioEffectDelay.xml +++ b/doc/classes/AudioEffectDelay.xml @@ -12,44 +12,44 @@ - - Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: [code]1[/code]. + + Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. - - If [code]true[/code], feedback is enabled. Default value: [code]false[/code]. + + If [code]true[/code], feedback is enabled. - - Feedback delay time in milliseconds. Default value: [code]340[/code]. + + Feedback delay time in milliseconds. - - Sound level for [code]tap1[/code]. Default value: [code]-6 dB[/code]. + + Sound level for [code]tap1[/code]. - - Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal. Default value: [code]16000[/code]. + + Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal. - - If [code]true[/code], [code]tap1[/code] will be enabled. Default value: [code]true[/code]. + + If [code]true[/code], [code]tap1[/code] will be enabled. - - [code]tap1[/code] delay time in milliseconds. Default value: [code]250ms[/code]. + + [code]tap1[/code] delay time in milliseconds. - - Sound level for [code]tap1[/code]. Default value: [code]-6 dB[/code]. + + Sound level for [code]tap1[/code]. - - Pan position for [code]tap1[/code]. Value can range from -1 (fully left) to 1 (fully right). Default value: [code]0.2[/code]. + + Pan position for [code]tap1[/code]. Value can range from -1 (fully left) to 1 (fully right). - - If [code]true[/code], [code]tap2[/code] will be enabled. Default value: [code]true[/code]. + + If [code]true[/code], [code]tap2[/code] will be enabled. - - [b]Tap2[/b] delay time in milliseconds. Default value: [code]500ms[/code]. + + [b]Tap2[/b] delay time in milliseconds. - - Sound level for [code]tap2[/code]. Default value: [code]-12 dB[/code]. + + Sound level for [code]tap2[/code]. - - Pan position for [code]tap2[/code]. Value can range from -1 (fully left) to 1 (fully right). Default value: [code]-0.4[/code]. + + Pan position for [code]tap2[/code]. Value can range from -1 (fully left) to 1 (fully right). diff --git a/doc/classes/AudioEffectDistortion.xml b/doc/classes/AudioEffectDistortion.xml index 91f45742a28..0ee7d73f88b 100644 --- a/doc/classes/AudioEffectDistortion.xml +++ b/doc/classes/AudioEffectDistortion.xml @@ -13,20 +13,20 @@ - - Distortion power. Value can range from 0 to 1. Default value: [code]0[/code]. + + Distortion power. Value can range from 0 to 1. - - High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: [code]16000[/code]. + + High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. - - Distortion type. Default value: [constant MODE_CLIP]. + + Distortion type. - - Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: [code]0[/code]. + + Increases or decreases the volume after the effect. Value can range from -80 to 24. - - Increases or decreases the volume before the effect. Value can range from -60 to 60. Default value: [code]0[/code]. + + Increases or decreases the volume before the effect. Value can range from -60 to 60. diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml index e3cc7076132..5daad6748f5 100644 --- a/doc/classes/AudioEffectFilter.xml +++ b/doc/classes/AudioEffectFilter.xml @@ -11,15 +11,15 @@ - + Threshold frequency for the filter, in Hz. - + - + Gain amount of the frequencies after the filter. - + Amount of boost in the overtones near the cutoff frequency. diff --git a/doc/classes/AudioEffectLimiter.xml b/doc/classes/AudioEffectLimiter.xml index 09fec556e11..ee6252809aa 100644 --- a/doc/classes/AudioEffectLimiter.xml +++ b/doc/classes/AudioEffectLimiter.xml @@ -12,16 +12,16 @@ - - The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1. Default value: [code]-0.1dB[/code]. + + The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1. - - Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. Default value: [code]2dB[/code]. + + Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. - + - - Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0. Default value: [code]0dB[/code]. + + Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0. diff --git a/doc/classes/AudioEffectPanner.xml b/doc/classes/AudioEffectPanner.xml index 26f5a9c3857..e3a2dfcf21c 100644 --- a/doc/classes/AudioEffectPanner.xml +++ b/doc/classes/AudioEffectPanner.xml @@ -11,7 +11,7 @@ - + Pan position. Value can range from -1 (fully left) to 1 (fully right). diff --git a/doc/classes/AudioEffectPhaser.xml b/doc/classes/AudioEffectPhaser.xml index 20781c018ab..445f78dd733 100644 --- a/doc/classes/AudioEffectPhaser.xml +++ b/doc/classes/AudioEffectPhaser.xml @@ -12,19 +12,19 @@ - - Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: [code]1[/code]. + + Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. - - Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: [code]0.7[/code]. + + Output percent of modified sound. Value can range from 0.1 to 0.9. - - Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000. Default value: [code]1600hz[/code]. + + Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000. - - Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000. Default value: [code]440hz[/code]. + + Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000. - + Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range. diff --git a/doc/classes/AudioEffectPitchShift.xml b/doc/classes/AudioEffectPitchShift.xml index e31f311af51..1f891dfb321 100644 --- a/doc/classes/AudioEffectPitchShift.xml +++ b/doc/classes/AudioEffectPitchShift.xml @@ -12,11 +12,11 @@ - + - + - + Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves). diff --git a/doc/classes/AudioEffectRecord.xml b/doc/classes/AudioEffectRecord.xml index d6e678f276f..4f97797b372 100644 --- a/doc/classes/AudioEffectRecord.xml +++ b/doc/classes/AudioEffectRecord.xml @@ -29,7 +29,7 @@ - + diff --git a/doc/classes/AudioEffectReverb.xml b/doc/classes/AudioEffectReverb.xml index 84caa2e3731..a0664e727fe 100644 --- a/doc/classes/AudioEffectReverb.xml +++ b/doc/classes/AudioEffectReverb.xml @@ -12,29 +12,29 @@ - - Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: [code]1[/code]. + + Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. - - Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: [code]1[/code]. + + Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. - - High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: [code]0[/code]. + + High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. - - Output percent of predelay. Value can range from 0 to 1. Default value: [code]1[/code]. + + Output percent of predelay. Value can range from 0 to 1. - - Time between the original signal and the early reflections of the reverb signal, in milliseconds. Default value: [code]150ms[/code]. + + Time between the original signal and the early reflections of the reverb signal, in milliseconds. - - Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: [code]0.8[/code]. + + Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. - - Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: [code]1[/code]. + + Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. - - Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. Default value: [code]0.5[/code]. + + Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. diff --git a/doc/classes/AudioEffectSpectrumAnalyzer.xml b/doc/classes/AudioEffectSpectrumAnalyzer.xml index 21d74a8fb01..a56e4f2692b 100644 --- a/doc/classes/AudioEffectSpectrumAnalyzer.xml +++ b/doc/classes/AudioEffectSpectrumAnalyzer.xml @@ -9,11 +9,11 @@ - + - + - + diff --git a/doc/classes/AudioEffectStereoEnhance.xml b/doc/classes/AudioEffectStereoEnhance.xml index 95bc6128f2a..6cb692b5d7a 100644 --- a/doc/classes/AudioEffectStereoEnhance.xml +++ b/doc/classes/AudioEffectStereoEnhance.xml @@ -9,11 +9,11 @@ - + - + - + diff --git a/doc/classes/AudioStreamGenerator.xml b/doc/classes/AudioStreamGenerator.xml index ab06ddd7107..9d67b88c71f 100644 --- a/doc/classes/AudioStreamGenerator.xml +++ b/doc/classes/AudioStreamGenerator.xml @@ -9,9 +9,9 @@ - + - + diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 09316f47c3c..92f3a9bd73e 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -50,27 +50,27 @@ - - If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code]. + + If [code]true[/code], audio plays when added to scene tree. - + Bus on which this audio is playing. - + If the audio configuration has more than two speakers, this sets the target channels. See [code]MIX_TARGET_*[/code] constants. - + Changes the pitch and the tempo of the audio. - + If [code]true[/code], audio is playing. - + The [AudioStream] object to be played. - + - + Volume of sound, in dB. diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index c8c01b04269..362a096810e 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -50,33 +50,33 @@ - + Areas in which this sound plays. - + Dampens audio over distance with this as an exponent. - - If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code]. + + If [code]true[/code], audio plays when added to scene tree. - + Bus on which this audio is playing. - + Maximum distance from which audio is still hearable. - + Changes the pitch and the tempo of the audio. - + If [code]true[/code], audio is playing. - + The [AudioStream] object to be played. - + - + Base volume without dampening. diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 823cacbcaa6..d722f2164d9 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -50,60 +50,60 @@ - + Areas in which this sound plays. - + Dampens audio above this frequency, in Hz. - + Amount how much the filter affects the loudness, in dB. - + Decides if audio should get quieter with distance linearly, quadratically, logarithmically, or not be affected by distance, effectively disabling attenuation. - - If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code]. + + If [code]true[/code], audio plays when added to scene tree. - + Bus on which this audio is playing. - + Decides in which step the Doppler effect should be calculated. - + The angle in which the audio reaches cameras undampened. - + If [code]true[/code], the audio should be dampened according to the direction of the sound. - + Dampens audio if camera is outside of [member emission_angle_degrees] and [member emission_angle_enabled] is set by this factor, in dB. - + Sets the absolute maximum of the soundlevel, in dB. - + Sets the distance from which the [member out_of_range_mode] takes effect. Has no effect if set to 0. - + Decides if audio should pause when source is outside of [member max_distance] range. - + Changes the pitch and the tempo of the audio. - + If [code]true[/code], audio is playing. - + The [AudioStream] object to be played. - + - + Base sound level unaffected by dampening, in dB. - + Factor for the attenuation effect. diff --git a/doc/classes/AudioStreamRandomPitch.xml b/doc/classes/AudioStreamRandomPitch.xml index 27d7c480bae..9c73a64537a 100644 --- a/doc/classes/AudioStreamRandomPitch.xml +++ b/doc/classes/AudioStreamRandomPitch.xml @@ -11,10 +11,10 @@ - + The current [AudioStream]. - + The intensity of random pitch variation. diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 5f9e454fb6a..6d033017495 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -22,26 +22,26 @@ - + Contains the audio data in bytes. - + Audio format. See [code]FORMAT_*[/code] constants for values. - + Loop start in bytes. - + Loop end in bytes. - + Loop mode. See [code]LOOP_*[/code] constants for values. - + The sample rate for mixing this audio. - - If [code]true[/code], audio is stereo. Default value: [code]false[/code]. + + If [code]true[/code], audio is stereo. diff --git a/doc/classes/BackBufferCopy.xml b/doc/classes/BackBufferCopy.xml index c2ffae9c14f..9bb32e04444 100644 --- a/doc/classes/BackBufferCopy.xml +++ b/doc/classes/BackBufferCopy.xml @@ -11,10 +11,10 @@ - + Buffer mode. See [enum CopyMode] constants. - + The area covered by the BackBufferCopy. Only used if [member copy_mode] is [constant COPY_MODE_RECT]. diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml index af9666b6e4b..571a6fde80b 100644 --- a/doc/classes/BakedLightmap.xml +++ b/doc/classes/BakedLightmap.xml @@ -28,32 +28,32 @@ - - Grid subdivision size for lightmapper calculation. Default value of [code]0.25[/code] will work for most cases. Increase for better lighting on small details or if your scene is very large. + + Grid subdivision size for lightmapper calculation. The default value will work for most cases. Increase for better lighting on small details or if your scene is very large. - + - + The size of the affected area. - - If [code]true[/code], the lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller file size. Default value: [code]false[/code]. + + If [code]true[/code], the lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller file size. - + Lightmapping mode. See [enum BakeMode]. - + - + Three quality modes are available. Higher quality requires more rendering time. See [enum BakeQuality]. - + Grid size used for real-time capture information on dynamic objects. Cannot be larger than [member bake_cell_size]. - + The location where lightmaps will be saved. - + The calculated light data. diff --git a/doc/classes/BakedLightmapData.xml b/doc/classes/BakedLightmapData.xml index 75f31874344..68bbfb8f602 100644 --- a/doc/classes/BakedLightmapData.xml +++ b/doc/classes/BakedLightmapData.xml @@ -49,15 +49,15 @@ - + - + - + - + - + diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index ad2edadb753..f306adced2c 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -41,35 +41,35 @@ - + Determines when the button is considered clicked, one of the [code]ACTION_MODE_*[/code] constants. - + Binary mask to choose which mouse buttons this button will respond to. To allow both left-click and right-click, use [code]BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT[/code]. - + If [code]true[/code], the button is in disabled state and can't be clicked or toggled. - + Focus access mode to use when switching between enabled/disabled (see [member Control.focus_mode] and [member disabled]). - + [ButtonGroup] associated to the button. - - If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it. Default value: [code]false[/code]. + + If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it. - + If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). - + [ShortCut] associated to the button. - + If [code]true[/code], the button will add information about its shortcut in the tooltip. - + If [code]true[/code], the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 4809dd21bc1..4d5c76a75c1 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -197,13 +197,13 @@ - + The basis matrix's X vector. - + The basis matrix's Y vector. - + The basis matrix's Z vector. diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml index b6b5d9d2449..5ec4947f460 100644 --- a/doc/classes/BitmapFont.xml +++ b/doc/classes/BitmapFont.xml @@ -104,16 +104,16 @@ - + Ascent (number of pixels above the baseline). - + If [code]true[/code], distance field hint is enabled. - + The fallback font. - + Total font height (ascent plus descent) in pixels. diff --git a/doc/classes/Bone2D.xml b/doc/classes/Bone2D.xml index 757c6c6a349..21e08f13f9d 100644 --- a/doc/classes/Bone2D.xml +++ b/doc/classes/Bone2D.xml @@ -35,10 +35,10 @@ - + 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 [method apply_rest]. diff --git a/doc/classes/BoneAttachment.xml b/doc/classes/BoneAttachment.xml index 109cac4fa34..a6145b6a783 100644 --- a/doc/classes/BoneAttachment.xml +++ b/doc/classes/BoneAttachment.xml @@ -11,7 +11,7 @@ - + The name of the attached bone. diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml index dc263d3c71a..77db8b74dbb 100644 --- a/doc/classes/BoxContainer.xml +++ b/doc/classes/BoxContainer.xml @@ -20,7 +20,7 @@ - + The alignment of the container's children (must be one of [constant ALIGN_BEGIN], [constant ALIGN_CENTER] or [constant ALIGN_END]). diff --git a/doc/classes/BoxShape.xml b/doc/classes/BoxShape.xml index 5152f17f511..9e3977b3429 100644 --- a/doc/classes/BoxShape.xml +++ b/doc/classes/BoxShape.xml @@ -11,7 +11,7 @@ - + The box's half extents. The width, height and depth of this shape is twice the half extents. diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index 86381676e16..3d8730b5880 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -11,19 +11,19 @@ - + Text alignment policy for the button's text, use one of the [code]ALIGN_*[/code] constants. - + When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. - + Flat buttons don't display decoration. - + Button's icon, if text is present the icon will be placed before the text. - + The button's text that will be displayed inside the button's area. @@ -45,17 +45,17 @@ - + - + - + - + - + diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index 0a860f4b219..bd59bdbf9ff 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -28,140 +28,140 @@ - + Number of particles emitted in one emission cycle. - + Initial rotation applied to each particle, in degrees. - + Each particle's rotation will be animated along this [Curve]. - - Rotation randomness ratio. Default value: [code]0[/code]. + + Rotation randomness ratio. - + Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. - + Each particle's angular velocity will vary along this [Curve]. - - Angular velocity randomness ratio. Default value: [code]0[/code]. + + Angular velocity randomness ratio. - + Particle animation offset. - + Each particle's animation offset will vary along this [Curve]. - - Animation offset randomness ratio. Default value: [code]0[/code]. + + Animation offset randomness ratio. - + Particle animation speed. - + Each particle's animation speed will vary along this [Curve]. - - Animation speed randomness ratio. Default value: [code]0[/code]. + + Animation speed randomness ratio. - + Unused for 3D particles. - + Unused for 3D particles. - + The rate at which particles lose velocity. - + Damping will vary along this [Curve]. - - Damping randomness ratio. Default value: [code]0[/code]. + + Damping randomness ratio. - - Particle draw order. Uses [enum DrawOrder] values. Default value: [constant DRAW_ORDER_INDEX]. + + 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. Default value: [constant EMISSION_SHAPE_POINT]. + + 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]. - - If [code]true[/code], particles are being emitted. Default value: [code]true[/code]. + + If [code]true[/code], particles are being emitted. - - How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins. Default value: [code]0[/code]. + + How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins. - + The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself. - + Align Y axis of particle with the direction of its velocity. - - If [code]true[/code], particles will not move on the z axis. Default value: [code]false[/code]. + + If [code]true[/code], particles will not move on the z axis. - + If [code]true[/code], particles rotate around Y axis by [member angle]. - - Amount of [member spread] in Y/Z plane. A value of [code]1[/code] restricts particles to X/Z plane. Default [code]0[/code]. + + Amount of [member spread] in Y/Z plane. A value of [code]1[/code] restricts particles to X/Z plane. - - If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code]. + + If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. - - Gravity applied to every particle. Default value: [code](0, -9.8, 0)[/code]. + + Gravity applied to every particle. - + Initial hue variation applied to each particle. - + Each particle's hue will vary along this [Curve]. - - Hue variation randomness ratio. Default value: [code]0[/code]. + + Hue variation randomness ratio. - + Initial velocity magnitude for each particle. Direction comes from [member spread] and the node's orientation. - - Initial velocity randomness ratio. Default value: [code]0[/code]. + + Initial velocity randomness ratio. - - Amount of time each particle will exist. Default value: [code]1[/code]. + + Amount of time each particle will exist. - + Linear acceleration applied to each particle in the direction of motion. - + Each particle's linear acceleration will vary along this [Curve]. - - Linear acceleration randomness ratio. Default value: [code]0[/code]. + + Linear acceleration randomness ratio. - - If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. Default value: [code]true[/code]. + + If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. - + The [Mesh] used for each particle. If [code]null[/code], particles will be spheres. - - 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]. + + 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. @@ -171,46 +171,46 @@ Each particle's orbital velocity will vary along this [Curve]. - Orbital velocity randomness ratio. Default value: [code]0[/code]. + Orbital velocity randomness ratio. - + Particle system starts as if it had already run for this many seconds. - + Radial acceleration applied to each particle. Makes particle accelerate away from origin. - + Each particle's radial acceleration will vary along this [Curve]. - - Radial acceleration randomness ratio. Default value: [code]0[/code]. + + Radial acceleration randomness ratio. - - Emission lifetime randomness ratio. Default value: [code]0[/code]. + + Emission lifetime randomness ratio. - + Initial scale applied to each particle. - + Each particle's scale will vary along this [Curve]. - - Scale randomness ratio. Default value: [code]0[/code]. + + Scale randomness ratio. - - Particle system's running speed scaling ratio. Default value: [code]1[/code]. A value of [code]0[/code] can be used to pause the particles. + + Particle system's running speed scaling ratio. A value of [code]0[/code] can be used to pause the particles. - - Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Default value: [code]45[/code]. + + Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Applied to X/Z plane and Y/Z planes. - + Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. - + Each particle's tangential acceleration will vary along this [Curve]. - - Tangential acceleration randomness ratio. Default value: [code]0[/code]. + + Tangential acceleration randomness ratio. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 379d57bef14..5ec460abb7b 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -29,62 +29,62 @@ - + Number of particles emitted in one emission cycle. - + Initial rotation applied to each particle, in degrees. - + Each particle's rotation will be animated along this [Curve]. - - Rotation randomness ratio. Default value: [code]0[/code]. + + Rotation randomness ratio. - + Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. - + Each particle's angular velocity will vary along this [Curve]. - - Angular velocity randomness ratio. Default value: [code]0[/code]. + + Angular velocity randomness ratio. - + Particle animation offset. - + Each particle's animation offset will vary along this [Curve]. - - Animation offset randomness ratio. Default value: [code]0[/code]. + + Animation offset randomness ratio. - + Particle animation speed. - + Each particle's animation speed will vary along this [Curve]. - - Animation speed randomness ratio. Default value: [code]0[/code]. + + Animation speed randomness ratio. - + Each particle's initial color. If [member texture] is defined, it will be multiplied by this color. - + Each particle's color will vary along this [Gradient]. - + The rate at which particles lose velocity. - + Damping will vary along this [Curve]. - - Damping randomness ratio. Default value: [code]0[/code]. + + Damping randomness ratio. - - Particle draw order. Uses [enum DrawOrder] values. Default value: [constant DRAW_ORDER_INDEX]. + + Particle draw order. Uses [enum DrawOrder] values. @@ -95,117 +95,117 @@ 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. Default value: [constant EMISSION_SHAPE_POINT]. + + 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]. - - If [code]true[/code], particles are being emitted. Default value: [code]true[/code]. + + If [code]true[/code], particles are being emitted. - - How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins. Default value: [code]0[/code]. + + How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins. - + The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. - + Align Y axis of particle with the direction of its velocity. - + - - If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code]. + + If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. - - Gravity applied to every particle. Default value: [code](0, 98)[/code]. + + Gravity applied to every particle. - + Initial hue variation applied to each particle. - + Each particle's hue will vary along this [Curve]. - - Hue variation randomness ratio. Default value: [code]0[/code]. + + Hue variation randomness ratio. - + Initial velocity magnitude for each particle. Direction comes from [member spread] and the node's orientation. - - Initial velocity randomness ratio. Default value: [code]0[/code]. + + Initial velocity randomness ratio. - - Amount of time each particle will exist. Default value: [code]1[/code]. + + Amount of time each particle will exist. - + Linear acceleration applied to each particle in the direction of motion. - + Each particle's linear acceleration will vary along this [Curve]. - - Linear acceleration randomness ratio. Default value: [code]0[/code]. + + Linear acceleration randomness ratio. - - If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. Default value: [code]true[/code]. + + If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. - + Normal map to be used for the [member texture] property. - - 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]. + + 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. Specified in number of full rotations around origin per second. - + Each particle's orbital velocity will vary along this [Curve]. - - Orbital velocity randomness ratio. Default value: [code]0[/code]. + + Orbital velocity randomness ratio. - + Particle system starts as if it had already run for this many seconds. - + Radial acceleration applied to each particle. Makes particle accelerate away from origin. - + Each particle's radial acceleration will vary along this [Curve]. - - Radial acceleration randomness ratio. Default value: [code]0[/code]. + + Radial acceleration randomness ratio. - - Emission lifetime randomness ratio. Default value: [code]0[/code]. + + Emission lifetime randomness ratio. - + Initial scale applied to each particle. - + Each particle's scale will vary along this [Curve]. - - Scale randomness ratio. Default value: [code]0[/code]. + + Scale randomness ratio. - - Particle system's running speed scaling ratio. Default value: [code]1[/code]. A value of [code]0[/code] can be used to pause the particles. + + Particle system's running speed scaling ratio. A value of [code]0[/code] can be used to pause the particles. - - Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Default value: [code]45[/code]. + + Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. - + Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. - + Each particle's tangential acceleration will vary along this [Curve]. - - Tangential acceleration randomness ratio. Default value: [code]0[/code]. + + Tangential acceleration randomness ratio. - + Particle texture. If [code]null[/code], particles will be squares. diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index 99431c2e001..c22413ae7ec 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -162,42 +162,42 @@ - + The culling mask that describes which 3D render layers are rendered by this camera. - - If [code]true[/code], the ancestor [Viewport] is currently using this camera. Default value: [code]false[/code]. + + If [code]true[/code], the ancestor [Viewport] is currently using this camera. - - If not [constant DOPPLER_TRACKING_DISABLED], this camera will simulate the Doppler effect for objects changed in particular [code]_process[/code] methods. See [enum DopplerTracking] for possible values. Default value: [constant DOPPLER_TRACKING_DISABLED]. + + If not [constant DOPPLER_TRACKING_DISABLED], this camera will simulate the Doppler effect for objects changed in particular [code]_process[/code] methods. See [enum DopplerTracking] for possible values. - + The [Environment] to use for this camera. - + The distance to the far culling boundary for this camera relative to its local Z axis. - + The camera's field of view angle (in degrees). Only applicable in perspective mode. Since [member keep_aspect] locks one axis, [code]fov[/code] sets the other axis' field of view angle. - + - + The horizontal (X) offset of the camera viewport. - + The axis to lock during [member fov]/[member size] adjustments. Can be either [constant KEEP_WIDTH] or [constant KEEP_HEIGHT]. - + The distance to the near culling boundary for this camera relative to its local Z axis. - + The camera's projection mode. In [constant PROJECTION_PERSPECTIVE] mode, objects' Z distance from the camera's local space scales their perceived size. - + The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since [member keep_aspect] locks on axis, [code]size[/code] sets the other axis' size length. - + The vertical (Y) offset of the camera viewport. diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 86f0b00d2f5..e9a9f22e825 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -62,78 +62,78 @@ - + The Camera2D's anchor point. See [code]ANCHOR_MODE_*[/code] constants. - + 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. - + Bottom margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen. - - If [code]true[/code], the camera only moves when reaching the horizontal drag margins. If [code]false[/code], the camera moves horizontally regardless of margins. Default value: [code]true[/code]. + + If [code]true[/code], the camera only moves when reaching the horizontal drag margins. If [code]false[/code], the camera moves horizontally regardless of margins. - + Left margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen. - + Right margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen. - + Top margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen. - - If [code]true[/code], the camera only moves when reaching the vertical drag margins. If [code]false[/code], the camera moves vertically regardless of margins. Default value: [code]true[/code]. + + If [code]true[/code], the camera only moves when reaching the vertical drag margins. If [code]false[/code], the camera moves vertically regardless of margins. - - If [code]true[/code], draws the camera's drag margin rectangle in the editor. Default value: [code]false[/code]. + + If [code]true[/code], draws the camera's drag margin rectangle in the editor. - - If [code]true[/code], draws the camera's limits rectangle in the editor. Default value: [code]true[/code]. + + If [code]true[/code], draws the camera's limits rectangle in the editor. - - If [code]true[/code], draws the camera's screen rectangle in the editor. Default value: [code]false[/code]. + + If [code]true[/code], draws the camera's screen rectangle in the editor. - + Bottom scroll limit in pixels. The camera stops moving when reaching this value. - + Left scroll limit in pixels. The camera stops moving when reaching this value. - + Right scroll limit in pixels. The camera stops moving when reaching this value. - - If [code]true[/code], the camera smoothly stops when reaches its limits. Default value: [code]false[/code]. + + If [code]true[/code], the camera smoothly stops when reaches its limits. - + Top scroll limit in pixels. The camera stops moving when reaching this value. - + The camera's offset, useful for looking around or camera shake animations. - - The horizontal offset of the camera, relative to the drag margins. Default value: [code]0[/code]. + + The horizontal offset of the camera, relative to the drag margins. - - The vertical offset of the camera, relative to the drag margins. Default value: [code]0[/code]. + + The vertical offset of the camera, relative to the drag margins. - + - - If [code]true[/code], the camera rotates with the target. Default value: [code]false[/code]. + + If [code]true[/code], the camera rotates with the target. - - If [code]true[/code], the camera smoothly moves towards the target at [member smoothing_speed]. Default value: [code]false[/code]. + + If [code]true[/code], the camera smoothly moves towards the target at [member smoothing_speed]. - + Speed in pixels per second of the camera's smoothing effect when [member smoothing_enabled] is [code]true[/code]. - + The camera's zoom relative to the viewport. Values larger than [code]Vector2(1, 1)[/code] zoom out and smaller values zoom in. For an example, use [code]Vector2(0.5, 0.5)[/code] for a 2× zoom-in, and [code]Vector2(4, 4)[/code] for a 4× zoom-out. diff --git a/doc/classes/CameraFeed.xml b/doc/classes/CameraFeed.xml index 28280d688f0..6d7757f9f58 100644 --- a/doc/classes/CameraFeed.xml +++ b/doc/classes/CameraFeed.xml @@ -33,9 +33,9 @@ - + - + diff --git a/doc/classes/CameraTexture.xml b/doc/classes/CameraTexture.xml index 5017df7a326..15da46885f7 100644 --- a/doc/classes/CameraTexture.xml +++ b/doc/classes/CameraTexture.xml @@ -11,13 +11,13 @@ - + The ID of the [CameraFeed] for which we want to display the image. - + Convenience property that gives access to the active property of the [CameraFeed]. - + Which image within the [CameraFeed] we want access to, important if the camera image is split in a Y and CbCr component. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index f1a5c3a62f7..5ac825ddcda 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -511,29 +511,29 @@ - - The rendering layers in which this [CanvasItem] responds to [Light2D] nodes. Default value: [code]1[/code]. + + The rendering layers in which this [CanvasItem] responds to [Light2D] nodes. - - The material applied to textures on this [CanvasItem]. Default value: [code]null[/code]. + + The material applied to textures on this [CanvasItem]. - - The color applied to textures on this [CanvasItem]. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white"). + + The color applied to textures on this [CanvasItem]. - - The color applied to textures on this [CanvasItem]. This is not inherited by children [CanvasItem]s. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white").. + + The color applied to textures on this [CanvasItem]. This is not inherited by children [CanvasItem]s. - - If [code]true[/code], the object draws behind its parent. Default value: [code]false[/code]. + + If [code]true[/code], the object draws behind its parent. - If [code]true[/code], the object draws on top of its parent. Default value: [code]true[/code]. + If [code]true[/code], the object draws on top of its parent. - - If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material. Default value: [code]false[/code]. + + If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material. - - If [code]true[/code], this [CanvasItem] is drawn. Default value: [code]true[/code]. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead. + + If [code]true[/code], this [CanvasItem] is drawn. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead. diff --git a/doc/classes/CanvasItemMaterial.xml b/doc/classes/CanvasItemMaterial.xml index f125c2be0d1..5963e00d9e2 100644 --- a/doc/classes/CanvasItemMaterial.xml +++ b/doc/classes/CanvasItemMaterial.xml @@ -11,10 +11,10 @@ - + The manner in which a material's rendering is applied to underlying textures. - + The manner in which material reacts to lighting. @@ -23,7 +23,7 @@ - + diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index a9b6b9f5610..2e56009f50d 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -23,26 +23,26 @@ The custom [Viewport] node assigned to the [CanvasLayer]. If [code]null[/code], uses the default viewport instead. - + - + - - Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code]. + + Layer index for draw order. Lower values are drawn first. - + The layer's base offset. - + The layer's rotation in radians. - + The layer's rotation in degrees. - + The layer's scale. - + The layer's transform. diff --git a/doc/classes/CanvasModulate.xml b/doc/classes/CanvasModulate.xml index aa956e3f513..95214b8c6a9 100644 --- a/doc/classes/CanvasModulate.xml +++ b/doc/classes/CanvasModulate.xml @@ -11,7 +11,7 @@ - + The tint color to apply. diff --git a/doc/classes/CapsuleMesh.xml b/doc/classes/CapsuleMesh.xml index eba440a84ef..3cdb9b3e220 100644 --- a/doc/classes/CapsuleMesh.xml +++ b/doc/classes/CapsuleMesh.xml @@ -11,17 +11,17 @@ - - Height of the capsule mesh from the center point. Defaults to 1.0. + + Height of the capsule mesh from the center point. - - Number of radial segments on the capsule mesh. Defaults to 64. + + Number of radial segments on the capsule mesh. - - Radius of the capsule mesh. Defaults to 1.0. + + Radius of the capsule mesh. - - Number of rings along the height of the capsule. Defaults to 8. + + Number of rings along the height of the capsule. diff --git a/doc/classes/CapsuleShape.xml b/doc/classes/CapsuleShape.xml index c867dcf3267..0b55ca34725 100644 --- a/doc/classes/CapsuleShape.xml +++ b/doc/classes/CapsuleShape.xml @@ -11,10 +11,10 @@ - + The capsule's height. - + The capsule's radius. diff --git a/doc/classes/CapsuleShape2D.xml b/doc/classes/CapsuleShape2D.xml index c7724314d61..a13abadf360 100644 --- a/doc/classes/CapsuleShape2D.xml +++ b/doc/classes/CapsuleShape2D.xml @@ -11,10 +11,10 @@ - + The capsule's height. - + The capsule's radius. diff --git a/doc/classes/CenterContainer.xml b/doc/classes/CenterContainer.xml index e7403daa00b..d792b1b180d 100644 --- a/doc/classes/CenterContainer.xml +++ b/doc/classes/CenterContainer.xml @@ -11,8 +11,8 @@ - - If [code]true[/code], centers children relative to the [CenterContainer]'s top left corner. Default value: [code]false[/code]. + + If [code]true[/code], centers children relative to the [CenterContainer]'s top left corner. diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index 91b176bc60e..5583775f950 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -13,7 +13,7 @@ - + @@ -23,21 +23,21 @@ - + - + - + - + - + - + diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml index 04344c18342..daed9128a9c 100644 --- a/doc/classes/CheckButton.xml +++ b/doc/classes/CheckButton.xml @@ -13,7 +13,7 @@ - + @@ -21,21 +21,21 @@ - + - + - + - + - + - + diff --git a/doc/classes/CircleShape2D.xml b/doc/classes/CircleShape2D.xml index 7c8bf923f41..4cff7b5cd42 100644 --- a/doc/classes/CircleShape2D.xml +++ b/doc/classes/CircleShape2D.xml @@ -11,7 +11,7 @@ - + The circle's radius. diff --git a/doc/classes/ClippedCamera.xml b/doc/classes/ClippedCamera.xml index c6dcd6cd967..f6a2a3bc112 100644 --- a/doc/classes/ClippedCamera.xml +++ b/doc/classes/ClippedCamera.xml @@ -71,15 +71,15 @@ - + - + - + - + - + diff --git a/doc/classes/CollisionObject.xml b/doc/classes/CollisionObject.xml index cb105300062..c30aeafcf38 100644 --- a/doc/classes/CollisionObject.xml +++ b/doc/classes/CollisionObject.xml @@ -180,11 +180,11 @@ - - If [code]true[/code], the [CollisionObject] will continue to receive input events as the mouse is dragged across its shapes. Default value: [code]false[/code]. + + If [code]true[/code], the [CollisionObject] will continue to receive input events as the mouse is dragged across its shapes. - - If [code]true[/code], the [CollisionObject]'s shapes will respond to [RayCast]s. Default value: [code]true[/code]. + + If [code]true[/code], the [CollisionObject]'s shapes will respond to [RayCast]s. diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index f847893a39e..eb69a4aed4c 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -214,7 +214,7 @@ - + If [code]true[/code], this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. Requires at least one [code]collision_layer[/code] bit to be set. diff --git a/doc/classes/CollisionPolygon.xml b/doc/classes/CollisionPolygon.xml index 74ff41a8545..994f5891902 100644 --- a/doc/classes/CollisionPolygon.xml +++ b/doc/classes/CollisionPolygon.xml @@ -11,13 +11,13 @@ - + Length that the resulting collision extends in either direction perpendicular to its polygon. - + If [code]true[/code], no collision will be produced. - + Array of vertices which define the polygon. [b]Note:[/b] The returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the [code]polygon[/code] member. diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml index b0c514affcf..fe46d45f719 100644 --- a/doc/classes/CollisionPolygon2D.xml +++ b/doc/classes/CollisionPolygon2D.xml @@ -11,18 +11,18 @@ - - Collision build mode. Use one of the [code]BUILD_*[/code] constants. Default value: [constant BUILD_SOLIDS]. + + Collision build mode. Use one of the [code]BUILD_*[/code] constants. - + If [code]true[/code], no collisions will be detected. - + If [code]true[/code], only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. - + - + The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the PoolVector2Array, not a reference. diff --git a/doc/classes/CollisionShape.xml b/doc/classes/CollisionShape.xml index 3f2e550e83d..bbbc07e6d3c 100644 --- a/doc/classes/CollisionShape.xml +++ b/doc/classes/CollisionShape.xml @@ -28,10 +28,10 @@ - + A disabled collision shape has no effect in the world. - + The actual shape owned by this collision shape. diff --git a/doc/classes/CollisionShape2D.xml b/doc/classes/CollisionShape2D.xml index 97dc230f22f..fa002bc8810 100644 --- a/doc/classes/CollisionShape2D.xml +++ b/doc/classes/CollisionShape2D.xml @@ -12,15 +12,15 @@ - + A disabled collision shape has no effect in the world. - + Sets whether this collision shape should only detect collision on one side (top or bottom). - + - + The actual shape owned by this collision shape. diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 41b8e735c2a..46499ed3494 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -263,37 +263,37 @@ - + Alpha value (range 0 to 1). - + Alpha value (range 0 to 255). - + Blue value (range 0 to 1). - + Blue value (range 0 to 255). - + Green value (range 0 to 1). - + Green value (range 0 to 255). - + HSV hue value (range 0 to 1). - + Red value (range 0 to 1). - + Red value (range 0 to 255). - + HSV saturation value (range 0 to 1). - + HSV value (range 0 to 1). diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index 08ddfd57708..b62eb443d9d 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -37,24 +37,24 @@ - + The currently selected color. - + If [code]true[/code], the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues). - + If [code]true[/code], shows an alpha channel slider (transparency). - + If [code]true[/code], allows editing the color with Hue/Saturation/Value sliders. [b]Note:[/b] Cannot be enabled if raw mode is on. - + - + - + If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). [b]Note:[/b] Cannot be enabled if HSV mode is on. @@ -91,19 +91,19 @@ - + - + - + - + - + diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 3e4911cac3d..7aeae61ebf4 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -25,11 +25,11 @@ - + The currently selected color. - - If [code]true[/code], the alpha channel in the displayed [ColorPicker] will be visible. Default value: [code]true[/code]. + + If [code]true[/code], the alpha channel in the displayed [ColorPicker] will be visible. @@ -56,17 +56,17 @@ - + - + - + - + - + diff --git a/doc/classes/ColorRect.xml b/doc/classes/ColorRect.xml index d659ebdfcd2..2ff0a7eee37 100644 --- a/doc/classes/ColorRect.xml +++ b/doc/classes/ColorRect.xml @@ -11,7 +11,7 @@ - + The fill color. [codeblock] $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect's color to red. diff --git a/doc/classes/ConcavePolygonShape2D.xml b/doc/classes/ConcavePolygonShape2D.xml index a4d91991cf1..a6fe2486eae 100644 --- a/doc/classes/ConcavePolygonShape2D.xml +++ b/doc/classes/ConcavePolygonShape2D.xml @@ -12,7 +12,7 @@ - + The array of points that make up the [ConcavePolygonShape2D]'s line segments. diff --git a/doc/classes/ConeTwistJoint.xml b/doc/classes/ConeTwistJoint.xml index c268e66abde..ad9c2b3a354 100644 --- a/doc/classes/ConeTwistJoint.xml +++ b/doc/classes/ConeTwistJoint.xml @@ -13,23 +13,23 @@ - + The speed with which the swing or twist will take place. The higher, the faster. - + Defines, how fast the swing- and twist-speed-difference on both sides gets synced. - + The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. - + Swing is rotation from side to side, around the axis perpendicular to the twist axis. The swing span defines, how much rotation will not get corrected along the swing axis. Could be defined as looseness in the [ConeTwistJoint]. - If below 0.05, this behavior is locked. Default value: [code]PI/4[/code]. + If below 0.05, this behavior is locked. - + Twist is the rotation around the twist axis, this value defined how far the joint can twist. Twist is locked if below 0.05. @@ -39,7 +39,7 @@ Swing is rotation from side to side, around the axis perpendicular to the twist axis. The swing span defines, how much rotation will not get corrected along the swing axis. Could be defined as looseness in the [ConeTwistJoint]. - If below 0.05, this behavior is locked. Default value: [code]PI/4[/code]. + If below 0.05, this behavior is locked. Twist is the rotation around the twist axis, this value defined how far the joint can twist. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index a99c29def23..d25c2b31eed 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -644,107 +644,107 @@ - - Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience. Default value: [constant ANCHOR_BEGIN]. + + Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience. - - Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience.Default value: [constant ANCHOR_BEGIN]. + + Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience. - - Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience. Default value: [constant ANCHOR_BEGIN]. + + Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience. - - Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience. Default value: [constant ANCHOR_BEGIN]. + + Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience. - + The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals. - + Tells Godot which node it should give keyboard focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the [code]ui_down[/code] input action. The node must be a [Control]. If this property is not set, Godot will give focus to the closest [Control] to the bottom of this one. - + Tells Godot which node it should give keyboard focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the [code]ui_left[/code] input action. The node must be a [Control]. If this property is not set, Godot will give focus to the closest [Control] to the left of this one. - + Tells Godot which node it should give keyboard focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the [code]ui_right[/code] input action. The node must be a [Control]. If this property is not set, Godot will give focus to the closest [Control] to the bottom of this one. - + Tells Godot which node it should give keyboard focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the [code]ui_top[/code] input action. The node must be a [Control]. If this property is not set, Godot will give focus to the closest [Control] to the bottom of this one. - + Tells Godot which node it should give keyboard focus to if the user presses Tab on a keyboard by default. You can change the key by editing the [code]ui_focus_next[/code] input action. If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree. - + Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab on a keyboard by default. You can change the key by editing the [code]ui_focus_prev[/code] input action. If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree. - + Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size. - + Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size. - + Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the [member mouse_filter] property is not [constant MOUSE_FILTER_IGNORE]. - + Distance between the node's bottom edge and its parent control, based on [member anchor_bottom]. Margins are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Margins update automatically when you move or resize the node. - + Distance between the node's left edge and its parent control, based on [member anchor_left]. Margins are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Margins update automatically when you move or resize the node. - + Distance between the node's right edge and its parent control, based on [member anchor_right]. Margins are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Margins update automatically when you move or resize the node. - + Distance between the node's top edge and its parent control, based on [member anchor_top]. Margins are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Margins update automatically when you move or resize the node. - + The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors. [b]Note:[/b] On Linux, shapes may vary depending on the cursor theme of the system. - + Controls whether the control will be able to receive mouse button input events through [method _gui_input] and how these events should be handled. Also controls whether the control can receive the [signal mouse_entered], and [signal mouse_exited] signals. See the constants to learn what each does. - + 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). - + The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes. - + By default, the node's pivot is its top-left corner. When you change its [member rect_scale], it will scale around this pivot. Set this property to [member rect_size] / 2 to center the pivot in the node's rectangle. - + The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by [member rect_pivot_offset]. - + The node's rotation around its pivot, in degrees. See [member rect_pivot_offset] to change the pivot's position. - + The node's scale, relative to its [member rect_size]. Change this property to scale the node around its [member rect_pivot_offset]. - + The size of the node's bounding rectangle, in pixels. [Container] nodes update this property automatically. - + Tells the parent [Container] nodes how they should resize and place the node on the X axis. Use one of the [code]SIZE_*[/code] constants to change the flags. See the constants to learn what each does. - + If the node and at least one of its neighbours uses the [constant SIZE_EXPAND] size flag, the parent [Container] will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space. - + Tells the parent [Container] nodes how they should resize and place the node on the Y axis. Use one of the [code]SIZE_*[/code] constants to change the flags. See the constants to learn what each does. - + Changing this property replaces the current [Theme] resource this node and all its [Control] children use. diff --git a/doc/classes/ConvexPolygonShape.xml b/doc/classes/ConvexPolygonShape.xml index 31b4d082131..d15a0a7336c 100644 --- a/doc/classes/ConvexPolygonShape.xml +++ b/doc/classes/ConvexPolygonShape.xml @@ -11,7 +11,7 @@ - + The list of 3D points forming the convex polygon shape. diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml index fc21cb2ba96..050ca23e05e 100644 --- a/doc/classes/ConvexPolygonShape2D.xml +++ b/doc/classes/ConvexPolygonShape2D.xml @@ -21,7 +21,7 @@ - + The polygon's list of vertices. Can be in either clockwise or counterclockwise order. diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml index 21329628a07..2cedc78499e 100644 --- a/doc/classes/CubeMap.xml +++ b/doc/classes/CubeMap.xml @@ -45,13 +45,13 @@ - + The render flags for the [CubeMap]. See the [code]FLAG_*[/code] constants for details. - + The lossy storage quality of the [CubeMap] if the storage mode is set to STORAGE_COMPRESS_LOSSY. - + The [CubeMap]'s storage mode. See [code]STORAGE_*[/code] constants. diff --git a/doc/classes/CubeMesh.xml b/doc/classes/CubeMesh.xml index d60bea3015b..67e559ab078 100644 --- a/doc/classes/CubeMesh.xml +++ b/doc/classes/CubeMesh.xml @@ -12,17 +12,17 @@ - - Size of the cuboid mesh. Defaults to (2, 2, 2). + + Size of the cuboid mesh. - - Number of extra edge loops inserted along the Z axis. Defaults to 0. + + Number of extra edge loops inserted along the Z axis. - - Number of extra edge loops inserted along the Y axis. Defaults to 0. + + Number of extra edge loops inserted along the Y axis. - - Number of extra edge loops inserted along the X axis. Defaults to 0. + + Number of extra edge loops inserted along the X axis. diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index cc721b674b9..0fb559296e1 100644 --- a/doc/classes/Curve.xml +++ b/doc/classes/Curve.xml @@ -194,14 +194,14 @@ - + The number of points to include in the baked (i.e. cached) curve data. - - The maximum value the curve can reach. Default value: [code]1[/code]. + + The maximum value the curve can reach. - - The minimum value the curve can reach. Default value: [code]0[/code]. + + The minimum value the curve can reach. diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 995010c2478..4e449a2032b 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -193,7 +193,7 @@ - + The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 190655153a3..4a0873a9868 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -242,10 +242,10 @@ - + The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. - + If [code]true[/code], the curve will bake up vectors used for orientation. This is used when [member PathFollow.rotation_mode] is set to [constant PathFollow.ROTATION_ORIENTED]. Changing it forces the cache to be recomputed. diff --git a/doc/classes/CurveTexture.xml b/doc/classes/CurveTexture.xml index 0184e1e6b69..666284138bf 100644 --- a/doc/classes/CurveTexture.xml +++ b/doc/classes/CurveTexture.xml @@ -11,10 +11,10 @@ - + The [code]curve[/code] rendered onto the texture. - + The width of the texture. diff --git a/doc/classes/CylinderMesh.xml b/doc/classes/CylinderMesh.xml index dbdc7aeb926..8e9397791a5 100644 --- a/doc/classes/CylinderMesh.xml +++ b/doc/classes/CylinderMesh.xml @@ -11,20 +11,20 @@ - - Bottom radius of the cylinder. Defaults to 1.0. + + Bottom radius of the cylinder. - - Full height of the cylinder. Defaults to 2.0. + + Full height of the cylinder. - - Number of radial segments on the cylinder. Defaults to 64. + + Number of radial segments on the cylinder. - - Number of edge rings along the height of the cylinder. Defaults to 4. + + Number of edge rings along the height of the cylinder. - - Top radius of the cylinder. Defaults to 1.0. + + Top radius of the cylinder. diff --git a/doc/classes/CylinderShape.xml b/doc/classes/CylinderShape.xml index 847265ef25c..5dff1567759 100644 --- a/doc/classes/CylinderShape.xml +++ b/doc/classes/CylinderShape.xml @@ -11,10 +11,10 @@ - + The cylinder's height. - + The cylinder's radius. diff --git a/doc/classes/DampedSpringJoint2D.xml b/doc/classes/DampedSpringJoint2D.xml index cfcf2d20e28..270d948f5ef 100644 --- a/doc/classes/DampedSpringJoint2D.xml +++ b/doc/classes/DampedSpringJoint2D.xml @@ -11,17 +11,17 @@ - - The spring joint's damping ratio. A value between [code]0[/code] and [code]1[/code]. When the two bodies move into different directions the system tries to align them to the spring axis again. A high [code]damping[/code] value forces the attached bodies to align faster. Default value: [code]1[/code]. + + The spring joint's damping ratio. A value between [code]0[/code] and [code]1[/code]. When the two bodies move into different directions the system tries to align them to the spring axis again. A high [code]damping[/code] value forces the attached bodies to align faster. - - The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: [code]50[/code]. + + The spring joint's maximum length. The two attached bodies cannot stretch it past this value. - - When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. Default value: [code]0[/code]. + + When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. - - The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. Default value: [code]20[/code]. + + The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. diff --git a/doc/classes/DirectionalLight.xml b/doc/classes/DirectionalLight.xml index eb025043984..4d0ff7f13bb 100644 --- a/doc/classes/DirectionalLight.xml +++ b/doc/classes/DirectionalLight.xml @@ -12,31 +12,31 @@ - + Amount of extra bias for shadow splits that are far away. If self-shadowing occurs only on the splits far away, increasing this value can fix them. - - If [code]true[/code], shadow detail is sacrificed in exchange for smoother transitions between splits. Default value: [code]false[/code]. + + If [code]true[/code], shadow detail is sacrificed in exchange for smoother transitions between splits. - + Optimizes shadow rendering for detail versus movement. See [enum ShadowDepthRange]. - + The maximum distance for shadow splits. - + The light's shadow rendering algorithm. See [enum ShadowMode]. - + Can be used to fix special cases of self shadowing when objects are perpendicular to the light. - + The distance from camera to shadow split 1. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_2_SPLITS[/code] or [code]SHADOW_PARALLEL_4_SPLITS[/code]. - + The distance from shadow split 1 to split 2. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_2_SPLITS[/code] or [code]SHADOW_PARALLEL_4_SPLITS[/code]. - + The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_4_SPLITS[/code]. @@ -51,7 +51,7 @@ Splits the view frustum in 4 areas, each with its own shadow map. - Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Default value. + Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges. diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index 5fdc1ebb750..b7710068a6c 100644 --- a/doc/classes/DynamicFont.xml +++ b/doc/classes/DynamicFont.xml @@ -62,32 +62,32 @@ - + Extra spacing at the bottom in pixels. - + Extra character spacing in pixels. - + Extra space spacing in pixels. - + Extra spacing at the top in pixels. - + The font data. - + - + - + The font size. - + If [code]true[/code], filtering is used. - + If [code]true[/code], mipmapping is used. diff --git a/doc/classes/DynamicFontData.xml b/doc/classes/DynamicFontData.xml index afdd09055cd..ecdab32e804 100644 --- a/doc/classes/DynamicFontData.xml +++ b/doc/classes/DynamicFontData.xml @@ -11,13 +11,13 @@ - + Controls whether the font should be rendered with anti-aliasing. - + The path to the vector font file. - + The font hinting mode used by FreeType. diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index 1d648db20dd..c9f55afbafe 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -40,28 +40,28 @@ - + The location from which the user may select a file, including [code]res://[/code], [code]user://[/code], and the local file system. - + The currently occupied directory. - + The currently selected file. - + The file system path in the address bar. - + If [code]true[/code], the [EditorFileDialog] will not warn the user before overwriting files. - + The view format in which the [EditorFileDialog] displays resources to the user. - + The purpose of the [EditorFileDialog], which defines the allowed behaviors. - + If [code]true[/code], hidden files and directories will be visible in the [EditorFileDialog]. diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index af804f88b59..0da87a9371c 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -105,7 +105,7 @@ - Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. Default value is 1.0. + Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is [code]1.0[/code]. diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 35c4e645a8a..5c24f0bebc0 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -72,22 +72,22 @@ - + Used by the inspector, set when property is checkable. - + Used by the inspector, when the property is checked. - + Used by the inspector, when the property must draw with error color. - + Used by the inspector, when the property can add keys for animation. - + Sets this property to change the label (if you want to show one). - + Used by the inspector, when the property is read-only. diff --git a/doc/classes/EditorSpatialGizmoPlugin.xml b/doc/classes/EditorSpatialGizmoPlugin.xml index 28586312f3d..777d558a8e9 100644 --- a/doc/classes/EditorSpatialGizmoPlugin.xml +++ b/doc/classes/EditorSpatialGizmoPlugin.xml @@ -25,7 +25,7 @@ - Override this method to define whether the gizmo can be hidden or not. Defaults to [code]true[/code]. + Override this method to define whether the gizmo can be hidden or not. Returns [code]true[/code] if not overridden. diff --git a/doc/classes/EncodedObjectAsID.xml b/doc/classes/EncodedObjectAsID.xml index 6efdda48ef4..7221aa845bf 100644 --- a/doc/classes/EncodedObjectAsID.xml +++ b/doc/classes/EncodedObjectAsID.xml @@ -12,7 +12,7 @@ - + The [Object] identifier stored in this [EncodedObjectAsID] instance. The object instance can be retrieved with [method @GDScript.instance_from_id]. diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 265396e7cfe..60a807c3047 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -120,18 +120,18 @@ - + If [code]true[/code], it is running inside the editor. Useful for tool scripts. - + The number of fixed iterations per second (for fixed process and physics). - + - - The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit. + + The desired frames per second. If the hardware cannot keep up, this setting may not be respected. A value of 0 means no limit. - + Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 7158c132e61..9df8ae1aa59 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -17,235 +17,235 @@ - + Global brightness value of the rendered scene (default value is 1). - + Applies the provided [Texture] resource to affect the global color aspect of the rendered scene. - + Global contrast value of the rendered scene (default value is 1). - + Enables the adjustment_* options provided by this resource. If [code]false[/code], adjustments modifications will have no effect on the rendered scene. - + Global color saturation value of the rendered scene (default value is 1). - + [Color] of the ambient light. - + Energy of the ambient light. The higher the value, the stronger the light. - + Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. - + Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light. - + Maximum luminance value for the auto exposure. - + Minimum luminance value for the auto exposure. - + Scale of the auto exposure effect. Affects the intensity of auto exposure. - + Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. - + The id of the camera feed to show in the background. - + Maximum layer id (if using Layer background mode). - + Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). - + Power of light emitted by the background. - + Defines the mode of background. - + [Sky] resource defined as background. - + [Sky] resource's custom field of view. - + [Sky] resource's rotation expressed as a [Basis] - + [Sky] resource's rotation expressed as euler angles in radians - + [Sky] resource's rotation expressed as euler angles in degrees - + Amount of far blur. - + Distance from the camera where the far blur effect affects the rendering. - + Enables the far blur effect. - + Quality of the far blur quality. - + Transition between no-blur area and far blur. - + Amount of near blur. - + Distance from the camera where the near blur effect affects the rendering. - + Enables the near blur effect. - + Quality of the near blur quality. - + Transition between near blur and no-blur area. - + Fog's [Color]. - + Fog's depth starting distance from the camera. - + Value defining the fog depth intensity. - + Enables the fog depth. - + - + Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. - + Value defining the fog height intensity. - + Enables the fog height. - + Maximum height of fog. - + Minimum height of fog. - + Amount of sun that affects the fog rendering. - + Sun [Color]. - + Amount of light that the fog transmits. - + Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog. - + - + Glow blending mode. - + Bloom value (global glow). - + Enables glow rendering. - + - + Bleed scale of the HDR glow. - + Bleed threshold of the HDR glow. - + Glow intensity. - + First level of glow (most local). - + Second level of glow. - + Third level of glow. - + Fourth level of glow. - + Fifth level of glow. - + Sixth level of glow. - + Seventh level of glow (most global). - + Glow strength. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + Default exposure for tonemap. - + Tonemapping mode. - + White reference value for tonemap. diff --git a/doc/classes/File.xml b/doc/classes/File.xml index fb462d001d3..9eff0a4d27d 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -417,7 +417,7 @@ - + If [code]true[/code], the file's endianness is swapped. Use this if you're dealing with files written on big-endian machines. [b]Note:[/b] This is about the file format, not CPU type. This is always reset to [code]false[/code] whenever you open the file. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index bc64f844f65..e78f21b274c 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -55,28 +55,28 @@ - + The file system access scope. See enum [code]Access[/code] constants. - + The current working directory of the file dialog. - + The currently selected file of the file dialog. - + The currently selected file path of the file dialog. - + The available file type filters. For example, this shows only [code].png[/code] and [code].gd[/code] files: [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))[/code]. - + The dialog's open or save mode, which affects the selection behavior. See enum [code]Mode[/code] constants. - + If [code]true[/code], changing the [code]Mode[/code] property will set the window title accordingly (e.g. setting mode to [constant MODE_OPEN_FILE] will change the window title to "Open a File"). - + If [code]true[/code], the dialog will show hidden files. @@ -130,7 +130,7 @@ - + diff --git a/doc/classes/GIProbe.xml b/doc/classes/GIProbe.xml index 84cd446ea29..6f672bd01a1 100644 --- a/doc/classes/GIProbe.xml +++ b/doc/classes/GIProbe.xml @@ -26,25 +26,25 @@ - + - + - + - + - + - + - + - + - + - + diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml index 94b86dee741..84bd695f433 100644 --- a/doc/classes/GIProbeData.xml +++ b/doc/classes/GIProbeData.xml @@ -9,27 +9,27 @@ - + - + - + - + - + - + - + - + - + - + - + diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml index 8d2f1285a95..91a1cb1cd4b 100644 --- a/doc/classes/Generic6DOFJoint.xml +++ b/doc/classes/Generic6DOFJoint.xml @@ -11,236 +11,236 @@ - + The amount of rotational damping across the X axis. The lower, the longer an impulse from one side takes to travel to the other side. - + If [code]true[/code], rotation across the X axis is limited. - + When rotating across the X axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. - + The maximum amount of force that can occur, when rotating around the X axis. - + The minimum rotation in negative direction to break loose and rotate around the X axis. - + The amount of rotational restitution across the X axis. The lower, the more restitution occurs. - + The speed of all rotations across the X axis. - + The minimum rotation in positive direction to break loose and rotate around the X axis. - + The amount of rotational damping across the Y axis. The lower, the more dampening occurs. - + If [code]true[/code], rotation across the Y axis is limited. - + When rotating across the Y axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. - + The maximum amount of force that can occur, when rotating around the Y axis. - + The minimum rotation in negative direction to break loose and rotate around the Y axis. - + The amount of rotational restitution across the Y axis. The lower, the more restitution occurs. - + The speed of all rotations across the Y axis. - + The minimum rotation in positive direction to break loose and rotate around the Y axis. - + The amount of rotational damping across the Z axis. The lower, the more dampening occurs. - + If [code]true[/code], rotation across the Z axis is limited. - + When rotating across the Z axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. - + The maximum amount of force that can occur, when rotating around the Z axis. - + The minimum rotation in negative direction to break loose and rotate around the Z axis. - + The amount of rotational restitution across the Z axis. The lower, the more restitution occurs. - + The speed of all rotations across the Z axis. - + The minimum rotation in positive direction to break loose and rotate around the Z axis. - + If [code]true[/code], a rotating motor at the X axis is enabled. - + Maximum acceleration for the motor at the X axis. - + Target speed for the motor at the X axis. - + If [code]true[/code], a rotating motor at the Y axis is enabled. - + Maximum acceleration for the motor at the Y axis. - + Target speed for the motor at the Y axis. - + If [code]true[/code], a rotating motor at the Z axis is enabled. - + Maximum acceleration for the motor at the Z axis. - + Target speed for the motor at the Z axis. - + - + - + - + - + - + - + - + - + - + - + - + - + The amount of damping that happens at the X motion. - + If [code]true[/code], the linear motion across the X axis is limited. - + The minimum difference between the pivot points' X axis. - + The amount of restitution on the X axis movement. The lower, the more momentum gets lost. - + A factor applied to the movement across the X axis. The lower, the slower the movement. - + The maximum difference between the pivot points' X axis. - + The amount of damping that happens at the Y motion. - + If [code]true[/code], the linear motion across the Y axis is limited. - + The minimum difference between the pivot points' Y axis. - + The amount of restitution on the Y axis movement. The lower, the more momentum gets lost. - + A factor applied to the movement across the Y axis. The lower, the slower the movement. - + The maximum difference between the pivot points' Y axis. - + The amount of damping that happens at the Z motion. - + If [code]true[/code], the linear motion across the Z axis is limited. - + The minimum difference between the pivot points' Z axis. - + The amount of restitution on the Z axis movement. The lower, the more momentum gets lost. - + A factor applied to the movement across the Z axis. The lower, the slower the movement. - + The maximum difference between the pivot points' Z axis. - + If [code]true[/code], then there is a linear motor on the X axis. It will attempt to reach the target velocity while staying within the force limits. - + The maximum force the linear motor can apply on the X axis while trying to reach the target velocity. - + The speed that the linear motor will attempt to reach on the X axis. - + If [code]true[/code], then there is a linear motor on the Y axis. It will attempt to reach the target velocity while staying within the force limits. - + The maximum force the linear motor can apply on the Y axis while trying to reach the target velocity. - + The speed that the linear motor will attempt to reach on the Y axis. - + If [code]true[/code], then there is a linear motor on the Z axis. It will attempt to reach the target velocity while staying within the force limits. - + The maximum force the linear motor can apply on the Z axis while trying to reach the target velocity. - + The speed that the linear motor will attempt to reach on the Z axis. - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index d3e3dfce929..eb1847a0557 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -20,29 +20,29 @@ - + The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values. - + The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box. - + The GeometryInstance's max LOD distance. - + The GeometryInstance's max LOD margin. - + The GeometryInstance's min LOD distance. - + The GeometryInstance's min LOD margin. - + The material override for the whole geometry. If there is a material in [code]material_override[/code], it will be used instead of any material set in any material slot of the mesh. - + If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] and/or any other form of baked lighting. diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index 62c23d1974a..247a7afe85e 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -87,10 +87,10 @@ - + Gradient's colors returned as a [PoolColorArray]. - + Gradient's offsets returned as a [PoolRealArray]. diff --git a/doc/classes/GradientTexture.xml b/doc/classes/GradientTexture.xml index a191af3a8d7..ef46491e02a 100644 --- a/doc/classes/GradientTexture.xml +++ b/doc/classes/GradientTexture.xml @@ -11,10 +11,10 @@ - + The [Gradient] that will be used to fill the texture. - + The number of color samples that will be obtained from the [Gradient]. diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index f6cb4ca4d9e..111bf2109e9 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -171,19 +171,19 @@ - + If [code]true[/code], enables disconnection of existing connections in the GraphEdit by dragging the right end. - + The scroll offset. - + The snapping distance in pixels. - + If [code]true[/code], enables snapping. - + The current zoom value. @@ -280,25 +280,25 @@ - + - + - + - + - + - + - + diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index e72b617bae4..6bc09e52892 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -173,21 +173,21 @@ - + - + The offset of the GraphNode, relative to the scroll offset of the [GraphEdit]. [b]Note:[/b] You cannot use position directly, as [GraphEdit] is a [Container]. - + - + - + - + - + @@ -235,9 +235,9 @@ - + - + @@ -251,7 +251,7 @@ - + @@ -259,13 +259,13 @@ - + - + - + diff --git a/doc/classes/GridContainer.xml b/doc/classes/GridContainer.xml index ba6b55be21e..08832c08b4a 100644 --- a/doc/classes/GridContainer.xml +++ b/doc/classes/GridContainer.xml @@ -11,16 +11,16 @@ - + The number of columns in the [GridContainer]. If modified, [GridContainer] reorders its children to accommodate the new layout. - + - + diff --git a/doc/classes/GrooveJoint2D.xml b/doc/classes/GrooveJoint2D.xml index 295338682e6..6b87fa5cfe0 100644 --- a/doc/classes/GrooveJoint2D.xml +++ b/doc/classes/GrooveJoint2D.xml @@ -11,11 +11,11 @@ - - The body B's initial anchor position defined by the joint's origin and a local offset [member initial_offset] along the joint's Y axis (along the groove). Default value: [code]25[/code]. + + The body B's initial anchor position defined by the joint's origin and a local offset [member initial_offset] along the joint's Y axis (along the groove). - - The groove's length. The groove is from the joint's origin towards [member length] along the joint's local Y axis. Default value: [code]50[/code]. + + The groove's length. The groove is from the joint's origin towards [member length] along the joint's local Y axis. diff --git a/doc/classes/HBoxContainer.xml b/doc/classes/HBoxContainer.xml index fce030a260f..e2abbe16cca 100644 --- a/doc/classes/HBoxContainer.xml +++ b/doc/classes/HBoxContainer.xml @@ -13,7 +13,7 @@ - + diff --git a/doc/classes/HSeparator.xml b/doc/classes/HSeparator.xml index ad607292a1b..c34364c573c 100644 --- a/doc/classes/HSeparator.xml +++ b/doc/classes/HSeparator.xml @@ -13,7 +13,7 @@ - + diff --git a/doc/classes/HSplitContainer.xml b/doc/classes/HSplitContainer.xml index accc09d1900..3a425705c61 100644 --- a/doc/classes/HSplitContainer.xml +++ b/doc/classes/HSplitContainer.xml @@ -13,13 +13,13 @@ - + - + diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 1c0f0e5440d..c91ddccaa4b 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -180,7 +180,7 @@ - + If [code]true[/code], execution will block until all data is read from the response. diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index eed81e4a8c5..306f17ea44d 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -59,16 +59,16 @@ - + Maximum allowed size for response bodies. - + The file to download into. Will output any received file into it. - + Maximum number of allowed redirects. - + If [code]true[/code], multithreading is used to improve performance. diff --git a/doc/classes/HeightMapShape.xml b/doc/classes/HeightMapShape.xml index 22896535b9f..cb7da8af269 100644 --- a/doc/classes/HeightMapShape.xml +++ b/doc/classes/HeightMapShape.xml @@ -11,13 +11,13 @@ - + Height map data, pool array must be of [member map_width] * [member map_depth] size. - + Depth of the height map data. Changing this will resize the [member map_data]. - + Width of the height map data. Changing this will resize the [member map_data]. diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml index 0a4c4d6564a..0ac67be96c5 100644 --- a/doc/classes/HingeJoint.xml +++ b/doc/classes/HingeJoint.xml @@ -11,33 +11,33 @@ - + The speed with which the rotation across the axis perpendicular to the hinge gets corrected. - + If [code]true[/code], the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects. - + The minimum rotation. Only active if [member angular_limit/enable] is [code]true[/code]. - + The lower this value, the more the rotation gets slowed down. - + - + The maximum rotation. Only active if [member angular_limit/enable] is [code]true[/code]. - + When activated, a motor turns the hinge. - + Maximum acceleration for the motor. - + Target speed for the motor. - + The speed with which the two bodies get pulled together when they move in different directions. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 501210cb924..65d5fbedc39 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -469,7 +469,13 @@ - + Holds all of the image's color data in a given format. See [code]FORMAT_*[/code] constants. diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index 0be09d1c8dc..0a09b96ba71 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -72,10 +72,10 @@ - + The storage quality for [constant STORAGE_COMPRESS_LOSSY]. - + The storage type (raw, lossy, or compressed). diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index cae8356094e..efd8d33faf8 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -335,7 +335,7 @@ - Whether to accumulate similar input events sent by the operating system. Defaults to [code]true[/code]. + Whether to accumulate similar input events sent by the operating system. Enabled by default. diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 335506867fc..f2c00908f62 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -102,7 +102,7 @@ - + The event's device ID. diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml index f5b93fd73e4..46c47e357fc 100644 --- a/doc/classes/InputEventAction.xml +++ b/doc/classes/InputEventAction.xml @@ -12,13 +12,13 @@ - + The action's name. Actions are accessed via this [String]. - + If [code]true[/code], the action's state is pressed. If [code]false[/code], the action's state is released. - + The action's strength between 0 and 1. This value is considered as equal to 0 if pressed is [code]false[/code]. The event strength allows faking analog joypad motion events, by precising how strongly is the joypad axis bent or pressed. diff --git a/doc/classes/InputEventGesture.xml b/doc/classes/InputEventGesture.xml index b1abf04b517..59750a09023 100644 --- a/doc/classes/InputEventGesture.xml +++ b/doc/classes/InputEventGesture.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index 9df25d59e12..dcdda836817 100644 --- a/doc/classes/InputEventJoypadButton.xml +++ b/doc/classes/InputEventJoypadButton.xml @@ -12,13 +12,13 @@ - + Button identifier. One of the [enum JoystickList] button constants. - + If [code]true[/code], the button's state is pressed. If [code]false[/code], the button's state is released. - + Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from [code]0[/code] to [code]1[/code]. diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index a5deacdf0a2..eb05cd2f994 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -12,10 +12,10 @@ - + Axis identifier. Use one of the [enum JoystickList] axis constants. - + Current position of the joystick on the given axis. The value ranges from [code]-1.0[/code] to [code]1.0[/code]. A value of [code]0[/code] means the axis is in its resting position. diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 0fe288cbda4..cf9faaa26d2 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -19,16 +19,16 @@ - + If [code]true[/code], the key was already pressed before this event. It means the user is holding the key down. - + If [code]true[/code], the key's state is pressed. If [code]false[/code], the key's state is released. - + Key scancode, one of the [enum KeyList] constants. - + Key Unicode identifier when relevant. Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information. diff --git a/doc/classes/InputEventMIDI.xml b/doc/classes/InputEventMIDI.xml index 5ded362bc74..fe77e46c6c7 100644 --- a/doc/classes/InputEventMIDI.xml +++ b/doc/classes/InputEventMIDI.xml @@ -9,21 +9,21 @@ - + - + - + - + - + - + - + - + diff --git a/doc/classes/InputEventMagnifyGesture.xml b/doc/classes/InputEventMagnifyGesture.xml index 8f01f6f4867..f5add435f58 100644 --- a/doc/classes/InputEventMagnifyGesture.xml +++ b/doc/classes/InputEventMagnifyGesture.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index 001be82c8d6..56ba33702b7 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -12,13 +12,13 @@ - + The mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] button masks. - + The global mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0. - + The local mouse position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] which is under the mouse. diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml index a2437ca450b..4cf7174ab15 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -12,16 +12,16 @@ - + The mouse button identifier, one of the [enum ButtonList] button or button wheel constants. - + If [code]true[/code], the mouse button's state is a double-click. - + The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be [code]0[/code] if not supported. - + If [code]true[/code], the mouse button's state is pressed. If [code]false[/code], the mouse button's state is released. diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index a96543e4c28..fab4cc0fb96 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -12,10 +12,10 @@ - + The mouse position relative to the previous position (position at the last frame). - + The mouse speed in pixels per second. diff --git a/doc/classes/InputEventPanGesture.xml b/doc/classes/InputEventPanGesture.xml index 8a2fa745979..dab2c74543f 100644 --- a/doc/classes/InputEventPanGesture.xml +++ b/doc/classes/InputEventPanGesture.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/InputEventScreenDrag.xml b/doc/classes/InputEventScreenDrag.xml index 5b18697791f..be2eafbe7c2 100644 --- a/doc/classes/InputEventScreenDrag.xml +++ b/doc/classes/InputEventScreenDrag.xml @@ -12,16 +12,16 @@ - + The drag event index in the case of a multi-drag event. - + The drag position. - + The drag position relative to its start position. - + The drag speed. diff --git a/doc/classes/InputEventScreenTouch.xml b/doc/classes/InputEventScreenTouch.xml index 279425aca67..6239fbc9496 100644 --- a/doc/classes/InputEventScreenTouch.xml +++ b/doc/classes/InputEventScreenTouch.xml @@ -13,13 +13,13 @@ - + The touch index in the case of a multi-touch event. One index = one finger. - + The touch position. - + If [code]true[/code], the touch's state is pressed. If [code]false[/code], the touch's state is released. diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml index 9ea9ff7bef5..9b31dd4639e 100644 --- a/doc/classes/InputEventWithModifiers.xml +++ b/doc/classes/InputEventWithModifiers.xml @@ -12,19 +12,19 @@ - + State of the [code]Alt[/code] modifier. - + State of the [code]Command[/code] modifier. - + State of the [code]Ctrl[/code] modifier. - + State of the [code]Meta[/code] modifier. - + State of the [code]Shift[/code] modifier. diff --git a/doc/classes/InterpolatedCamera.xml b/doc/classes/InterpolatedCamera.xml index d124ea707a7..ca3a5d0733e 100644 --- a/doc/classes/InterpolatedCamera.xml +++ b/doc/classes/InterpolatedCamera.xml @@ -21,13 +21,13 @@ - + If [code]true[/code], and a target is set, the camera will move automatically. - + How quickly the camera moves toward its target. Higher values will result in tighter camera motion. - + The target's [NodePath]. diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index 42a21016f83..95c0e663ce7 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -73,7 +73,7 @@ - Returns the custom background color of the item specified by [code]idx[/code] index. Default value is [code]Color(0, 0, 0, 0)[/code]. + Returns the custom background color of the item specified by [code]idx[/code] index. @@ -82,7 +82,7 @@ - Returns the custom foreground color of the item specified by [code]idx[/code] index. Default value is [code]Color(0, 0, 0, 0)[/code]. + Returns the custom foreground color of the item specified by [code]idx[/code] index. @@ -91,7 +91,7 @@ - Returns the icon associated with the specified index. Default value is [code]null[/code]. + Returns the icon associated with the specified index. @@ -399,36 +399,36 @@ - + If [code]true[/code], the currently selected item can be selected again. - + If [code]true[/code], right mouse button click can select items. - + If [code]true[/code], the control will automatically resize the height to fit its content. - + Sets the default column width in pixels. If left to default value, each item will have a width equal to the width of its content and the columns will have an uneven width. - + Sets the default icon size in pixels. - + Sets the default position of the icon to either [constant ICON_MODE_LEFT] or [constant ICON_MODE_TOP]. - - Sets the icon size to its initial size multiplied by the specified scale. Default value is 1.0. + + Sets the icon size to its initial size multiplied by the specified scale. - + Sets the maximum columns the list will have. If set to anything other than the default, the content will be split among the specified columns. - + - + If set to [code]true[/code], all columns will have the same width specified by [member fixed_column_width]. - + Allows single or multiple item selection. See the [enum SelectMode] constants. @@ -505,23 +505,23 @@ - + - + - + - + - + - + - + diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index f83c80924ce..98db123f5b8 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -14,10 +14,10 @@ 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. diff --git a/doc/classes/Joint.xml b/doc/classes/Joint.xml index 0235c841b72..fe50cdac106 100644 --- a/doc/classes/Joint.xml +++ b/doc/classes/Joint.xml @@ -11,16 +11,16 @@ - + If [code]true[/code], the two bodies of the nodes are not able to collide with each other. - + The node attached to the first side (A) of the joint. - + The node attached to the second side (B) of the joint. - + The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority. diff --git a/doc/classes/Joint2D.xml b/doc/classes/Joint2D.xml index ee7395d2d3e..63d083d470d 100644 --- a/doc/classes/Joint2D.xml +++ b/doc/classes/Joint2D.xml @@ -11,16 +11,16 @@ - - When [member node_a] and [member node_b] move in different directions the [code]bias[/code] controls how fast the joint pulls them back to their original position. The lower the [code]bias[/code] the more the two bodies can pull on the joint. Default value: [code]0[/code]. + + When [member node_a] and [member node_b] move in different directions the [code]bias[/code] controls how fast the joint pulls them back to their original position. The lower the [code]bias[/code] the more the two bodies can pull on the joint. - - If [code]true[/code], [member node_a] and [member node_b] can collide. Default value: [code]false[/code]. + + If [code]true[/code], [member node_a] and [member node_b] can collide. - + The first body attached to the joint. Must derive from [PhysicsBody2D]. - + The second body attached to the joint. Must derive from [PhysicsBody2D]. diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index 72cce106d95..b4e6b0abab1 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -135,16 +135,16 @@ - + If the body is at least this close to another body, this body will consider them to be colliding. - + Lock the body's X axis movement. - + Lock the body's Y axis movement. - + Lock the body's Z axis movement. diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index 949e364ed3e..39d84c6e315 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -141,10 +141,10 @@ - + If the body is at least this close to another body, this body will consider them to be colliding. - + If [code]true[/code], the body's movement will be synchronized to the physics frame. This is useful when animating movement via [AnimationPlayer], for example on moving platforms. Do [b]not[/b] use together with [method move_and_slide] or [method move_and_collide] functions. diff --git a/doc/classes/KinematicCollision.xml b/doc/classes/KinematicCollision.xml index 38e7384fca8..4ce28b25c9c 100644 --- a/doc/classes/KinematicCollision.xml +++ b/doc/classes/KinematicCollision.xml @@ -12,37 +12,37 @@ - + The colliding body. - + The colliding body's unique [RID]. The colliding body's metadata. See [Object]. - + The colliding body's shape. - + The colliding shape's index. See [CollisionObject]. - + The colliding object's velocity. - + The moving object's colliding shape. - + The colliding body's shape's normal at the point of collision. - + The point of collision. - + The moving object's remaining movement vector. - + The distance the moving object traveled before collision. diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index 04d53be3d00..91cee3d05a9 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -12,37 +12,37 @@ - + The colliding body. - + The colliding body's unique [RID]. The colliding body's metadata. See [Object]. - + The colliding body's shape. - + The colliding shape's index. See [CollisionObject2D]. - + The colliding object's velocity. - + The moving object's colliding shape. - + The colliding body's shape's normal at the point of collision. - + The point of collision. - + The moving object's remaining movement vector. - + The distance the moving object traveled before collision. diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index f9978bb1f39..72e640adb66 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -40,34 +40,34 @@ - + Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the [code]ALIGN_*[/code] constants. - - If [code]true[/code], wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: [code]false[/code]. + + If [code]true[/code], wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. - + If [code]true[/code], the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely. - + The node ignores the first [code]lines_skipped[/code] lines before it starts to display text. - + Limits the lines of text the node shows on screen. - + Limits the count of visible characters. If you set [code]percent_visible[/code] to 50, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box. - + The text to display on screen. - + If [code]true[/code], all the text displays as UPPERCASE. - + Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the [code]VALIGN_*[/code] constants. - + Restricts the number of characters to display. Set to -1 to disable. @@ -100,21 +100,21 @@ - + - + - + - + - + - + - + diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index 8acc4ff6437..64d84421805 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -12,43 +12,43 @@ - - If [code]true[/code], the light only appears in the editor and will not be visible at runtime. Default value: [code]false[/code]. + + If [code]true[/code], the light only appears in the editor and will not be visible at runtime. - + The light's bake mode. See [enum BakeMode]. - + The light's color. - + The light will affect objects in the selected layers. - + The light's strength multiplier. - + Secondary multiplier used with indirect light (light bounces). This works on both [BakedLightmap] and [GIProbe]. - - If [code]true[/code], the light's effect is reversed, darkening areas and casting bright shadows. Default value: [code]false[/code]. + + If [code]true[/code], the light's effect is reversed, darkening areas and casting bright shadows. - + The intensity of the specular blob in objects affected by the light. At [code]0[/code] the light becomes a pure diffuse light. - + Used to adjust shadow appearance. Too small a value results in self-shadowing, while too large a value causes shadows to separate from casters. Adjust as needed. - + The color of shadows cast by this light. - + Attempts to reduce [member shadow_bias] gap. - - If [code]true[/code], the light will cast shadows. Default value: [code]false[/code]. + + If [code]true[/code], the light will cast shadows. - + diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index 1d7ccb020e0..88ad3719838 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -13,67 +13,67 @@ - + The Light2D's [Color]. - - If [code]true[/code], Light2D will only appear when editing the scene. Default value: [code]false[/code]. + + If [code]true[/code], Light2D will only appear when editing the scene. - - If [code]true[/code], Light2D will emit light. Default value: [code]true[/code]. + + If [code]true[/code], Light2D will emit light. - + The Light2D's energy value. The larger the value, the stronger the light. - + The Light2D's mode. See [code]MODE_*[/code] constants for values. - + The offset of the Light2D's [code]texture[/code]. - + The height of the Light2D. Used with 2D normal mapping. - + The layer mask. Only objects with a matching mask will be affected by the Light2D. - - Maximum layer value of objects that are affected by the Light2D. Default value: [code]0[/code]. + + Maximum layer value of objects that are affected by the Light2D. - - Minimum layer value of objects that are affected by the Light2D. Default value: [code]0[/code]. + + Minimum layer value of objects that are affected by the Light2D. - - Maximum [code]z[/code] value of objects that are affected by the Light2D. Default value: [code]1024[/code]. + + Maximum [code]z[/code] value of objects that are affected by the Light2D. - - Minimum [code]z[/code] value of objects that are affected by the Light2D. Default value: [code]-1024[/code]. + + Minimum [code]z[/code] value of objects that are affected by the Light2D. - - Shadow buffer size. Default value: [code]2048[/code]. + + Shadow buffer size. - + [Color] of shadows cast by the Light2D. - - If [code]true[/code], the Light2D will cast shadows. Default value: [code]false[/code]. + + If [code]true[/code], the Light2D will cast shadows. - - Shadow filter type. See [enum ShadowFilter] for possible values. Default value: [constant SHADOW_FILTER_NONE]. + + Shadow filter type. See [enum ShadowFilter] for possible values. - + Smoothing value for shadows. - + Smooth shadow gradient length. - + The shadow mask. Used with [LightOccluder2D] to cast shadows. Only occluders with a matching shadow mask will cast shadows. - + [Texture] used for the Light2D's appearance. - + The [code]texture[/code]'s scale factor. diff --git a/doc/classes/LightOccluder2D.xml b/doc/classes/LightOccluder2D.xml index a621937eb3c..55978aa0a1c 100644 --- a/doc/classes/LightOccluder2D.xml +++ b/doc/classes/LightOccluder2D.xml @@ -12,10 +12,10 @@ - + The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). - + The [OccluderPolygon2D] used to compute the shadow. diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index ab10426ebf4..27d3f4bade4 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -66,37 +66,37 @@ - - Controls the style of the line's first point. Use [code]LINE_CAP_*[/code] constants. Default value: [constant LINE_CAP_NONE]. + + Controls the style of the line's first point. Use [code]LINE_CAP_*[/code] constants. - + The line's color. Will not be used if a gradient is set. - - Controls the style of the line's last point. Use [code]LINE_CAP_*[/code] constants. Default value: [constant LINE_CAP_NONE]. + + Controls the style of the line's last point. Use [code]LINE_CAP_*[/code] constants. - + The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. - + The style for the points between the start and the end. - + The points that form the lines. The line is drawn between every point set in this array. - + The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. - + The direction difference in radians between vector points. This value is only used if [code]joint mode[/code] is set to [constant LINE_JOINT_SHARP]. - + The texture used for the line's texture. Uses [code]texture_mode[/code] for drawing style. - - The style to render the [code]texture[/code] on the line. Use [code]LINE_TEXTURE_*[/code] constants. Default value: [constant LINE_TEXTURE_NONE]. + + The style to render the [code]texture[/code] on the line. Use [code]LINE_TEXTURE_*[/code] constants. - + The line's width. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 0f41e38d584..482ec28c56c 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -83,49 +83,49 @@ - + Text alignment as defined in the [code]ALIGN_*[/code] enum. - + If [code]true[/code], the caret (visual cursor) blinks. - + Duration (in seconds) of a caret's blinking cycle. - + The cursor's position inside the [LineEdit]. When set, the text may scroll to accommodate it. - + If [code]true[/code], the [LineEdit] will show a clear button if [code]text[/code] is not empty. - + If [code]true[/code], the context menu will appear when right-clicked. - + If [code]false[/code], existing text cannot be modified and new text cannot be added. - + If [code]true[/code], the [LineEdit] width will increase to stay longer than the [member text]. It will [b]not[/b] compress if the [member text] is shortened. - + Defines how the [LineEdit] can grab focus (Keyboard and mouse, only keyboard, or none). See [enum Control.FocusMode] for details. - + Maximum amount of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit. - + Opacity of the [member placeholder_text]. From [code]0[/code] to [code]1[/code]. - + Text shown when the [LineEdit] is empty. It is [b]not[/b] the [LineEdit]'s default value (see [member text]). - + If [code]true[/code], every character is replaced with the secret character (see [member secret_character]). - + The character to use to mask secret input (defaults to "*"). Only a single character can be used as the secret character. - + String value of the [LineEdit]. @@ -187,29 +187,29 @@ - + - + - + - + - + - + - + - + diff --git a/doc/classes/LineShape2D.xml b/doc/classes/LineShape2D.xml index 67cb9b0eee6..fbab1dbe3c5 100644 --- a/doc/classes/LineShape2D.xml +++ b/doc/classes/LineShape2D.xml @@ -11,10 +11,10 @@ - + The line's distance from the origin. - + The line's normal. diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index 1dc0c3f91d8..5dfb55a8dda 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -11,9 +11,9 @@ - + - + @@ -32,13 +32,13 @@ - + - + - + - + diff --git a/doc/classes/MarginContainer.xml b/doc/classes/MarginContainer.xml index fe63ba956f5..08e8098a753 100644 --- a/doc/classes/MarginContainer.xml +++ b/doc/classes/MarginContainer.xml @@ -21,16 +21,16 @@ - + All direct children of [MarginContainer] will have a bottom margin of [code]margin_bottom[/code] pixels. - + All direct children of [MarginContainer] will have a left margin of [code]margin_left[/code] pixels. - + All direct children of [MarginContainer] will have a right margin of [code]margin_right[/code] pixels. - + All direct children of [MarginContainer] will have a top margin of [code]margin_top[/code] pixels. diff --git a/doc/classes/Material.xml b/doc/classes/Material.xml index 22da012022d..80d8b674f33 100644 --- a/doc/classes/Material.xml +++ b/doc/classes/Material.xml @@ -11,9 +11,9 @@ - + - + diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 1043aa1087a..609bf6317a9 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -26,7 +26,7 @@ - + If [code]true[/code], when the cursor hovers above another MenuButton within the same parent which also has [code]switch_on_hover[/code] enabled, it will close the current MenuButton and open the other one. @@ -46,17 +46,17 @@ - + - + - + - + - + diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index 6066d09b4ea..f7b3b0d7eae 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -94,7 +94,7 @@ - + diff --git a/doc/classes/MeshInstance.xml b/doc/classes/MeshInstance.xml index f5868f51cbf..e7dbb8e017c 100644 --- a/doc/classes/MeshInstance.xml +++ b/doc/classes/MeshInstance.xml @@ -59,10 +59,10 @@ - + The [Mesh] resource for the instance. - + [NodePath] to the [Skeleton] associated with the instance. diff --git a/doc/classes/MeshInstance2D.xml b/doc/classes/MeshInstance2D.xml index 4b38b9aa96a..a44b009fb62 100644 --- a/doc/classes/MeshInstance2D.xml +++ b/doc/classes/MeshInstance2D.xml @@ -12,13 +12,13 @@ - + The [Mesh] that will be drawn by the [MeshInstance2D]. - + The normal map that will be used if using the default [CanvasItemMaterial]. - + 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/MeshTexture.xml b/doc/classes/MeshTexture.xml index ba2b1621ff3..4ec8268cc5c 100644 --- a/doc/classes/MeshTexture.xml +++ b/doc/classes/MeshTexture.xml @@ -11,13 +11,13 @@ - + Sets the base texture that the Mesh will use to draw. - + Sets the size of the image, needed for reference. - + Sets the mesh used to draw. It must be a mesh using 2D vertices. diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index d0b9a04824e..295f23a92c6 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -114,22 +114,22 @@ - + Format of colors in color array that gets passed to shader. - + Format of custom data in custom data array that gets passed to shader. - + Number of instances that will get drawn. This clears and (re)sizes the buffers. By default, all instances are drawn but you can limit this with [member visible_instance_count]. - + Mesh to be drawn. - + Format of transform used to transform mesh, either 2D or 3D. - + Limits the number of instances drawn, -1 draws all instances. Changing this does not change the sizes of the buffers. diff --git a/doc/classes/MultiMeshInstance.xml b/doc/classes/MultiMeshInstance.xml index 16f16fdc8b9..5e8cb83a39f 100644 --- a/doc/classes/MultiMeshInstance.xml +++ b/doc/classes/MultiMeshInstance.xml @@ -14,7 +14,7 @@ - + The [MultiMesh] resource that will be used and shared among all instances of the [MultiMeshInstance]. diff --git a/doc/classes/MultiMeshInstance2D.xml b/doc/classes/MultiMeshInstance2D.xml index 8509986c3c8..28cee1aeba4 100644 --- a/doc/classes/MultiMeshInstance2D.xml +++ b/doc/classes/MultiMeshInstance2D.xml @@ -12,13 +12,13 @@ - + The [MultiMesh] that will be drawn by the [MultiMeshInstance2D]. - + The normal map that will be used if using the default [CanvasItemMaterial]. - + 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/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index afe2ebc40fa..5f8c7ed1209 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -87,14 +87,14 @@ - + 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. - + If [code]true[/code], the MultiplayerAPI's [member network_peer] refuses new incoming connections. diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index 83e1889efc4..58b7d1255e1 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -97,7 +97,7 @@ - + Defines which direction is up. By default, this is [code](0, 1, 0)[/code], which is the world's "up" direction. diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 79ad7f63ae0..f6c7a7d1b51 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -77,43 +77,43 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/doc/classes/NavigationMeshInstance.xml b/doc/classes/NavigationMeshInstance.xml index 3b11005e38c..a6266aac0a5 100644 --- a/doc/classes/NavigationMeshInstance.xml +++ b/doc/classes/NavigationMeshInstance.xml @@ -9,9 +9,9 @@ - + - + diff --git a/doc/classes/NavigationPolygonInstance.xml b/doc/classes/NavigationPolygonInstance.xml index e566e25336f..26cc7fbf313 100644 --- a/doc/classes/NavigationPolygonInstance.xml +++ b/doc/classes/NavigationPolygonInstance.xml @@ -9,9 +9,9 @@ - + - + diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index c8040156597..4f212cf3925 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -45,15 +45,15 @@ Sets the peer to which packets will be sent. - The [code]id[/code] can be one of: [constant TARGET_PEER_BROADCAST] to send to all connected peers, [constant TARGET_PEER_SERVER] to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. Default: [constant TARGET_PEER_BROADCAST] + The [code]id[/code] can be one of: [constant TARGET_PEER_BROADCAST] to send to all connected peers, [constant TARGET_PEER_SERVER] to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. By default, the target peer is [constant TARGET_PEER_BROADCAST]. - - If [code]true[/code], this [NetworkedMultiplayerPeer] refuses new connections. Default value: [code]false[/code]. + + If [code]true[/code], this [NetworkedMultiplayerPeer] refuses new connections. - + The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode]. diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index d6759d7d434..0723d50ba1e 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -11,31 +11,31 @@ - + Doesn't do anything at the time of writing. - + Doesn't do anything at the time of writing. - - If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. Default value: [code]true[/code]. + + If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. - + The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. - + The height of the 9-slice's left column. - + The height of the 9-slice's right column. - + The height of the 9-slice's top row. - + Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. - + The node's texture resource. @@ -48,7 +48,7 @@ - Doesn't do anything at the time of writing. Default value for [code]axis_stretch_horizontal[/code] and [code]axis_stretch_vertical[/code]. + Doesn't do anything at the time of writing. Doesn't do anything at the time of writing. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index d9df2a50c6e..5a903541242 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -828,7 +828,7 @@ 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. - + Pause mode. How the node will behave if the [SceneTree] is paused. diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 5fbcbc06654..abdbfa09f71 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -130,25 +130,25 @@ Global [Transform2D]. - + Position, relative to the node's parent. - + Rotation in radians, relative to the node's parent. - + Rotation in degrees, relative to the node's parent. - + The node's scale. Unscaled value: [code](1, 1)[/code]. Local [Transform2D]. - + If [code]true[/code], the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5. - + Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index e9b51d03c3a..d73c85a6d96 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -800,58 +800,58 @@ - + The clipboard from the host OS. Might be unavailable on some platforms. - + The current screen index (starting from 0). - + The exit code passed to the OS when the main loop exits. - + If [code]true[/code], the engine tries to keep the screen on while the game is running. Useful on mobile. - + If [code]true[/code], the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. - + The maximum size of the window (without counting window manager decorations). Does not affect fullscreen mode. Set to [code](0, 0)[/code] to reset to the system default value. - + The minimum size of the window (without counting window manager decorations). Does not affect fullscreen mode. Set to [code](0, 0)[/code] to reset to the system default value. - + The current screen orientation. - + If [code]true[/code], vertical synchronization (Vsync) is enabled. - + If [code]true[/code], removes the window frame. [b]Note:[/b] Setting [code]window_borderless[/code] to [code]false[/code] disables per-pixel transparency. - + If [code]true[/code], the window is fullscreen. - + If [code]true[/code], the window is maximized. - + If [code]true[/code], the window is minimized. - + If [code]true[/code], the window background is transparent and window frame is removed. Use [code]get_tree().get_root().set_transparent_background(true)[/code] to disable main viewport background rendering. [b]Note:[/b] This property has no effect if [b]Project > Project Settings > Display > Window > Per-pixel transparency > Allowed[/b] setting is disabled. - + The window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. - + If [code]true[/code], the window is resizable by the user. - + The size of the window (without counting window manager decorations). diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 551edff7bd9..b87e912b45c 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -66,7 +66,7 @@ Virtual method which can be overridden to customize the return value of [method to_string], and thus the object's representation where it is converted to a string, e.g. with [code]print(obj)[/code]. - Returns a [String] representing the object. Default is [code]"[ClassName:RID]"[/code]. + Returns a [String] representing the object. If not overridden, defaults to [code]"[ClassName:RID]"[/code]. @@ -426,7 +426,7 @@ - Defines whether the object can translate strings (with calls to [method tr]). Default is [code]true[/code]. + Defines whether the object can translate strings (with calls to [method tr]). Enabled by default. @@ -453,7 +453,7 @@ - Returns a [String] representing the object. Default is [code]"[ClassName:RID]"[/code]. + Returns a [String] representing the object. If not overridden, defaults to [code]"[ClassName:RID]"[/code]. Override the method [method _to_string] to customize the [String] representation. diff --git a/doc/classes/OccluderPolygon2D.xml b/doc/classes/OccluderPolygon2D.xml index ffab87f1a6d..f4fa6ac6880 100644 --- a/doc/classes/OccluderPolygon2D.xml +++ b/doc/classes/OccluderPolygon2D.xml @@ -11,13 +11,13 @@ - - If [code]true[/code], closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value: [code]true[/code]. + + If [code]true[/code], closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. - - The culling mode to use. Default value: [constant CULL_DISABLED]. + + The culling mode to use. - + A [Vector2] array with the index for polygon's vertices positions. [b]Note:[/b] The returned value is a copy of the underlying array, rather than a reference. diff --git a/doc/classes/OmniLight.xml b/doc/classes/OmniLight.xml index b051f62bfbb..7189826385d 100644 --- a/doc/classes/OmniLight.xml +++ b/doc/classes/OmniLight.xml @@ -12,16 +12,16 @@ - + The light's attenuation (drop-off) curve. A number of presets are available in the [b]Inspector[/b] by right-clicking the curve. - + The light's radius. - + See [enum ShadowDetail]. - + See [enum ShadowMode]. diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 9c8066fa619..c44495ead99 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -197,7 +197,7 @@ - + @@ -221,7 +221,7 @@ - + @@ -229,17 +229,17 @@ - + - + - + - + - + diff --git a/doc/classes/PackedDataContainer.xml b/doc/classes/PackedDataContainer.xml index f230953aac8..fa6a00d65de 100644 --- a/doc/classes/PackedDataContainer.xml +++ b/doc/classes/PackedDataContainer.xml @@ -23,7 +23,7 @@ - + diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index a5989f8494e..f01ef78c02b 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -65,7 +65,17 @@ - + A dictionary representation of the scene contents. Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene. diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index 34357eb8352..d52bf4e3bb6 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -62,7 +62,7 @@ - + [i]Deprecated.[/i] Use [code]get_var[/code] and [code]put_var[/code] parameters instead. If [code]true[/code], the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var]. [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. diff --git a/doc/classes/PacketPeerStream.xml b/doc/classes/PacketPeerStream.xml index 20e5e570ac4..0376fea5925 100644 --- a/doc/classes/PacketPeerStream.xml +++ b/doc/classes/PacketPeerStream.xml @@ -11,9 +11,9 @@ - + - + The wrapped [StreamPeer] object. diff --git a/doc/classes/PanoramaSky.xml b/doc/classes/PanoramaSky.xml index 96aefc06232..93a8bc61663 100644 --- a/doc/classes/PanoramaSky.xml +++ b/doc/classes/PanoramaSky.xml @@ -11,7 +11,7 @@ - + [Texture] to be applied to the PanoramaSky. diff --git a/doc/classes/ParallaxBackground.xml b/doc/classes/ParallaxBackground.xml index ae560f22f14..27787075777 100644 --- a/doc/classes/ParallaxBackground.xml +++ b/doc/classes/ParallaxBackground.xml @@ -11,22 +11,22 @@ - + The base position offset for all [ParallaxLayer] children. - + The base motion scale for all [ParallaxLayer] children. - + If [code]true[/code], elements in [ParallaxLayer] child aren't affected by the zoom level of the camera. - + Top-left limits for scrolling to begin. If the camera is outside of this limit, the background will stop scrolling. Must be lower than [member scroll_limit_end] to work. - + Bottom-right limits for scrolling to end. If the camera is outside of this limit, the background will stop scrolling. Must be higher than [member scroll_limit_begin] to work. - + The ParallaxBackground's scroll value. Calculated automatically when using a [Camera2D], but can be used to manually manage scrolling when no camera is present. diff --git a/doc/classes/ParallaxLayer.xml b/doc/classes/ParallaxLayer.xml index 4b3861ed111..75c69cc4b1d 100644 --- a/doc/classes/ParallaxLayer.xml +++ b/doc/classes/ParallaxLayer.xml @@ -13,13 +13,13 @@ - - The ParallaxLayer's [Texture] mirroring. Useful for creating an infinite scrolling background. If an axis is set to [code]0[/code], the [Texture] will not be mirrored. Default value: [code](0, 0)[/code]. + + The ParallaxLayer's [Texture] mirroring. Useful for creating an infinite scrolling background. If an axis is set to [code]0[/code], the [Texture] will not be mirrored. - + The ParallaxLayer's offset relative to the parent ParallaxBackground's [member ParallaxBackground.scroll_offset]. - + Multiplies the ParallaxLayer's motion. If an axis is set to [code]0[/code], it will not scroll. diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml index a395b6c525e..7ff99ebb732 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -27,13 +27,13 @@ - + Number of particles to emit. - - Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Default value: [constant DRAW_ORDER_INDEX]. + + Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. - + [Mesh] that is drawn for the first draw pass. @@ -45,43 +45,43 @@ [Mesh] that is drawn for the fourth draw pass. - + The number of draw passes when rendering particles. - - If [code]true[/code], particles are being emitted. Default value: [code]true[/code]. + + If [code]true[/code], particles are being emitted. - - Time ratio between each emission. If [code]0[/code], particles are emitted continuously. If [code]1[/code], all particles are emitted simultaneously. Default value: [code]0[/code]. + + Time ratio between each emission. If [code]0[/code], particles are emitted continuously. If [code]1[/code], all particles are emitted simultaneously. - + The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. - - If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code]. + + If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. - - Amount of time each particle will exist. Default value: [code]1[/code]. + + Amount of time each particle will exist. - - If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. Default value: [code]true[/code]. + + If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. - - If [code]true[/code], only [code]amount[/code] particles will be emitted. Default value: [code]false[/code]. + + If [code]true[/code], only [code]amount[/code] particles will be emitted. - + Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting. - + [Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial]. - - Emission randomness ratio. Default value: [code]0[/code]. + + Emission randomness ratio. - - Speed scaling ratio. Default value: [code]1[/code]. A value of [code]0[/code] can be used to pause the particles. + + Speed scaling ratio. A value of [code]0[/code] can be used to pause the particles. - + The [AABB] that determines the area of the world part of which needs to be visible on screen for the particle system to be active. diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml index 676c633fa79..52b0c846cab 100644 --- a/doc/classes/Particles2D.xml +++ b/doc/classes/Particles2D.xml @@ -27,52 +27,52 @@ - + Number of particles emitted in one emission cycle. - - Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Default value: [constant DRAW_ORDER_INDEX]. + + Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. - - If [code]true[/code], particles are being emitted. Default value: [code]true[/code]. + + If [code]true[/code], particles are being emitted. - - How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins. Default value: [code]0[/code]. + + How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins. - + The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. - - If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code]. + + If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. - - Amount of time each particle will exist. Default value: [code]1[/code]. + + Amount of time each particle will exist. - - If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. Default value: [code]true[/code]. + + If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. - + Normal map to be used for the [member texture] property. - - 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]. + + 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. - + Particle system starts as if it had already run for this many seconds. - + [Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial]. - - Emission lifetime randomness ratio. Default value: [code]0[/code]. + + Emission lifetime randomness ratio. - - Particle system's running speed scaling ratio. Default value: [code]1[/code]. A value of [code]0[/code] can be used to pause the particles. + + Particle system's running speed scaling ratio. A value of [code]0[/code] can be used to pause the particles. - + Particle texture. If [code]null[/code], particles will be squares. - + Editor visibility helper. diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 4c85a21ff0e..e0618a87c1e 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -13,58 +13,58 @@ - + Initial rotation applied to each particle, in degrees. Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [constant SpatialMaterial.BILLBOARD_PARTICLES]. - + Each particle's rotation will be animated along this [CurveTexture]. - - Rotation randomness ratio. Default value: [code]0[/code]. + + Rotation randomness ratio. - + Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [constant SpatialMaterial.BILLBOARD_PARTICLES]. - + Each particle's angular velocity will vary along this [CurveTexture]. - - Angular velocity randomness ratio. Default value: [code]0[/code]. + + Angular velocity randomness ratio. - + Particle animation offset. - + Each particle's animation offset will vary along this [CurveTexture]. - - Animation offset randomness ratio. Default value: [code]0[/code]. + + Animation offset randomness ratio. - + Particle animation speed. - + Each particle's animation speed will vary along this [CurveTexture]. - - Animation speed randomness ratio. Default value: [code]0[/code]. + + Animation speed randomness ratio. - + Each particle's initial color. If the [Particles2D]'s [code]texture[/code] is defined, it will be multiplied by this color. To have particle display color in a [SpatialMaterial] make sure to set [member SpatialMaterial.vertex_color_use_as_albedo] to [code]true[/code]. - + Each particle's color will vary along this [GradientTexture]. - + The rate at which particles lose velocity. - + Damping will vary along this [CurveTexture]. - - Damping randomness ratio. Default value: [code]0[/code]. + + Damping randomness ratio. The box's extents if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_BOX]. @@ -81,50 +81,50 @@ 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. Default value: [constant EMISSION_SHAPE_POINT]. + + 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]. - + Align Y axis of particle with the direction of its velocity. - - If [code]true[/code], particles will not move on the z axis. Default value: [code]true[/code] for [Particles2D], [code]false[/code] for [Particles]. + + If [code]true[/code], particles will not move on the z axis. - + If [code]true[/code], particles rotate around Y axis by [member angle]. - - Amount of [member spread] in Y/Z plane. A value of [code]1[/code] restricts particles to X/Z plane. Default [code]0[/code]. + + Amount of [member spread] in Y/Z plane. A value of [code]1[/code] restricts particles to X/Z plane. - - Gravity applied to every particle. Default value: [code](0, -9.8, 0)[/code]. + + Gravity applied to every particle. - + Initial hue variation applied to each particle. - + Each particle's hue will vary along this [CurveTexture]. - - Hue variation randomness ratio. Default value: [code]0[/code]. + + Hue variation randomness ratio. - + Initial velocity magnitude for each particle. Direction comes from [member spread] and the node's orientation. - - Initial velocity randomness ratio. Default value: [code]0[/code]. + + Initial velocity randomness ratio. - + Linear acceleration applied to each particle in the direction of motion. - + Each particle's linear acceleration will vary along this [CurveTexture]. - - Linear acceleration randomness ratio. Default value: [code]0[/code]. + + 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. @@ -134,45 +134,45 @@ Each particle's orbital velocity will vary along this [CurveTexture]. - Orbital velocity randomness ratio. Default value: [code]0[/code]. + Orbital velocity randomness ratio. - + Radial acceleration applied to each particle. Makes particle accelerate away from origin. - + Each particle's radial acceleration will vary along this [CurveTexture]. - - Radial acceleration randomness ratio. Default value: [code]0[/code]. + + Radial acceleration randomness ratio. - + Initial scale applied to each particle. - + Each particle's scale will vary along this [CurveTexture]. - - Scale randomness ratio. Default value: [code]0[/code]. + + Scale randomness ratio. - - Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Default value: [code]45[/code]. Applied to X/Z plane and Y/Z planes. + + Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Applied to X/Z plane and Y/Z planes. - + Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. - + Each particle's tangential acceleration will vary along this [CurveTexture]. - - Tangential acceleration randomness ratio. Default value: [code]0[/code]. + + Tangential acceleration randomness ratio. - + Trail particles' color will vary along this [GradientTexture]. - + Emitter will emit [code]amount[/code] divided by [code]trail_divisor[/code] particles. The remaining particles will be used as trail(s). - + Trail particles' size will vary along this [CurveTexture]. diff --git a/doc/classes/Path.xml b/doc/classes/Path.xml index 12ae8fd3d50..5c1100e6701 100644 --- a/doc/classes/Path.xml +++ b/doc/classes/Path.xml @@ -12,7 +12,11 @@ - + A [Curve3D] describing the path. diff --git a/doc/classes/Path2D.xml b/doc/classes/Path2D.xml index b49a3d928d1..960cd5163d2 100644 --- a/doc/classes/Path2D.xml +++ b/doc/classes/Path2D.xml @@ -12,7 +12,10 @@ - + A [Curve2D] describing the path. diff --git a/doc/classes/PathFollow.xml b/doc/classes/PathFollow.xml index 58f66b07d6f..0b4a781a7e2 100644 --- a/doc/classes/PathFollow.xml +++ b/doc/classes/PathFollow.xml @@ -12,27 +12,27 @@ - + If [code]true[/code], the position between two cached points is interpolated cubically, and linearly otherwise. The points along the [Curve3D] of the [Path] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. There are two answers to this problem: either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. - + The node's offset along the curve. - + If [code]true[/code], any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. - + The distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. - + Allows or forbids rotation on one or more axes, depending on the [enum RotationMode] constants being used. - + The distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. - + The node's offset perpendicular to the curve. diff --git a/doc/classes/PathFollow2D.xml b/doc/classes/PathFollow2D.xml index dcf19a22322..9c4624dfee6 100644 --- a/doc/classes/PathFollow2D.xml +++ b/doc/classes/PathFollow2D.xml @@ -12,30 +12,30 @@ - + If [code]true[/code], the position between two cached points is interpolated cubically, and linearly otherwise. The points along the [Curve2D] of the [Path2D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. There are two answers to this problem: either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. - + The node's offset along the curve. - - How far to look ahead of the curve to calculate the tangent if the node is rotating. E.g. shorter lookaheads will lead to faster rotations. Default value: [code]4[/code]. + + How far to look ahead of the curve to calculate the tangent if the node is rotating. E.g. shorter lookaheads will lead to faster rotations. - + If [code]true[/code], any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. - + The distance along the path in pixels. - + If [code]true[/code], this node rotates to follow the path, making its descendants rotate. - + The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. - + The node's offset perpendicular to the curve. diff --git a/doc/classes/PhysicalBone.xml b/doc/classes/PhysicalBone.xml index bf379afab8e..583c24e2c03 100644 --- a/doc/classes/PhysicalBone.xml +++ b/doc/classes/PhysicalBone.xml @@ -33,21 +33,21 @@ - + - + - + - + - + - + - + - + diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 7459e120f53..7d46dd28767 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -20,26 +20,26 @@ - + - + - + The physics layer the query should be made on. - + The list of objects or object [RID]s, that will be excluded from collisions. - + The collision margin for the shape. - + The motion of the shape being queried for. The [RID] of the queried shape. See also [method set_shape]. - + the transform matrix of the queried shape. diff --git a/doc/classes/Physics2DTestMotionResult.xml b/doc/classes/Physics2DTestMotionResult.xml index a0f8a1ca4c2..410bffc0f0e 100644 --- a/doc/classes/Physics2DTestMotionResult.xml +++ b/doc/classes/Physics2DTestMotionResult.xml @@ -9,23 +9,23 @@ - + - + - + - + - + - + - + - + diff --git a/doc/classes/PhysicsBody.xml b/doc/classes/PhysicsBody.xml index fc4f2e18fd5..ee50f5a6c38 100644 --- a/doc/classes/PhysicsBody.xml +++ b/doc/classes/PhysicsBody.xml @@ -77,15 +77,13 @@ - + The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the [member collision_mask] property. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - Default value: 1 (the first layer/bit is enabled). - + The physics layers this area scans for collisions. - Default value: 1 (the first layer/bit is enabled). diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index a5024c2432c..076131357bb 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -77,15 +77,13 @@ - + The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the [member collision_mask] property. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - Default value: 1 (the first layer/bit is enabled). - + The physics layers this area scans for collisions. - Default value: 1 (the first layer/bit is enabled). 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/PhysicsMaterial.xml b/doc/classes/PhysicsMaterial.xml index b507b4f9f5d..73f14161725 100644 --- a/doc/classes/PhysicsMaterial.xml +++ b/doc/classes/PhysicsMaterial.xml @@ -11,15 +11,15 @@ - + - - The body's bounciness. Default value: [code]0[/code]. + + The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). - - The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). Default value: [code]1[/code]. + + The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). - + diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index b06b0df40da..a779a34e6ac 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -1390,7 +1390,7 @@ Swing is rotation from side to side, around the axis perpendicular to the twist axis. The swing span defines, how much rotation will not get corrected allong the swing axis. Could be defined as looseness in the [ConeTwistJoint]. - If below 0.05, this behavior is locked. Default value: [code]PI/4[/code]. + If below 0.05, this behavior is locked. Twist is the rotation around the twist axis, this value defined how far the joint can twist. diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml index c1f8b48d73e..7d7307592e3 100644 --- a/doc/classes/PhysicsShapeQueryParameters.xml +++ b/doc/classes/PhysicsShapeQueryParameters.xml @@ -17,19 +17,19 @@ - + - + - + - + - + - + diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index 925722fd21e..10ae3d27d97 100644 --- a/doc/classes/PinJoint.xml +++ b/doc/classes/PinJoint.xml @@ -11,13 +11,13 @@ - + The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. - + The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. - + If above 0, this value is the maximum value for an impulse that this Joint produces. diff --git a/doc/classes/PinJoint2D.xml b/doc/classes/PinJoint2D.xml index bb651723656..f65cb86b1ce 100644 --- a/doc/classes/PinJoint2D.xml +++ b/doc/classes/PinJoint2D.xml @@ -11,7 +11,7 @@ - + The higher this value, the more the bond to the pinned partner can flex. diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index 841f4c08d89..69dfe28ac44 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -143,15 +143,15 @@ - + - + - + - + - + diff --git a/doc/classes/PlaneMesh.xml b/doc/classes/PlaneMesh.xml index a507f9f145a..01aee93dadb 100644 --- a/doc/classes/PlaneMesh.xml +++ b/doc/classes/PlaneMesh.xml @@ -11,14 +11,14 @@ - - Size of the generated plane. Defaults to (2.0, 2.0). + + Size of the generated plane. - - Number of subdivision along the Z axis. Defaults to 0. + + Number of subdivision along the Z axis. - - Number of subdivision along the X axis. Defaults to 0. + + Number of subdivision along the X axis. diff --git a/doc/classes/PlaneShape.xml b/doc/classes/PlaneShape.xml index 83d8b09280c..b94bb8e6134 100644 --- a/doc/classes/PlaneShape.xml +++ b/doc/classes/PlaneShape.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 4cfffa8a256..6fc0d76d027 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -77,52 +77,52 @@ - - If [code]true[/code], polygon edges will be anti-aliased. Default value: [code]false[/code]. + + If [code]true[/code], polygon edges will be anti-aliased. - + - + The polygon's fill color. If [code]texture[/code] is defined, it will be multiplied by this color. It will also be the default color for vertices not set in [code]vertex_colors[/code]. - + - - Added padding applied to the bounding box when using [code]invert[/code]. Setting this value too small may result in a "Bad Polygon" error. Default value: [code]100[/code]. + + Added padding applied to the bounding box when using [code]invert[/code]. Setting this value too small may result in a "Bad Polygon" error. - - If [code]true[/code], polygon will be inverted, containing the area outside the defined points and extending to the [code]invert_border[/code]. Default value: [code]false[/code]. + + If [code]true[/code], polygon will be inverted, containing the area outside the defined points and extending to the [code]invert_border[/code]. - + The offset applied to each vertex. - + The polygon's list of vertices. The final point will be connected to the first. [b]Note:[/b] This returns a copy of the [PoolVector2Array] rather than a reference. - + - + - + The polygon's fill texture. Use [code]uv[/code] to set texture coordinates. - + 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. - + The texture's rotation in degrees. - + Amount to multiply the [code]uv[/code] coordinates when using a [code]texture[/code]. Larger values make the texture smaller, and vice versa. - + Texture coordinates for each vertex of the polygon. There should be one [code]uv[/code] per polygon vertex. If there are fewer, undefined vertices will use [code](0, 0)[/code]. - + Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use [code]color[/code]. diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml index ef7e3d2c117..1e24aadfd9c 100644 --- a/doc/classes/Popup.xml +++ b/doc/classes/Popup.xml @@ -58,7 +58,7 @@ - + If [code]true[/code], the popup will not be hidden when a click event occurs outside of it, or when it receives the [code]ui_cancel[/code] action event. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 3ce923e36a0..a05aff9a596 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -550,20 +550,20 @@ - - If [code]true[/code], allows to navigate [PopupMenu] with letter keys. Default value: [code]false[/code]. + + If [code]true[/code], allows to navigate [PopupMenu] with letter keys. - + If [code]true[/code], hides the [PopupMenu] when a checkbox or radio button is selected. - + If [code]true[/code], hides the [PopupMenu] when an item is selected. - + If [code]true[/code], hides the [PopupMenu] when a state item is selected. - - Sets the delay time for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. Default value: [code]0.3[/code] seconds. + + Sets the delay time in seconds for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. @@ -598,21 +598,21 @@ Sets a custom [Font]. - + Sets a custom [Color] for the [Font]. - + - + Sets a custom [Color] for disabled text. - + Sets a custom [Color] for the hovered text. Sets a custom [StyleBox] when the [PopupMenu] is hovered. - + Sets the horizontal space separation between each item. @@ -640,7 +640,7 @@ Sets a custom [Texture] icon for [code]unchecked[/code] of checkbox items. - + Sets the vertical space separation between each item. diff --git a/doc/classes/PrimitiveMesh.xml b/doc/classes/PrimitiveMesh.xml index b3be8e431ae..83d4dea5b1d 100644 --- a/doc/classes/PrimitiveMesh.xml +++ b/doc/classes/PrimitiveMesh.xml @@ -18,13 +18,13 @@ - + Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unnexpected culling when using a shader to offset vertices. - - If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn. Result is the same as using *CULL_BACK* in [SpatialMaterial]. Default is false. + + If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn. Result is the same as using *CULL_BACK* in [SpatialMaterial]. - + The current [Material] of the primitive mesh. diff --git a/doc/classes/PrismMesh.xml b/doc/classes/PrismMesh.xml index 62f1278bba7..1d4e5ddab75 100644 --- a/doc/classes/PrismMesh.xml +++ b/doc/classes/PrismMesh.xml @@ -11,20 +11,20 @@ - - Displacement of the upper edge along the X axis. 0.0 positions edge straight above the bottom-left edge. Defaults to 0.5 (positioned on the midpoint). + + Displacement of the upper edge along the X axis. 0.0 positions edge straight above the bottom-left edge. - - Size of the prism. Defaults to (2.0, 2.0, 2.0). + + Size of the prism. - - Number of added edge loops along the Z axis. Defaults to 0. + + Number of added edge loops along the Z axis. - - Number of added edge loops along the Y axis. Defaults to 0. + + Number of added edge loops along the Y axis. - - Number of added edge loops along the X axis. Defaults to 0. + + Number of added edge loops along the X axis. diff --git a/doc/classes/ProceduralSky.xml b/doc/classes/ProceduralSky.xml index 13d6a9ce19a..9ffca20081a 100644 --- a/doc/classes/ProceduralSky.xml +++ b/doc/classes/ProceduralSky.xml @@ -12,52 +12,52 @@ - + Color of the ground at the bottom. - + How quickly the [member ground_horizon_color] fades into the [member ground_bottom_color]. - + Amount of energy contribution from the ground. - + Color of the ground at the horizon. - + How quickly the [member sky_horizon_color] fades into the [member sky_top_color]. - + Amount of energy contribution from the sky. - + Color of the sky at the horizon. - + Color of the sky at the top. - + Distance from center of sun where it fades out completely. - + Distance from sun where it goes from solid to starting to fade. - + The sun's color. - + How quickly the sun fades away between [member sun_angle_min] and [member sun_angle_max]. - + Amount of energy contribution from the sun. - + The sun's height using polar coordinates. - + The direction of the sun using polar coordinates. - + Size of [Texture] that the ProceduralSky will generate. The size is set using [enum TextureSize]. diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml index 2064ead8f4b..a8168958cfe 100644 --- a/doc/classes/ProgressBar.xml +++ b/doc/classes/ProgressBar.xml @@ -11,8 +11,8 @@ - - If [code]true[/code], the fill percentage is displayed on the bar. Default value: [code]true[/code]. + + If [code]true[/code], the fill percentage is displayed on the bar. @@ -24,9 +24,9 @@ - + - + diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 73d4c7b5049..3e9e063c0c6 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -161,686 +161,751 @@ - + Comma-separated list of custom Android modules (which must have been built in the Android export templates) using their Java package path, e.g. [code]org/godotengine/org/GodotPaymentV3,org/godotengine/godot/MyCustomSingleton"[/code]. - + Background color for the boot splash. - + If [code]true[/code], scale the boot splash image to the full window length when engine starts. If [code]false[/code], the engine will leave it at the default pixel size. - + Path to an image used as the boot splash. - + If [code]true[/code], applies linear filtering when scaling the image (recommended for high resolution artwork). If [code]false[/code], uses nearest-neighbor interpolation (recommended for pixel art). - + This user directory is used for storing persistent data ([code]user://[/code] filesystem). If left empty, [code]user://[/code] resolves to a project-specific folder in Godot's own configuration folder (see [method OS.get_user_data_dir]). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in [method OS.get_user_data_dir]). The [member application/config/use_custom_user_dir] setting must be enabled for this to take effect. - + Icon used for the project, set when project loads. Exporters will also use this icon when possible. - + - + The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files. - + Specifies a file to override project settings. For example: [code]user://custom_settings.cfg[/code]. - + If [code]true[/code], the project will save user data to its own user directory (see [member application/config/custom_user_dir_name]). This setting is only effective on desktop platforms. A name must be set in the [member application/config/custom_user_dir_name] setting for this to take effect. If [code]false[/code], the project will save user data to [code](OS user data directory)/Godot/app_userdata/(project name)[/code]. - + - + If [code]true[/code], disables printing to standard error in an exported build. - + If [code]true[/code], disables printing to standard output in an exported build. - + Forces a delay between frames in the main loop (in milliseconds). This may be useful if you plan to disable vertical synchronization. - + If [code]true[/code], enables low-processor usage mode. This setting only works on desktop platforms. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) in most games. - + Amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage. - + Path to the main scene file that will be loaded when the project runs. - + Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. - + Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. - + - + Specifies the audio driver to use. This setting is platform-dependent as each platform supports different audio drivers. If left empty, the default audio driver will be used. - + If [code]true[/code], microphone input will be allowed. This requires appropriate permissions to be set when exporting to Android or iOS. - + Mixing rate used for audio. In general, it's better to not touch this and leave it to the host operating system. - + Output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware. - + Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. - + Default compression level for gzip. Affects compressed scenes and resources. - + Default compression level for Zlib. Affects compressed scenes and resources. - + Default compression level for Zstandard. Affects compressed scenes and resources. - + Enables long-distance matching in Zstandard. - + - + If [code]true[/code], displays getters and setters in autocompletion results in the script editor. This setting is meant to be used when porting old projects (Godot 2), as using member variables is the preferred style from Godot 3 onwards. - + If [code]true[/code], enables warnings when a constant is used as a function. - + If [code]true[/code], enables warnings when deprecated keywords such as [code]slave[/code] are used. - + If [code]true[/code], enables specific GDScript warnings (see [code]debug/gdscript/warnings/*[/code] settings). If [code]false[/code], disables all GDScript warnings. - + If [code]true[/code], enables warnings when a function is declared with the same name as a constant. - + If [code]true[/code], enables warnings when a function is declared with the same name as a variable. This will turn into an error in a future version when first-class functions become supported in GDScript. - + If [code]true[/code], enables warnings when a function assigned to a variable may yield and return a function state instead of a value. - + If [code]true[/code], enables warnings when using a function as if it was a property. - + If [code]true[/code], enables warnings when a ternary operator may emit values with incompatible types. - + If [code]true[/code], enables warnings when dividing an integer by another integer (the decimal part will be discarded). - + If [code]true[/code], enables warnings when passing a floating-point value to a function that expects an integer (it will be converted and lose precision). - + If [code]true[/code], enables warnings when using a property as if it was a function. - + If [code]true[/code], enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the [enum Error] enum. - + If [code]true[/code], enables warnings when defining a local or subclass member variable that would shadow a variable at an upper level (such as a member variable). - + If [code]true[/code], enables warnings when calling an expression that has no effect on the surrounding code, such as writing [code]2 + 2[/code] as a statement. - + If [code]true[/code], all warnings will be reported as if they were errors. - + If [code]true[/code], enables warnings when using a variable that wasn't previously assigned. - + If [code]true[/code], enables warnings when assigning a variable using an assignment operator like [code]+=[/code] if the variable wasn't previously assigned. - + If [code]true[/code], enables warnings when unreachable code is detected (such as after a [code]return[/code] statement that will always be executed). - + If [code]true[/code], enables warnings when using an expression whose type may not be compatible with the function parameter expected. - + If [code]true[/code], enables warnings when performing an unsafe cast. - + If [code]true[/code], enables warnings when calling a method whose presence is not guaranteed at compile-time in the class. - + If [code]true[/code], enables warnings when accessing a property whose presence is not guaranteed at compile-time in the class. - + If [code]true[/code], enables warnings when a function parameter is unused. - + If [code]true[/code], enables warnings when a member variable is unused. - + If [code]true[/code], enables warnings when a signal is unused. - + If [code]true[/code], enables warnings when a local variable is unused. - + If [code]true[/code], enables warnings when a variable is declared with the same name as a function. This will turn into an error in a future version when first-class functions become supported in GDScript. - + If [code]true[/code], enables warnings when assigning the result of a function that returns [code]void[/code] to a variable. - + Message to be displayed before the backtrace when the engine crashes. - + - + Maximum call stack allowed for debugging GDScript. - + Maximum amount of functions per frame allowed when profiling. - + Print frames per second to standard output every second. - + Print more information to standard output when running. It displays information such as memory leaks, which scenes and resources are being loaded, etc. - + Maximum call stack in visual scripting, to avoid infinite recursion. - + Custom image for the mouse cursor (limited to 256×256). - + Hotspot for the custom mouse cursor image. - + Position offset for tooltips, relative to the mouse cursor's hotspot. - + If [code]true[/code], allows HiDPI display on Windows and macOS. This setting has no effect on desktop Linux, as DPI-awareness fallbacks are not supported there. - + If [code]true[/code], keeps the screen on (even in case of inactivity), so the screensaver does not take over. Works on desktop and mobile platforms. - + Default orientation on mobile devices. - + If [code]true[/code], allows per-pixel transparency in a desktop window. This affects performance, so leave it on [code]false[/code] unless you need it. - + Sets the window background to transparent when it starts. - + Force the window to be always on top. - + Force the window to be borderless. - + Sets the window to full screen when it starts. - + Sets the main window height. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. - + Allows the window to be resizable by default. - + If greater than zero, uses a different height for the window when running from the editor. The main use for this is to test with stretch modes. - + If greater than zero, uses a different width for the window when running from the editor. The main use for this is to test with stretch modes. - + Sets the main window width. On desktop platforms, this is the default window size. Stretch mode settings use this also as a reference when enabled. - + If [code]true[/code], enables vertical synchronization. This eliminates tearing that may appear in moving scenes, at the cost of higher input latency and stuttering at lower framerates. If [code]false[/code], vertical synchronization will be disabled, however, many platforms will enforce it regardless (such as mobile platforms and HTML5). - + Internal editor setting, don't touch. - + - + - + If [code]true[/code], swaps OK and Cancel buttons in dialogs on Windows and UWP to follow interface conventions. - + Use a custom theme resource, set a path to it here. - + Use a custom default font resource, set a path to it here. - + If [code]true[/code], makes sure the theme used works with HiDPI. - + Timer setting for incremental search in Tree, IntemList, etc. controls (in milliseconds). - + Timer for detecting idle in the editor (in seconds). - + - + - + - + - + - + - + - + - + - + - + - + - + - + If [code]true[/code], sends mouse input events when tapping or swiping on the touchscreen. - + If [code]true[/code], sends touch input events when clicking or dragging the mouse. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + The locale to fall back to if a translation isn't available in a given language. If left empty, [code]en[/code] (English) will be used. - + If non-empty, this locale will be used when running the project from the editor. - + If [code]true[/code], logs all output to files. - + Path to logs within the project. Using an [code]user://[/code] path is recommended. - + Specifies the maximum amount of log files allowed (used for rotation). - + Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here. - + This is used by servers when used in multi-threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number. - + Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. - + Maximum amount of errors allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. - + Maximum amount of messages allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. - + Default size of packet peer stream for deserializing Godot data. Over this size, data is dropped. - + - + - + - + - + - + - + - + - + Amount of read ahead used by remote filesystem. Higher values decrease the effects of latency at the cost of higher bandwidth usage. - + Page size used by remote filesystem (in bytes). - + When creating node names automatically, set the type of casing in this project. This is mostly an editor setting. - + What to use to separate node name from number. This is mostly an editor setting. - + - + + + Sets whether physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API access to only physics process. - + - + + + Sets which physics engine to use. - + Frames per second used in the physics. Physics always needs a fixed amount of frames per second. - + Fix to improve physics jitter, specially on monitors where refresh rate is different than the physics FPS. - + Default background clear color. Overriddable per [Viewport] using its [Environment]. See [member Environment.background_mode] and [member Environment.background_color] in particular. To change this default color programmatically, use [method VisualServer.set_default_clear_color]. - + Max buffer size for blend shapes. Any blend shape bigger than this will not work. - + Max buffer size for drawing polygons. Any polygon bigger than this will not work. - + Max index buffer size for drawing polygons. Any polygon bigger than this will not work. - + Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work. - + Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not meshes themselves. - + Shaders have a time variable that constantly increases. At some point, it needs to be rolled back to zero to avoid precision errors on shader animations. This setting specifies when (in seconds). - + Some NVIDIA GPU drivers have a bug which produces flickering issues for the [code]draw_rect[/code] method, especially as used in [TileMap]. Refer to [url=https://github.com/godotengine/godot/issues/9913]GitHub issue 9913[/url] for details. If [code]true[/code], this option enables a "safe" code path for such NVIDIA GPUs at the cost of performance. This option only impacts the GLES2 rendering backend (so the bug stays if you use GLES3), and only desktop platforms. - + If [code]true[/code], forces snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. - + Disables depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. - + If [code]true[/code], performs a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. - + The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. - + - + The video driver to use ("GLES2" or "GLES3"). [b]Note:[/b] The backend in use can be overridden at runtime via the [code]--video-driver[/code] command line argument, or by the [member rendering/quality/driver/fallback_to_gles2] option if the target system does not support GLES3 and falls back to GLES2. In such cases, this property is not updated, so use [method OS.get_current_video_driver] to query it at run-time. - + If [code]true[/code], allows falling back to the GLES2 driver if the GLES3 driver is not supported. [b]Note:[/b] The two video drivers are not drop-in replacements for each other, so a game designed for GLES3 might not work properly when falling back to GLES2. In particular, some features of the GLES3 backend are not available in GLES2. Enabling this setting also means that both ETC and ETC2 VRAM-compressed textures will be exported on Android and iOS, increasing the data pack's size. - + Maximum anisotropic filter level used for textures with anisotropy enabled. Higher values will result in sharper textures when viewed from oblique angles, at the cost of performance. Only power-of-two values are valid (2, 4, 8, 16). - + If [code]true[/code], uses nearest-neighbor mipmap filtering when using mipmaps (also called "bilinear filtering"), which will result in visible seams appearing between mipmap stages. This may increase performance in mobile as less memory bandwidth is used. If [code]false[/code], linear mipmap filtering (also called "trilinear filtering") is used. - + Strategy used for framebuffer allocation. The simpler it is, the less resources it uses (but the less features it supports). - + - + If [code]true[/code], uses a high amount of samples to create blurred variants of reflection probes and panorama backgrounds (sky). Those blurred variants are used by rough materials. - + - + If [code]true[/code], uses texture arrays instead of mipmaps for reflection probes and panorama backgrounds (sky). This reduces jitter noise on reflections, but costs more performance and memory. - + - + If [code]true[/code], uses faster but lower-quality Blinn model to generate blurred reflections instead of the GGX model. - + - + If [code]true[/code], uses faster but lower-quality Lambert material lighting model instead of Burley. - + - + If [code]true[/code], forces vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can be used to optimize performance on low-end mobile devices. - + - + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - + Size for shadow atlas (used for OmniLights and SpotLights). See documentation. - + - + Shadow filter mode. Higher-quality settings result in smoother shadows that flicker less when moving. "Disabled" is the fastest option, but also has the lowest quality. "PCF5" is smoother but is also slower. "PCF13" is the smoothest option, but is also the slowest. - + - + Improves quality of subsurface scattering, but cost significantly increases. - + Quality setting for subsurface scaterring (samples taken). - + - + Weight subsurface scattering samples. Helps to avoid reading samples from unrelated parts of the screen. - + Use high-quality voxel cone tracing. This results in better-looking reflections, but is much more expensive on the GPU. - + Thread model for rendering. Rendering on a thread can vastly improve performance, but synchronizing to the main thread can cause a bit more jitter. - + If [code]true[/code], the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the GLES3 renderer. - + If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression algorithm. This algorithm doesn't support alpha channels in textures. - + If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm. This texture compression algorithm is only supported when using the GLES3 renderer. - + If [code]true[/code], the texture importer will import VRAM-compressed textures using the PowerVR Texture Compression algorithm. This texture compression algorithm is only supported on iOS. - + If [code]true[/code], the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm. This algorithm is only supported on desktop platforms and consoles. - + diff --git a/doc/classes/ProximityGroup.xml b/doc/classes/ProximityGroup.xml index 184ba872291..3c081bf91f0 100644 --- a/doc/classes/ProximityGroup.xml +++ b/doc/classes/ProximityGroup.xml @@ -21,11 +21,11 @@ - + - + - + diff --git a/doc/classes/ProxyTexture.xml b/doc/classes/ProxyTexture.xml index a36f670c421..d4031960222 100644 --- a/doc/classes/ProxyTexture.xml +++ b/doc/classes/ProxyTexture.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/QuadMesh.xml b/doc/classes/QuadMesh.xml index cf7e56f895a..209e91eef20 100644 --- a/doc/classes/QuadMesh.xml +++ b/doc/classes/QuadMesh.xml @@ -11,8 +11,8 @@ - - Size in the X and Y axes. Default is [code]Vector2(1, 1)[/code]. + + Size on the X and Y axes. diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index ea805c91369..9d163e926c2 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -171,17 +171,17 @@ - - W component of the quaternion. Default value: [code]1[/code]. + + W component of the quaternion. - - X component of the quaternion. Default value: [code]0[/code]. + + X component of the quaternion. - - Y component of the quaternion. Default value: [code]0[/code]. + + Y component of the quaternion. - - Z component of the quaternion. Default value: [code]0[/code]. + + Z component of the quaternion. diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml index dc96bba304c..31abe9b000a 100644 --- a/doc/classes/RandomNumberGenerator.xml +++ b/doc/classes/RandomNumberGenerator.xml @@ -66,7 +66,7 @@ - + The seed used by the random number generator. A given seed will give a reproducible sequence of pseudo-random numbers. [b]Note:[/b] The RNG does not have an avalanche effect, and can output similar random streams given similar seeds. Consider using a hash function to improve your seed quality if they're sourced externally. diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index 9f1863600b7..82fffd0cb82 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -27,34 +27,34 @@ - - If [code]true[/code], [member value] may be greater than [member max_value]. Default value: [code]false[/code]. + + If [code]true[/code], [member value] may be greater than [member max_value]. - - If [code]true[/code], [member value] may be less than [member min_value]. Default value: [code]false[/code]. + + If [code]true[/code], [member value] may be less than [member min_value]. - + If [code]true[/code], and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly. - - Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code]. Default value: [code]100[/code]. + + Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code]. - - Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code]. Default value: [code]0[/code]. + + Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code]. - + 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. - - If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer. Default value: [code]false[/code]. + + If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer. - + If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer. - + Range's current value. diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index a38b45e2d8a..19f62a57bd2 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -125,23 +125,23 @@ - + The ray's destination point, relative to the RayCast's [code]position[/code]. - - If [code]true[/code], collision with [Area]s will be reported. Default value: [code]false[/code]. + + If [code]true[/code], collision with [Area]s will be reported. - - If [code]true[/code], collision with [PhysicsBody]s will be reported. Default value: [code]true[/code]. + + If [code]true[/code], collision with [PhysicsBody]s will be reported. - + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. - - If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. + + If [code]true[/code], collisions will be reported. - - If [code]true[/code], collisions will be ignored for this RayCast's immediate parent. Default value: [code]true[/code]. + + If [code]true[/code], collisions will be ignored for this RayCast's immediate parent. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index c68929d4a0a..81d66ef4962 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -122,23 +122,23 @@ - + The ray's destination point, relative to the RayCast's [code]position[/code]. - - If [code]true[/code], collision with [Area2D]s will be reported. Default value: [code]false[/code]. + + If [code]true[/code], collision with [Area2D]s will be reported. - - If [code]true[/code], collision with [PhysicsBody2D]s will be reported. Default value: [code]true[/code]. + + If [code]true[/code], collision with [PhysicsBody2D]s will be reported. - + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. - - If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. + + If [code]true[/code], collisions will be reported. - - If [code]true[/code], the parent node will be excluded from collision detection. Default value: [code]true[/code]. + + If [code]true[/code], the parent node will be excluded from collision detection. diff --git a/doc/classes/RayShape.xml b/doc/classes/RayShape.xml index 086654c469e..3f5859714ee 100644 --- a/doc/classes/RayShape.xml +++ b/doc/classes/RayShape.xml @@ -11,11 +11,11 @@ - + The ray's length. - - If [code]true[/code], allow the shape to return the correct normal. Default value: [code]false[/code]. + + If [code]true[/code], allow the shape to return the correct normal. diff --git a/doc/classes/RayShape2D.xml b/doc/classes/RayShape2D.xml index 23cb06f57a5..377a19e8da2 100644 --- a/doc/classes/RayShape2D.xml +++ b/doc/classes/RayShape2D.xml @@ -11,11 +11,11 @@ - + The ray's length. - - If [code]true[/code], allow the shape to return the correct normal. Default value: [code]false[/code]. + + If [code]true[/code], allow the shape to return the correct normal. diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 705e048e8e3..9d6bfbf3984 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -148,13 +148,13 @@ - + Ending corner. - + Position (starting corner). - + Size from position to end. diff --git a/doc/classes/RectangleShape2D.xml b/doc/classes/RectangleShape2D.xml index 62ead5598bc..d55324c98ff 100644 --- a/doc/classes/RectangleShape2D.xml +++ b/doc/classes/RectangleShape2D.xml @@ -11,7 +11,7 @@ - + The rectangle's half extents. The width and height of this shape is twice the half extents. diff --git a/doc/classes/ReferenceRect.xml b/doc/classes/ReferenceRect.xml index 3b5481a7a13..393a72cf60e 100644 --- a/doc/classes/ReferenceRect.xml +++ b/doc/classes/ReferenceRect.xml @@ -11,10 +11,10 @@ - + Sets the border [Color] of the [ReferenceRect]. - + If set to [code]true[/code], the [ReferenceRect] will only be visible while in editor. Otherwise, [ReferenceRect] will be visible in game. diff --git a/doc/classes/ReflectionProbe.xml b/doc/classes/ReflectionProbe.xml index 3268e9f8e5d..68b9110b50e 100644 --- a/doc/classes/ReflectionProbe.xml +++ b/doc/classes/ReflectionProbe.xml @@ -10,29 +10,29 @@ - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/doc/classes/RemoteTransform.xml b/doc/classes/RemoteTransform.xml index 17ee7bf123b..4628ef8519e 100644 --- a/doc/classes/RemoteTransform.xml +++ b/doc/classes/RemoteTransform.xml @@ -12,20 +12,20 @@ - + The [NodePath] to the remote node, relative to the RemoteTransform's position in the scene. - - If [code]true[/code], the remote node's position is updated. Default value: [code]true[/code]. + + If [code]true[/code], the remote node's position is updated. - - If [code]true[/code], the remote node's rotation is updated. Default value: [code]true[/code]. + + If [code]true[/code], the remote node's rotation is updated. - - If [code]true[/code], the remote node's scale is updated. Default value: [code]true[/code]. + + If [code]true[/code], the remote node's scale is updated. - - If [code]true[/code], global coordinates are used. If [code]false[/code], local coordinates are used. Default value: [code]true[/code]. + + If [code]true[/code], global coordinates are used. If [code]false[/code], local coordinates are used. diff --git a/doc/classes/RemoteTransform2D.xml b/doc/classes/RemoteTransform2D.xml index b8eb7c6f13f..6a317724a0f 100644 --- a/doc/classes/RemoteTransform2D.xml +++ b/doc/classes/RemoteTransform2D.xml @@ -12,20 +12,20 @@ - + The [NodePath] to the remote node, relative to the RemoteTransform2D's position in the scene. - - If [code]true[/code], the remote node's position is updated. Default value: [code]true[/code]. + + If [code]true[/code], the remote node's position is updated. - - If [code]true[/code], the remote node's rotation is updated. Default value: [code]true[/code]. + + If [code]true[/code], the remote node's rotation is updated. - - If [code]true[/code], the remote node's scale is updated. Default value: [code]true[/code]. + + If [code]true[/code], the remote node's scale is updated. - - If [code]true[/code], global coordinates are used. If [code]false[/code], local coordinates are used. Default value: [code]true[/code]. + + If [code]true[/code], global coordinates are used. If [code]false[/code], local coordinates are used. diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index 8f1903378cd..a50f5c97d17 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -59,13 +59,13 @@ - + If [code]true[/code], the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene. - + The name of the resource. This is an optional identifier. - + The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index e1e93dbb150..405eb595636 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -222,38 +222,38 @@ - - If [code]true[/code], the label uses BBCode formatting. Default value: [code]false[/code]. + + If [code]true[/code], the label uses BBCode formatting. - + The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited. - - If [code]true[/code], the label underlines meta tags such as [code][url]{text}[/url][/code]. Default value: [code]true[/code]. + + If [code]true[/code], the label underlines meta tags such as [code][url]{text}[/url][/code]. - - If [code]true[/code], the label uses the custom font color. Default value: [code]false[/code]. + + If [code]true[/code], the label uses the custom font color. - + The text's visibility, as a [float] between 0.0 and 1.0. - - If [code]true[/code], the scrollbar is visible. Does not block scrolling completely. See [method scroll_to_line]. Default value: [code]true[/code]. + + If [code]true[/code], the scrollbar is visible. Does not block scrolling completely. See [method scroll_to_line]. - - If [code]true[/code], the window scrolls down to display new content automatically. Default value: [code]false[/code]. + + If [code]true[/code], the window scrolls down to display new content automatically. - + If [code]true[/code], the label allows text selection. - + The number of spaces associated with a single tab length. Does not affect [code]\t[/code] in text tags, only indent tags. - + The raw text of the label. When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse BBCodes. Does not modify [member bbcode_text]. - + The restricted number of characters to display in the label. If [code]-1[/code], all characters will be displayed. @@ -327,17 +327,17 @@ - + - + - + - + @@ -345,17 +345,17 @@ - + - + - + - + - + - + diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index fefa519cea3..a7057894139 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -101,73 +101,75 @@ - + Damps RigidBody's rotational forces. - + RigidBody's rotational velocity. - + Lock the body's rotation in the X axis. - + Lock the body's rotation in the Y axis. - + Lock the body's rotation in the Z axis. - + Lock the body's movement in the X axis. - + Lock the body's movement in the Y axis. - + Lock the body's movement in the Z axis. - RigidBody's bounciness. + The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). + Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override]. - + If [code]true[/code], the RigidBody will not calculate forces and will act as a static body while there is no movement. It will wake up when forces are applied through other collisions or when the [code]apply_impulse[/code] method is used. - + If [code]true[/code], the RigidBody will emit signals when it collides with another RigidBody. - + The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. - + If [code]true[/code], continuous collision detection is used. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. Continuous collision detection is more precise, and misses fewer impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects. - + 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). + Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override]. - + This is multiplied by the global 3D gravity setting found in [b]Project > Project Settings > Physics > 3d[/b] to produce RigidBody's gravity. For example, a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. - - The body's linear damp. Default value: -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. + + The body's linear damp. Cannot be less than -1.0. If this value is different from -1.0, any linear damp derived from the world or areas will be overridden. - + The body's linear velocity. Can be used sporadically, but [b]don't set this every frame[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. - + The body's mass. - - The body mode. See [enum Mode] for possible values. Default value: [code]MODE_RIGID[/code]. + + The body mode. See [enum Mode] for possible values. - + - + If [code]true[/code], the body is sleeping and will not calculate forces until woken up by a collision or the [code]apply_impulse[/code] method. - + The body's weight based on its mass and the global 3D gravity. Global values are set in [b]Project > Project Settings > Physics > 3d[/b]. diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index f22ad9e4b2d..907a82d51d8 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -114,64 +114,66 @@ - - Damps the body's [member angular_velocity]. If [code]-1[/code], the body will use the [b]Default Angular Damp[/b] defined in [b]Project > Project Settings > Physics > 2d[/b]. Default value: [code]-1[/code]. + + Damps the body's [member angular_velocity]. If [code]-1[/code], the body will use the [b]Default Angular Damp[/b] defined in [b]Project > Project Settings > Physics > 2d[/b]. - + The body's rotational velocity. - + The body's total applied force. - + The body's total applied torque. - The body's bounciness. Default value: [code]0[/code]. + The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). + Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override]. - - If [code]true[/code], the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using [method apply_impulse] or [method add_force]. Default value: [code]true[/code]. + + If [code]true[/code], the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using [method apply_impulse] or [method add_force]. - - If [code]true[/code], the body will emit signals when it collides with another RigidBody2D. See also [member contacts_reported]. Default value: [code]false[/code]. + + If [code]true[/code], the body will emit signals when it collides with another RigidBody2D. See also [member contacts_reported]. - - The maximum number of contacts to report. Default value: [code]0[/code]. + + The maximum number of contacts to report. - - Continuous collision detection mode. Default value: [constant CCD_MODE_DISABLED]. + + Continuous collision detection mode. Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. See [enum CCDMode] for details. - + 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). Default value: [code]1[/code]. + The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). + Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override]. - - 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. Default value: [code]1[/code]. + + 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. - - Damps the body's [member linear_velocity]. If [code]-1[/code], the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 2d[/b]. Default value: [code]-1[/code]. + + Damps the body's [member linear_velocity]. If [code]-1[/code], the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 2d[/b]. - + The body's linear velocity. - - The body's mass. Default value: [code]1[/code]. + + The body's mass. - - The body's mode. See [enum Mode] for possible values. Default value: [constant MODE_RIGID]. + + The body's mode. See [enum Mode] for possible values. - + - + If [code]true[/code], the body is sleeping and will not calculate forces until woken up by a collision or by using [method apply_impulse] or [method add_force]. - + The body's weight based on its mass and the [b]Default Gravity[/b] value in [b]Project > Project Settings > Physics > 2d[/b]. diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 5e898642d66..1302c1e6bf9 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -203,7 +203,7 @@ - If [code]true[/code], the application automatically accepts quitting. Defaults to [code]true[/code]. + If [code]true[/code], the application automatically accepts quitting. Enabled by default. @@ -247,7 +247,7 @@ - If [code]true[/code], the application quits automatically on going back (e.g. on Android). Defaults to [code]true[/code]. + If [code]true[/code], the application quits automatically on going back (e.g. on Android). Enabled by default. @@ -270,10 +270,10 @@ The current scene. - + If [code]true[/code], collision shapes will be visible when running the game from the editor for debugging purposes. - + If [code]true[/code], navigation polygons will be visible when running the game from the editor for debugging purposes. @@ -282,25 +282,25 @@ 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. - + If [code]true[/code], the [SceneTree] is paused. Doing so will have the following behavior: - 2D and 3D physics will be stopped. - [method Node._process], [method Node._physics_process] and [method Node._input] will not be called anymore in nodes. - + If [code]true[/code], the [SceneTree]'s [member network_peer] refuses new incoming connections. The [SceneTree]'s root [Viewport]. - + If [code]true[/code], font oversampling is used. diff --git a/doc/classes/ScrollBar.xml b/doc/classes/ScrollBar.xml index 8576fd26e29..29bc85cc56a 100644 --- a/doc/classes/ScrollBar.xml +++ b/doc/classes/ScrollBar.xml @@ -11,7 +11,7 @@ - + diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 8eca55373b5..59e8d566cf8 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -23,18 +23,18 @@ - + - + The current horizontal scroll value. - + If [code]true[/code], enables horizontal scrolling. - + The current vertical scroll value. - + If [code]true[/code], enables vertical scrolling. diff --git a/doc/classes/SegmentShape2D.xml b/doc/classes/SegmentShape2D.xml index af2392787c4..e9e9d01a42d 100644 --- a/doc/classes/SegmentShape2D.xml +++ b/doc/classes/SegmentShape2D.xml @@ -11,10 +11,10 @@ - + The segment's first point position. - + The segment's second point position. diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index b14351ee28c..be9509fda56 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -45,7 +45,7 @@ - + diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index ef355c44178..01d90555699 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -48,7 +48,7 @@ - + The [Shader] program used to render this material. diff --git a/doc/classes/Shape.xml b/doc/classes/Shape.xml index d622ff1cf22..ce5947bc061 100644 --- a/doc/classes/Shape.xml +++ b/doc/classes/Shape.xml @@ -12,7 +12,7 @@ - + diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 65abc352829..2c3120f04d0 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -76,7 +76,7 @@ - + diff --git a/doc/classes/ShortCut.xml b/doc/classes/ShortCut.xml index 4c5dc0e77b5..44a10ba598b 100644 --- a/doc/classes/ShortCut.xml +++ b/doc/classes/ShortCut.xml @@ -35,7 +35,7 @@ - + The shortcut's [InputEvent]. Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent]. diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index a6e535bcfe9..b1e71ee9242 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -266,7 +266,7 @@ - + diff --git a/doc/classes/SkeletonIK.xml b/doc/classes/SkeletonIK.xml index 42c7759c1f3..2f35826cc73 100644 --- a/doc/classes/SkeletonIK.xml +++ b/doc/classes/SkeletonIK.xml @@ -35,25 +35,25 @@ - + - + - + - + - + - + - + - + - + - + diff --git a/doc/classes/Sky.xml b/doc/classes/Sky.xml index cc9d2dc0df7..398a988d9e6 100644 --- a/doc/classes/Sky.xml +++ b/doc/classes/Sky.xml @@ -11,9 +11,9 @@ - + The [Sky]'s radiance map size. The higher the radiance map size, the more detailed the lighting from the [Sky] will be. - See [enum RadianceSize] constants for values. Default size is [constant RADIANCE_SIZE_512]. + See [enum RadianceSize] constants for values. diff --git a/doc/classes/Slider.xml b/doc/classes/Slider.xml index 482c83f225d..24ddb95c962 100644 --- a/doc/classes/Slider.xml +++ b/doc/classes/Slider.xml @@ -11,18 +11,18 @@ - + If [code]true[/code], the slider can be interacted with. If [code]false[/code], the value can be changed only by code. - + - + If [code]true[/code], the value can be changed using the mouse wheel. - + Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers. - + If [code]true[/code], the slider will display ticks for minimum and maximum values. diff --git a/doc/classes/SliderJoint.xml b/doc/classes/SliderJoint.xml index 6a07bd97254..a91f67f1072 100644 --- a/doc/classes/SliderJoint.xml +++ b/doc/classes/SliderJoint.xml @@ -11,73 +11,73 @@ - + The amount of damping of the rotation when the limit is surpassed. A lower damping value allows a rotation initiated by body A to travel to body B slower. - + The lower limit of rotation in the slider. - + The amount of restitution of the rotation when the limit is surpassed. Does not affect damping. - + A factor applied to the all rotation once the limit is surpassed. Makes all rotation slower when between 0 and 1. - + The upper limit of rotation in the slider. - + The amount of damping of the rotation in the limits. - + The amount of restitution of the rotation in the limits. - + A factor applied to the all rotation in the limits. - + The amount of damping of the rotation across axes orthogonal to the slider. - + The amount of restitution of the rotation across axes orthogonal to the slider. - + A factor applied to the all rotation across axes orthogonal to the slider. - + The amount of damping that happens once the limit defined by [member linear_limit/lower_distance] and [member linear_limit/upper_distance] is surpassed. - + The minimum difference between the pivot points on their X axis before damping happens. - + The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. - + A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. - + The maximum difference between the pivot points on their X axis before damping happens. - + The amount of damping inside the slider limits. - + The amount of restitution inside the slider limits. - + A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement. - + The amount of damping when movement is across axes orthogonal to the slider. - + The amount of restitution when movement is across axes orthogonal to the slider. - + A factor applied to the movement across axes orthogonal to the slider. diff --git a/doc/classes/SoftBody.xml b/doc/classes/SoftBody.xml index b235a26ad76..5cde31fa590 100644 --- a/doc/classes/SoftBody.xml +++ b/doc/classes/SoftBody.xml @@ -90,34 +90,34 @@ - + - + The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - + The physics layers this area scans for collisions. - + - + - + - + - + - + - + Increasing this value will improve the resulting simulation, but can affect performance. Use with care. - + - + diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 5614d0b8992..9f4118aa7b9 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -303,20 +303,20 @@ 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. - + Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). - + Scale part of the local transformation. - + Local space [Transform] of this node, with respect to the parent node. - + Local translation of this node. - - If [code]true[/code], this node is drawn. Default value: [code]true[/code]. + + If [code]true[/code], this node is drawn. diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 6b4a34826b5..5e18e72f907 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -12,20 +12,20 @@ - + The material's base color. - + 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. Default value: [code]false[/code]. + + 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. @@ -38,8 +38,8 @@ - - If [code]true[/code], clearcoat rendering is enabled. Adds a secondary transparent pass to the material. Default value: [code]false[/code]. + + If [code]true[/code], clearcoat rendering is enabled. Adds a secondary transparent pass to the material. @@ -47,7 +47,7 @@ - + If [code]true[/code], depth mapping is enabled (also called "parallax mapping" or "height mapping"). See also [member normal_enabled]. @@ -66,7 +66,7 @@ - + @@ -78,12 +78,12 @@ - + The emitted light's color. See [member emission_enabled]. - + If [code]true[/code], the body emits light. @@ -95,52 +95,52 @@ - + - - If [code]true[/code], the object receives no ambient light. Default value: [code]false[/code]. + + If [code]true[/code], the object receives no ambient light. - - If [code]true[/code], the object receives no shadow that would otherwise be cast onto it. Default value: [code]false[/code]. + + If [code]true[/code], the object receives no shadow that would otherwise be cast onto it. - + - - If [code]true[/code], the object is rendered at the same size regardless of distance. Default value: [code]false[/code]. + + If [code]true[/code], the object is rendered at the same size regardless of distance. - + If [code]true[/code], depth testing is disabled and the object will be drawn in render order. - - If [code]true[/code], transparency is enabled on the body. Default value: [code]false[/code]. See also [member params_blend_mode]. + + If [code]true[/code], transparency is enabled on the body. See also [member params_blend_mode]. - - If [code]true[/code], the object is unaffected by lighting. Default value: [code]false[/code]. + + If [code]true[/code], the object is unaffected by lighting. - + If [code]true[/code], render point size can be changed. [b]Note:[/b] this is only effective for objects whose geometry is point-based rather than triangle-based. See also [member params_point_size]. - + - - If [code]true[/code], lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. Default value: [code]false[/code]. + + If [code]true[/code], lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. - - If [code]true[/code], triplanar mapping is calculated in world space rather than object local space. See also [member uv1_triplanar]. Default value: [code]false[/code]. + + If [code]true[/code], triplanar mapping is calculated in world space rather than object local space. See also [member uv1_triplanar]. - + The reflectivity of the object's surface. The higher the value, the more light is reflected. - + General reflectivity amount. [b]Note:[/b] unlike [member metallic], this is not energy-conserving, so it should be left at [code]0.5[/code] in most cases. See also [member roughness]. - + - + - + If [code]true[/code], normal mapping is enabled. @@ -150,39 +150,39 @@ - + - + Controls how the object faces the camera. See [enum BillboardMode]. - + The material's blend mode. [b]Note:[/b] Values other than [code]Mix[/code] force the object into the transparent pipeline. See [enum BlendMode]. - + Which side of the object is not drawn when backfaces are rendered. See [enum CullMode]. - + Determines when depth rendering takes place. See [enum DepthDrawMode]. See also [member flags_transparent]. - + The algorithm used for diffuse light scattering. See [enum DiffuseMode]. - + If [code]true[/code], enables the vertex grow setting. See [member params_grow_amount]. Grows object vertices in the direction of their normals. - + - + The point size in pixels. See [member flags_use_point_size]. - + The method for rendering the specular blob. See [enum SpecularMode]. - + The number of horizontal frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode]. @@ -195,11 +195,11 @@ - - If [code]true[/code], the proximity and distance fade effect is enabled. Default value: [code]false[/code]. + + If [code]true[/code], the proximity and distance fade effect is enabled. - - If [code]true[/code], the refraction effect is enabled. Distorts transparency based on light from behind the object. Default value: [code]false[/code]. + + If [code]true[/code], the refraction effect is enabled. Distorts transparency based on light from behind the object. The strength of the refraction effect. @@ -210,22 +210,22 @@ - - If [code]true[/code], rim effect is enabled. Default value: [code]false[/code]. + + 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. - + Surface reflection. A value of [code]0[/code] represents a perfect mirror while a value of [code]1[/code] completely blurs the reflection. See also [member metallic]. - + - + - + If [code]true[/code], subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. @@ -236,32 +236,32 @@ The color used by the transmission effect. Represents the light passing through an object. - - If [code]true[/code], the transmission effect is enabled. Default value: [code]false[/code]. + + If [code]true[/code], the transmission effect is enabled. - + - + - + - + - + - + - + - + - - If [code]true[/code], the model's vertex colors are processed as sRGB mode. Default value: [code]false[/code]. + + If [code]true[/code], the model's vertex colors are processed as sRGB mode. - - If [code]true[/code], the vertex color is used as albedo color. Default value: [code]false[/code]. + + If [code]true[/code], the vertex color is used as albedo color. @@ -433,7 +433,7 @@ No specular blob. - Default value. + Billboard mode is disabled. The object's Z axis will always face the camera. diff --git a/doc/classes/SpatialVelocityTracker.xml b/doc/classes/SpatialVelocityTracker.xml index 45dd06e9264..0dcd174a670 100644 --- a/doc/classes/SpatialVelocityTracker.xml +++ b/doc/classes/SpatialVelocityTracker.xml @@ -31,7 +31,7 @@ - + diff --git a/doc/classes/SphereMesh.xml b/doc/classes/SphereMesh.xml index c33c676ea1d..6d81d8ff829 100644 --- a/doc/classes/SphereMesh.xml +++ b/doc/classes/SphereMesh.xml @@ -11,21 +11,21 @@ - - Full height of the sphere. Defaults to 2.0. + + Full height of the sphere. - + Determines whether a full sphere or a hemisphere is created. - [b]Note:[/b] To get a regular hemisphere, the height and radius of the sphere must be equal. Defaults to [code]false[/code]. + [b]Note:[/b] To get a regular hemisphere, the height and radius of the sphere must be equal. - - Number of radial segments on the sphere. Defaults to 64. + + Number of radial segments on the sphere. - - Radius of sphere. Defaults to 1.0. + + Radius of sphere. - - Number of segments along the height of the sphere. Defaults to 32. + + Number of segments along the height of the sphere. diff --git a/doc/classes/SphereShape.xml b/doc/classes/SphereShape.xml index 21309ae83e6..616c3b3894f 100644 --- a/doc/classes/SphereShape.xml +++ b/doc/classes/SphereShape.xml @@ -11,7 +11,7 @@ - + The sphere's radius. The shape's diameter is double the radius. diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 3388af2dd03..bda0b1192dd 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -28,16 +28,16 @@ - + Sets the text alignment of the [SpinBox]. - + If [code]true[/code], the [SpinBox] will be editable. Otherwise, it will be read only. - + Adds the specified [code]prefix[/code] string before the numerical value of the [SpinBox]. - + Adds the specified [code]prefix[/code] string after the numerical value of the [SpinBox]. diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index 5d9a233624a..d756c17cefb 100644 --- a/doc/classes/SplitContainer.xml +++ b/doc/classes/SplitContainer.xml @@ -17,12 +17,12 @@ - + - + Determines whether the dragger is visible. - + diff --git a/doc/classes/SpotLight.xml b/doc/classes/SpotLight.xml index edd578a5b06..93aee55b997 100644 --- a/doc/classes/SpotLight.xml +++ b/doc/classes/SpotLight.xml @@ -12,16 +12,16 @@ - + The spotlight's angle in degrees. - + The spotlight's angular attenuation curve. - + The spotlight's light energy attenuation curve. - + The maximal range that can be reached by the spotlight. diff --git a/doc/classes/SpringArm.xml b/doc/classes/SpringArm.xml index 50c6fef1486..16b4b846e4b 100644 --- a/doc/classes/SpringArm.xml +++ b/doc/classes/SpringArm.xml @@ -37,13 +37,13 @@ - + - + - + - + diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml index 64889313549..c14ae43f66a 100644 --- a/doc/classes/Sprite.xml +++ b/doc/classes/Sprite.xml @@ -34,40 +34,40 @@ - - If [code]true[/code], texture is centered. Default value: [code]true[/code]. + + If [code]true[/code], texture is centered. - - If [code]true[/code], texture is flipped horizontally. Default value: [code]false[/code]. + + If [code]true[/code], texture is flipped horizontally. - - If [code]true[/code], texture is flipped vertically. Default value: [code]false[/code]. + + If [code]true[/code], texture is flipped vertically. - + Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1. - + The number of columns in the sprite sheet. - + The normal map gives depth to the Sprite. - + The texture's drawing offset. - - If [code]true[/code], texture is cut from a larger atlas texture. See [member region_rect]. Default value: [code]false[/code]. + + If [code]true[/code], texture is cut from a larger atlas texture. See [member region_rect]. - + If [code]true[/code], the outermost pixels get blurred out. - + The region of the atlas texture to display. [member region_enabled] must be [code]true[/code]. - + [Texture] object to draw. - + The number of rows in the sprite sheet. diff --git a/doc/classes/Sprite3D.xml b/doc/classes/Sprite3D.xml index 02976993377..78004c60ee9 100644 --- a/doc/classes/Sprite3D.xml +++ b/doc/classes/Sprite3D.xml @@ -11,22 +11,22 @@ - + Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1. - + The number of columns in the sprite sheet. - - If [code]true[/code], texture will be cut from a larger atlas texture. See [member region_rect]. Default value: [code]false[/code]. + + If [code]true[/code], texture will be cut from a larger atlas texture. See [member region_rect]. - + The region of the atlas texture to display. [member region_enabled] must be [code]true[/code]. - + [Texture] object to draw. - + The number of rows in the sprite sheet. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index b42ba23358a..9c5ed213a89 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -23,40 +23,40 @@ - + - + The direction in which the front of the texture faces. - - If [code]true[/code], texture will be centered. Default value: [code]true[/code]. + + If [code]true[/code], texture will be centered. - - If [code]true[/code], texture can be seen from the back as well, if [code]false[/code], it is invisible when looking at it from behind. Default value: [code]true[/code]. + + If [code]true[/code], texture can be seen from the back as well, if [code]false[/code], it is invisible when looking at it from behind. - - If [code]true[/code], texture is flipped horizontally. Default value: [code]false[/code]. + + If [code]true[/code], texture is flipped horizontally. - - If [code]true[/code], texture is flipped vertically. Default value: [code]false[/code]. + + If [code]true[/code], texture is flipped vertically. - + A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. - + The texture's drawing offset. - + The objects visibility on a scale from [code]0[/code] fully invisible to [code]1[/code] fully visible. - + The size of one pixel's width on the sprite to scale it in 3D. - - If [code]true[/code], the [Light] in the [Environment] has effects on the sprite. Default value: [code]false[/code]. + + If [code]true[/code], the [Light] in the [Environment] has effects on the sprite. - - If [code]true[/code], the texture's transparency and the opacity are used to make those parts of the sprite invisible. Default value: [code]true[/code]. + + If [code]true[/code], the texture's transparency and the opacity are used to make those parts of the sprite invisible. diff --git a/doc/classes/StaticBody.xml b/doc/classes/StaticBody.xml index 6d91f8b238c..878d76a2e37 100644 --- a/doc/classes/StaticBody.xml +++ b/doc/classes/StaticBody.xml @@ -14,18 +14,20 @@ - The body's bounciness. + The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). + Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override]. - + The body's constant angular velocity. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation. - + 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). + Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override]. - + diff --git a/doc/classes/StaticBody2D.xml b/doc/classes/StaticBody2D.xml index 9d6ab631f9a..4522a50557d 100644 --- a/doc/classes/StaticBody2D.xml +++ b/doc/classes/StaticBody2D.xml @@ -14,17 +14,19 @@ The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). + Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override]. - + The body's constant angular velocity. This does not rotate the body, but affects colliding bodies, as if it were rotating. - + 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). + Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override]. - + diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index 11b4c116c45..678c587f8de 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -271,7 +271,7 @@ - + If [code]true[/code], this [StreamPeer] will using big-endian format for encoding and decoding. diff --git a/doc/classes/StreamPeerBuffer.xml b/doc/classes/StreamPeerBuffer.xml index de4603b7c0d..30a220863db 100644 --- a/doc/classes/StreamPeerBuffer.xml +++ b/doc/classes/StreamPeerBuffer.xml @@ -49,7 +49,7 @@ - + diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index d529b6da996..9b5f4e75807 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -54,7 +54,7 @@ - + diff --git a/doc/classes/StreamTexture.xml b/doc/classes/StreamTexture.xml index 4723fec2103..20cbadb5f0a 100644 --- a/doc/classes/StreamTexture.xml +++ b/doc/classes/StreamTexture.xml @@ -11,7 +11,7 @@ - + The StreamTexture's file path to a [code].stex[/code] file. diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index 832f93e0ba6..6b8f0762119 100644 --- a/doc/classes/StyleBox.xml +++ b/doc/classes/StyleBox.xml @@ -68,21 +68,21 @@ - + The bottom margin for the contents of this style box. Increasing this value reduces the space available to the contents from the bottom. If this value is negative, it is ignored and a child-specific margin is used instead. For example for [StyleBoxFlat] the border thickness (if any) is used instead. It is up to the code using this style box to decide what these contents are: for example, a [Button] respects this content margin for the textual contents of the button. [method get_margin] should be used to fetch this value as consumer instead of reading these properties directly. This is because it correctly respects negative values and the fallback mentioned above. - + The left margin for the contents of this style box. Increasing this value reduces the space available to the contents from the left. Refer to [member content_margin_bottom] for extra considerations. - + The right margin for the contents of this style box. Increasing this value reduces the space available to the contents from the right. Refer to [member content_margin_bottom] for extra considerations. - + The top margin for the contents of this style box. Increasing this value reduces the space available to the contents from the top. Refer to [member content_margin_bottom] for extra considerations. diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index 53188d6b108..28f49f831cb 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -84,71 +84,71 @@ - + Antialiasing draws a small ring around the edges, which fades to transparency. As a result, edges look much smoother. This is only noticeable when using rounded corners. - + This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. - + The background color of the stylebox. - + If [code]true[/code], the border will fade into the background color. - + Sets the color of the border. - + Border width for the bottom border. - + Border width for the left border. - + Border width for the right border. - + Border width for the top border. - + This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value, you should take the corner radius ([method set_corner_radius_all]) into account. For corner radii smaller than 10, 4-5 should be enough. For corner radii smaller than 30, 8-12 should be enough. - + The bottom-left corner's radius. If [code]0[/code], the corner is not rounded. - + The bottom-right corner's radius. If [code]0[/code], the corner is not rounded. - + The top-left corner's radius. If [code]0[/code], the corner is not rounded. - + The top-right corner's radius. If [code]0[/code], the corner is not rounded. - + Toggles drawing of the inner part of the stylebox. - + Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with [member border_width_bottom] to draw a border outside the control rect. - + Expands the stylebox outside of the control rect on the left edge. Useful in combination with [member border_width_left] to draw a border outside the control rect. - + Expands the stylebox outside of the control rect on the right edge. Useful in combination with [member border_width_right] to draw a border outside the control rect. - + Expands the stylebox outside of the control rect on the top edge. Useful in combination with [member border_width_top] to draw a border outside the control rect. - + The color of the shadow. This has no effect if [member shadow_size] is lower than 1. - + The shadow offset in pixels. Adjusts the position of the shadow relatively to the stylebox. - + The shadow size in pixels. diff --git a/doc/classes/StyleBoxLine.xml b/doc/classes/StyleBoxLine.xml index aa306291c85..c0745c5f392 100644 --- a/doc/classes/StyleBoxLine.xml +++ b/doc/classes/StyleBoxLine.xml @@ -9,15 +9,15 @@ - + - + - + - + - + diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index b50dc741121..e51120f269b 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -33,55 +33,55 @@ - + - + - + - + Expands the bottom margin of this style box when drawing, causing it to be drawn larger than requested. - + Expands the left margin of this style box when drawing, causing it to be drawn larger than requested. - + Expands the right margin of this style box when drawing, causing it to be drawn larger than requested. - + Expands the top margin of this style box when drawing, causing it to be drawn larger than requested. - + Increases the bottom margin of the 3×3 texture box. A higher value means more of the source texture is considered to be part of the bottom border of the 3×3 box. This is also the value used as fallback for [member StyleBox.content_margin_bottom] if it is negative. - + Increases the left margin of the 3×3 texture box. A higher value means more of the source texture is considered to be part of the left border of the 3×3 box. This is also the value used as fallback for [member StyleBox.content_margin_left] if it is negative. - + Increases the right margin of the 3×3 texture box. A higher value means more of the source texture is considered to be part of the right border of the 3×3 box. This is also the value used as fallback for [member StyleBox.content_margin_right] if it is negative. - + Increases the top margin of the 3×3 texture box. A higher value means more of the source texture is considered to be part of the top border of the 3×3 box. This is also the value used as fallback for [member StyleBox.content_margin_top] if it is negative. - + Modulates the color of the texture when this style box is drawn. - + The normal map to use when drawing this style box. - + Species a sub region of the texture to use. This is equivalent to first wrapping the texture in an [AtlasTexture] with the same region. - + The texture to use when drawing this style box. diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 3fce5909678..2eb84110783 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -137,17 +137,17 @@ - + The current tab index. When set, this index's [Control] node's [code]visible[/code] property is set to [code]true[/code] and all others are set to [code]false[/code]. - + If [code]true[/code], tabs can be rearranged with mouse drag. - + The alignment of all tabs in the tab container. See the [code]ALIGN_*[/code] constants for details. - - If [code]true[/code], tabs are visible. If [code]false[/code], tabs' content and titles are hidden. Default value: [code]true[/code]. + + If [code]true[/code], tabs are visible. If [code]false[/code], tabs' content and titles are hidden. @@ -189,21 +189,21 @@ - + - + - + - + - + - + @@ -211,7 +211,7 @@ - + @@ -219,7 +219,7 @@ - + diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index 989c079036c..b6d702ba453 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -172,18 +172,18 @@ - + Select tab at index [code]tab_idx[/code]. - + If [code]true[/code], tabs can be rearranged with mouse drag. - + - + The alignment of all tabs. See enum [code]TabAlign[/code] constants for details. - + @@ -260,21 +260,21 @@ - + - + - + - + - + - + @@ -284,7 +284,7 @@ - + diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 748e1c188b3..e6651788097 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -94,7 +94,7 @@ Moves the cursor at the specified [code]column[/code] index. - If [code]adjust_viewport[/code] is set to true, the viewport will center at the cursor position after the move occurs. Default value is [code]true[/code]. + If [code]adjust_viewport[/code] is set to true, the viewport will center at the cursor position after the move occurs. @@ -110,8 +110,8 @@ Moves the cursor at the specified [code]line[/code] index. - If [code]adjust_viewport[/code] is set to true, the viewport will center at the cursor position after the move occurs. Default value is [code]true[/code]. - If [code]can_be_hidden[/code] is set to true, the specified [code]line[/code] can be hidden using [method set_line_as_hidden]. Default value is [code]true[/code]. + If [code]adjust_viewport[/code] is set to true, the viewport will center at the cursor position after the move occurs. + If [code]can_be_hidden[/code] is set to true, the specified [code]line[/code] can be hidden using [method set_line_as_hidden]. @@ -380,65 +380,65 @@ - + If [code]true[/code], the breakpoint gutter is visible. - + If [code]true[/code], the caret (visual cursor) blinks. - + Duration (in seconds) of a caret's blinking cycle. - + If [code]true[/code], the caret displays as a rectangle. If [code]false[/code], the caret displays as a bar. - + If [code]true[/code], a right-click moves the cursor at the mouse position before displaying the context menu. If [code]false[/code], the context menu disregards mouse location. - + If [code]true[/code], a right-click displays the context menu. - + If [code]true[/code], the "space" character will have a visible representation. - + If [code]true[/code], the "tab" character will have a visible representation. - + If [code]true[/code], the fold gutter is visible. This enables folding groups of indented lines. - + If [code]true[/code], all lines that have been set to hidden by [method set_line_as_hidden], will not be visible. - + If [code]true[/code], all occurrences of the selected text will be highlighted. - + If [code]true[/code], the line containing the cursor is highlighted. - + - + If [code]true[/code], read-only mode is enabled. Existing text cannot be modified and new text cannot be added. - + If [code]true[/code], line numbers are displayed to the left of the text. - + If [code]true[/code], sets the [code]step[/code] of the scrollbars to [code]0.25[/code] which results in smoother scrolling. - + If [code]true[/code], any custom color properties that have been set for this [TextEdit] will be visible. - + String value of the [TextEdit]. - + Vertical scroll sensitivity. - + If [code]true[/code], enables text wrapping when it goes beyond the edge of what is visible. @@ -520,45 +520,45 @@ - + Sets the background [Color] of this [TextEdit]. [member syntax_highlighting] has to be enabled. - + Sets the [Color] of the bookmark marker. [member syntax_highlighting] has to be enabled. - + - + Sets the [Color] of the breakpoints. [member breakpoint_gutter] has to be enabled. - + - + - + - + - + - + - + - + - + - + - + - + Sets the [Color] of the breakpoints. [member breakpoint_gutter] has to be enabled. - + @@ -569,47 +569,47 @@ Sets the default [Font]. - + Sets the font [Color]. - + - + - + - + Sets the [Color] of the line numbers. [member show_line_numbers] has to be enabled. - + Sets the spacing between the lines. - + Sets the [Color] of marked text. - + Sets the [StyleBox] of this [TextEdit]. - + Sets the [StyleBox] of this [TextEdit] when [member readonly] is enabled. - + - + Sets the highlight [Color] of text selections. - + Sets a custom [Texture] for tab text characters. - + Sets the highlight [Color] of multiple occurrences. [member highlight_all_occurrences] has to be enabled. diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index 5bd07b7ecb8..238d6929ba3 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -99,13 +99,13 @@ - + The texture's flags. - Default flags. [constant FLAG_MIPMAPS], [constant FLAG_REPEAT] and [constant FLAG_FILTER] are are enabled. + Default flags. [constant FLAG_MIPMAPS], [constant FLAG_REPEAT] and [constant FLAG_FILTER] are enabled. Generates mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. diff --git a/doc/classes/TextureButton.xml b/doc/classes/TextureButton.xml index 6f28c3f48f0..e3396a10c2b 100644 --- a/doc/classes/TextureButton.xml +++ b/doc/classes/TextureButton.xml @@ -12,28 +12,28 @@ - - If [code]true[/code], the texture stretches to the edges of the node's bounding rectangle using the [member stretch_mode]. If [code]false[/code], the texture will not scale with the node. Default value: [code]false[/code]. + + If [code]true[/code], the texture stretches to the edges of the node's bounding rectangle using the [member stretch_mode]. If [code]false[/code], the texture will not scale with the node. - + Controls the texture's behavior when you resize the node's bounding rectangle, [b]only if[/b] [member expand] is [code]true[/code]. Set it to one of the [code]STRETCH_*[/code] constants. See the constants to learn more. - + Pure black and white [BitMap] image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes. - + Texture to display when the node is disabled. See [member BaseButton.disabled]. - + Texture to display when the node has mouse or keyboard focus. - + Texture to display when the mouse hovers the node. - + Texture to display by default, when the node is [b]not[/b] in the disabled, focused, hover or pressed state. - + Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the Enter key or if the player presses the [member BaseButton.shortcut] key. diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml index 7c77bd43a30..a9ad5c251d8 100644 --- a/doc/classes/TextureLayered.xml +++ b/doc/classes/TextureLayered.xml @@ -83,9 +83,16 @@ - + - + diff --git a/doc/classes/TextureProgress.xml b/doc/classes/TextureProgress.xml index 5b97f3e0de7..409d005067e 100644 --- a/doc/classes/TextureProgress.xml +++ b/doc/classes/TextureProgress.xml @@ -11,51 +11,51 @@ - + The fill direction. See [enum FillMode] for possible values. - - If [code]true[/code], Godot treats the bar's textures like in [NinePatchRect]. Use the [code]stretch_margin_*[/code] properties like [member stretch_margin_bottom] to set up the nine patch's 3×3 grid. Default value: [code]false[/code]. + + If [code]true[/code], Godot treats the bar's textures like in [NinePatchRect]. Use the [code]stretch_margin_*[/code] properties like [member stretch_margin_bottom] to set up the nine patch's 3×3 grid. - + Offsets [member texture_progress] if [member fill_mode] is [constant FILL_CLOCKWISE] or [constant FILL_COUNTER_CLOCKWISE]. - + Upper limit for the fill of [member texture_progress] if [member fill_mode] is [constant FILL_CLOCKWISE] or [constant FILL_COUNTER_CLOCKWISE]. When the node's [code]value[/code] is equal to its [code]max_value[/code], the texture fills up to this angle. See [member Range.value], [member Range.max_value]. - + Starting angle for the fill of [member texture_progress] if [member fill_mode] is [constant FILL_CLOCKWISE] or [constant FILL_COUNTER_CLOCKWISE]. When the node's [code]value[/code] is equal to its [code]min_value[/code], the texture doesn't show up at all. When the [code]value[/code] increases, the texture fills and tends towards [member radial_fill_degrees]. - + The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. - + The width of the 9-patch's left column. - + The width of the 9-patch's right column. - + The height of the 9-patch's top row. - + [Texture] that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of [member texture_progress]. - + [Texture] that clips based on the node's [code]value[/code] and [member fill_mode]. As [code]value[/code] increased, the texture fills up. It shows entirely when [code]value[/code] reaches [code]max_value[/code]. It doesn't show at all if [code]value[/code] is equal to [code]min_value[/code]. The [code]value[/code] property comes from [Range]. See [member Range.value], [member Range.min_value], [member Range.max_value]. - + [Texture] that draws under the progress bar. The bar's background. - + Multiplies the color of the bar's [code]texture_over[/code] texture. The effect is similar to [member CanvasItem.modulate], except it only affects this specific texture instead of the entire node. - + Multiplies the color of the bar's [code]texture_progress[/code] texture. - + Multiplies the color of the bar's [code]texture_under[/code] texture. diff --git a/doc/classes/TextureRect.xml b/doc/classes/TextureRect.xml index b0b786a7225..8320d535ea2 100644 --- a/doc/classes/TextureRect.xml +++ b/doc/classes/TextureRect.xml @@ -11,19 +11,19 @@ - - If [code]true[/code], the texture scales to fit its bounding rectangle. Default value: [code]false[/code]. + + If [code]true[/code], the texture scales to fit its bounding rectangle. - - If [code]true[/code], texture is flipped horizontally. Default value: [code]false[/code]. + + If [code]true[/code], texture is flipped horizontally. - - If [code]true[/code], texture is flipped vertically. Default value: [code]false[/code]. + + If [code]true[/code], texture is flipped vertically. - + Controls the texture's behavior when resizing the node's bounding rectangle. See [enum StretchMode]. - + The node's [Texture] resource. diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index e4db9243efc..9c2676a55aa 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -335,7 +335,7 @@ - + The theme's default font. diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index b4dd2379c9a..55666b94b59 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -254,48 +254,50 @@ - + - + The custom [Transform2D] to be applied to the TileMap's cells. - - Amount to offset alternating tiles. See [enum HalfOffset] for possible values. Default value: [code]HALF_OFFSET_DISABLED[/code]. + + Amount to offset alternating tiles. See [enum HalfOffset] for possible values. - - The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16. + + The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. - + The TileMap's cell size. - - Position for tile origin. See [enum TileOrigin] for possible values. Default value: [code]TILE_ORIGIN_TOP_LEFT[/code]. + + Position for tile origin. See [enum TileOrigin] for possible values. - - If [code]true[/code], the TileMap's children will be drawn in order of their Y coordinate. Default value: [code]false[/code]. + + If [code]true[/code], the TileMap's children will be drawn in order of their Y coordinate. - - Bounce value for static body collisions (see [code]collision_use_kinematic[/code]). Default value: 0. + + Bounce value for static body collisions (see [code]collision_use_kinematic[/code]). - - Friction value for static body collisions (see [code]collision_use_kinematic[/code]). Default value: 1. + + Friction value for static body collisions (see [code]collision_use_kinematic[/code]). - + The collision layer(s) for all colliders in the TileMap. - + 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. Default value: [code]false[/code]. + + 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. Default value: [code]MODE_SQUARE[/code]. + - + + The TileMap orientation mode. See [enum Mode] for possible values. + + The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). - + The assigned [TileSet]. diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 120367f42ed..4f455fb3778 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -35,23 +35,23 @@ - - If [code]true[/code], the timer will automatically start when entering the scene tree. Default value: [code]false[/code]. + + If [code]true[/code], the timer will automatically start when entering the scene tree. - - If [code]true[/code], the timer will stop when reaching 0. If [code]false[/code], it will restart. Default value: [code]false[/code]. + + 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]. - + Wait time in seconds. diff --git a/doc/classes/ToolButton.xml b/doc/classes/ToolButton.xml index b48ab75fd01..35119874747 100644 --- a/doc/classes/ToolButton.xml +++ b/doc/classes/ToolButton.xml @@ -23,17 +23,17 @@ - + - + - + - + - + diff --git a/doc/classes/TouchScreenButton.xml b/doc/classes/TouchScreenButton.xml index 8a15f078bab..fd9f96a41ec 100644 --- a/doc/classes/TouchScreenButton.xml +++ b/doc/classes/TouchScreenButton.xml @@ -18,31 +18,31 @@ - + The button's action. Actions can be handled with [InputEventAction]. - + The button's bitmask. - + The button's texture for the normal state. - + If [code]true[/code], pass-by presses are enabled. - + The button's texture for the pressed state. - + The button's shape. - + If [code]true[/code], the button's shape is centered. - + If [code]true[/code], the button's shape is visible. - + The button's visibility mode. See [enum VisibilityMode] for possible values. diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 7f7bac9bbd8..80a393dcee2 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -158,10 +158,10 @@ - + The basis is a matrix containing 3 [Vector3] as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. - + The translation offset of the transform. diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 450768bb4d5..c5ae88d0503 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -160,13 +160,13 @@ - + The transform's translation offset. - + The X axis of 2×2 basis matrix containing 2 [Vector2]s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. - + The Y axis of 2×2 basis matrix containing 2 [Vector2]s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index 8d24d559984..e2599b96950 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -56,7 +56,7 @@ - + The locale of the translation. diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 70e85b187fc..416a9eb6568 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -218,25 +218,25 @@ - + If [code]true[/code], the currently selected cell may be selected again. - + If [code]true[/code], a right mouse button click can select items. - + The number of columns. - + The drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. Once dropping is done, reverts to [constant DROP_MODE_DISABLED]. Setting this during [method Control.can_drop_data] is recommended. - + If [code]true[/code], the folding arrow is hidden. - + If [code]true[/code], the tree's root is hidden. - + Allows single or multiple selection. See the [code]SELECT_*[/code] constants. @@ -368,7 +368,7 @@ - + @@ -376,43 +376,43 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -420,9 +420,9 @@ - + - + @@ -436,7 +436,7 @@ - + diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index c6949e915f1..0f7a93e8d59 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -338,13 +338,13 @@ - - The tween's animation process thread. See [enum TweenProcessMode]. Default value: [constant TWEEN_PROCESS_IDLE]. + + The tween's animation process thread. See [enum TweenProcessMode]. - + The tween's speed multiplier. For example, set it to [code]1.0[/code] for normal speed, [code]2.0[/code] for two times normal speed, or [code]0.5[/code] for half of the normal speed. A value of [code]0[/code] pauses the animation, but see also [method set_active] or [method stop_all] for this. - + If [code]true[/code], the tween loops. diff --git a/doc/classes/VBoxContainer.xml b/doc/classes/VBoxContainer.xml index 1b4a6a6b62f..4709772615c 100644 --- a/doc/classes/VBoxContainer.xml +++ b/doc/classes/VBoxContainer.xml @@ -13,7 +13,7 @@ - + diff --git a/doc/classes/VSeparator.xml b/doc/classes/VSeparator.xml index b0f0bf038ef..e618c2b84b2 100644 --- a/doc/classes/VSeparator.xml +++ b/doc/classes/VSeparator.xml @@ -13,7 +13,7 @@ - + diff --git a/doc/classes/VSplitContainer.xml b/doc/classes/VSplitContainer.xml index 594b662feaf..da2a54dca0b 100644 --- a/doc/classes/VSplitContainer.xml +++ b/doc/classes/VSplitContainer.xml @@ -13,13 +13,13 @@ - + - + diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 073035131da..0c96c50c584 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -276,10 +276,10 @@ - + The vector's X component. Also accessible by using the index position [code][0][/code]. - + The vector's Y component. Also accessible by using the index position [code][1][/code]. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index ddb72f6d030..3e1083ab693 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -277,13 +277,13 @@ - + The vector's X component. Also accessible by using the index position [code][0][/code]. - + The vector's Y component. Also accessible by using the index position [code][1][/code]. - + The vector's Z component. Also accessible by using the index position [code][2][/code]. diff --git a/doc/classes/VehicleBody.xml b/doc/classes/VehicleBody.xml index 0858b1f4dd6..956144b54c5 100644 --- a/doc/classes/VehicleBody.xml +++ b/doc/classes/VehicleBody.xml @@ -12,15 +12,15 @@ - + Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the [member RigidBody.mass] of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. - + Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have [member VehicleWheel.use_as_traction] set to [code]true[/code] and are in contact with a surface. The [member RigidBody.mass] of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. [b]Note:[/b] The simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears. A negative value will result in the vehicle reversing. - + The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have [member VehicleWheel.use_as_steering] set to [code]true[/code] will automatically be rotated. diff --git a/doc/classes/VehicleWheel.xml b/doc/classes/VehicleWheel.xml index 4106ec2157f..6de64295314 100644 --- a/doc/classes/VehicleWheel.xml +++ b/doc/classes/VehicleWheel.xml @@ -31,38 +31,38 @@ - + The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car. - + The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5. - + The maximum force the spring can resist. This value should be higher than a quarter of the [member RigidBody.mass] of the [VehicleBody] or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3× to 4× this number. - + This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. - + This is the distance the suspension can travel. As Godot units are equivalent to meters, keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car. - + If [code]true[/code], this wheel will be turned when the car steers. - + If [code]true[/code], this wheel transfers engine force to the ground to propel the vehicle forward. - + This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear. It's best to set this to 1.0 when starting out. - + The radius of the wheel in meters. - + This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest. - + This value affects the roll of your vehicle. If set to 0.0 for all wheels, your vehicle will be prone to rolling over, while a value of 1.0 will resist body roll. diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index fcf7abd74f6..45341cee740 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -46,25 +46,25 @@ - + The embedded audio track to play. - - If [code]true[/code], playback starts when the scene loads. Default value: [code]false[/code]. + + If [code]true[/code], playback starts when the scene loads. - + Amount of time in milliseconds to store in buffer while playing. - + Audio bus to use for sound playback. - - If [code]true[/code], the video scales to the control size. Default value: [code]true[/code]. + + If [code]true[/code], the video scales to the control size. - + If [code]true[/code], the video is paused. - + The current position of the stream, in seconds. @@ -72,7 +72,7 @@ Audio volume as a linear value. - + Audio volume in dB. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 29f6e909bc7..a9ffd9f66d4 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -210,87 +210,87 @@ - - If [code]true[/code], the viewport will be used in AR/VR process. Default value: [code]false[/code]. + + If [code]true[/code], the viewport will be used in AR/VR process. - - If [code]true[/code], the viewport will process 2D audio streams. Default value: [code]false[/code]. + + If [code]true[/code], the viewport will process 2D audio streams. - - If [code]true[/code], the viewport will process 3D audio streams. Default value: [code]false[/code]. + + 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. - - The overlay mode for test rendered geometry in debug purposes. Default value: [constant DEBUG_DRAW_DISABLED]. + + The overlay mode for test rendered geometry in debug purposes. - - If [code]true[/code], the viewport will disable 3D rendering. For actual disabling use [code]usage[/code]. Default value: [code]false[/code]. + + 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. - - If [code]true[/code], the viewport will not receive input event. Default value: [code]false[/code]. + + If [code]true[/code], the viewport will not receive input event. - - If [code]true[/code], the GUI controls on the viewport will lay pixel perfectly. Default value: [code]true[/code]. + + If [code]true[/code], the GUI controls on the viewport will lay pixel perfectly. - + - - If [code]true[/code], the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: [code]true[/code]. + + If [code]true[/code], the viewport rendering will receive benefits from High Dynamic Range algorithm. - + If [code]true[/code], the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output. - - The multisample anti-aliasing mode. Default value: [constant MSAA_DISABLED]. + + The multisample anti-aliasing mode. - - If [code]true[/code], the viewport will use [World] defined in [code]world[/code] property. Default value: [code]false[/code]. + + If [code]true[/code], the viewport will use [World] defined in [code]world[/code] property. - - If [code]true[/code], the objects rendered by viewport become subjects of mouse picking process. Default value: [code]false[/code]. + + If [code]true[/code], the objects rendered by viewport become subjects of mouse picking process. - - If [code]true[/code], renders the Viewport directly to the screen instead of to the root viewport. Only available in GLES2. This is a low-level optimization and should not be used in most cases. If used, reading from the Viewport or from [code]SCREEN_TEXTURE[/code] becomes unavailable. For more information see [method VisualServer.viewport_set_render_direct_to_screen]. Default value: [code]false[/code]. + + If [code]true[/code], renders the Viewport directly to the screen instead of to the root viewport. Only available in GLES2. This is a low-level optimization and should not be used in most cases. If used, reading from the Viewport or from [code]SCREEN_TEXTURE[/code] becomes unavailable. For more information see [method VisualServer.viewport_set_render_direct_to_screen]. - - The clear mode when viewport used as a render target. Default value: [constant CLEAR_MODE_ALWAYS]. + + The clear mode when viewport used as a render target. - - The update mode when viewport used as a render target. Default value: [constant UPDATE_WHEN_VISIBLE]. + + The update mode when viewport used as a render target. - - If [code]true[/code], the result of rendering will be flipped vertically. Default value: [code]false[/code]. + + If [code]true[/code], the result of rendering will be flipped vertically. - - The subdivision amount of first quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_4[/code]. + + The subdivision amount of first quadrant on shadow atlas. - - The subdivision amount of second quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_4[/code]. + + The subdivision amount of second quadrant on shadow atlas. - - The subdivision amount of third quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_16[/code]. + + The subdivision amount of third quadrant on shadow atlas. - - The subdivision amount of fourth quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_64[/code]. + + The subdivision amount of fourth quadrant on shadow atlas. - + The resolution of shadow atlas. Both width and height is equal to one value. - + The width and height of viewport. - - If [code]true[/code], the viewport should render its background as transparent. Default value: [code]false[/code]. + + If [code]true[/code], the viewport should render its background as transparent. - - The rendering mode of viewport. Default value: [code]USAGE_3D[/code]. + + The rendering mode of viewport. - + The custom [World] which can be used as 3D environment source. diff --git a/doc/classes/ViewportContainer.xml b/doc/classes/ViewportContainer.xml index 543140544f2..e4c60919094 100644 --- a/doc/classes/ViewportContainer.xml +++ b/doc/classes/ViewportContainer.xml @@ -11,10 +11,10 @@ - - If [code]true[/code], the viewport will be scaled to the control's size. Default value: [code]false[/code]. + + If [code]true[/code], the viewport will be scaled to the control's size. - + diff --git a/doc/classes/ViewportTexture.xml b/doc/classes/ViewportTexture.xml index ab3c2696aa2..5b9eb6a8cbe 100644 --- a/doc/classes/ViewportTexture.xml +++ b/doc/classes/ViewportTexture.xml @@ -12,7 +12,7 @@ - + The path to the [Viewport] node to display. This is relative to the scene root, not to the node which uses the texture. diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 72d02ddd3d3..4acb4d87c11 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -11,10 +11,10 @@ - + If [code]true[/code], [RigidBody] nodes will be paused. - + If [code]true[/code], [AnimationPlayer] nodes will be paused. diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index d954a379ae8..dbea3f5de8f 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -11,22 +11,22 @@ - + If [code]true[/code], [RigidBody2D] nodes will be paused. - + If [code]true[/code], [AnimatedSprite] nodes will be paused. - + If [code]true[/code], [AnimationPlayer] nodes will be paused. - + If [code]true[/code], [Particles2D] nodes will be paused. - + If [code]true[/code], the parent's [method Node._physics_process] will be stopped. - + If [code]true[/code], the parent's [method Node._process] will be stopped. diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml index 136f2c2845b..4cbfa7ba763 100644 --- a/doc/classes/VisibilityNotifier.xml +++ b/doc/classes/VisibilityNotifier.xml @@ -19,7 +19,7 @@ - + The VisibilityNotifier's bounding box. diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml index b3387da72bd..7e1d933c440 100644 --- a/doc/classes/VisibilityNotifier2D.xml +++ b/doc/classes/VisibilityNotifier2D.xml @@ -19,7 +19,7 @@ - + The VisibilityNotifier2D's bounding rectangle. diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index ce8f729ce7f..7576bf7ad80 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -64,7 +64,7 @@ - + The render layer(s) this VisualInstance is drawn on. This object will only be visible for [Camera]s whose cull mask includes the render object this VisualInstance is set to. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 230b9280058..5e054ce7ce6 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -4008,7 +4008,7 @@ Texture is a video surface. - Default flags. [constant TEXTURE_FLAG_MIPMAPS], [constant TEXTURE_FLAG_REPEAT] and [constant TEXTURE_FLAG_FILTER] are are enabled. + Default flags. [constant TEXTURE_FLAG_MIPMAPS], [constant TEXTURE_FLAG_REPEAT] and [constant TEXTURE_FLAG_FILTER] are enabled. Shader is a 3D shader. diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index 0c9292930d8..4bd3de4fc8d 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -183,7 +183,7 @@ - + diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml index 4fa80d8c82b..19495a88599 100644 --- a/doc/classes/VisualShaderNode.xml +++ b/doc/classes/VisualShaderNode.xml @@ -27,9 +27,9 @@ - + - + diff --git a/doc/classes/VisualShaderNodeBooleanConstant.xml b/doc/classes/VisualShaderNodeBooleanConstant.xml index fd406db0536..b46905cfeae 100644 --- a/doc/classes/VisualShaderNodeBooleanConstant.xml +++ b/doc/classes/VisualShaderNodeBooleanConstant.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeColorConstant.xml b/doc/classes/VisualShaderNodeColorConstant.xml index d9a927e75d6..282966a9ca4 100644 --- a/doc/classes/VisualShaderNodeColorConstant.xml +++ b/doc/classes/VisualShaderNodeColorConstant.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeColorFunc.xml b/doc/classes/VisualShaderNodeColorFunc.xml index 23223587a5c..b37a669ee9f 100644 --- a/doc/classes/VisualShaderNodeColorFunc.xml +++ b/doc/classes/VisualShaderNodeColorFunc.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeColorOp.xml b/doc/classes/VisualShaderNodeColorOp.xml index b78efa2adc3..77c5361f4dc 100644 --- a/doc/classes/VisualShaderNodeColorOp.xml +++ b/doc/classes/VisualShaderNodeColorOp.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeCubeMap.xml b/doc/classes/VisualShaderNodeCubeMap.xml index 09f68a0e9a4..9a4cb5b17c4 100644 --- a/doc/classes/VisualShaderNodeCubeMap.xml +++ b/doc/classes/VisualShaderNodeCubeMap.xml @@ -9,9 +9,9 @@ - + - + diff --git a/doc/classes/VisualShaderNodeExpression.xml b/doc/classes/VisualShaderNodeExpression.xml index 8a5477280f1..ddb85d7e439 100644 --- a/doc/classes/VisualShaderNodeExpression.xml +++ b/doc/classes/VisualShaderNodeExpression.xml @@ -15,7 +15,7 @@ - + diff --git a/doc/classes/VisualShaderNodeInput.xml b/doc/classes/VisualShaderNodeInput.xml index 32398b85455..25fd2ec8d81 100644 --- a/doc/classes/VisualShaderNodeInput.xml +++ b/doc/classes/VisualShaderNodeInput.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeScalarConstant.xml b/doc/classes/VisualShaderNodeScalarConstant.xml index b18ac46fbde..0af09e74e3d 100644 --- a/doc/classes/VisualShaderNodeScalarConstant.xml +++ b/doc/classes/VisualShaderNodeScalarConstant.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeScalarDerivativeFunc.xml b/doc/classes/VisualShaderNodeScalarDerivativeFunc.xml index 6c3eb95b6f3..09e2d2fa725 100644 --- a/doc/classes/VisualShaderNodeScalarDerivativeFunc.xml +++ b/doc/classes/VisualShaderNodeScalarDerivativeFunc.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeScalarFunc.xml b/doc/classes/VisualShaderNodeScalarFunc.xml index b0ee422bbd9..ef52086d6e6 100644 --- a/doc/classes/VisualShaderNodeScalarFunc.xml +++ b/doc/classes/VisualShaderNodeScalarFunc.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeScalarOp.xml b/doc/classes/VisualShaderNodeScalarOp.xml index b2939a55eef..0aa692c2281 100644 --- a/doc/classes/VisualShaderNodeScalarOp.xml +++ b/doc/classes/VisualShaderNodeScalarOp.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeTexture.xml b/doc/classes/VisualShaderNodeTexture.xml index 7a73868c2bb..1f4d3b16d17 100644 --- a/doc/classes/VisualShaderNodeTexture.xml +++ b/doc/classes/VisualShaderNodeTexture.xml @@ -9,11 +9,11 @@ - + - + - + diff --git a/doc/classes/VisualShaderNodeTextureUniform.xml b/doc/classes/VisualShaderNodeTextureUniform.xml index 9312c24fe75..3d58ec88c55 100644 --- a/doc/classes/VisualShaderNodeTextureUniform.xml +++ b/doc/classes/VisualShaderNodeTextureUniform.xml @@ -9,9 +9,9 @@ - + - + diff --git a/doc/classes/VisualShaderNodeTransformConstant.xml b/doc/classes/VisualShaderNodeTransformConstant.xml index 5b4c046ce14..b184a3d337f 100644 --- a/doc/classes/VisualShaderNodeTransformConstant.xml +++ b/doc/classes/VisualShaderNodeTransformConstant.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeTransformFunc.xml b/doc/classes/VisualShaderNodeTransformFunc.xml index e74f4492129..7fb17b1a792 100644 --- a/doc/classes/VisualShaderNodeTransformFunc.xml +++ b/doc/classes/VisualShaderNodeTransformFunc.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeTransformMult.xml b/doc/classes/VisualShaderNodeTransformMult.xml index 6082434beb2..04060500251 100644 --- a/doc/classes/VisualShaderNodeTransformMult.xml +++ b/doc/classes/VisualShaderNodeTransformMult.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeTransformVecMult.xml b/doc/classes/VisualShaderNodeTransformVecMult.xml index 46d3be2dedd..881d0cf3cf2 100644 --- a/doc/classes/VisualShaderNodeTransformVecMult.xml +++ b/doc/classes/VisualShaderNodeTransformVecMult.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeUniform.xml b/doc/classes/VisualShaderNodeUniform.xml index 09371f91deb..6835a30baa2 100644 --- a/doc/classes/VisualShaderNodeUniform.xml +++ b/doc/classes/VisualShaderNodeUniform.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeVec3Constant.xml b/doc/classes/VisualShaderNodeVec3Constant.xml index 1ea7e8115ed..b17f56e1f8f 100644 --- a/doc/classes/VisualShaderNodeVec3Constant.xml +++ b/doc/classes/VisualShaderNodeVec3Constant.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeVectorDerivativeFunc.xml b/doc/classes/VisualShaderNodeVectorDerivativeFunc.xml index 678df0fe3b4..56f89ffc38f 100644 --- a/doc/classes/VisualShaderNodeVectorDerivativeFunc.xml +++ b/doc/classes/VisualShaderNodeVectorDerivativeFunc.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeVectorFunc.xml b/doc/classes/VisualShaderNodeVectorFunc.xml index e67cb2e07f0..3725a43395b 100644 --- a/doc/classes/VisualShaderNodeVectorFunc.xml +++ b/doc/classes/VisualShaderNodeVectorFunc.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/VisualShaderNodeVectorOp.xml b/doc/classes/VisualShaderNodeVectorOp.xml index cfcd16bbff8..0ec49a38459 100644 --- a/doc/classes/VisualShaderNodeVectorOp.xml +++ b/doc/classes/VisualShaderNodeVectorOp.xml @@ -9,7 +9,7 @@ - + diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml index c5d66af984e..595aaeeceea 100644 --- a/doc/classes/WindowDialog.xml +++ b/doc/classes/WindowDialog.xml @@ -18,10 +18,10 @@ - - If [code]true[/code], the user can resize the window. Default value: [code]false[/code]. + + If [code]true[/code], the user can resize the window. - + The text displayed in the window's title bar. @@ -30,21 +30,21 @@ - + - + - + - + - + diff --git a/doc/classes/World.xml b/doc/classes/World.xml index c8e6944b83e..adb3286c51b 100644 --- a/doc/classes/World.xml +++ b/doc/classes/World.xml @@ -15,10 +15,10 @@ The World's physics direct space state, used for making various queries. Might be used only during [code]_physics_process[/code]. - + The World's [Environment]. - + The World's fallback_environment will be used if the World's [Environment] fails or is missing. diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml index b4524bfea0d..a2a454d1b31 100644 --- a/doc/classes/WorldEnvironment.xml +++ b/doc/classes/WorldEnvironment.xml @@ -14,7 +14,7 @@ - + The [Environment] resource used by this [WorldEnvironment], defining the default properties. diff --git a/doc/classes/YSort.xml b/doc/classes/YSort.xml index b9f3fa914b4..6045a5713c6 100644 --- a/doc/classes/YSort.xml +++ b/doc/classes/YSort.xml @@ -12,8 +12,8 @@ - - If [code]true[/code], child nodes are sorted, otherwise sorting is disabled. Default: [code]true[/code]. + + If [code]true[/code], child nodes are sorted, otherwise sorting is disabled. diff --git a/modules/csg/doc_classes/CSGBox.xml b/modules/csg/doc_classes/CSGBox.xml index e5084684155..d100c01205d 100644 --- a/modules/csg/doc_classes/CSGBox.xml +++ b/modules/csg/doc_classes/CSGBox.xml @@ -11,16 +11,16 @@ - + Depth of the box measured from the center of the box. - + Height of the box measured from the center of the box. - + The material used to render the box. - + Width of the box measured from the center of the box. diff --git a/modules/csg/doc_classes/CSGCylinder.xml b/modules/csg/doc_classes/CSGCylinder.xml index 24c3f8ba2e0..643eb7c7f46 100644 --- a/modules/csg/doc_classes/CSGCylinder.xml +++ b/modules/csg/doc_classes/CSGCylinder.xml @@ -11,22 +11,22 @@ - + If [code]true[/code] a cone is created, the [member radius] will only apply to one side. - + The height of the cylinder. - + The material used to render the cylinder. - + The radius of the cylinder. - + The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder. - + If [code]true[/code] the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If [code]false[/code] the cylinder will have a flat shaded look. diff --git a/modules/csg/doc_classes/CSGMesh.xml b/modules/csg/doc_classes/CSGMesh.xml index afe0bc262d3..daa08decb6d 100644 --- a/modules/csg/doc_classes/CSGMesh.xml +++ b/modules/csg/doc_classes/CSGMesh.xml @@ -11,9 +11,9 @@ - + - + The mesh resource to use as a CSG shape. diff --git a/modules/csg/doc_classes/CSGPolygon.xml b/modules/csg/doc_classes/CSGPolygon.xml index 2c5d298222c..48f5d730cce 100644 --- a/modules/csg/doc_classes/CSGPolygon.xml +++ b/modules/csg/doc_classes/CSGPolygon.xml @@ -11,13 +11,13 @@ - + Extrusion depth when [member mode] is [constant MODE_DEPTH]. - + Material to use for the resulting mesh. - + Extrusion mode. @@ -38,10 +38,10 @@ The method by which each slice is rotated along the path when [member mode] is [constant MODE_PATH]. - + Point array that defines the shape that we'll extrude. - + Generates smooth normals so smooth shading is applied to our mesh. diff --git a/modules/csg/doc_classes/CSGPrimitive.xml b/modules/csg/doc_classes/CSGPrimitive.xml index 869e4006fe9..6c2f8376373 100644 --- a/modules/csg/doc_classes/CSGPrimitive.xml +++ b/modules/csg/doc_classes/CSGPrimitive.xml @@ -10,7 +10,7 @@ - + Invert the faces of the mesh. diff --git a/modules/csg/doc_classes/CSGShape.xml b/modules/csg/doc_classes/CSGShape.xml index 7fa7c78534c..91f54f8246b 100644 --- a/modules/csg/doc_classes/CSGShape.xml +++ b/modules/csg/doc_classes/CSGShape.xml @@ -64,23 +64,23 @@ - + Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child. - + The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - + The physics layers this CSG shape scans for collisions. - + The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. - + - + Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden. diff --git a/modules/csg/doc_classes/CSGSphere.xml b/modules/csg/doc_classes/CSGSphere.xml index 2a12cf84dbe..0a626441797 100644 --- a/modules/csg/doc_classes/CSGSphere.xml +++ b/modules/csg/doc_classes/CSGSphere.xml @@ -11,19 +11,19 @@ - + The material used to render the sphere. - + Number of vertical slices for the sphere. - + Radius of the sphere. - + Number of horizontal slices for the sphere. - + If [code]true[/code] the normals of the sphere are set to give a smooth effect making the sphere seem rounded. If [code]false[/code] the sphere will have a flat shaded look. diff --git a/modules/csg/doc_classes/CSGTorus.xml b/modules/csg/doc_classes/CSGTorus.xml index 0d4437d87f2..156fb185e7c 100644 --- a/modules/csg/doc_classes/CSGTorus.xml +++ b/modules/csg/doc_classes/CSGTorus.xml @@ -11,22 +11,22 @@ - + The inner radius of the torus. - + The material used to render the torus. - + The outer radius of the torus. - + The number of edges each ring of the torus is constructed of. - + The number of slices the torus is constructed of. - + If [code]true[/code] the normals of the torus are set to give a smooth effect making the torus seem rounded. If [code]false[/code] the torus will have a flat shaded look. diff --git a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml index 8a8511c0085..84ed5fd9eed 100644 --- a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml +++ b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml @@ -106,16 +106,16 @@ - + Enforce ordered packets when using [constant NetworkedMultiplayerPeer.TRANSFER_MODE_UNRELIABLE] (thus behaving similarly to [constant NetworkedMultiplayerPeer.TRANSFER_MODE_UNRELIABLE_ORDERED]). This is the only way to use ordering with the RPC system. - - The number of channels to be used by ENet. Default: [code]3[/code]. Channels are used to separate different kinds of data. In reliable or ordered mode, for example, the packet delivery order is ensured on a per channel basis. + + The number of channels to be used by ENet. Channels are used to separate different kinds of data. In reliable or ordered mode, for example, the packet delivery order is ensured on a per channel basis. - - 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. Default value: [constant COMPRESS_NONE]. + + 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. - + Set the default channel to be used to transfer data. By default, this value is [code]-1[/code] which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel [code]0[/code] is reserved, and cannot be used. Setting this member to any value between [code]0[/code] and [member channel_count] (excluded) will force ENet to use that channel for sending data. diff --git a/modules/gdnative/doc_classes/GDNative.xml b/modules/gdnative/doc_classes/GDNative.xml index 8750ddc56d9..95ed1fc0482 100644 --- a/modules/gdnative/doc_classes/GDNative.xml +++ b/modules/gdnative/doc_classes/GDNative.xml @@ -33,7 +33,7 @@ - + diff --git a/modules/gdnative/doc_classes/GDNativeLibrary.xml b/modules/gdnative/doc_classes/GDNativeLibrary.xml index 8bfd386b8df..7e1cac243a2 100644 --- a/modules/gdnative/doc_classes/GDNativeLibrary.xml +++ b/modules/gdnative/doc_classes/GDNativeLibrary.xml @@ -23,13 +23,13 @@ - + - + - + - + diff --git a/modules/gdnative/doc_classes/NativeScript.xml b/modules/gdnative/doc_classes/NativeScript.xml index ac8b793b223..460471386d3 100644 --- a/modules/gdnative/doc_classes/NativeScript.xml +++ b/modules/gdnative/doc_classes/NativeScript.xml @@ -51,13 +51,13 @@ - + - + - + - + diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index 951a49e0c1f..325432579f8 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -189,28 +189,28 @@ - + If [code]true[/code], grid items are centered on the X axis. - + If [code]true[/code], grid items are centered on the Y axis. - + If [code]true[/code], grid items are centered on the Z axis. - + The size of each octant measured in number of cells. This applies to all three axis. - + - + The dimensions of the grid's cells. - + - + - + The assigned [MeshLibrary]. diff --git a/modules/mobile_vr/doc_classes/MobileVRInterface.xml b/modules/mobile_vr/doc_classes/MobileVRInterface.xml index 8cd63b304af..a132333a87f 100644 --- a/modules/mobile_vr/doc_classes/MobileVRInterface.xml +++ b/modules/mobile_vr/doc_classes/MobileVRInterface.xml @@ -18,25 +18,25 @@ - + The distance between the display and the lenses inside of the device in centimeters. - + The width of the display in centimeters. - + The height at which the camera is placed in relation to the ground (i.e. [ARVROrigin] node). - + The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye. - + The k1 lens factor is one of the two constants that define the strength of the lens used and directly influences the lens distortion effect. - + The k2 lens factor, see k1. - + The oversample setting. Because of the lens distortion we have to render our buffers at a higher resolution then the screen can natively handle. A value between 1.5 and 2.0 often provides good results but at the cost of performance. diff --git a/modules/opensimplex/doc_classes/NoiseTexture.xml b/modules/opensimplex/doc_classes/NoiseTexture.xml index c789724fc46..4826b6cd2ae 100644 --- a/modules/opensimplex/doc_classes/NoiseTexture.xml +++ b/modules/opensimplex/doc_classes/NoiseTexture.xml @@ -12,21 +12,21 @@ - + If [code]true[/code], the resulting texture contains a normal map created from the original noise interpreted as a bump map. - + - + Height of the generated texture. - + The [OpenSimplexNoise] instance used to generate the noise. - + Whether the texture can be tiled without visible seams or not. Seamless textures take longer to generate. - + Width of the generated texture. diff --git a/modules/opensimplex/doc_classes/OpenSimplexNoise.xml b/modules/opensimplex/doc_classes/OpenSimplexNoise.xml index 86acd4eaeaa..f3fbbab3da6 100644 --- a/modules/opensimplex/doc_classes/OpenSimplexNoise.xml +++ b/modules/opensimplex/doc_classes/OpenSimplexNoise.xml @@ -113,19 +113,19 @@ - + Difference in period between [member octaves]. - + Number of OpenSimplex noise layers that are sampled to get the fractal noise. - + Period of the base octave. A lower period results in a higher-frequency noise (more value changes across the same distance). - + Contribution factor of the different octaves. A [code]persistence[/code] value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one. - + Seed used to generate random values, different seeds will generate different noise maps. diff --git a/modules/regex/doc_classes/RegExMatch.xml b/modules/regex/doc_classes/RegExMatch.xml index 398d2ee3b66..e279607d13d 100644 --- a/modules/regex/doc_classes/RegExMatch.xml +++ b/modules/regex/doc_classes/RegExMatch.xml @@ -48,13 +48,15 @@ - + A dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one. - + An [Array] of the match and its capturing groups. - + The source string used with the search pattern to find this matching result. diff --git a/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml b/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml index 388c5e81edd..94031993987 100644 --- a/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml +++ b/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml @@ -11,12 +11,12 @@ - + Contains the audio data in bytes. - + - + diff --git a/modules/upnp/doc_classes/UPNP.xml b/modules/upnp/doc_classes/UPNP.xml index d3eb21e1595..aac0932995d 100644 --- a/modules/upnp/doc_classes/UPNP.xml +++ b/modules/upnp/doc_classes/UPNP.xml @@ -134,13 +134,13 @@ - + If [code]true[/code], IPv6 is used for [UPNPDevice] discovery. - + If [code]0[/code], the local port to use for discovery is chosen automatically by the system. If [code]1[/code], discovery will be done from the source port 1900 (same as destination port). Otherwise, the value will be used as the port. - + Multicast interface to use for discovery. Uses the default multicast interface if empty. diff --git a/modules/upnp/doc_classes/UPNPDevice.xml b/modules/upnp/doc_classes/UPNPDevice.xml index 1d9a7283653..4d3a0f4f1d5 100644 --- a/modules/upnp/doc_classes/UPNPDevice.xml +++ b/modules/upnp/doc_classes/UPNPDevice.xml @@ -53,22 +53,22 @@ - + URL to the device description. - + IDG control URL. - + Address of the local machine in the network connecting it to this [UPNPDevice]. - + IGD service type. - + IGD status. See [enum IGDStatus]. - + Service type. diff --git a/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml b/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml index b591dc9a516..6dc54dbc03a 100644 --- a/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml +++ b/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml @@ -11,7 +11,7 @@ - + The type to get the constant from. diff --git a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml index 7add0bc2ba0..470a3a5e35e 100644 --- a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml +++ b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml @@ -12,7 +12,7 @@ - + The function to be executed. diff --git a/modules/visual_script/doc_classes/VisualScriptClassConstant.xml b/modules/visual_script/doc_classes/VisualScriptClassConstant.xml index 7d83cd0203e..49ea7850ef5 100644 --- a/modules/visual_script/doc_classes/VisualScriptClassConstant.xml +++ b/modules/visual_script/doc_classes/VisualScriptClassConstant.xml @@ -15,10 +15,10 @@ - + The constant's parent class. - + The constant to return. See the given class for its available constants. diff --git a/modules/visual_script/doc_classes/VisualScriptComment.xml b/modules/visual_script/doc_classes/VisualScriptComment.xml index 96526546109..2538bc83561 100644 --- a/modules/visual_script/doc_classes/VisualScriptComment.xml +++ b/modules/visual_script/doc_classes/VisualScriptComment.xml @@ -12,13 +12,13 @@ - + The text inside the comment node. - + The comment node's size (in pixels). - + The comment node's title. diff --git a/modules/visual_script/doc_classes/VisualScriptConstant.xml b/modules/visual_script/doc_classes/VisualScriptConstant.xml index b15af8e4ea1..eb12fc37316 100644 --- a/modules/visual_script/doc_classes/VisualScriptConstant.xml +++ b/modules/visual_script/doc_classes/VisualScriptConstant.xml @@ -15,7 +15,7 @@ - + The constant's type. diff --git a/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml b/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml index a0eed5b7539..c8543287b42 100644 --- a/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml +++ b/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml @@ -11,7 +11,7 @@ - + The type to deconstruct. diff --git a/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml b/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml index 623aa1ba860..1a567905a90 100644 --- a/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml +++ b/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml @@ -15,7 +15,7 @@ - + The signal to emit. diff --git a/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml b/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml index 525389366ac..05bd87ec229 100644 --- a/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml +++ b/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml @@ -11,7 +11,7 @@ - + The singleton's name. diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml b/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml index e4d0bb7672e..f7f86e8c802 100644 --- a/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml +++ b/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml @@ -11,23 +11,23 @@ - + - + - + - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml b/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml index 4099a351e6d..6c70dc7dc47 100644 --- a/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml +++ b/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml @@ -9,7 +9,7 @@ - + diff --git a/modules/visual_script/doc_classes/VisualScriptInputAction.xml b/modules/visual_script/doc_classes/VisualScriptInputAction.xml index 4bd1430cf6e..8c942813b21 100644 --- a/modules/visual_script/doc_classes/VisualScriptInputAction.xml +++ b/modules/visual_script/doc_classes/VisualScriptInputAction.xml @@ -9,9 +9,9 @@ - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptLocalVar.xml b/modules/visual_script/doc_classes/VisualScriptLocalVar.xml index 5d061ea79f7..8c21c3f0bcf 100644 --- a/modules/visual_script/doc_classes/VisualScriptLocalVar.xml +++ b/modules/visual_script/doc_classes/VisualScriptLocalVar.xml @@ -15,10 +15,10 @@ - + The local variable's type. - + The local variable's name. diff --git a/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml b/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml index 049195d890c..a981432cdb5 100644 --- a/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml +++ b/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml @@ -17,10 +17,10 @@ - + The local variable's type. - + The local variable's name. diff --git a/modules/visual_script/doc_classes/VisualScriptMathConstant.xml b/modules/visual_script/doc_classes/VisualScriptMathConstant.xml index fb4e423f0e0..3be392aef59 100644 --- a/modules/visual_script/doc_classes/VisualScriptMathConstant.xml +++ b/modules/visual_script/doc_classes/VisualScriptMathConstant.xml @@ -15,7 +15,7 @@ - + The math constant. diff --git a/modules/visual_script/doc_classes/VisualScriptOperator.xml b/modules/visual_script/doc_classes/VisualScriptOperator.xml index a0827972e00..80449ac521e 100644 --- a/modules/visual_script/doc_classes/VisualScriptOperator.xml +++ b/modules/visual_script/doc_classes/VisualScriptOperator.xml @@ -14,9 +14,9 @@ - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptPreload.xml b/modules/visual_script/doc_classes/VisualScriptPreload.xml index b3b39691c9b..05ed0ad1e58 100644 --- a/modules/visual_script/doc_classes/VisualScriptPreload.xml +++ b/modules/visual_script/doc_classes/VisualScriptPreload.xml @@ -15,7 +15,7 @@ - + The [Resource] to load. diff --git a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml index 697a31ca466..af1e8e68e8d 100644 --- a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml +++ b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml @@ -11,7 +11,7 @@ - + @@ -19,9 +19,9 @@ - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptPropertySet.xml b/modules/visual_script/doc_classes/VisualScriptPropertySet.xml index c41e3781d47..380c196cafe 100644 --- a/modules/visual_script/doc_classes/VisualScriptPropertySet.xml +++ b/modules/visual_script/doc_classes/VisualScriptPropertySet.xml @@ -9,11 +9,11 @@ - + - + @@ -21,9 +21,9 @@ - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptResourcePath.xml b/modules/visual_script/doc_classes/VisualScriptResourcePath.xml index 40862b810b7..da37bbbb2c2 100644 --- a/modules/visual_script/doc_classes/VisualScriptResourcePath.xml +++ b/modules/visual_script/doc_classes/VisualScriptResourcePath.xml @@ -9,7 +9,7 @@ - + diff --git a/modules/visual_script/doc_classes/VisualScriptReturn.xml b/modules/visual_script/doc_classes/VisualScriptReturn.xml index 40c8963efe2..9a81c671d4f 100644 --- a/modules/visual_script/doc_classes/VisualScriptReturn.xml +++ b/modules/visual_script/doc_classes/VisualScriptReturn.xml @@ -16,10 +16,10 @@ - + If [code]true[/code], the [code]return[/code] input port is available. - + The return value's data type. diff --git a/modules/visual_script/doc_classes/VisualScriptSceneNode.xml b/modules/visual_script/doc_classes/VisualScriptSceneNode.xml index 81ef4ceedc1..99f4acbd27c 100644 --- a/modules/visual_script/doc_classes/VisualScriptSceneNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptSceneNode.xml @@ -15,7 +15,7 @@ - + The node's path in the scene tree. diff --git a/modules/visual_script/doc_classes/VisualScriptSelect.xml b/modules/visual_script/doc_classes/VisualScriptSelect.xml index 3b1e7f7f028..e6a6cd5a48a 100644 --- a/modules/visual_script/doc_classes/VisualScriptSelect.xml +++ b/modules/visual_script/doc_classes/VisualScriptSelect.xml @@ -17,7 +17,7 @@ - + The input variables' type. diff --git a/modules/visual_script/doc_classes/VisualScriptSequence.xml b/modules/visual_script/doc_classes/VisualScriptSequence.xml index 26af15b404a..2ceceb199fb 100644 --- a/modules/visual_script/doc_classes/VisualScriptSequence.xml +++ b/modules/visual_script/doc_classes/VisualScriptSequence.xml @@ -17,7 +17,7 @@ - + The number of steps in the sequence. diff --git a/modules/visual_script/doc_classes/VisualScriptTypeCast.xml b/modules/visual_script/doc_classes/VisualScriptTypeCast.xml index a9e920bca66..999a190a9ad 100644 --- a/modules/visual_script/doc_classes/VisualScriptTypeCast.xml +++ b/modules/visual_script/doc_classes/VisualScriptTypeCast.xml @@ -9,9 +9,9 @@ - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptVariableGet.xml b/modules/visual_script/doc_classes/VisualScriptVariableGet.xml index e1c7c4e4d4c..40e461294bd 100644 --- a/modules/visual_script/doc_classes/VisualScriptVariableGet.xml +++ b/modules/visual_script/doc_classes/VisualScriptVariableGet.xml @@ -15,7 +15,7 @@ - + The variable's name. diff --git a/modules/visual_script/doc_classes/VisualScriptVariableSet.xml b/modules/visual_script/doc_classes/VisualScriptVariableSet.xml index 73394829085..6c53ad61b48 100644 --- a/modules/visual_script/doc_classes/VisualScriptVariableSet.xml +++ b/modules/visual_script/doc_classes/VisualScriptVariableSet.xml @@ -16,7 +16,7 @@ - + The variable's name. diff --git a/modules/visual_script/doc_classes/VisualScriptYield.xml b/modules/visual_script/doc_classes/VisualScriptYield.xml index 9f61a5f88c2..c506e6db01f 100644 --- a/modules/visual_script/doc_classes/VisualScriptYield.xml +++ b/modules/visual_script/doc_classes/VisualScriptYield.xml @@ -9,7 +9,7 @@ - + diff --git a/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml b/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml index 67913751824..b9d7aedaab2 100644 --- a/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml +++ b/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml @@ -9,13 +9,13 @@ - + - + - + diff --git a/modules/webrtc/doc_classes/WebRTCDataChannel.xml b/modules/webrtc/doc_classes/WebRTCDataChannel.xml index 6d600f62397..98715ee99b6 100644 --- a/modules/webrtc/doc_classes/WebRTCDataChannel.xml +++ b/modules/webrtc/doc_classes/WebRTCDataChannel.xml @@ -89,7 +89,7 @@ - + The transfer mode to use when sending outgoing packet. Either text or binary. diff --git a/scene/2d/cpu_particles_2d.cpp b/scene/2d/cpu_particles_2d.cpp index faa0a08d108..75315bfc6ee 100644 --- a/scene/2d/cpu_particles_2d.cpp +++ b/scene/2d/cpu_particles_2d.cpp @@ -1410,7 +1410,7 @@ CPUParticles2D::CPUParticles2D() { set_emission_sphere_radius(1); set_emission_rect_extents(Vector2(1, 1)); - set_gravity(Vector2(0, 98.8)); + set_gravity(Vector2(0, 98)); for (int i = 0; i < PARAM_MAX; i++) { set_param_randomness(Parameter(i), 0); diff --git a/scene/2d/line_2d.cpp b/scene/2d/line_2d.cpp index 4488dc501cb..1c8245d1596 100644 --- a/scene/2d/line_2d.cpp +++ b/scene/2d/line_2d.cpp @@ -44,6 +44,7 @@ Line2D::Line2D() { _end_cap_mode = LINE_CAP_NONE; _width = 10; _default_color = Color(0.4, 0.5, 1); + _texture_mode = LINE_TEXTURE_NONE; _sharp_limit = 2.f; _round_precision = 8; } diff --git a/scene/2d/tile_map.cpp b/scene/2d/tile_map.cpp index bf59fa0ba8b..fc53c9e4ace 100644 --- a/scene/2d/tile_map.cpp +++ b/scene/2d/tile_map.cpp @@ -1829,6 +1829,7 @@ TileMap::TileMap() { half_offset = HALF_OFFSET_DISABLED; use_parent = false; collision_parent = NULL; + use_kinematic = false; navigation = NULL; y_sort_mode = false; occluder_light_mask = 1;