From ad79c703008394a360eb9875196a9414e1c84585 Mon Sep 17 00:00:00 2001 From: Bojidar Marinov Date: Fri, 12 Jan 2018 00:38:35 +0200 Subject: Update docs [ci skip] --- doc/classes/@GlobalScope.xml | 5 +- doc/classes/Animation.xml | 59 ++---- doc/classes/AnimationPlayer.xml | 96 ++-------- doc/classes/ArrayMesh.xml | 34 +--- doc/classes/AudioEffectReverb.xml | 14 -- doc/classes/AudioStreamSample.xml | 14 -- doc/classes/BakedLightmapData.xml | 64 +------ doc/classes/BoneAttachment.xml | 21 +- doc/classes/Camera2D.xml | 57 +----- doc/classes/CanvasLayer.xml | 59 +----- doc/classes/ColorPicker.xml | 59 ++---- doc/classes/Control.xml | 57 +----- doc/classes/CubeMap.xml | 19 +- doc/classes/Engine.xml | 78 ++------ doc/classes/File.xml | 23 +-- doc/classes/FileDialog.xml | 57 +----- doc/classes/GIProbeData.xml | 178 +++-------------- doc/classes/GraphEdit.xml | 92 ++------- doc/classes/GraphNode.xml | 67 +------ doc/classes/HTTPClient.xml | 40 +--- doc/classes/HTTPRequest.xml | 19 +- doc/classes/ImageTexture.xml | 40 +--- doc/classes/ItemList.xml | 16 +- doc/classes/Label.xml | 19 +- doc/classes/LineEdit.xml | 19 +- doc/classes/NetworkedMultiplayerPeer.xml | 33 +--- doc/classes/Node.xml | 58 +----- doc/classes/Node2D.xml | 17 +- doc/classes/OS.xml | 263 ++++---------------------- doc/classes/PacketPeer.xml | 18 +- doc/classes/PacketPeerStream.xml | 46 +---- doc/classes/PathFollow.xml | 140 +++----------- doc/classes/PathFollow2D.xml | 142 +++----------- doc/classes/Physics2DDirectBodyState.xml | 138 ++++---------- doc/classes/Physics2DShapeQueryParameters.xml | 116 ++---------- doc/classes/Physics2DTestMotionResult.xml | 74 ++------ doc/classes/PhysicsDirectBodyState.xml | 140 ++++---------- doc/classes/PhysicsShapeQueryParameters.xml | 82 ++------ doc/classes/Polygon2D.xml | 19 +- doc/classes/PopupMenu.xml | 16 +- doc/classes/ProximityGroup.xml | 24 +-- doc/classes/Range.xml | 19 +- doc/classes/RichTextLabel.xml | 115 ++--------- doc/classes/RigidBody2D.xml | 57 +----- doc/classes/SceneTree.xml | 136 +++---------- doc/classes/SceneTreeTimer.xml | 18 +- doc/classes/Script.xml | 21 +- doc/classes/ScrollContainer.xml | 44 +---- doc/classes/Shader.xml | 18 +- doc/classes/ShaderMaterial.xml | 18 +- doc/classes/Spatial.xml | 19 +- doc/classes/SpatialVelocityTracker.xml | 18 +- doc/classes/StreamPeer.xml | 21 +- doc/classes/StreamPeerBuffer.xml | 18 +- doc/classes/StyleBoxLine.xml | 16 +- doc/classes/Tabs.xml | 16 +- doc/classes/TextEdit.xml | 21 +- doc/classes/Texture.xml | 27 +-- doc/classes/Timer.xml | 29 +-- doc/classes/Tree.xml | 122 +++--------- doc/classes/TreeItem.xml | 59 ++---- doc/classes/Tween.xml | 38 +--- doc/classes/VideoPlayer.xml | 57 +----- doc/classes/Viewport.xml | 55 +----- doc/classes/World.xml | 31 +-- doc/classes/World2D.xml | 32 ++-- 66 files changed, 652 insertions(+), 2905 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 6e8b760966..41adeac06a 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -29,9 +29,6 @@ [Geometry] singleton - - [GodotSharp] singleton - [IP] singleton @@ -1285,7 +1282,7 @@ - + Flag for normal method diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index f78b39eadb..4955701792 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -50,20 +50,6 @@ Return the index of the specified track. If the track is not found, return -1. - - - - - Return the total length of the animation (in seconds). - - - - - - - Get the animation step value. - - @@ -71,13 +57,6 @@ Return the amount of tracks in the animation. - - - - - Return whether the animation has the loop flag set. - - @@ -122,33 +101,6 @@ Remove a track by specifying the track index. - - - - - - - Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. - - - - - - - - - Set 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. - - - - - - - - - Set the animation step value. - - @@ -456,6 +408,17 @@ + + + The total length of the animation (in seconds). Note that 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. + + Value tracks set values in node properties, but only those which can be Interpolated. diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index a244788020..ee7e795389 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -90,13 +90,6 @@ Returns the list of stored animation names. - - - - - Returns the name of the animation that will be automatically played when the scene is loaded. - - @@ -108,34 +101,6 @@ Get the blend time (in seconds) between two animations, referenced by their names. - - - - - Returns the name of the animation being played. - - - - - - - Get the length (in seconds) of the currently being played animation. - - - - - - - Get the position (in seconds) of the currently playing animation. - - - - - - - Returns the speed scaling ratio of the current animation channel. 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. - - @@ -145,13 +110,6 @@ Returns [code]true[/code] if the [code]AnimationPlayer[/code] stores an [Animation] with key [code]name[/code]. - - - - - Returns [code]true[/code] if the player is active. - - @@ -226,24 +184,6 @@ Seek the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. - - - - - - - Sets the player as active (playing). If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code]. - - - - - - - - - Defines the name of the animation to play when the scene loads. Default value: [code]""[/code]. - - @@ -257,24 +197,6 @@ Specify a blend time (in seconds) between two animations, referenced by their names. - - - - - - - Sets the name of the current animation. If already playing, restarts the animation. Ensure [member active] is [code]true[/code] to simulate [method play]. Default value: [code]""[/code]. - - - - - - - - - Sets the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: [code]1[/code]. - - @@ -286,12 +208,30 @@ + + The name of the animation to play when the scene loads. 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]. Default value: [code]""[/code]. + + + The length (in seconds) of the currently being played animation. + + + The position (in seconds) of the currently playing animation. + + + If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code]. + The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: [code]0[/code]. The process notification in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. + + 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 node from which node path references will travel. Default value: [code]".."[/code]. diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 92c4fe2fe7..2f1c0b92fd 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -51,12 +51,6 @@ - - - - - - @@ -65,12 +59,6 @@ - - - - - - @@ -84,22 +72,6 @@ - - - - - - - - - - - - - - - - @@ -212,6 +184,12 @@ + + + + + + Default value used for index_array_len when no indices are present. diff --git a/doc/classes/AudioEffectReverb.xml b/doc/classes/AudioEffectReverb.xml index 13bc66f6f3..037f4778a5 100644 --- a/doc/classes/AudioEffectReverb.xml +++ b/doc/classes/AudioEffectReverb.xml @@ -12,20 +12,6 @@ - - - - - - - - - - - - - - diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 83e9729bc1..c3c218b1d7 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -11,20 +11,6 @@ - - - - - - - - - - - - - - diff --git a/doc/classes/BakedLightmapData.xml b/doc/classes/BakedLightmapData.xml index 2b95cff136..5d23bf876a 100644 --- a/doc/classes/BakedLightmapData.xml +++ b/doc/classes/BakedLightmapData.xml @@ -27,30 +27,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - @@ -73,42 +49,18 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + diff --git a/doc/classes/BoneAttachment.xml b/doc/classes/BoneAttachment.xml index b7f21ebf0c..6af47b940f 100644 --- a/doc/classes/BoneAttachment.xml +++ b/doc/classes/BoneAttachment.xml @@ -11,23 +11,12 @@ - - - - - Returns the name of the bone node attached to. - - - - - - - - - Changes the name of the bone node - - + + + The name of the attached bone. + + diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index c95691d07f..72f6513e66 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -47,27 +47,6 @@ Returns the location of the [code]Camera2D[/code]'s screen-center, relative to the origin. - - - - - Returns the [Viewport] used by the camera if it is not using the default viewport. - - - - - - - Returns the horizontal offset of the camera. - - - - - - - Returns the vertical offset of the camera. - - @@ -83,33 +62,6 @@ This has no effect if smoothing is disabled. - - - - - - - Assigns a custom [Viewport] node to the [code]Camera2D[/code]. If [code]viewport[/code] is not a [Viewport], it re-assigns the default viewport instead. - - - - - - - - - The camera's horizontal offset is set to [code]ofs[/code]. - - - - - - - - - The camera's vertical offset is set to [code]ofs[/code]. - - @@ -118,6 +70,9 @@ 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 [code]Camera2D[/code]. If null 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. @@ -163,6 +118,12 @@ 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 vertical offset of the camera, relative to the drag margins. Default value: [code]0[/code] + If [code]true[/code] the camera rotates with the target. Default value: [code]false[/code] diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 01c2dd6ba9..bccbf69cdf 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -11,27 +11,6 @@ - - - - - Returns the [Viewport] used by the camera if it is not using the default viewport. - - - - - - - Return the base rotation for this layer in radians (helper). - - - - - - - Return the base transform for this layer. - - @@ -39,47 +18,29 @@ Return the [World2D] used by this layer. - - - - - - - Assigns a custom [Viewport] node to the [code]CanvasLayer[/code]. If [code]viewport[/code] is not a [Viewport], it re-assigns the default viewport instead. - - - - - - - - - Set the base rotation for this layer in radians (helper). - - - - - - - - - Set the base transform for this layer. - - + + The custom [Viewport] node assigned to the [code]CanvasLayer[/code]. If null, uses the default viewport instead. + Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code]. 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/ColorPicker.xml b/doc/classes/ColorPicker.xml index 192f139ba9..1896fd46fb 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -20,55 +20,18 @@ Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. - - - - - Gets the current color. - - - - - - - Returns whether the color has transparency or not. - - - - - - - Returns whether this color picker is in raw mode or not, raw mode will allow the color R, G, B component values to go beyond 1, you have to consider that the max value for color components is 1, going beyond that value will not have effect in the color, but can be used for special operations that require it (like tinting without darkening or rendering sprites in HDR). - - - - - - - - - Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color. - - - - - - - - - Select the current color. - - - - - - - - - Set whether this color picker is using raw mode or not, see [method is_raw_mode]. - - + + + The currently selected color. + + + If [code]true[/code], shows an alpha channel slider (transparency). + + + 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). + + diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 214f78afab..87ed5df500 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -178,13 +178,6 @@ Returns the mouse cursor shape the control displays on mouse hover, one of the [code]CURSOR_*[/code] constants. - - - - - Returns the default cursor shape for this control. See enum [code]CURSOR_*[/code] for the list of shapes. - - @@ -200,13 +193,6 @@ Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). - - - - - Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]). - - @@ -224,13 +210,6 @@ - - - - - Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. - - @@ -490,15 +469,6 @@ Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). - - - - - - - Sets the default cursor shape for this control. See [code]CURSOR_*[/code] for the list of available cursor shapes. Useful for Godot plugins and applications or games that use the system's mouse cursors. - - @@ -524,24 +494,6 @@ Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]). - - - - - - - Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals. - - - - - - - - - Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]). - - @@ -594,6 +546,9 @@ Anchors the top edge of the node to the origin, the center or the end of its parent container. It changes how the top margin updates when the node moves or changes size. Use one of the [code]ANCHOR_*[/code] constants. Default value: [code]ANCHOR_BEGIN[/code]. + + 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 Tab, the down arrow on the keyboard, or down on a gamepad. The node must be a [code]Control[/code]. If this property is not set, Godot will give focus to the closest [code]Control[/code] to the bottom of this one. If the user presses Tab, Godot will give focus to the closest node to the right first, then to the bottom. If the user presses Shift+Tab, Godot will look to the left of the node, then above it. @@ -631,11 +586,17 @@ Distance between the node's top edge and its parent container, based on [member anchor_top]. + + The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors. + Controls whether the control will be able to receive mouse button input events through [method _gui_input] and how these events should be handled. Use one of the [code]MOUSE_FILTER_*[/code] constants. See the constants to learn what each does. + + 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. diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml index 30022efd38..7639f6d409 100644 --- a/doc/classes/CubeMap.xml +++ b/doc/classes/CubeMap.xml @@ -11,13 +11,6 @@ - - - - - Returns the render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details. - - @@ -41,15 +34,6 @@ Returns the [code]CubeMap[/code]'s width. - - - - - - - Returns the render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details. - - @@ -63,6 +47,9 @@ + + The render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details. + The lossy storage quality of the [code]CubeMap[/code] if the storage mode is set to STORAGE_COMPRESS_LOSSY. diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 0fd5892860..400ec83ecc 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -25,13 +25,6 @@ Returns the frames per second of the running game. - - - - - Returns the number of fixed iterations per second (for fixed process and physics). - - @@ -47,20 +40,6 @@ - - - - - Returns the desired frames per second. If the hardware cannot keep up, this setting may not be respected. It defaults to 0, which indicates no limit. - - - - - - - Returns 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. - - @@ -83,13 +62,6 @@ - - - - - Returns [code]true[/code] if the editor is running. - - @@ -97,43 +69,21 @@ Returns [code]true[/code] if the game is inside the fixed process and physics phase of the game loop. - - - - - - - Sets the running inside the editor hint if [code]enabled[/code] is [code]true[/code]. - - - - - - - - - Sets the number of fixed iterations per second (for fixed process and physics). - - - - - - - - - Sets the target frames per second. - - - - - - - - - Sets the time scale. - - + + + 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. + + + 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/File.xml b/doc/classes/File.xml index 8c270ece4b..20ea064a18 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -109,13 +109,6 @@ Returns the next 64 bits from the file as a floating point number. - - - - - Returns [code]true[/code] if endian swap is enabled for this file. - - @@ -274,16 +267,6 @@ Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file. - - - - - - - If [code]true[/code] the file's endianness is swapped. Use this if you're dealing with files written in big endian machines. - Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file. - - @@ -393,6 +376,12 @@ + + + If [code]true[/code] the file's endianness is swapped. Use this if you're dealing with files written in big endian machines. + Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file. + + Opens the file for read operations. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 3387b4a2ed..d064ae908f 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -33,27 +33,6 @@ - - - - - Get the current working directory of the file dialog. - - - - - - - Get the current selected file of the file dialog (empty if none). - - - - - - - Get the current selected path (directory and file) of the file dialog (empty if none). - - @@ -68,37 +47,19 @@ Invalidate and update the current dialog content list. - - - - - - - Set the current working directory of the file dialog. - - - - - - - - - Set the current selected file name of the file dialog. - - - - - - - - - Set the current selected file path of the file dialog. - - + + 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. + diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml index aba59f57ea..2ac591889c 100644 --- a/doc/classes/GIProbeData.xml +++ b/doc/classes/GIProbeData.xml @@ -9,161 +9,31 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 3bc7fed1d9..d7a263bd3f 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -49,26 +49,6 @@ Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } - - - - - Return the scroll offset. - - - - - - - - - - - - - Return the current zoom value. - - @@ -84,36 +64,6 @@ Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. - - - - - Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise. - - - - - - - - - - - - - - - Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. - - - - - - - - - - @@ -122,32 +72,24 @@ - - - - - - - - - - - - - - - - - - - - - - - Set the zoom value of the GraphEdit. Zoom value is between [0.01; 1.728]. - - + + + 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. + + diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index c1b18e4cd8..9a8b56f8a1 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -95,19 +95,6 @@ Return the type of the output connection 'idx'. - - - - - Return the offset of the GraphNode. - - - - - - - - @@ -144,18 +131,6 @@ Return the (integer) type of right (output) 'idx' slot. - - - - - - - - - - - - @@ -174,39 +149,6 @@ Return true if right (output) slot 'idx' is enabled. False otherwise. - - - - - - - - - - - - - - - Set the offset of the GraphNode. - - - - - - - - - - - - - - - - - - @@ -233,8 +175,17 @@ + + + + The offset of the GraphNode, relative to the scroll offset of the [GraphEdit]. Note that you cannot use position directly, as [GraphEdit] is a [Container]. + + + + + diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 80f6966e12..d54e749d72 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -39,13 +39,6 @@ [code]verify_host[/code] will check the SSL identity of the host if set to [code]true[/code]. - - - - - Returns the current connection. - - @@ -90,13 +83,6 @@ If [code]true[/code] this [code]HTTPClient[/code] has a response available. - - - - - If [code]true[/code] blocking mode is enabled. - - @@ -172,24 +158,6 @@ Sends the body data raw, as a byte array and does not encode it in any way. - - - - - - - If set to true, execution will block until all data is read from the response. - - - - - - - - - Sets connection to use for this client. - - @@ -200,6 +168,14 @@ + + + If [code]true[/code], execution will block until all data is read from the response. + + + The connection to use for this client. + + HTTP GET method. The GET method requests a representation of the specified resource. Requests using GET should only retrieve data. diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 985198c76f..f8da5297e1 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -26,13 +26,6 @@ Returns the response body length. - - - - - Returns the file this request will download into. - - @@ -63,20 +56,14 @@ - - - - - - - Sets the file to download into. Outputs the response body into the file if set. - - Maximum allowed size for response bodies. + + The file to download into. Will output any received file into it. + Maximum number of allowed redirects. diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index a20af677cb..15b9d2298e 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -46,20 +46,6 @@ Return the format of the [code]ImageTexture[/code], one of [Image].FORMAT_*. - - - - - Return the storage quality for [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY. - - - - - - - Return the storage type. One of [code]ImageTexture[/code].STORAGE_*. - - @@ -78,15 +64,6 @@ Set the [Image] of this [code]ImageTexture[/code]. - - - - - - - Set the storage quality in case of [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY. - - @@ -96,16 +73,15 @@ Resizes the [code]ImageTexture[/code] to the specified dimensions. - - - - - - - Set the storage type. One of [code]ImageTexture[/code].STORAGE_*. - - + + + The storage quality for [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY. + + + The storage type (raw, lossy, or compressed). + + [Image] data is stored raw and unaltered. diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index f3d0c271ac..76af678d51 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -53,12 +53,6 @@ Ensure selection is visible, adjusting the scroll position as necessary. - - - - - - @@ -198,14 +192,6 @@ Note: This method does not trigger the item selection signal. - - - - - - - - @@ -328,6 +314,8 @@ + + diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index bfc130634d..a84294f2c5 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -33,13 +33,6 @@ Returns the total length of the text. - - - - - Returns the restricted number of characters to display. Returns -1 if unrestricted. - - @@ -47,15 +40,6 @@ Returns the number of lines shown. Useful if the [code]Label[/code] 's height cannot currently display all lines. - - - - - - - Restricts the number of characters to display. Set to -1 to disable. - - @@ -85,6 +69,9 @@ 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. + diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index c28b722eb3..5dab9199e0 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -34,13 +34,6 @@ Clears the current selection. - - - - - Returns the cursor position inside the [code]LineEdit[/code]. - - @@ -81,15 +74,6 @@ Selects the whole [String]. - - - - - - - Sets the cursor position inside the [code]LineEdit[/code]. The text may scroll if needed. - - @@ -101,6 +85,9 @@ Duration (in seconds) of a caret's blinking cycle. + + The cursor's position inside the [code]LineEdit[/code]. When set, the text may scroll to accomodate it. + If [code]true[/code] the context menu will appear when right clicked. diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index a7350b3863..db345bd0d8 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -32,13 +32,6 @@ Returns the ID of this [code]NetworkedMultiplayerPeer[/code]. - - - - - Returns [code]true[/code] if this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. - - @@ -46,15 +39,6 @@ Waits up to 1 second to receive a new network event. - - - - - - - If [code]true[/code] this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. - - @@ -64,16 +48,15 @@ The peer to which packets will be sent. Default value: [code]0[/code]. - - - - - - - The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode]. - - + + + If [code]true[/code] this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. + + + The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode]. + + diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index e56733f102..d16a128034 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -184,13 +184,6 @@ Returns an array of references to node's children. - - - - - Returns a filename that may be contained by the node. When a scene is instanced from a file, its topmost node contains the filename from which it was loaded (see [method set_filename]). - - @@ -205,13 +198,6 @@ Returns the node's index, i.e. its position among the siblings of its parent. - - - - - Returns the name of the node. This name is unique among the siblings (other child nodes from the same parent). - - @@ -255,13 +241,6 @@ - - - - - Returns the node owner (see [method set_owner]). - - @@ -659,24 +638,6 @@ Sets the folded state of the node in the Scene dock. - - - - - - - A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. - - - - - - - - - Sets the name of the node. The name must be unique within the parent. Using an existing name will cause the node to be automatically renamed. - - @@ -688,15 +649,6 @@ Sets the node network master to the peer with the given peer ID. The network master is the peer that has authority over it on the network. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server). - - - - - - - Sets 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 SceneSaver) all the nodes it owns will be saved with it. This allows for the creation of complex [SceneTree]s, with instancing and subinstancing. - - @@ -768,6 +720,16 @@ + + When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. + + + The name of the node. This name is unique among the siblings (other child nodes from the same parent). + When set to an existing name, the node will be automatically renamed + + + The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows for the creation of complex [SceneTree]s, with instancing and subinstancing. + diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 5b7def99dc..6f6fc9f835 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -38,12 +38,6 @@ Returns the [Transform2D] relative to this node's parent. - - - - - - @@ -93,14 +87,6 @@ Applies a rotation to the node, in radians, starting from its current rotation. - - - - - - - - @@ -148,6 +134,9 @@ 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. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 902bf4ebfa..f2c09feef8 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -99,20 +99,6 @@ Returns the scancode of the given string (e.g. "Escape") - - - - - Returns true if the current window is borderless. - - - - - - - Get clipboard from the host OS. - - @@ -120,13 +106,6 @@ Returns the command line arguments passed to the engine. - - - - - Returns the current screen index (0 padded). - - @@ -178,12 +157,6 @@ Returns the path to the current engine executable. - - - - - - @@ -281,13 +254,6 @@ xxxhdpi - 640 dpi - - - - - Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class. - - @@ -403,20 +369,6 @@ - - - - - Returns 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. - - - - - - - Returns the size of the window (without counting window manager decorations). - - @@ -464,20 +416,6 @@ Returns [code]false[/code] if the build is a release build. - - - - - Returns [code]true[/code] if low cpu usage mode is enabled. - - - - - - - Returns [code]true[/code] if the screen is being kept on. - - @@ -508,41 +446,6 @@ If [code]true[/code], the [code]user://[/code] file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable. - - - - - Returns [code]true[/code] if synchronizing the framerate to the monitor's refresh rate is enabled. - - - - - - - Returns [code]true[/code] if the window is in fullscreen mode. - - - - - - - Returns [code]true[/code] if the window is maximized. - - - - - - - Returns [code]true[/code] if the window is minimized. - - - - - - - Returns [code]true[/code] if the window is resizable. - - @@ -636,42 +539,6 @@ Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX. - - - - - - - Removes the window frame. - - - - - - - - - Sets clipboard to the OS. - - - - - - - - - Sets the current screen by index. - - - - - - - - - Sets the exit code that will be returned by the game. - - @@ -689,33 +556,6 @@ - - - - - - - Sets keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS) - - - - - - - - - Set to [code]true[/code] to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. Use this in tool mode to reduce CPU usage. - - - - - - - - - Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class. - - @@ -734,69 +574,6 @@ Enables backup saves if [code]enabled[/code] is [code]true[/code]. - - - - - - - If [code]true[/code] the framerate will synchronize to the monitor's refresh rate. - - - - - - - - - Sets window fullscreen mode to the [i]enabled[/i] argument, [i]enabled[/i] is a toggle for the fullscreen mode, calling the function with [i]enabled[/i] true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with [i]enabled[/i] false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode. - - - - - - - - - Set [code]true[/code] to maximize the window. - - - - - - - - - Set [code]true[/code] to minimize the window. - - - - - - - - - Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen). - - - - - - - - - Sets the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings. - - - - - - - - - Sets the window size to the specified size. - - @@ -827,6 +604,46 @@ + + + The clipboard from the host OS. Might be unavailable on some platforms. + + + The current screen index (starting from 0). + + + + + + + + + The current screen orientation. + + + + + If [code]true[/code], removes the window frame. + + + If [code]true[/code], the window is fullscreen. + + + If [code]true[/code], the window is maximized. + + + If [code]true[/code], the window is minimized. + + + 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/PacketPeer.xml b/doc/classes/PacketPeer.xml index 57d88d7ff8..b920d92f3d 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -39,12 +39,6 @@ Get a Variant. - - - - - - @@ -63,15 +57,11 @@ Send a Variant as a packet. - - - - - - - - + + + + diff --git a/doc/classes/PacketPeerStream.xml b/doc/classes/PacketPeerStream.xml index 5d320a09f8..879a2f2c52 100644 --- a/doc/classes/PacketPeerStream.xml +++ b/doc/classes/PacketPeerStream.xml @@ -11,44 +11,16 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Set the [StreamPeer] object to be wrapped. - - + + + + + + + The wrapped [StreamPeer] object. + + diff --git a/doc/classes/PathFollow.xml b/doc/classes/PathFollow.xml index de7bb8715c..ac170b2ed7 100644 --- a/doc/classes/PathFollow.xml +++ b/doc/classes/PathFollow.xml @@ -12,122 +12,32 @@ - - - - - This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. - - - - - - - Returns the X displacement this node has from its parent [Path]. - - - - - - - Returns the distance along the path in 3D units. - - - - - - - Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode. - - - - - - - Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). - - - - - - - Returns the Y displacement this node has from its parent [Path]. - - - - - - - Returns whether this node wraps its offsets around, or truncates them to the path ends. - - - - - - - - - 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. - This method controls whether the position between two cached points is interpolated linearly, or cubicly. - - - - - - - - - Moves this node in the X axis. As this node's position will be set every time its offset is set, this allows many PathFollow to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. - A similar effect may be achieved moving the this node's descendants. - - - - - - - - - If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths. - - - - - - - - - Sets 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, per the constants below. - - - - - - - - - Sets 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. - - - - - - - - - Moves this node in the Y axis, for the same reasons of [method set_h_offset]. - - + + + 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 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. + + Forbids the PathFollow to rotate. diff --git a/doc/classes/PathFollow2D.xml b/doc/classes/PathFollow2D.xml index 56bec3d719..eed12b610d 100644 --- a/doc/classes/PathFollow2D.xml +++ b/doc/classes/PathFollow2D.xml @@ -12,122 +12,34 @@ - - - - - This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. - - - - - - - Returns the horizontal displacement this node has from its parent [Path2D]. - - - - - - - Returns the distance along the path in pixels. - - - - - - - Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). - - - - - - - Returns the vertical displacement this node has from its parent [Path2D]. - - - - - - - Returns whether this node wraps its offsets around, or truncates them to the path ends. - - - - - - - Returns whether this node rotates to follow the path. - - - - - - - - - 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. - This method controls whether the position between two cached points is interpolated linearly, or cubicly. - - - - - - - - - Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. - A similar effect may be achieved moving this node's descendants. - - - - - - - - - If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths. - - - - - - - - - Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path. - - - - - - - - - If set, this node rotates to follow the path, making its descendants rotate. - - - - - - - - - Sets 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. - - - - - - - - - Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset]. - - + + + 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. + + + + + 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/Physics2DDirectBodyState.xml b/doc/classes/Physics2DDirectBodyState.xml index a229ca494d..c359801020 100644 --- a/doc/classes/Physics2DDirectBodyState.xml +++ b/doc/classes/Physics2DDirectBodyState.xml @@ -11,13 +11,6 @@ - - - - - Return the angular velocity of the body. - - @@ -115,27 +108,6 @@ Return the local shape index of the collision. - - - - - Return the inverse of the inertia of the body. - - - - - - - Return the inverse of the mass of the body. - - - - - - - Return the current linear velocity of the body. - - @@ -143,41 +115,6 @@ Return the current state of space, useful for queries. - - - - - Return the timestep (delta) used for the simulation. - - - - - - - Return the rate at which the body stops rotating, if there are not any other forces moving it. - - - - - - - Return the total gravity vector being currently applied to this body. - - - - - - - Return the rate at which the body stops moving, if there are not any other forces moving it. - - - - - - - Return the transform matrix of the body. - - @@ -185,50 +122,39 @@ Call the built-in force integration code. - - - - - Return true if this body is currently sleeping (not active). - - - - - - - - - Change the angular velocity of the body. - - - - - - - - - Change the linear velocity of the body. - - - - - - - - - Set the sleeping state of the body, only affects character/rigid bodies. - - - - - - - - - Change the transform matrix of the body. - - + + + The angular velocity of the body. + + + The inverse of the inertia of the body. + + + The inverse of the mass of the body. + + + The linear velocity of the body. + + + [code]true[/code] if this body is currently sleeping (not active). + + + The timestep (delta) used for the simulation. + + + The rate at which the body stops rotating, if there are not any other forces moving it. + + + The total gravity vector being currently applied to this body. + + + The rate at which the body stops moving, if there are not any other forces moving it. + + + The transformation matrix of the body. + + diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 93165afe60..eeba622f85 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -11,84 +11,6 @@ - - - - - Return the physics layer the shape belongs to. - - - - - - - Return the list of objects, or object [RID]s, that will be excluded from collisions. - - - - - - - Return the collision margin for the shape. - - - - - - - Return the current movement speed of the shape. - - - - - - - Return the [RID] of the shape queried. - - - - - - - Return the transform matrix of the shape queried. - - - - - - - - - Set the physics layer the shape belongs to. - - - - - - - - - Set the list of objects, or object [RID]s, that will be excluded from collisions. - - - - - - - - - Set the collision margin for the shape. A collision margin is an amount (in pixels) that the shape will grow when computing collisions, to account for numerical imprecision. - - - - - - - - - Set the current movement speed of the shape. - - @@ -98,25 +20,27 @@ Set the [Shape2D] that will be used for collision/intersection queries. - - - - - - - Set the [RID] of the shape to be used in queries. - - - - - - - - - Set the transformation matrix of the shape. This is necessary to set its position/rotation/scale. - - + + + 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 [method set_shape] also. + + + the transform matrix of the queried shape. + + diff --git a/doc/classes/Physics2DTestMotionResult.xml b/doc/classes/Physics2DTestMotionResult.xml index bc7cb68bc9..93809ca2a4 100644 --- a/doc/classes/Physics2DTestMotionResult.xml +++ b/doc/classes/Physics2DTestMotionResult.xml @@ -9,61 +9,27 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/PhysicsDirectBodyState.xml b/doc/classes/PhysicsDirectBodyState.xml index 1d588ecfff..486804f196 100644 --- a/doc/classes/PhysicsDirectBodyState.xml +++ b/doc/classes/PhysicsDirectBodyState.xml @@ -37,18 +37,6 @@ - - - - - - - - - - - - @@ -127,111 +115,55 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + The angular velocity of the body. + + + + + The inverse of the inertia of the body. + + + The inverse of the mass of the body. + + + The linear velocity of the body. + + + + + [code]true[/code] if this body is currently sleeping (not active). + + + The timestep (delta) used for the simulation. + + + The rate at which the body stops rotating, if there are not any other forces moving it. + + + The total gravity vector being currently applied to this body. + + + The rate at which the body stops moving, if there are not any other forces moving it. + + + The transformation matrix of the body. + + diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml index 98d6846b13..19036151ed 100644 --- a/doc/classes/PhysicsShapeQueryParameters.xml +++ b/doc/classes/PhysicsShapeQueryParameters.xml @@ -9,60 +9,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -71,23 +17,19 @@ - - - - - - - - - - - - - - - - + + + + + + + + + + + + diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index f69010458e..26ddf617ea 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -11,22 +11,6 @@ - - - - - Return the rotation in radians of the texture polygon. - - - - - - - - - Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation. - - @@ -54,6 +38,9 @@ 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. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 13cf16d2ee..c9a8b2a9fd 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -233,12 +233,6 @@ - - - - - - @@ -284,14 +278,6 @@ Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. - - - - - - - - @@ -455,6 +441,8 @@ + + diff --git a/doc/classes/ProximityGroup.xml b/doc/classes/ProximityGroup.xml index 42e2c5e690..4c9a20d630 100644 --- a/doc/classes/ProximityGroup.xml +++ b/doc/classes/ProximityGroup.xml @@ -21,26 +21,14 @@ - - - - - - - - - - - - - - - - + + + + @@ -53,5 +41,9 @@ + + + + diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index d86ff57661..169f28bd7a 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -11,22 +11,6 @@ - - - - - Return value mapped to 0 to 1 range. - - - - - - - - - Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. - - @@ -57,6 +41,9 @@ 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. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 5c04d3406e..39b0e80775 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -53,20 +53,6 @@ Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line. - - - - - Returns the number of spaces associated with a single tab length. Does not affect "\t" in text tags, only indent tags. - - - - - - - Returns the raw content of [member bbcode_text]. - - @@ -88,34 +74,6 @@ Returns the number of visible lines. - - - - - Returns [code]true[/code] if the label underlines meta tags such as [url]{text}[/url]. - - - - - - - Returns [code]true[/code] if the scrollbar is visible. Does not block scrolling completely. See [method scroll_to_line]. - - - - - - - Returns [code]true[/code] if the window scrolls down to display new content automatically. - - - - - - - Returns [code]true[/code] if the label allows text selection. - - @@ -234,51 +192,6 @@ Scrolls the window's top line to match [code]line[/code]. - - - - - - - If [code]true[/code] will underline meta tags such as the [url] bbcode. Default value: [code]true[/code]. - - - - - - - - - If [code]false[/code] the vertical scrollbar is hidden. Default value: [code]true[/code]. - - - - - - - - - If [code]true[/code] the window scrolls to reveal new content. Default value: [code]false[/code]. - - - - - - - - - If [code]true[/code] text can be selected. - - - - - - - - - Sets the current tab length in spaces. Use with [method push_indent] to redefine indent length. - - @@ -294,15 +207,6 @@ Columns with a [code]false[/code] expand will not contribute to the total ratio. - - - - - - - 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]. - - @@ -311,12 +215,31 @@ 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 [url]{text}[/url]. Default value: [code]true[/code]. + If [code]true[/code] the label uses the custom font color. Default value: [code]false[/code]. 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 window scrolls down to display new content automatically. Default value: [code]false[/code]. + + + If [code]true[/code], the label allows text selection. + + + The number of spaces associated with a single tab length. Does not affect "\t" 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. diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 991e0fa3f4..3465c851f8 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -49,20 +49,6 @@ Applies a positioned impulse to the body (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied instantaneously. Both the impulse and the offset from the body origin are in global coordinates. - - - - - Returns the body's total applied force. - - - - - - - Returns the body's total applied torque. - - @@ -70,31 +56,6 @@ Returns a list of the bodies colliding with this one. Use [member contacts_reported] to set the maximum number reported. You must also set [member contact_monitor] to [code]true[/code]. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. - - - - - Returns the body's moment of inertia, which is computed automatically from the body's mass and assigned [Shape2D]s during the physics frame. Note that it will not yet have a value in the [code]_ready()[/code] function. - - - - - - - - - Sets the applied force vector. This is the equivalent of firing a rocket: the force is applied constantly. - - - - - - - - - Sets the applied torque. - - @@ -104,15 +65,6 @@ Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. - - - - - - - Set 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. - - @@ -134,6 +86,12 @@ 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]. @@ -159,6 +117,9 @@ Multiplies the gravity applied to the body. The body's gravity is calculated from the "Default Gravity" value in "Project > Project Settings > Physics > 2d" and/or any additional gravity vector applied by [Area2D]s. Default value: [code]1[/code]. + + 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 "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: [code]-1[/code]. diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 3a4b843b06..fff7f2aa26 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -1,4 +1,4 @@ - +xml version="1.0" encoding="UTF-8" ?> @@ -57,18 +57,6 @@ - - - - - - - - - - - - @@ -101,12 +89,6 @@ - - - - - - @@ -128,18 +110,6 @@ Returns true if there is a [NetworkedMultiplayerPeer] set (with [method SceneTree.set_network_peer]). - - - - - - - - - - - - @@ -153,24 +123,6 @@ Returns true if this SceneTree's [NetworkedMultiplayerPeer] is in server mode (listening for connections). - - - - - - - - - - - - - - - - - - @@ -221,38 +173,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -285,23 +205,6 @@ - - - - - - - Set the peer object to handle the RPC system (effectively enabling networking). Depending on the peer itself, the SceneTree will become a network server (check with [method is_network_server()]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. 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. - - - - - - - - - - @@ -310,14 +213,6 @@ - - - - - - - - @@ -332,15 +227,28 @@ - - - - - - - - + + + + + + + + + + + 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 root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. 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. + + + + + + + + + + diff --git a/doc/classes/SceneTreeTimer.xml b/doc/classes/SceneTreeTimer.xml index 0fdcb26e6e..c05f4d1fd6 100644 --- a/doc/classes/SceneTreeTimer.xml +++ b/doc/classes/SceneTreeTimer.xml @@ -9,21 +9,11 @@ - - - - - - - - - - - - - - + + + + diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index c7df24879e..4fcd4b20d9 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -31,13 +31,6 @@ - - - - - Returns the script source code, or an empty string if source code is not available. - - @@ -79,16 +72,12 @@ Reloads the script's class implementation. Returns an error code. - - - - - - - Sets the script source code. Does not reload the class implementation. - - + + + The script source code, or an empty string if source code is not available. When set, does not reload the class implementation automatically. + + diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 87ad7d57f5..65ea3216f8 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -11,43 +11,19 @@ - - - - - Return current horizontal scroll value. - - - - - - - Return current vertical scroll value. - - - - - - - - - Set horizontal scroll value. - - - - - - - - - Set vertical scroll value. - - - + + The current horizontal scroll value. - + + If [code]true[/code], enables horizontal scrolling. + + + The current horizontal scroll value. + + + If [code]true[/code], enables vertical scrolling. diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index 082c48dfce..543164d92e 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -11,12 +11,6 @@ - - - - - - @@ -39,14 +33,6 @@ - - - - - - - - @@ -58,6 +44,10 @@ + + + + diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 096d6d4332..1c2ff15a63 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -9,12 +9,6 @@ - - - - - - @@ -23,14 +17,6 @@ - - - - - - - - @@ -42,6 +28,10 @@ + + + + diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index d0addcf9f9..4f23dbf053 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -13,13 +13,6 @@ - - - - - Returns the SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. - - @@ -195,15 +188,6 @@ Makes the node ignore its parents transformations. Node transformations are only in global space. - - - - - - - Set [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. - - @@ -289,6 +273,9 @@ + + The SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. + World space (global) [Transform] of this node. diff --git a/doc/classes/SpatialVelocityTracker.xml b/doc/classes/SpatialVelocityTracker.xml index a58049a141..deb58c54ee 100644 --- a/doc/classes/SpatialVelocityTracker.xml +++ b/doc/classes/SpatialVelocityTracker.xml @@ -15,12 +15,6 @@ - - - - - - @@ -29,14 +23,6 @@ - - - - - - - - @@ -46,6 +32,10 @@ + + + + diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index 8ecd9e5816..c4cb816dc8 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -131,13 +131,6 @@ Get a Variant from the stream. - - - - - Return whether this [code]StreamPeer[/code] is using big-endian format. - - @@ -264,16 +257,12 @@ Put a Variant into the stream. - - - - - - - Set this [code]StreamPeer[/code] to use big-endian format. Default is false. - - + + + If [code]true[/code], this [code]StreamPeer[/code] will using big-endian format for encoding and decoding. + + diff --git a/doc/classes/StreamPeerBuffer.xml b/doc/classes/StreamPeerBuffer.xml index 66696ed416..d2a83f1384 100644 --- a/doc/classes/StreamPeerBuffer.xml +++ b/doc/classes/StreamPeerBuffer.xml @@ -21,12 +21,6 @@ - - - - - - @@ -55,15 +49,11 @@ - - - - - - - - + + + + diff --git a/doc/classes/StyleBoxLine.xml b/doc/classes/StyleBoxLine.xml index e18af2334c..051cc90a7c 100644 --- a/doc/classes/StyleBoxLine.xml +++ b/doc/classes/StyleBoxLine.xml @@ -9,24 +9,12 @@ - - - - - - - - - - - - - - + + diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index fbda1aedb4..4bb175701f 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -35,12 +35,6 @@ - - - - - - @@ -105,14 +99,6 @@ - - - - - - - - @@ -149,6 +135,8 @@ + + diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index f4d80c46b4..c7b3794e29 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -294,24 +294,6 @@ - - - - - - - Set the maximum amount of characters editable. - - - - - - - - - Enable text wrapping when it goes beyond he edge of what is visible. - - @@ -384,6 +366,9 @@ String value of the [TextEdit]. + If [code]true[/code], enables text wrapping when it goes beyond he edge of what is visible. + + diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index bf27bc4768..fd1598996a 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -71,13 +71,6 @@ - - - - - Return the current texture flags. - - @@ -105,17 +98,16 @@ - - - - - - - Change the texture flags. - - + + + The texture's flags. + + + + Default flags. Generate mipmaps, repeat, and filter are enabled. + Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. @@ -125,9 +117,6 @@ Magnifying filter, to enable smooth zooming in of the texture. - - Default flags. Generate mipmaps, repeat, and filter are enabled. - Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 09071b2ad1..876eed92ae 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -11,20 +11,6 @@ - - - - - Returns the timer's remaining time in seconds. Returns 0 if the timer is inactive. - - - - - - - Returns [code]true[/code] if the timer is paused. - - @@ -32,15 +18,6 @@ Returns [code]true[/code] if the timer is stopped. - - - - - - - Pauses the timer. If [code]paused[/code] is [code]true[/code], the timer will not process until it is started or unpaused again, even if [method start] is called. - - @@ -64,9 +41,15 @@ If [code]true[/code], Timer will stop when reaching 0. If [code]false[/code], it will restart. Default value: [code]false[/code]. + + 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. Uses TIMER_PROCESS_* constants as value. + + The timer's remaining time in seconds. Returns 0 if the timer is inactive. + Wait time in seconds. diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index e26082c47e..7e11421b74 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -54,20 +54,6 @@ Makes the currently selected item visible. This will scroll the tree to make sure the selected item is visible. - - - - - Returns [code]true[/code] if a cell that is currently already selected may be selected again. - - - - - - - Returns [code]true[/code] if a right click can select items. - - @@ -95,13 +81,6 @@ Returns the column's width in pixels. - - - - - Returns the amount of columns. - - @@ -109,13 +88,6 @@ Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See [method TreeItem.set_cell_mode]. - - - - - Returns the current drop mode's flags. - - @@ -202,31 +174,6 @@ Returns the current selection's column. - - - - - Returns [code]true[/code] if the folding arrow is hidden. - - - - - - - - - If [code]true[/code] the currently selected cell may be selected again. - - - - - - - - - If [code]true[/code] a right mouse button click can select items. - - @@ -269,52 +216,31 @@ If [code]true[/code] column titles are visible. - - - - - - - Set the amount of columns. - - - - - - - - - Set the drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. - - - - - - - - - If [code]true[/code] the folding arrow is hidden. - - - - - - - - - If [code]true[/code] the tree's root is hidden. - - - - - - - - - Allow single or multiple selection. See the [code]SELECT_*[/code] constants. - - + + + 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 amount of columns. + + + The drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. + + + If [code]true[/code] the folding arrow is hidden. + + + If [code]true[/code] the tree's root is hidden. + + + Allow single or multiple selection. See the [code]SELECT_*[/code] constants. + + diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 421185fe51..d5bb5a2726 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -111,13 +111,6 @@ Returns the custom background color of column [code]column[/code]. - - - - - Returns the custom minimum height. - - @@ -260,13 +253,6 @@ Returns [code]true[/code] if the given column is checked. - - - - - Returns [code]true[/code] if this TreeItem is collapsed. - - @@ -284,13 +270,6 @@ Returns [code]true[/code] if column [code]column[/code] is editable. - - - - - Returns [code]true[/code] if folding is disabled for this TreeItem. - - @@ -376,15 +355,6 @@ If [code]true[/code] the column [code]column[/code] is checked. - - - - - - - If [code]true[/code] the TreeItem is collapsed. - - @@ -432,24 +402,6 @@ Sets the given column's custom draw callback to [code]callback[/code] method on [code]object[/code]. - - - - - - - Sets the custom minimum height of this TreeItem. - - - - - - - - - If [code]true[/code] folding is disabled for this TreeItem. - - @@ -585,6 +537,17 @@ + + + If [code]true[/code] the TreeItem is collapsed. + + + The custom minimum height. + + + If [code]true[/code] folding is disabled for this TreeItem. + + Cell contains a string. diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index a11580860a..3d1dd8abf6 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -78,13 +78,6 @@ Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. - - - - - Returns the speed that has been set from editor GUI or [method set_repeat]. - - @@ -186,13 +179,6 @@ Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended. - - - - - Returns true if repeat has been set from editor GUI or [method set_repeat]. - - @@ -265,24 +251,6 @@ Activate/deactivate the tween. You can use this for pausing animations, though [method stop_all] and [method resume_all] might be more fit for this. - - - - - - - Make the tween repeat after all tweens have finished. - - - - - - - - - Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using [method set_active] or [method stop_all] and [method resume_all] for this. - - @@ -371,6 +339,12 @@ + + The speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using [method set_active] or [method stop_all] and [method resume_all] for this. + + + If [code]true[/code], the tween will repeat. + diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 281dc1f071..2ea1a1a841 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -11,13 +11,6 @@ - - - - - Get the amount of milliseconds to store in buffer while playing. - - @@ -25,13 +18,6 @@ Get the name of the video stream. - - - - - Get the current position of the stream, in seconds. - - @@ -39,13 +25,6 @@ Get the current frame of the video as a [Texture]. - - - - - Get the volume of the audio track as a linear value. - - @@ -60,33 +39,6 @@ Start the video playback. - - - - - - - Set the amount of milliseconds to buffer during playback. - - - - - - - - - Set the current position of the stream, in seconds. - - - - - - - - - Set the audio volume as a linear value. - - @@ -100,6 +52,9 @@ + + The amount of milliseconds to store in buffer while playing. + @@ -108,6 +63,12 @@ + + The current position of the stream, in seconds. + + + The volume of the audio track as a linear value. + diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index ad3903d549..acef5a6ea1 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -37,13 +37,6 @@ Return the active 3D camera. - - - - - Get the canvas transform of the viewport. - - @@ -51,13 +44,6 @@ Get the total transform of the viewport. - - - - - Get the global canvas transform of the viewport. - - @@ -101,13 +87,6 @@ Return the final, visible rect in global screen coordinates. - - - - - Return the 2D world of the viewport. - - @@ -152,24 +131,6 @@ - - - - - - - Set 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. - - - - - - - - - Set the global canvas transform of the viewport. The canvas transform is relative to this. - - @@ -192,14 +153,6 @@ Set whether the size override affects stretch as well. - - - - - - - - @@ -232,10 +185,16 @@ + + 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 global canvas transform of the viewport. The canvas transform is relative to this. + @@ -272,6 +231,8 @@ + + diff --git a/doc/classes/World.xml b/doc/classes/World.xml index 9011d39669..d5bbef268a 100644 --- a/doc/classes/World.xml +++ b/doc/classes/World.xml @@ -11,35 +11,24 @@ - - - - - Returns the World's physics space. - - - - - - - Returns the World's visual scenario. - - - - - - - Returns the World's sound space. - - + + 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. + + The World's visual scenario. + + + + The World's physics space. + diff --git a/doc/classes/World2D.xml b/doc/classes/World2D.xml index 93c88968ac..c9524c85a1 100644 --- a/doc/classes/World2D.xml +++ b/doc/classes/World2D.xml @@ -11,28 +11,18 @@ - - - - - Retrieve the [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing. - - - - - - - Retrieve the state of this world's physics space. This allows arbitrary querying for collision. - - - - - - - Retrieve the [RID] of this world's physics space resource. Used by the [Physics2DServer] for 2D physics, treating it as both a space and an area. - - + + + The [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing. + + + The state of this world's physics space. This allows arbitrary querying for collision. + + + The [RID] of this world's physics space resource. Used by the [Physics2DServer] for 2D physics, treating it as both a space and an area. + + -- cgit v1.2.3