diff options
Diffstat (limited to 'doc')
418 files changed, 1531 insertions, 3493 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index c98a80ca8c..4e9a6a5fc0 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="@GDScript" category="Core" version="3.0-beta"> +<class name="@GDScript" category="Core" version="3.0-stable"> <brief_description> Built-in GDScript functions. </brief_description> @@ -182,14 +182,14 @@ <method name="clamp"> <return type="float"> </return> - <argument index="0" name="val" type="float"> + <argument index="0" name="value" type="float"> </argument> <argument index="1" name="min" type="float"> </argument> <argument index="2" name="max" type="float"> </argument> <description> - Clamps [code]val[/code] and returns a value not less than [code]min[/code] and not more than [code]max[/code]. + Clamps [code]value[/code] and returns a value not less than [code]min[/code] and not more than [code]max[/code]. [codeblock] speed = 1000 # a is 20 @@ -466,7 +466,7 @@ </argument> <argument index="1" name="to" type="float"> </argument> - <argument index="2" name="value" type="float"> + <argument index="2" name="weight" type="float"> </argument> <description> Returns a normalized value considering the given range. @@ -589,10 +589,10 @@ <method name="nearest_po2"> <return type="int"> </return> - <argument index="0" name="val" type="int"> + <argument index="0" name="value" type="int"> </argument> <description> - Returns the nearest larger power of 2 for integer [code]val[/code]. + Returns the nearest larger power of 2 for integer [code]value[/code]. [codeblock] nearest_po2(3) # returns 4 nearest_po2(4) # returns 4 @@ -608,6 +608,7 @@ <description> Parse JSON text to a Variant (use [method typeof] to check if it is what you expect). Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to [float] types. + Note that JSON objects do not preserve key order like Godot dictionaries, thus you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements: [codeblock] p = parse_json('["a", "b", "c"]') if typeof(p) == TYPE_ARRAY: diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 6e8b760966..1f6256f8c9 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="@GlobalScope" category="Core" version="3.0-beta"> +<class name="@GlobalScope" category="Core" version="3.0-stable"> <brief_description> Global scope constants and variables. </brief_description> @@ -45,6 +45,7 @@ [JSON] singleton </member> <member name="JavaScript" type="JavaScript" setter="" getter=""> + [JavaScript] singleton </member> <member name="Marshalls" type="Reference" setter="" getter=""> [Marshalls] singleton @@ -1076,7 +1077,7 @@ Joypad Right Analog Trigger </constant> <constant name="OK" value="0" enum="Error"> - Functions that return Error return OK when no error occured. Most functions don't return errors and/or just print errors to STDOUT. + Functions that return Error return OK when no error occurred. Most functions don't return errors and/or just print errors to STDOUT. </constant> <constant name="FAILED" value="1" enum="Error"> Generic error. @@ -1285,7 +1286,7 @@ </constant> <constant name="PROPERTY_USAGE_DEFAULT_INTL" value="71" enum="PropertyUsageFlags"> </constant> - <constant name="PROPERTY_USAGE_NOEDITOR" value="1048581" enum="PropertyUsageFlags"> + <constant name="PROPERTY_USAGE_NOEDITOR" value="5" enum="PropertyUsageFlags"> </constant> <constant name="METHOD_FLAG_NORMAL" value="1" enum="MethodFlags"> Flag for normal method diff --git a/doc/classes/@NativeScript.xml b/doc/classes/@NativeScript.xml index 898c30431f..8fde9e3dc3 100644 --- a/doc/classes/@NativeScript.xml +++ b/doc/classes/@NativeScript.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="@NativeScript" category="Core" version="3.0-beta"> +<class name="@NativeScript" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/@VisualScript.xml b/doc/classes/@VisualScript.xml index 0d105b4274..4867a5a22b 100644 --- a/doc/classes/@VisualScript.xml +++ b/doc/classes/@VisualScript.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="@VisualScript" category="Core" version="3.0-beta"> +<class name="@VisualScript" category="Core" version="3.0-stable"> <brief_description> Built-in visual script functions. </brief_description> diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index 4aef151fbd..f253d49dc0 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AABB" category="Built-In Types" version="3.0-beta"> +<class name="AABB" category="Built-In Types" version="3.0-stable"> <brief_description> Axis-Aligned Bounding Box. </brief_description> @@ -7,6 +7,7 @@ AABB consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/math/index.html </tutorials> <demos> </demos> diff --git a/doc/classes/ARVRAnchor.xml b/doc/classes/ARVRAnchor.xml index 88862ec5f1..cc9370e8fe 100644 --- a/doc/classes/ARVRAnchor.xml +++ b/doc/classes/ARVRAnchor.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRAnchor" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="ARVRAnchor" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Anchor point in AR Space </brief_description> diff --git a/doc/classes/ARVRCamera.xml b/doc/classes/ARVRCamera.xml index 5195568e67..b603a69337 100644 --- a/doc/classes/ARVRCamera.xml +++ b/doc/classes/ARVRCamera.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRCamera" inherits="Camera" category="Core" version="3.0-beta"> +<class name="ARVRCamera" inherits="Camera" category="Core" version="3.0-stable"> <brief_description> A camera node with a few overrules for AR/VR applied such as location tracking. </brief_description> diff --git a/doc/classes/ARVRController.xml b/doc/classes/ARVRController.xml index 2adc073ebe..07692f5ab2 100644 --- a/doc/classes/ARVRController.xml +++ b/doc/classes/ARVRController.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRController" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="ARVRController" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> A spatial node representing a spatially tracked controller. </brief_description> diff --git a/doc/classes/ARVRInterface.xml b/doc/classes/ARVRInterface.xml index d00b5eeaf4..bf9dde7706 100644 --- a/doc/classes/ARVRInterface.xml +++ b/doc/classes/ARVRInterface.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRInterface" inherits="Reference" category="Core" version="3.0-beta"> +<class name="ARVRInterface" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Base class for ARVR interface implementation. </brief_description> @@ -91,7 +91,7 @@ This interface support AR (video background and real world tracking). </constant> <constant name="ARVR_EXTERNAL" value="8" enum="Capabilities"> - This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a seperate viewport node frees up the main viewport for other purposes. + This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a separate viewport node frees up the main viewport for other purposes. </constant> <constant name="EYE_MONO" value="0" enum="Eyes"> Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported. diff --git a/doc/classes/ARVROrigin.xml b/doc/classes/ARVROrigin.xml index 6e0999a1f9..ec9b79bf84 100644 --- a/doc/classes/ARVROrigin.xml +++ b/doc/classes/ARVROrigin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVROrigin" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="ARVROrigin" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Our origin point in AR/VR. </brief_description> diff --git a/doc/classes/ARVRPositionalTracker.xml b/doc/classes/ARVRPositionalTracker.xml index 88740f5dc1..ea2139406b 100644 --- a/doc/classes/ARVRPositionalTracker.xml +++ b/doc/classes/ARVRPositionalTracker.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRPositionalTracker" inherits="Object" category="Core" version="3.0-beta"> +<class name="ARVRPositionalTracker" inherits="Object" category="Core" version="3.0-stable"> <brief_description> A tracked object </brief_description> diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index 7f9eedce50..29d217d1d3 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRServer" inherits="Object" category="Core" version="3.0-beta"> +<class name="ARVRServer" inherits="Object" category="Core" version="3.0-stable"> <brief_description> This is our AR/VR Server. </brief_description> @@ -49,7 +49,7 @@ <return type="int"> </return> <description> - Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look throught the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true. + Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look through the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true. </description> </method> <method name="get_interfaces" qualifiers="const"> @@ -99,21 +99,21 @@ </members> <signals> <signal name="interface_added"> - <argument index="0" name="name" type="String"> + <argument index="0" name="interface_name" type="String"> </argument> <description> Signal send when a new interface has been added. </description> </signal> <signal name="interface_removed"> - <argument index="0" name="name" type="String"> + <argument index="0" name="interface_name" type="String"> </argument> <description> Signal send when an interface is removed. </description> </signal> <signal name="tracker_added"> - <argument index="0" name="name" type="String"> + <argument index="0" name="tracker_name" type="String"> </argument> <argument index="1" name="type" type="int"> </argument> @@ -124,7 +124,7 @@ </description> </signal> <signal name="tracker_removed"> - <argument index="0" name="name" type="String"> + <argument index="0" name="tracker_name" type="String"> </argument> <argument index="1" name="type" type="int"> </argument> diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index 08ac12736a..0573e4edf0 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AStar" inherits="Reference" category="Core" version="3.0-beta"> +<class name="AStar" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> AStar class representation that uses vectors as edges. </brief_description> diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 219995023e..a6cc40238b 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AcceptDialog" inherits="WindowDialog" category="Core" version="3.0-beta"> +<class name="AcceptDialog" inherits="WindowDialog" category="Core" version="3.0-stable"> <brief_description> Base dialog for user notification. </brief_description> diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml index 9645758ea0..3e67fd6840 100644 --- a/doc/classes/AnimatedSprite.xml +++ b/doc/classes/AnimatedSprite.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AnimatedSprite" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="AnimatedSprite" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Sprite node that can use multiple textures for animation. </brief_description> diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index beb65d4d28..f72211776e 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AnimatedSprite3D" inherits="SpriteBase3D" category="Core" version="3.0-beta"> +<class name="AnimatedSprite3D" inherits="SpriteBase3D" category="Core" version="3.0-stable"> <brief_description> 2D sprite node in 3D world, that can use multiple 2D textures for animation. </brief_description> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index f78b39eadb..f8c94dd12d 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Animation" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Animation" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Contains data used to animate everything in the engine. </brief_description> @@ -8,6 +8,7 @@ Animations are just data containers, and must be added to odes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/animation/index.html </tutorials> <demos> </demos> @@ -50,20 +51,6 @@ Return the index of the specified track. If the track is not found, return -1. </description> </method> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the total length of the animation (in seconds). - </description> - </method> - <method name="get_step" qualifiers="const"> - <return type="float"> - </return> - <description> - Get the animation step value. - </description> - </method> <method name="get_track_count" qualifiers="const"> <return type="int"> </return> @@ -71,13 +58,6 @@ Return the amount of tracks in the animation. </description> </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the animation has the loop flag set. - </description> - </method> <method name="method_track_get_key_indices" qualifiers="const"> <return type="PoolIntArray"> </return> @@ -122,33 +102,6 @@ Remove a track by specifying the track index. </description> </method> - <method name="set_length"> - <return type="void"> - </return> - <argument index="0" name="time_sec" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_loop"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_step"> - <return type="void"> - </return> - <argument index="0" name="size_sec" type="float"> - </argument> - <description> - Set the animation step value. - </description> - </method> <method name="track_find_key" qualifiers="const"> <return type="int"> </return> @@ -456,6 +409,17 @@ </description> </method> </methods> + <members> + <member name="length" type="float" setter="set_length" getter="get_length"> + 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. + </member> + <member name="loop" type="bool" setter="set_loop" getter="has_loop"> + 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. + </member> + <member name="step" type="float" setter="set_step" getter="get_step"> + The animation step value. + </member> + </members> <constants> <constant name="TYPE_VALUE" value="0" enum="TrackType"> 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..b15f0ec732 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AnimationPlayer" inherits="Node" category="Core" version="3.0-beta"> +<class name="AnimationPlayer" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Container and player of [Animation] resources. </brief_description> @@ -7,6 +7,8 @@ An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. </description> <tutorials> + http://docs.godotengine.org/en/3.0/getting_started/step_by_step/animations.html + http://docs.godotengine.org/en/3.0/tutorials/animation/index.html </tutorials> <demos> </demos> @@ -90,13 +92,6 @@ Returns the list of stored animation names. </description> </method> - <method name="get_autoplay" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the name of the animation that will be automatically played when the scene is loaded. - </description> - </method> <method name="get_blend_time" qualifiers="const"> <return type="float"> </return> @@ -108,34 +103,6 @@ Get the blend time (in seconds) between two animations, referenced by their names. </description> </method> - <method name="get_current_animation" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the name of the animation being played. - </description> - </method> - <method name="get_current_animation_length" qualifiers="const"> - <return type="float"> - </return> - <description> - Get the length (in seconds) of the currently being played animation. - </description> - </method> - <method name="get_current_animation_position" qualifiers="const"> - <return type="float"> - </return> - <description> - Get the position (in seconds) of the currently playing animation. - </description> - </method> - <method name="get_speed_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - 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. - </description> - </method> <method name="has_animation" qualifiers="const"> <return type="bool"> </return> @@ -145,13 +112,6 @@ Returns [code]true[/code] if the [code]AnimationPlayer[/code] stores an [Animation] with key [code]name[/code]. </description> </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the player is active. - </description> - </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> @@ -226,24 +186,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. </description> </method> - <method name="set_active"> - <return type="void"> - </return> - <argument index="0" name="active" type="bool"> - </argument> - <description> - Sets the player as active (playing). If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code]. - </description> - </method> - <method name="set_autoplay"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - Defines the name of the animation to play when the scene loads. Default value: [code]""[/code]. - </description> - </method> <method name="set_blend_time"> <return type="void"> </return> @@ -257,24 +199,6 @@ Specify a blend time (in seconds) between two animations, referenced by their names. </description> </method> - <method name="set_current_animation"> - <return type="void"> - </return> - <argument index="0" name="anim" type="String"> - </argument> - <description> - 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]. - </description> - </method> - <method name="set_speed_scale"> - <return type="void"> - </return> - <argument index="0" name="speed" type="float"> - </argument> - <description> - Sets the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: [code]1[/code]. - </description> - </method> <method name="stop"> <return type="void"> </return> @@ -286,12 +210,33 @@ </method> </methods> <members> + <member name="assigned_animation" type="String" setter="set_assigned_animation" getter="get_assigned_animation"> + 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]. + </member> + <member name="autoplay" type="String" setter="set_autoplay" getter="get_autoplay"> + The name of the animation to play when the scene loads. Default value: [code]""[/code]. + </member> + <member name="current_animation" type="String" setter="set_current_animation" getter="get_current_animation"> + 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]. + </member> + <member name="current_animation_length" type="float" setter="" getter="get_current_animation_length"> + The length (in seconds) of the currently being played animation. + </member> + <member name="current_animation_position" type="float" setter="" getter="get_current_animation_position"> + The position (in seconds) of the currently playing animation. + </member> + <member name="playback_active" type="bool" setter="set_active" getter="is_active"> + If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code]. + </member> <member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time"> The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: [code]0[/code]. </member> <member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationPlayer.AnimationProcessMode"> The process notification in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. </member> + <member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale"> + 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]. + </member> <member name="root_node" type="NodePath" setter="set_root" getter="get_root"> The node from which node path references will travel. Default value: [code]".."[/code]. </member> @@ -307,14 +252,14 @@ </description> </signal> <signal name="animation_finished"> - <argument index="0" name="name" type="String"> + <argument index="0" name="anim_name" type="String"> </argument> <description> Notifies when an animation finished playing. </description> </signal> <signal name="animation_started"> - <argument index="0" name="name" type="String"> + <argument index="0" name="anim_name" type="String"> </argument> <description> Notifies when an animation starts playing. diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index ecd1f81951..c09121857e 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AnimationTreePlayer" inherits="Node" category="Core" version="3.0-beta"> +<class name="AnimationTreePlayer" inherits="Node" category="Core" version="3.0-stable"> <brief_description> - Animation Player that uses a node graph for the blending. + Animation Player that uses a node graph for blending Animations. </brief_description> <description> A node graph tool for blending multiple animations bound to an [AnimationPlayer]. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose. + It takes [Animation]s from an [AnimationPlayer] node and mixes them depending on the graph. </description> <tutorials> </tutorials> @@ -37,7 +38,7 @@ <argument index="0" name="id" type="String"> </argument> <description> - Returns the [AnimationPlayer]'s animation bound to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code]. + Returns the [AnimationPlayer]'s [Animation] bound to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code]. </description> </method> <method name="animation_node_get_master_animation" qualifiers="const"> @@ -46,7 +47,7 @@ <argument index="0" name="id" type="String"> </argument> <description> - Returns the name of the [member master_player]'s animation bound to this animation node. + Returns the name of the [member master_player]'s [Animation] bound to this animation node. </description> </method> <method name="animation_node_set_animation"> @@ -57,7 +58,7 @@ <argument index="1" name="animation" type="Animation"> </argument> <description> - Binds a new animation from the [member master_player] to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code]. + Binds a new [Animation] from the [member master_player] to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code]. </description> </method> <method name="animation_node_set_filter_path"> @@ -81,7 +82,7 @@ <argument index="1" name="source" type="String"> </argument> <description> - Binds the animation named [code]source[/code] from [member master_player] to the animation node [code]id[/code]. Recalculates caches. + Binds the [Animation] named [code]source[/code] from [member master_player] to the animation node [code]id[/code]. Recalculates caches. </description> </method> <method name="are_nodes_connected" qualifiers="const"> @@ -115,6 +116,10 @@ </argument> <description> Sets the blend amount of a Blend2 node given its name and value. + A Blend2 Node blends two animations with the amount between 0 and 1. + At 0, Output is input a. + Towards 1, the influence of a gets lessened, the influence of b gets raised. + At 1, Output is input b. </description> </method> <method name="blend2_node_set_filter_path"> @@ -148,6 +153,12 @@ </argument> <description> Sets the blend amount of a Blend3 node given its name and value. + A Blend3 Node blends three animations with the amount between -1 and 1. + At -1, Output is input b-. + From -1 to 0, the influence of b- gets lessened, the influence of a gets raised and the influence of b+ is 0. + At 0, Output is input a. + From 0 to 1, the influence of a gets lessened, the influence of b+ gets raised and the influence of b+ is 0. + At 1, Output is input b+. </description> </method> <method name="blend4_node_get_amount" qualifiers="const"> @@ -168,6 +179,8 @@ </argument> <description> Sets the blend amount of a Blend4 node given its name and value. + A Blend4 Node blends two pairs of animations. + The two pairs are blended like blend2 and then added together. </description> </method> <method name="connect_nodes"> @@ -198,7 +211,7 @@ <return type="PoolStringArray"> </return> <description> - Returns a PoolStringArray containing the name of all nodes. + Returns a [PoolStringArray] containing the name of all nodes. </description> </method> <method name="mix_node_get_amount" qualifiers="const"> @@ -219,6 +232,7 @@ </argument> <description> Sets mix amount of a Mix node given its name and value. + A Mix node adds input b to input a by a the amount given by ratio. </description> </method> <method name="node_exists" qualifiers="const"> @@ -450,7 +464,7 @@ <return type="void"> </return> <description> - Resets this AnimationTreePlayer. + Resets this [code]AnimationTreePlayer[/code]. </description> </method> <method name="timescale_node_get_scale" qualifiers="const"> @@ -471,6 +485,8 @@ </argument> <description> Sets the time scale of the TimeScale node with name [code]id[/code] to [code]scale[/code]. + The timescale node is used to speed [Animation]s up if the scale is above 1 or slow them down if it is below 1. + If applied after a blend or mix, affects all input animations to that blend or mix. </description> </method> <method name="timeseek_node_seek"> @@ -482,6 +498,7 @@ </argument> <description> Sets the time seek value of the TimeSeek node with name [code]id[/code] to [code]seconds[/code] + This functions as a seek in the [Animation] or the blend or mix of [Animation]s input in it. </description> </method> <method name="transition_node_delete_input"> @@ -510,7 +527,7 @@ <argument index="0" name="id" type="String"> </argument> <description> - Returns the number of inputs for the transition node with name [code]id[/code]. + Returns the number of inputs for the transition node with name [code]id[/code]. You can add inputs by rightclicking on the transition node. </description> </method> <method name="transition_node_get_xfade_time" qualifiers="const"> @@ -586,9 +603,11 @@ </member> <member name="base_path" type="NodePath" setter="set_base_path" getter="get_base_path"> The node from which to relatively access other nodes. Default value: [code]".."[/code]. + It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at. </member> <member name="master_player" type="NodePath" setter="set_master_player" getter="get_master_player"> The path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes. + Once set, Animation nodes can be added to the AnimationTreePlayer. </member> <member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationTreePlayer.AnimationProcessMode"> The thread in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index b74e767fd2..2853159c0e 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Area" inherits="CollisionObject" category="Core" version="3.0-beta"> +<class name="Area" inherits="CollisionObject" category="Core" version="3.0-stable"> <brief_description> General purpose area node for detection and 3D physics influence. </brief_description> @@ -33,14 +33,14 @@ <return type="Array"> </return> <description> - Returns a list of intersecting [code]Area[/code]s. + Returns a list of intersecting [code]Area[/code]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Returns a list of intersecting [PhysicsBody]s. + Returns a list of intersecting [PhysicsBody]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="overlaps_area" qualifiers="const"> @@ -49,7 +49,7 @@ <argument index="0" name="area" type="Node"> </argument> <description> - If [code]true[/code] the given area overlaps the Area. + If [code]true[/code] the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. </description> </method> <method name="overlaps_body" qualifiers="const"> @@ -58,7 +58,7 @@ <argument index="0" name="body" type="Node"> </argument> <description> - If [code]true[/code] the given body overlaps the Area. + If [code]true[/code] the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. </description> </method> <method name="set_collision_layer_bit"> diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 6a3f0e7645..8e8382d5de 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Area2D" inherits="CollisionObject2D" category="Core" version="3.0-beta"> +<class name="Area2D" inherits="CollisionObject2D" category="Core" version="3.0-stable"> <brief_description> 2D area for detection and 2D physics influence. </brief_description> @@ -33,14 +33,14 @@ <return type="Array"> </return> <description> - Returns a list of intersecting [code]Area2D[/code]s. + Returns a list of intersecting [code]Area2D[/code]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Returns a list of intersecting [PhysicsBody2D]s. + Returns a list of intersecting [PhysicsBody2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="overlaps_area" qualifiers="const"> @@ -49,7 +49,7 @@ <argument index="0" name="area" type="Node"> </argument> <description> - If [code]true[/code] the given area overlaps the Area2D. + If [code]true[/code] the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. </description> </method> <method name="overlaps_body" qualifiers="const"> @@ -58,7 +58,7 @@ <argument index="0" name="body" type="Node"> </argument> <description> - If [code]true[/code] the given body overlaps the Area2D. + If [code]true[/code] the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. </description> </method> <method name="set_collision_layer_bit"> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 9445a1732e..4d282761fe 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Array" category="Built-In Types" version="3.0-beta"> +<class name="Array" category="Built-In Types" version="3.0-stable"> <brief_description> Generic array datatype. </brief_description> diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 92c4fe2fe7..7b74b678bd 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ArrayMesh" inherits="Mesh" category="Core" version="3.0-beta"> +<class name="ArrayMesh" inherits="Mesh" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -51,12 +51,6 @@ <description> </description> </method> - <method name="get_blend_shape_mode" qualifiers="const"> - <return type="int" enum="Mesh.BlendShapeMode"> - </return> - <description> - </description> - </method> <method name="get_blend_shape_name" qualifiers="const"> <return type="String"> </return> @@ -65,12 +59,6 @@ <description> </description> </method> - <method name="get_custom_aabb" qualifiers="const"> - <return type="AABB"> - </return> - <description> - </description> - </method> <method name="get_surface_count" qualifiers="const"> <return type="int"> </return> @@ -84,22 +72,6 @@ <description> </description> </method> - <method name="set_blend_shape_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Mesh.BlendShapeMode"> - </argument> - <description> - </description> - </method> - <method name="set_custom_aabb"> - <return type="void"> - </return> - <argument index="0" name="aabb" type="AABB"> - </argument> - <description> - </description> - </method> <method name="surface_get_array_index_len" qualifiers="const"> <return type="int"> </return> @@ -212,6 +184,12 @@ </description> </method> </methods> + <members> + <member name="blend_shape_mode" type="int" setter="set_blend_shape_mode" getter="get_blend_shape_mode" enum="Mesh.BlendShapeMode"> + </member> + <member name="custom_aabb" type="AABB" setter="set_custom_aabb" getter="get_custom_aabb"> + </member> + </members> <constants> <constant name="NO_INDEX_ARRAY" value="-1"> Default value used for index_array_len when no indices are present. diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index f1a79bc312..87cd072d99 100644 --- a/doc/classes/AtlasTexture.xml +++ b/doc/classes/AtlasTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AtlasTexture" inherits="Texture" category="Core" version="3.0-beta"> +<class name="AtlasTexture" inherits="Texture" category="Core" version="3.0-stable"> <brief_description> Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls. </brief_description> diff --git a/doc/classes/AudioBusLayout.xml b/doc/classes/AudioBusLayout.xml index a70a3e1702..d960093fc6 100644 --- a/doc/classes/AudioBusLayout.xml +++ b/doc/classes/AudioBusLayout.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioBusLayout" inherits="Resource" category="Core" version="3.0-beta"> +<class name="AudioBusLayout" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Stores information about the audiobusses. </brief_description> diff --git a/doc/classes/AudioEffect.xml b/doc/classes/AudioEffect.xml index 0122f727d0..81c72e34b2 100644 --- a/doc/classes/AudioEffect.xml +++ b/doc/classes/AudioEffect.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffect" inherits="Resource" category="Core" version="3.0-beta"> +<class name="AudioEffect" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Audio Effect For Audio. </brief_description> diff --git a/doc/classes/AudioEffectAmplify.xml b/doc/classes/AudioEffectAmplify.xml index efdf6c3b9b..7a031f7f47 100644 --- a/doc/classes/AudioEffectAmplify.xml +++ b/doc/classes/AudioEffectAmplify.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectAmplify" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectAmplify" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Adds a Amplify audio effect to an Audio bus. Increases or decreases the volume of the selected audio bus. diff --git a/doc/classes/AudioEffectBandLimitFilter.xml b/doc/classes/AudioEffectBandLimitFilter.xml index 64542e8b92..592735e098 100644 --- a/doc/classes/AudioEffectBandLimitFilter.xml +++ b/doc/classes/AudioEffectBandLimitFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> +<class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" category="Core" version="3.0-stable"> <brief_description> Adds a band limit filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectBandPassFilter.xml b/doc/classes/AudioEffectBandPassFilter.xml index dbc8b2c85a..3705590c83 100644 --- a/doc/classes/AudioEffectBandPassFilter.xml +++ b/doc/classes/AudioEffectBandPassFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> +<class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-stable"> <brief_description> Adds a band pass filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml index 465fda28da..4bcd0e2552 100644 --- a/doc/classes/AudioEffectChorus.xml +++ b/doc/classes/AudioEffectChorus.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectChorus" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectChorus" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Adds a chorus audio effect. </brief_description> diff --git a/doc/classes/AudioEffectCompressor.xml b/doc/classes/AudioEffectCompressor.xml index dd9d6481e2..4fd28326a2 100644 --- a/doc/classes/AudioEffectCompressor.xml +++ b/doc/classes/AudioEffectCompressor.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectCompressor" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectCompressor" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Adds a Compressor audio effect to an Audio bus. Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume. diff --git a/doc/classes/AudioEffectDelay.xml b/doc/classes/AudioEffectDelay.xml index c961f1f582..d253ffab96 100644 --- a/doc/classes/AudioEffectDelay.xml +++ b/doc/classes/AudioEffectDelay.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectDelay" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectDelay" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Adds a Delay audio effect to an Audio bus. Plays input signal back after a period of time. Two tap delay and feedback options. diff --git a/doc/classes/AudioEffectDistortion.xml b/doc/classes/AudioEffectDistortion.xml index fd77a91570..91a1961b30 100644 --- a/doc/classes/AudioEffectDistortion.xml +++ b/doc/classes/AudioEffectDistortion.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectDistortion" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectDistortion" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Adds a Distortion audio effect to an Audio bus. Modify the sound to make it dirty. diff --git a/doc/classes/AudioEffectEQ.xml b/doc/classes/AudioEffectEQ.xml index a78b9e4bb1..667982d529 100644 --- a/doc/classes/AudioEffectEQ.xml +++ b/doc/classes/AudioEffectEQ.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectEQ" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectEQ" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Base class for audio equalizers. Gives you control over frequencies. Use it to create a custom equalizer if [AudioEffectEQ6], [AudioEffectEQ10] or [AudioEffectEQ21] don't fit your needs. diff --git a/doc/classes/AudioEffectEQ10.xml b/doc/classes/AudioEffectEQ10.xml index 9a007f80b1..9e5303a266 100644 --- a/doc/classes/AudioEffectEQ10.xml +++ b/doc/classes/AudioEffectEQ10.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectEQ10" inherits="AudioEffectEQ" category="Core" version="3.0-beta"> +<class name="AudioEffectEQ10" inherits="AudioEffectEQ" category="Core" version="3.0-stable"> <brief_description> Adds a 10-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 31 Hz to 16000 Hz. Each frequency can be modulated between -60/+24 dB. diff --git a/doc/classes/AudioEffectEQ21.xml b/doc/classes/AudioEffectEQ21.xml index 6e13291895..ec0db8bbbe 100644 --- a/doc/classes/AudioEffectEQ21.xml +++ b/doc/classes/AudioEffectEQ21.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectEQ21" inherits="AudioEffectEQ" category="Core" version="3.0-beta"> +<class name="AudioEffectEQ21" inherits="AudioEffectEQ" category="Core" version="3.0-stable"> <brief_description> Adds a 21-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 22 Hz to 22000 Hz. Each frequency can be modulated between -60/+24 dB. diff --git a/doc/classes/AudioEffectEQ6.xml b/doc/classes/AudioEffectEQ6.xml index ecfc7afeed..f5748f0a36 100644 --- a/doc/classes/AudioEffectEQ6.xml +++ b/doc/classes/AudioEffectEQ6.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectEQ6" inherits="AudioEffectEQ" category="Core" version="3.0-beta"> +<class name="AudioEffectEQ6" inherits="AudioEffectEQ" category="Core" version="3.0-stable"> <brief_description> Adds a 6-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 32 Hz to 10000 Hz. Each frequency can be modulated between -60/+24 dB. diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml index 3e1848f314..9c0eb38612 100644 --- a/doc/classes/AudioEffectFilter.xml +++ b/doc/classes/AudioEffectFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Adds a filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectHighPassFilter.xml b/doc/classes/AudioEffectHighPassFilter.xml index ac57ec0d2f..451c65a228 100644 --- a/doc/classes/AudioEffectHighPassFilter.xml +++ b/doc/classes/AudioEffectHighPassFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> +<class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-stable"> <brief_description> Adds a high pass filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectHighShelfFilter.xml b/doc/classes/AudioEffectHighShelfFilter.xml index 9496fcbffe..a26d4a4e6b 100644 --- a/doc/classes/AudioEffectHighShelfFilter.xml +++ b/doc/classes/AudioEffectHighShelfFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectHighShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> +<class name="AudioEffectHighShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/AudioEffectLimiter.xml b/doc/classes/AudioEffectLimiter.xml index e641be782d..b6fe7b74e5 100644 --- a/doc/classes/AudioEffectLimiter.xml +++ b/doc/classes/AudioEffectLimiter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectLimiter" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectLimiter" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Adds a soft clip Limiter audio effect to an Audio bus. </brief_description> diff --git a/doc/classes/AudioEffectLowPassFilter.xml b/doc/classes/AudioEffectLowPassFilter.xml index 50d66e874e..25c80e2ea0 100644 --- a/doc/classes/AudioEffectLowPassFilter.xml +++ b/doc/classes/AudioEffectLowPassFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> +<class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0-stable"> <brief_description> Adds a low pass filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectLowShelfFilter.xml b/doc/classes/AudioEffectLowShelfFilter.xml index 689faba672..f60429ca15 100644 --- a/doc/classes/AudioEffectLowShelfFilter.xml +++ b/doc/classes/AudioEffectLowShelfFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectLowShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> +<class name="AudioEffectLowShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/AudioEffectNotchFilter.xml b/doc/classes/AudioEffectNotchFilter.xml index dc160ae3e6..ac78d9c3e5 100644 --- a/doc/classes/AudioEffectNotchFilter.xml +++ b/doc/classes/AudioEffectNotchFilter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" category="Core" version="3.0-beta"> +<class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" category="Core" version="3.0-stable"> <brief_description> Adds a notch filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectPanner.xml b/doc/classes/AudioEffectPanner.xml index 05a6444a1e..493e83393a 100644 --- a/doc/classes/AudioEffectPanner.xml +++ b/doc/classes/AudioEffectPanner.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectPanner" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectPanner" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Adds a Panner audio effect to an Audio bus. Pans sound left or right. </brief_description> diff --git a/doc/classes/AudioEffectPhaser.xml b/doc/classes/AudioEffectPhaser.xml index 6b82a4d32a..3cc89e73f8 100644 --- a/doc/classes/AudioEffectPhaser.xml +++ b/doc/classes/AudioEffectPhaser.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectPhaser" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectPhaser" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Adds a Phaser audio effect to an Audio bus. Combines the original signal with a copy that is slightly out of phase with the original. diff --git a/doc/classes/AudioEffectPitchShift.xml b/doc/classes/AudioEffectPitchShift.xml index a6d2bef9ff..b0e7dbc049 100644 --- a/doc/classes/AudioEffectPitchShift.xml +++ b/doc/classes/AudioEffectPitchShift.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectPitchShift" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectPitchShift" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Adds a Pitch shift audio effect to an Audio bus. Raises or lowers the pitch of original sound. diff --git a/doc/classes/AudioEffectReverb.xml b/doc/classes/AudioEffectReverb.xml index 13bc66f6f3..46d1866ff0 100644 --- a/doc/classes/AudioEffectReverb.xml +++ b/doc/classes/AudioEffectReverb.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectReverb" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectReverb" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> Adds a Reverb audio effect to an Audio bus. Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces. @@ -12,20 +12,6 @@ <demos> </demos> <methods> - <method name="get_predelay_feedback" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_predelay_feedback"> - <return type="void"> - </return> - <argument index="0" name="feedback" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="damping" type="float" setter="set_damping" getter="get_damping"> diff --git a/doc/classes/AudioEffectStereoEnhance.xml b/doc/classes/AudioEffectStereoEnhance.xml index 006145c0f1..6e6e9af5c6 100644 --- a/doc/classes/AudioEffectStereoEnhance.xml +++ b/doc/classes/AudioEffectStereoEnhance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectStereoEnhance" inherits="AudioEffect" category="Core" version="3.0-beta"> +<class name="AudioEffectStereoEnhance" inherits="AudioEffect" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 1d861d5a4f..a6352bca1e 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioServer" inherits="Object" category="Core" version="3.0-beta"> +<class name="AudioServer" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Server interface for low level audio access. </brief_description> @@ -7,6 +7,7 @@ AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/audio/audio_buses.html </tutorials> <demos> </demos> diff --git a/doc/classes/AudioStream.xml b/doc/classes/AudioStream.xml index 342382ca05..f06ca0f901 100644 --- a/doc/classes/AudioStream.xml +++ b/doc/classes/AudioStream.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStream" inherits="Resource" category="Core" version="3.0-beta"> +<class name="AudioStream" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Base class for audio streams. </brief_description> @@ -7,6 +7,7 @@ Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a [Sample]. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/audio/audio_streams.html </tutorials> <demos> </demos> diff --git a/doc/classes/AudioStreamPlayback.xml b/doc/classes/AudioStreamPlayback.xml index 663b2b57a4..3babff52d1 100644 --- a/doc/classes/AudioStreamPlayback.xml +++ b/doc/classes/AudioStreamPlayback.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamPlayback" inherits="Reference" category="Core" version="3.0-beta"> +<class name="AudioStreamPlayback" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Meta class for playing back audio. </brief_description> diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 032473113c..e2cb442c36 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamPlayer" inherits="Node" category="Core" version="3.0-beta"> +<class name="AudioStreamPlayer" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Plays back audio. </brief_description> @@ -8,6 +8,7 @@ </description> <tutorials> http://docs.godotengine.org/en/latest/learning/features/audio/index.html + http://docs.godotengine.org/en/3.0/tutorials/audio/audio_streams.html </tutorials> <demos> </demos> diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 63e569ee39..2abb86472b 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamPlayer2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="AudioStreamPlayer2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Plays audio in 2D. </brief_description> @@ -8,6 +8,7 @@ </description> <tutorials> http://docs.godotengine.org/en/latest/learning/features/audio/index.html + http://docs.godotengine.org/en/3.0/tutorials/audio/audio_streams.html </tutorials> <demos> </demos> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 21edfd12d5..a40a6b4f96 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamPlayer3D" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="AudioStreamPlayer3D" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Plays 3D sound in 3D space </brief_description> @@ -8,6 +8,7 @@ </description> <tutorials> http://docs.godotengine.org/en/latest/learning/features/audio/index.html + http://docs.godotengine.org/en/3.0/tutorials/audio/audio_streams.html </tutorials> <demos> </demos> diff --git a/doc/classes/AudioStreamRandomPitch.xml b/doc/classes/AudioStreamRandomPitch.xml index 24d6f8965a..a78c412f26 100644 --- a/doc/classes/AudioStreamRandomPitch.xml +++ b/doc/classes/AudioStreamRandomPitch.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamRandomPitch" inherits="AudioStream" category="Core" version="3.0-beta"> +<class name="AudioStreamRandomPitch" inherits="AudioStream" category="Core" version="3.0-stable"> <brief_description> Plays audio with random pitch tweaking. </brief_description> diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 83e9729bc1..8e11a870ca 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.0-beta"> +<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.0-stable"> <brief_description> Plays audio. </brief_description> @@ -11,20 +11,6 @@ <demos> </demos> <methods> - <method name="get_data" qualifiers="const"> - <return type="PoolByteArray"> - </return> - <description> - </description> - </method> - <method name="set_data"> - <return type="void"> - </return> - <argument index="0" name="data" type="PoolByteArray"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format"> diff --git a/doc/classes/BackBufferCopy.xml b/doc/classes/BackBufferCopy.xml index 122e0c7fae..e11b55a6a0 100644 --- a/doc/classes/BackBufferCopy.xml +++ b/doc/classes/BackBufferCopy.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BackBufferCopy" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="BackBufferCopy" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction. </brief_description> diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml index b23b608589..a9033906dc 100644 --- a/doc/classes/BakedLightmap.xml +++ b/doc/classes/BakedLightmap.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BakedLightmap" inherits="VisualInstance" category="Core" version="3.0-beta"> +<class name="BakedLightmap" inherits="VisualInstance" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/3d/baked_lightmaps.html </tutorials> <demos> </demos> diff --git a/doc/classes/BakedLightmapData.xml b/doc/classes/BakedLightmapData.xml index 2b95cff136..0fcd984c5e 100644 --- a/doc/classes/BakedLightmapData.xml +++ b/doc/classes/BakedLightmapData.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BakedLightmapData" inherits="Resource" category="Core" version="3.0-beta"> +<class name="BakedLightmapData" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -27,30 +27,6 @@ <description> </description> </method> - <method name="get_bounds" qualifiers="const"> - <return type="AABB"> - </return> - <description> - </description> - </method> - <method name="get_cell_space_transform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - </description> - </method> - <method name="get_cell_subdiv" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_octree" qualifiers="const"> - <return type="PoolByteArray"> - </return> - <description> - </description> - </method> <method name="get_user_count" qualifiers="const"> <return type="int"> </return> @@ -73,42 +49,18 @@ <description> </description> </method> - <method name="set_bounds"> - <return type="void"> - </return> - <argument index="0" name="bounds" type="AABB"> - </argument> - <description> - </description> - </method> - <method name="set_cell_space_transform"> - <return type="void"> - </return> - <argument index="0" name="xform" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="set_cell_subdiv"> - <return type="void"> - </return> - <argument index="0" name="cell_subdiv" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_octree"> - <return type="void"> - </return> - <argument index="0" name="octree" type="PoolByteArray"> - </argument> - <description> - </description> - </method> </methods> <members> + <member name="bounds" type="AABB" setter="set_bounds" getter="get_bounds"> + </member> + <member name="cell_space_transform" type="Transform" setter="set_cell_space_transform" getter="get_cell_space_transform"> + </member> + <member name="cell_subdiv" type="int" setter="set_cell_subdiv" getter="get_cell_subdiv"> + </member> <member name="energy" type="float" setter="set_energy" getter="get_energy"> </member> + <member name="octree" type="PoolByteArray" setter="set_octree" getter="get_octree"> + </member> </members> <constants> </constants> diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 7f1aaa6822..6d7ee544e4 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BaseButton" inherits="Control" category="Core" version="3.0-beta"> +<class name="BaseButton" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Base class for different kinds of buttons. </brief_description> @@ -21,7 +21,7 @@ <method name="_toggled" qualifiers="virtual"> <return type="void"> </return> - <argument index="0" name="pressed" type="bool"> + <argument index="0" name="button_pressed" type="bool"> </argument> <description> Called when button is toggled (only if toggle_mode is active). @@ -82,7 +82,7 @@ </description> </signal> <signal name="toggled"> - <argument index="0" name="pressed" type="bool"> + <argument index="0" name="button_pressed" type="bool"> </argument> <description> This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the [i]pressed[/i] argument. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 1573596487..c90dfeea27 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Basis" category="Built-In Types" version="3.0-beta"> +<class name="Basis" category="Built-In Types" version="3.0-stable"> <brief_description> 3x3 matrix datatype. </brief_description> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index 39bf46ac3d..f85c538456 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BitMap" inherits="Resource" category="Core" version="3.0-beta"> +<class name="BitMap" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Boolean matrix. </brief_description> diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml index 2fb7d7d87a..77c1e0949c 100644 --- a/doc/classes/BitmapFont.xml +++ b/doc/classes/BitmapFont.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BitmapFont" inherits="Font" category="Core" version="3.0-beta"> +<class name="BitmapFont" inherits="Font" category="Core" version="3.0-stable"> <brief_description> Renders text using [code]*.fnt[/code] fonts. </brief_description> diff --git a/doc/classes/BoneAttachment.xml b/doc/classes/BoneAttachment.xml index b7f21ebf0c..77c8bd603e 100644 --- a/doc/classes/BoneAttachment.xml +++ b/doc/classes/BoneAttachment.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BoneAttachment" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="BoneAttachment" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> A node that will attach to a bone. </brief_description> @@ -11,23 +11,12 @@ <demos> </demos> <methods> - <method name="get_bone_name" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the name of the bone node attached to. - </description> - </method> - <method name="set_bone_name"> - <return type="void"> - </return> - <argument index="0" name="bone_name" type="String"> - </argument> - <description> - Changes the name of the bone node - </description> - </method> </methods> + <members> + <member name="bone_name" type="String" setter="set_bone_name" getter="get_bone_name"> + The name of the attached bone. + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml index 7003158387..b509e83985 100644 --- a/doc/classes/BoxContainer.xml +++ b/doc/classes/BoxContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BoxContainer" inherits="Container" category="Core" version="3.0-beta"> +<class name="BoxContainer" inherits="Container" category="Core" version="3.0-stable"> <brief_description> Base class for box containers. </brief_description> diff --git a/doc/classes/BoxShape.xml b/doc/classes/BoxShape.xml index 4a4b528449..00b4b6bdbb 100644 --- a/doc/classes/BoxShape.xml +++ b/doc/classes/BoxShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BoxShape" inherits="Shape" category="Core" version="3.0-beta"> +<class name="BoxShape" inherits="Shape" category="Core" version="3.0-stable"> <brief_description> Box shape resource. </brief_description> diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index 854f1cc7c3..bc1608baf8 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Button" inherits="BaseButton" category="Core" version="3.0-beta"> +<class name="Button" inherits="BaseButton" category="Core" version="3.0-stable"> <brief_description> Standard themed Button. </brief_description> diff --git a/doc/classes/ButtonGroup.xml b/doc/classes/ButtonGroup.xml index 2c857371f9..19a75843e1 100644 --- a/doc/classes/ButtonGroup.xml +++ b/doc/classes/ButtonGroup.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ButtonGroup" inherits="Resource" category="Core" version="3.0-beta"> +<class name="ButtonGroup" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Group of Buttons. </brief_description> diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index c2ae9101e1..e481799c5c 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Camera" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="Camera" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Camera node, displays from a point of view. </brief_description> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index c95691d07f..f3825019a2 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Camera2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="Camera2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Camera node for 2D scenes. </brief_description> @@ -47,27 +47,6 @@ Returns the location of the [code]Camera2D[/code]'s screen-center, relative to the origin. </description> </method> - <method name="get_custom_viewport" qualifiers="const"> - <return type="Node"> - </return> - <description> - Returns the [Viewport] used by the camera if it is not using the default viewport. - </description> - </method> - <method name="get_h_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the horizontal offset of the camera. - </description> - </method> - <method name="get_v_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the vertical offset of the camera. - </description> - </method> <method name="make_current"> <return type="void"> </return> @@ -83,33 +62,6 @@ This has no effect if smoothing is disabled. </description> </method> - <method name="set_custom_viewport"> - <return type="void"> - </return> - <argument index="0" name="viewport" type="Node"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_h_offset"> - <return type="void"> - </return> - <argument index="0" name="ofs" type="float"> - </argument> - <description> - The camera's horizontal offset is set to [code]ofs[/code]. - </description> - </method> - <method name="set_v_offset"> - <return type="void"> - </return> - <argument index="0" name="ofs" type="float"> - </argument> - <description> - The camera's vertical offset is set to [code]ofs[/code]. - </description> - </method> </methods> <members> <member name="anchor_mode" type="int" setter="set_anchor_mode" getter="get_anchor_mode" enum="Camera2D.AnchorMode"> @@ -118,6 +70,9 @@ <member name="current" type="bool" setter="_set_current" getter="is_current"> 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. </member> + <member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport"> + The custom [Viewport] node attached to the [code]Camera2D[/code]. If null or not a [Viewport], uses the default viewport instead. + </member> <member name="drag_margin_bottom" type="float" setter="set_drag_margin" getter="get_drag_margin"> 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. </member> @@ -163,6 +118,12 @@ <member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> The camera's offset, useful for looking around or camera shake animations. </member> + <member name="offset_h" type="float" setter="set_h_offset" getter="get_h_offset"> + The horizontal offset of the camera, relative to the drag margins. Default value: [code]0[/code] + </member> + <member name="offset_v" type="float" setter="set_v_offset" getter="get_v_offset"> + The vertical offset of the camera, relative to the drag margins. Default value: [code]0[/code] + </member> <member name="rotating" type="bool" setter="set_rotating" getter="is_rotating"> If [code]true[/code] the camera rotates with the target. Default value: [code]false[/code] </member> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index bd20cfcf5d..bb3d4938b8 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CanvasItem" inherits="Node" category="Core" version="3.0-beta"> +<class name="CanvasItem" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Base class of anything 2D. </brief_description> @@ -11,6 +11,8 @@ Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/2d/2d_transforms.html + http://docs.godotengine.org/en/3.0/tutorials/2d/custom_drawing_in_2d.html </tutorials> <demos> </demos> @@ -413,7 +415,7 @@ <return type="bool"> </return> <description> - Returns [code]true[/code] if the node is in the [SceneTree] and is visible on-screen. + Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and its inherited visibility is also [code]true[/code]. </description> </method> <method name="make_canvas_position_local" qualifiers="const"> diff --git a/doc/classes/CanvasItemMaterial.xml b/doc/classes/CanvasItemMaterial.xml index 81709227ad..5ec32bc63d 100644 --- a/doc/classes/CanvasItemMaterial.xml +++ b/doc/classes/CanvasItemMaterial.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CanvasItemMaterial" inherits="Material" category="Core" version="3.0-beta"> +<class name="CanvasItemMaterial" inherits="Material" category="Core" version="3.0-stable"> <brief_description> A material for [CanvasItem]s. </brief_description> diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 01c2dd6ba9..3b7ba5b1ad 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CanvasLayer" inherits="Node" category="Core" version="3.0-beta"> +<class name="CanvasLayer" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Canvas drawing layer. </brief_description> @@ -7,31 +7,12 @@ Canvas drawing layer. [CanvasItem] nodes that are direct or indirect children of a [code]CanvasLayer[/code] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [code]CanvasLayer[/code] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/2d/2d_transforms.html + http://docs.godotengine.org/en/3.0/tutorials/2d/canvas_layers.html </tutorials> <demos> </demos> <methods> - <method name="get_custom_viewport" qualifiers="const"> - <return type="Node"> - </return> - <description> - Returns the [Viewport] used by the camera if it is not using the default viewport. - </description> - </method> - <method name="get_rotation" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the base rotation for this layer in radians (helper). - </description> - </method> - <method name="get_transform" qualifiers="const"> - <return type="Transform2D"> - </return> - <description> - Return the base transform for this layer. - </description> - </method> <method name="get_world_2d" qualifiers="const"> <return type="World2D"> </return> @@ -39,47 +20,29 @@ Return the [World2D] used by this layer. </description> </method> - <method name="set_custom_viewport"> - <return type="void"> - </return> - <argument index="0" name="viewport" type="Node"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_rotation"> - <return type="void"> - </return> - <argument index="0" name="radians" type="float"> - </argument> - <description> - Set the base rotation for this layer in radians (helper). - </description> - </method> - <method name="set_transform"> - <return type="void"> - </return> - <argument index="0" name="transform" type="Transform2D"> - </argument> - <description> - Set the base transform for this layer. - </description> - </method> </methods> <members> + <member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport"> + The custom [Viewport] node assigned to the [code]CanvasLayer[/code]. If null, uses the default viewport instead. + </member> <member name="layer" type="int" setter="set_layer" getter="get_layer"> Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code]. </member> <member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> The layer's base offset. </member> - <member name="rotation" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees"> + <member name="rotation" type="float" setter="set_rotation" getter="get_rotation"> + The layer's rotation in radians. + </member> + <member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees"> The layer's rotation in degrees. </member> <member name="scale" type="Vector2" setter="set_scale" getter="get_scale"> The layer's scale. </member> + <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform"> + The layer's transform. + </member> </members> <constants> </constants> diff --git a/doc/classes/CanvasModulate.xml b/doc/classes/CanvasModulate.xml index 117230db1c..827502d6c0 100644 --- a/doc/classes/CanvasModulate.xml +++ b/doc/classes/CanvasModulate.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CanvasModulate" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="CanvasModulate" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Tint the entire canvas. </brief_description> diff --git a/doc/classes/CapsuleMesh.xml b/doc/classes/CapsuleMesh.xml index 715bd7ac5a..3a291128c7 100644 --- a/doc/classes/CapsuleMesh.xml +++ b/doc/classes/CapsuleMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CapsuleMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> +<class name="CapsuleMesh" inherits="PrimitiveMesh" category="Core" version="3.0-stable"> <brief_description> Class representing a capsule-shaped [PrimitiveMesh]. </brief_description> diff --git a/doc/classes/CapsuleShape.xml b/doc/classes/CapsuleShape.xml index 25f5b8eb35..1ff4f5aa00 100644 --- a/doc/classes/CapsuleShape.xml +++ b/doc/classes/CapsuleShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CapsuleShape" inherits="Shape" category="Core" version="3.0-beta"> +<class name="CapsuleShape" inherits="Shape" category="Core" version="3.0-stable"> <brief_description> Capsule shape for collisions. </brief_description> diff --git a/doc/classes/CapsuleShape2D.xml b/doc/classes/CapsuleShape2D.xml index 75a69546aa..0b306643b9 100644 --- a/doc/classes/CapsuleShape2D.xml +++ b/doc/classes/CapsuleShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CapsuleShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> +<class name="CapsuleShape2D" inherits="Shape2D" category="Core" version="3.0-stable"> <brief_description> Capsule shape for 2D collisions. </brief_description> diff --git a/doc/classes/CenterContainer.xml b/doc/classes/CenterContainer.xml index 6235a3fec4..a4e17bf0b6 100644 --- a/doc/classes/CenterContainer.xml +++ b/doc/classes/CenterContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CenterContainer" inherits="Container" category="Core" version="3.0-beta"> +<class name="CenterContainer" inherits="Container" category="Core" version="3.0-stable"> <brief_description> Keeps children controls centered. </brief_description> diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index f38b43cf8c..25340ed284 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CheckBox" inherits="Button" category="Core" version="3.0-beta"> +<class name="CheckBox" inherits="Button" category="Core" version="3.0-stable"> <brief_description> Binary choice user interface widget </brief_description> diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml index 77de3c17fc..ec214fc498 100644 --- a/doc/classes/CheckButton.xml +++ b/doc/classes/CheckButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CheckButton" inherits="Button" category="Core" version="3.0-beta"> +<class name="CheckButton" inherits="Button" category="Core" version="3.0-stable"> <brief_description> Checkable button. </brief_description> diff --git a/doc/classes/CircleShape2D.xml b/doc/classes/CircleShape2D.xml index 1018790803..0c8b2088b3 100644 --- a/doc/classes/CircleShape2D.xml +++ b/doc/classes/CircleShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CircleShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> +<class name="CircleShape2D" inherits="Shape2D" category="Core" version="3.0-stable"> <brief_description> Circular shape for 2D collisions. </brief_description> diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index b4d4d0b448..e90a84f07c 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ClassDB" inherits="Object" category="Core" version="3.0-beta"> +<class name="ClassDB" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Class information repository. </brief_description> diff --git a/doc/classes/CollisionObject.xml b/doc/classes/CollisionObject.xml index 5d0984bcdf..8b397f3227 100644 --- a/doc/classes/CollisionObject.xml +++ b/doc/classes/CollisionObject.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionObject" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="CollisionObject" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Base node for collision objects. </brief_description> diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index 086513cad5..5b4ab46fd9 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionObject2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="CollisionObject2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Base node for 2D collision objects. </brief_description> diff --git a/doc/classes/CollisionPolygon.xml b/doc/classes/CollisionPolygon.xml index ff689e36f4..79c41e632e 100644 --- a/doc/classes/CollisionPolygon.xml +++ b/doc/classes/CollisionPolygon.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionPolygon" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="CollisionPolygon" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Editor-only class for defining a collision polygon in 3D space. </brief_description> diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml index 995b868f89..0b17e6d26e 100644 --- a/doc/classes/CollisionPolygon2D.xml +++ b/doc/classes/CollisionPolygon2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionPolygon2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="CollisionPolygon2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Defines a 2D collision polygon. </brief_description> diff --git a/doc/classes/CollisionShape.xml b/doc/classes/CollisionShape.xml index b893ee79ad..36a015ce80 100644 --- a/doc/classes/CollisionShape.xml +++ b/doc/classes/CollisionShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionShape" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="CollisionShape" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Node that represents collision shape data in 3D space. </brief_description> @@ -7,6 +7,7 @@ Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area] to give it a detection shape, or add it to a [PhysicsBody] to give create solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method get_shape] to get the actual shape. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html </tutorials> <demos> </demos> diff --git a/doc/classes/CollisionShape2D.xml b/doc/classes/CollisionShape2D.xml index 2ab9540196..ed5a094996 100644 --- a/doc/classes/CollisionShape2D.xml +++ b/doc/classes/CollisionShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionShape2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="CollisionShape2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Node that represents collision shape data in 2D space. </brief_description> @@ -7,6 +7,7 @@ Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area2D] to give it a detection shape, or add it to a [PhysicsBody2D] to give create solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method get_shape] to get the actual shape. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html </tutorials> <demos> </demos> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index ef555537a1..11c59531a8 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Color" category="Built-In Types" version="3.0-beta"> +<class name="Color" category="Built-In Types" version="3.0-stable"> <brief_description> Color in RGBA format with some support for ARGB format. </brief_description> @@ -204,8 +204,7 @@ var c = Color(1, .5, .2) print(str(c.to_32())) # prints 4294934323 [/codeblock] - - [i]This is same as [method to_ARGB32] but may be changed later to support RGBA format instead[/i]. + [i]This is same as [method to_argb32] but may be changed later to support RGBA format instead[/i]. </description> </method> </methods> diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index 192f139ba9..c69fc360a8 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ColorPicker" inherits="BoxContainer" category="Core" version="3.0-beta"> +<class name="ColorPicker" inherits="BoxContainer" category="Core" version="3.0-stable"> <brief_description> Color picker control. </brief_description> @@ -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. </description> </method> - <method name="get_pick_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - Gets the current color. - </description> - </method> - <method name="is_editing_alpha" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether the color has transparency or not. - </description> - </method> - <method name="is_raw_mode" qualifiers="const"> - <return type="bool"> - </return> - <description> - 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). - </description> - </method> - <method name="set_edit_alpha"> - <return type="void"> - </return> - <argument index="0" name="show" type="bool"> - </argument> - <description> - Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color. - </description> - </method> - <method name="set_pick_color"> - <return type="void"> - </return> - <argument index="0" name="color" type="Color"> - </argument> - <description> - Select the current color. - </description> - </method> - <method name="set_raw_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="bool"> - </argument> - <description> - Set whether this color picker is using raw mode or not, see [method is_raw_mode]. - </description> - </method> </methods> + <members> + <member name="color" type="Color" setter="set_pick_color" getter="get_pick_color"> + The currently selected color. + </member> + <member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha"> + If [code]true[/code], shows an alpha channel slider (transparency). + </member> + <member name="raw_mode" type="bool" setter="set_raw_mode" getter="is_raw_mode"> + 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). + </member> + </members> <signals> <signal name="color_changed"> <argument index="0" name="color" type="Color"> diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 87d00b7600..47fc198638 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ColorPickerButton" inherits="Button" category="Core" version="3.0-beta"> +<class name="ColorPickerButton" inherits="Button" category="Core" version="3.0-stable"> <brief_description> Button that pops out a [ColorPicker] </brief_description> diff --git a/doc/classes/ColorRect.xml b/doc/classes/ColorRect.xml index af1b0f57e2..332d0f573f 100644 --- a/doc/classes/ColorRect.xml +++ b/doc/classes/ColorRect.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ColorRect" inherits="Control" category="Core" version="3.0-beta"> +<class name="ColorRect" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Colored rect for canvas. </brief_description> diff --git a/doc/classes/ConcavePolygonShape.xml b/doc/classes/ConcavePolygonShape.xml index bae86d5b22..4700491921 100644 --- a/doc/classes/ConcavePolygonShape.xml +++ b/doc/classes/ConcavePolygonShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConcavePolygonShape" inherits="Shape" category="Core" version="3.0-beta"> +<class name="ConcavePolygonShape" inherits="Shape" category="Core" version="3.0-stable"> <brief_description> Concave polygon shape. </brief_description> diff --git a/doc/classes/ConcavePolygonShape2D.xml b/doc/classes/ConcavePolygonShape2D.xml index 1d2aabd6ea..c339ee65a0 100644 --- a/doc/classes/ConcavePolygonShape2D.xml +++ b/doc/classes/ConcavePolygonShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConcavePolygonShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> +<class name="ConcavePolygonShape2D" inherits="Shape2D" category="Core" version="3.0-stable"> <brief_description> Concave polygon 2D shape resource for physics. </brief_description> diff --git a/doc/classes/ConeTwistJoint.xml b/doc/classes/ConeTwistJoint.xml index 4fcacb6d46..b7a4894ea7 100644 --- a/doc/classes/ConeTwistJoint.xml +++ b/doc/classes/ConeTwistJoint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConeTwistJoint" inherits="Joint" category="Core" version="3.0-beta"> +<class name="ConeTwistJoint" inherits="Joint" category="Core" version="3.0-stable"> <brief_description> A twist joint between two 3D bodies </brief_description> diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index fcd8834b0c..17243b2100 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConfigFile" inherits="Reference" category="Core" version="3.0-beta"> +<class name="ConfigFile" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Helper class to handle INI-style files. </brief_description> diff --git a/doc/classes/ConfirmationDialog.xml b/doc/classes/ConfirmationDialog.xml index 77eb1bfc2c..2759c1b883 100644 --- a/doc/classes/ConfirmationDialog.xml +++ b/doc/classes/ConfirmationDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConfirmationDialog" inherits="AcceptDialog" category="Core" version="3.0-beta"> +<class name="ConfirmationDialog" inherits="AcceptDialog" category="Core" version="3.0-stable"> <brief_description> Dialog for confirmation of actions. </brief_description> diff --git a/doc/classes/Container.xml b/doc/classes/Container.xml index a2aa39414c..0447c80887 100644 --- a/doc/classes/Container.xml +++ b/doc/classes/Container.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Container" inherits="Control" category="Core" version="3.0-beta"> +<class name="Container" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Base node for containers. </brief_description> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 680e008ff1..9db93bb6a9 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Control" inherits="CanvasItem" category="Core" version="3.0-beta"> +<class name="Control" inherits="CanvasItem" category="Core" version="3.0-stable"> <brief_description> All User Interface nodes inherit from Control. Features anchors and margins to adapt its position and size to its parent. </brief_description> @@ -8,11 +8,13 @@ For more information on Godot's UI system, anchors, margins, and containers, see the related tutorials in the manual. To build flexible UIs, you'll need a mix of UI elements that inherit from [code]Control[/code] and [Container] nodes. [b]User Interface nodes and input[/b] Godot sends input events to the scene's root node first, by calling [method Node._input]. [method Node._input] forwards the event down the node tree to the nodes under the mouse cursor, or on keyboard focus. To do so, it calls [method MainLoop._input_event]. Call [method accept_event] so no other node receives the event. Once you accepted an input, it becomes handled so [method Node._unhandled_input] will not process it. - Only one [code]Control[/code] node can be in keyboard focus. Only the node in focus will receive keyboard events. To get the foucs, call [method set_focus_mode]. [code]Control[/code] nodes lose focus when another node grabs it, or if you hide the node in focus. - Call [method set_ignore_mouse] to tell a [code]Control[/code] node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. + Only one [code]Control[/code] node can be in keyboard focus. Only the node in focus will receive keyboard events. To get the focus, call [method grab_focus]. [code]Control[/code] nodes lose focus when another node grabs it, or if you hide the node in focus. + Set [member mouse_filter] to MOUSE_FILTER_IGNORE to tell a [code]Control[/code] node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. [Theme] resources change the Control's appearance. If you change the [Theme] on a [code]Control[/code] node, it affects all of its children. To override some of the theme's parameters, call one of the [code]add_*_override[/code] methods, like [method add_font_override]. You can override the theme with the inspector. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/gui/index.html + http://docs.godotengine.org/en/3.0/tutorials/2d/custom_drawing_in_2d.html </tutorials> <demos> </demos> @@ -96,7 +98,7 @@ Overrides the [code]name[/code] shader in the [theme] resource the node uses. If [code]shader[/code] is empty, Godot clears the override. </description> </method> - <method name="add_style_override"> + <method name="add_stylebox_override"> <return type="void"> </return> <argument index="0" name="name" type="String"> @@ -178,13 +180,6 @@ Returns the mouse cursor shape the control displays on mouse hover, one of the [code]CURSOR_*[/code] constants. </description> </method> - <method name="get_default_cursor_shape" qualifiers="const"> - <return type="int" enum="Control.CursorShape"> - </return> - <description> - Returns the default cursor shape for this control. See enum [code]CURSOR_*[/code] for the list of shapes. - </description> - </method> <method name="get_drag_data" qualifiers="virtual"> <return type="Object"> </return> @@ -200,13 +195,6 @@ Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). </description> </method> - <method name="get_focus_mode" qualifiers="const"> - <return type="int" enum="Control.FocusMode"> - </return> - <description> - Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]). - </description> - </method> <method name="get_focus_owner" qualifiers="const"> <return type="Control"> </return> @@ -224,13 +212,6 @@ <description> </description> </method> - <method name="get_global_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. - </description> - </method> <method name="get_global_rect" qualifiers="const"> <return type="Rect2"> </return> @@ -400,6 +381,14 @@ <description> </description> </method> + <method name="has_shader_override" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> <method name="has_stylebox" qualifiers="const"> <return type="bool"> </return> @@ -490,15 +479,6 @@ Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). </description> </method> - <method name="set_default_cursor_shape"> - <return type="void"> - </return> - <argument index="0" name="shape" type="int" enum="Control.CursorShape"> - </argument> - <description> - 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. - </description> - </method> <method name="set_drag_forwarding"> <return type="void"> </return> @@ -524,24 +504,6 @@ Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]). </description> </method> - <method name="set_focus_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Control.FocusMode"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_global_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <description> - 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]). - </description> - </method> <method name="set_margins_preset"> <return type="void"> </return> @@ -594,6 +556,9 @@ <member name="anchor_top" type="float" setter="_set_anchor" getter="get_anchor"> 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]. </member> + <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" enum="Control.FocusMode"> + 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. + </member> <member name="focus_neighbour_bottom" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour"> 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 +596,17 @@ <member name="margin_top" type="float" setter="set_margin" getter="get_margin"> Distance between the node's top edge and its parent container, based on [member anchor_top]. </member> + <member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" enum="Control.CursorShape"> + The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors. + </member> <member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" enum="Control.MouseFilter"> - Controls whether the control will be able to receive mouse button input events through [Control._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. + 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. </member> <member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents"> </member> + <member name="rect_global_position" type="Vector2" setter="set_global_position" getter="get_global_position"> + The node's global position, relative to the world (usually to the top-left corner of the window). + </member> <member name="rect_min_size" type="Vector2" setter="set_custom_minimum_size" getter="get_custom_minimum_size"> 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. </member> @@ -697,12 +668,12 @@ </signal> <signal name="mouse_entered"> <description> - Emitted when the mouse enters the control's [code]Rect[/code] area. + Emitted when the mouse enters the control's [code]Rect[/code] area, provided its [member mouse_filter] lets the event reach it. </description> </signal> <signal name="mouse_exited"> <description> - Emitted when the mouse leaves the control's [code]Rect[/code] area. + Emitted when the mouse leaves the control's [code]Rect[/code] area, provided its [member mouse_filter] lets the event reach it. </description> </signal> <signal name="resized"> @@ -870,13 +841,13 @@ Tells the parent [Container] to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with [member size_flags_horizontal] and [member size_flags_vertical]. </constant> <constant name="MOUSE_FILTER_STOP" value="0" enum="MouseFilter"> - The control will receive mouse button input events through [method Control._gui_input] if clicked on. These events are automatically marked as handled and they will not propogate further to other controls. + The control will receive mouse button input events through [method _gui_input] if clicked on. These events are automatically marked as handled and they will not propagate further to other controls. </constant> <constant name="MOUSE_FILTER_PASS" value="1" enum="MouseFilter"> - The control will receive mouse button input events through [method Control._gui_input] if clicked on. If this control does not handle the event, the parent control (if any) will be considered for a mouse click, and so on until there is no more parent control to potentially handle it. Even if no control handled it at all, the event will still be handled automatically. + The control will receive mouse button input events through [method _gui_input] if clicked on. If this control does not handle the event, the parent control (if any) will be considered for a mouse click, and so on until there is no more parent control to potentially handle it. Even if no control handled it at all, the event will still be handled automatically. </constant> <constant name="MOUSE_FILTER_IGNORE" value="2" enum="MouseFilter"> - The control will not receive mouse button input events through [method Control._gui_input] and will not block other controls from receiving these events. These events will also not be handled automatically. + The control will not receive mouse button input events through [method _gui_input] and will not block other controls from receiving these events. These events will also not be handled automatically. </constant> <constant name="GROW_DIRECTION_BEGIN" value="0" enum="GrowDirection"> </constant> diff --git a/doc/classes/ConvexPolygonShape.xml b/doc/classes/ConvexPolygonShape.xml index 5ed57a5c05..2b809ca80a 100644 --- a/doc/classes/ConvexPolygonShape.xml +++ b/doc/classes/ConvexPolygonShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConvexPolygonShape" inherits="Shape" category="Core" version="3.0-beta"> +<class name="ConvexPolygonShape" inherits="Shape" category="Core" version="3.0-stable"> <brief_description> Convex polygon shape for 3D physics. </brief_description> diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml index a670ddc9cd..b5ce052b4b 100644 --- a/doc/classes/ConvexPolygonShape2D.xml +++ b/doc/classes/ConvexPolygonShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConvexPolygonShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> +<class name="ConvexPolygonShape2D" inherits="Shape2D" category="Core" version="3.0-stable"> <brief_description> Convex Polygon Shape for 2D physics. </brief_description> diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml index 30022efd38..26fda49803 100644 --- a/doc/classes/CubeMap.xml +++ b/doc/classes/CubeMap.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CubeMap" inherits="Resource" category="Core" version="3.0-beta"> +<class name="CubeMap" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> A CubeMap is a 6 sided 3D texture. </brief_description> @@ -11,13 +11,6 @@ <demos> </demos> <methods> - <method name="get_flags" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details. - </description> - </method> <method name="get_height" qualifiers="const"> <return type="int"> </return> @@ -41,15 +34,6 @@ Returns the [code]CubeMap[/code]'s width. </description> </method> - <method name="set_flags"> - <return type="void"> - </return> - <argument index="0" name="flags" type="int"> - </argument> - <description> - Returns the render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details. - </description> - </method> <method name="set_side"> <return type="void"> </return> @@ -63,6 +47,9 @@ </method> </methods> <members> + <member name="flags" type="int" setter="set_flags" getter="get_flags"> + The render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details. + </member> <member name="lossy_storage_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality"> The lossy storage quality of the [code]CubeMap[/code] if the storage mode is set to STORAGE_COMPRESS_LOSSY. </member> diff --git a/doc/classes/CubeMesh.xml b/doc/classes/CubeMesh.xml index 56ca64e10a..c7ec4d9dfe 100644 --- a/doc/classes/CubeMesh.xml +++ b/doc/classes/CubeMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CubeMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> +<class name="CubeMesh" inherits="PrimitiveMesh" category="Core" version="3.0-stable"> <brief_description> Generate an axis-aligned cuboid [PrimitiveMesh]. </brief_description> diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index 8a007cc5cc..388d8ab54f 100644 --- a/doc/classes/Curve.xml +++ b/doc/classes/Curve.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Curve" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Curve" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> A mathematic curve. </brief_description> diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 8a857799e6..2dbfcbc6ec 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Curve2D" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Curve2D" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Describes a Bezier curve in 2D space. </brief_description> diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 91d7a9bed8..acb6b0d72f 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Curve3D" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Curve3D" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Describes a Bezier curve in 3D space. </brief_description> diff --git a/doc/classes/CurveTexture.xml b/doc/classes/CurveTexture.xml index f62da8a135..bc090d623a 100644 --- a/doc/classes/CurveTexture.xml +++ b/doc/classes/CurveTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CurveTexture" inherits="Texture" category="Core" version="3.0-beta"> +<class name="CurveTexture" inherits="Texture" category="Core" version="3.0-stable"> <brief_description> A texture that shows a curve. </brief_description> diff --git a/doc/classes/CylinderMesh.xml b/doc/classes/CylinderMesh.xml index 57c0027c4c..e57ffd2841 100644 --- a/doc/classes/CylinderMesh.xml +++ b/doc/classes/CylinderMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CylinderMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> +<class name="CylinderMesh" inherits="PrimitiveMesh" category="Core" version="3.0-stable"> <brief_description> Class representing a cylindrical [PrimitiveMesh]. </brief_description> diff --git a/doc/classes/DampedSpringJoint2D.xml b/doc/classes/DampedSpringJoint2D.xml index a49f03eb07..950817dc04 100644 --- a/doc/classes/DampedSpringJoint2D.xml +++ b/doc/classes/DampedSpringJoint2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="DampedSpringJoint2D" inherits="Joint2D" category="Core" version="3.0-beta"> +<class name="DampedSpringJoint2D" inherits="Joint2D" category="Core" version="3.0-stable"> <brief_description> Damped spring constraint for 2D physics. </brief_description> diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index 08c01c1d85..37845dbae4 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Dictionary" category="Built-In Types" version="3.0-beta"> +<class name="Dictionary" category="Built-In Types" version="3.0-stable"> <brief_description> Dictionary type. </brief_description> diff --git a/doc/classes/DirectionalLight.xml b/doc/classes/DirectionalLight.xml index 287c98e715..bbb8936a12 100644 --- a/doc/classes/DirectionalLight.xml +++ b/doc/classes/DirectionalLight.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="DirectionalLight" inherits="Light" category="Core" version="3.0-beta"> +<class name="DirectionalLight" inherits="Light" category="Core" version="3.0-stable"> <brief_description> Directional Light, such as the Sun or the Moon. </brief_description> @@ -7,6 +7,7 @@ A DirectionalLight is a type of [Light] node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html </tutorials> <demos> </demos> diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index c87d1ef006..bfd1e2872d 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Directory" inherits="Reference" category="Core" version="3.0-beta"> +<class name="Directory" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Type used to handle the filesystem. </brief_description> @@ -23,6 +23,7 @@ [/codeblock] </description> <tutorials> + http://docs.godotengine.org/en/3.0/getting_started/step_by_step/filesystem.html </tutorials> <demos> </demos> diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index eae7a1b02b..06291c1e61 100644 --- a/doc/classes/DynamicFont.xml +++ b/doc/classes/DynamicFont.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="DynamicFont" inherits="Font" category="Core" version="3.0-beta"> +<class name="DynamicFont" inherits="Font" category="Core" version="3.0-stable"> <brief_description> DynamicFont renders vector font files at runtime. </brief_description> diff --git a/doc/classes/DynamicFontData.xml b/doc/classes/DynamicFontData.xml index 360f0cb0d8..5f4e598f36 100644 --- a/doc/classes/DynamicFontData.xml +++ b/doc/classes/DynamicFontData.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="DynamicFontData" inherits="Resource" category="Core" version="3.0-beta"> +<class name="DynamicFontData" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Used with [DynamicFont] to describe the location of a font file. </brief_description> diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index ef430d31be..ede892e7ef 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorExportPlugin" inherits="Reference" category="Core" version="3.0-beta"> +<class name="EditorExportPlugin" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index 1a1c382e59..b3a12dbede 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorFileDialog" inherits="ConfirmationDialog" category="Core" version="3.0-beta"> +<class name="EditorFileDialog" inherits="ConfirmationDialog" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index 54b3accb19..1eda817d33 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorFileSystem" inherits="Node" category="Core" version="3.0-beta"> +<class name="EditorFileSystem" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Resource filesystem, as the editor sees it. </brief_description> diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index 1a2f73a683..005bebaca8 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorFileSystemDirectory" inherits="Object" category="Core" version="3.0-beta"> +<class name="EditorFileSystemDirectory" inherits="Object" category="Core" version="3.0-stable"> <brief_description> A diretory for the resource filesystem. </brief_description> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index f9e3c288e7..85f3d80607 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorImportPlugin" inherits="Reference" category="Core" version="3.0-beta"> +<class name="EditorImportPlugin" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Registers a custom resource importer in the editor. Use the class to parse any file and import it as a new resource type. </brief_description> @@ -64,6 +64,13 @@ Get the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: "name", "default_value", "property_hint" (optional), "hint_string" (optional), "usage" (optional). </description> </method> + <method name="get_import_order" qualifiers="virtual"> + <return type="int"> + </return> + <description> + Get the order of this importer to be run when importing resources. Higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. + </description> + </method> <method name="get_importer_name" qualifiers="virtual"> <return type="String"> </return> @@ -97,6 +104,13 @@ Get the name of the options preset at this index. </description> </method> + <method name="get_priority" qualifiers="virtual"> + <return type="float"> + </return> + <description> + Get the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. Default value is 1.0. + </description> + </method> <method name="get_recognized_extensions" qualifiers="virtual"> <return type="Array"> </return> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index db715d2379..61c93becde 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorInterface" inherits="Node" category="Core" version="3.0-beta"> +<class name="EditorInterface" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Editor interface and main components. </brief_description> @@ -100,6 +100,15 @@ Shows the given property on the given [code]object[/code] in the Editor's Inspector dock. </description> </method> + <method name="is_plugin_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="plugin" type="String"> + </argument> + <description> + Returns the enabled status of a plugin. The plugin name is the same as its directory name. + </description> + </method> <method name="make_mesh_previews"> <return type="Array"> </return> @@ -155,6 +164,17 @@ <description> </description> </method> + <method name="set_plugin_enabled"> + <return type="void"> + </return> + <argument index="0" name="plugin" type="String"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + Sets the enabled status of a plugin. The plugin name is the same as its directory name. + </description> + </method> </methods> <constants> </constants> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 1505845824..b3aca798a4 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorPlugin" inherits="Node" category="Core" version="3.0-beta"> +<class name="EditorPlugin" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Used by the editor to extend its functionality. </brief_description> @@ -7,6 +7,7 @@ Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. </description> <tutorials> + http://docs.godotengine.org/en/3.0/development/plugins/index.html </tutorials> <demos> </demos> @@ -273,6 +274,17 @@ Remove the control from the bottom panel. Don't forget to call this if you added one, so the editor can remove it cleanly. </description> </method> + <method name="remove_control_from_container"> + <return type="void"> + </return> + <argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer"> + </argument> + <argument index="1" name="control" type="Control"> + </argument> + <description> + Remove the control from the specified container. Use it when cleaning up after adding a control with [method add_control_to_container]. Note that you can simply free the control if you won't use it anymore. + </description> + </method> <method name="remove_control_from_docks"> <return type="void"> </return> diff --git a/doc/classes/EditorResourceConversionPlugin.xml b/doc/classes/EditorResourceConversionPlugin.xml index 8d6aa3a605..9facba18b0 100644 --- a/doc/classes/EditorResourceConversionPlugin.xml +++ b/doc/classes/EditorResourceConversionPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorResourceConversionPlugin" inherits="Reference" category="Core" version="3.0-beta"> +<class name="EditorResourceConversionPlugin" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index 481ffed70b..9b14771f0f 100644 --- a/doc/classes/EditorResourcePreview.xml +++ b/doc/classes/EditorResourcePreview.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorResourcePreview" inherits="Node" category="Core" version="3.0-beta"> +<class name="EditorResourcePreview" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Helper to generate previews of resources or files. </brief_description> diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml index 03cb232619..d116e56cf7 100644 --- a/doc/classes/EditorResourcePreviewGenerator.xml +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorResourcePreviewGenerator" inherits="Reference" category="Core" version="3.0-beta"> +<class name="EditorResourcePreviewGenerator" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Custom generator of previews. </brief_description> diff --git a/doc/classes/EditorSceneImporter.xml b/doc/classes/EditorSceneImporter.xml index 69fe4050f4..31846ed401 100644 --- a/doc/classes/EditorSceneImporter.xml +++ b/doc/classes/EditorSceneImporter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSceneImporter" inherits="Reference" category="Core" version="3.0-beta"> +<class name="EditorSceneImporter" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/EditorScenePostImport.xml b/doc/classes/EditorScenePostImport.xml index a9bc659e7d..4c0709249e 100644 --- a/doc/classes/EditorScenePostImport.xml +++ b/doc/classes/EditorScenePostImport.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorScenePostImport" inherits="Reference" category="Core" version="3.0-beta"> +<class name="EditorScenePostImport" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 97f126e7f7..a3cd12ab50 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorScript" inherits="Reference" category="Core" version="3.0-beta"> +<class name="EditorScript" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Base script that can be used to add extension functions to the editor. </brief_description> diff --git a/doc/classes/EditorSelection.xml b/doc/classes/EditorSelection.xml index 31e27a1b01..0424ab5e43 100644 --- a/doc/classes/EditorSelection.xml +++ b/doc/classes/EditorSelection.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSelection" inherits="Object" category="Core" version="3.0-beta"> +<class name="EditorSelection" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Manages the SceneTree selection in the editor. </brief_description> diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 174b62fde0..a37ea0fec7 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSettings" inherits="Resource" category="Core" version="3.0-beta"> +<class name="EditorSettings" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Object that holds the project-independent editor settings. </brief_description> @@ -126,6 +126,8 @@ </argument> <argument index="1" name="value" type="Variant"> </argument> + <argument index="2" name="update_current" type="bool"> + </argument> <description> </description> </method> diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index e55cdd0ca7..ba026166bb 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSpatialGizmo" inherits="SpatialGizmo" category="Core" version="3.0-beta"> +<class name="EditorSpatialGizmo" inherits="SpatialGizmo" category="Core" version="3.0-stable"> <brief_description> Custom gizmo for editing Spatial objects. </brief_description> diff --git a/doc/classes/EncodedObjectAsID.xml b/doc/classes/EncodedObjectAsID.xml index b60f2fc2bd..604ce42516 100644 --- a/doc/classes/EncodedObjectAsID.xml +++ b/doc/classes/EncodedObjectAsID.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EncodedObjectAsID" inherits="Reference" category="Core" version="3.0-beta"> +<class name="EncodedObjectAsID" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 0fd5892860..ad5e75bad5 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Engine" inherits="Object" category="Core" version="3.0-beta"> +<class name="Engine" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Access to basic engine properties. </brief_description> @@ -25,13 +25,6 @@ Returns the frames per second of the running game. </description> </method> - <method name="get_iterations_per_second" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the number of fixed iterations per second (for fixed process and physics). - </description> - </method> <method name="get_main_loop" qualifiers="const"> <return type="MainLoop"> </return> @@ -47,20 +40,6 @@ <description> </description> </method> - <method name="get_target_fps" qualifiers="const"> - <return type="float"> - </return> - <description> - 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. - </description> - </method> - <method name="get_time_scale"> - <return type="float"> - </return> - <description> - 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. - </description> - </method> <method name="get_version_info" qualifiers="const"> <return type="Dictionary"> </return> @@ -83,13 +62,6 @@ <description> </description> </method> - <method name="is_editor_hint" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the editor is running. - </description> - </method> <method name="is_in_physics_frame" qualifiers="const"> <return type="bool"> </return> @@ -97,43 +69,21 @@ Returns [code]true[/code] if the game is inside the fixed process and physics phase of the game loop. </description> </method> - <method name="set_editor_hint"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Sets the running inside the editor hint if [code]enabled[/code] is [code]true[/code]. - </description> - </method> - <method name="set_iterations_per_second"> - <return type="void"> - </return> - <argument index="0" name="iterations_per_second" type="int"> - </argument> - <description> - Sets the number of fixed iterations per second (for fixed process and physics). - </description> - </method> - <method name="set_target_fps"> - <return type="void"> - </return> - <argument index="0" name="target_fps" type="int"> - </argument> - <description> - Sets the target frames per second. - </description> - </method> - <method name="set_time_scale"> - <return type="void"> - </return> - <argument index="0" name="time_scale" type="float"> - </argument> - <description> - Sets the time scale. - </description> - </method> </methods> + <members> + <member name="editor_hint" type="bool" setter="set_editor_hint" getter="is_editor_hint"> + If [code]true[/code], it is running inside the editor. Useful for tool scripts. + </member> + <member name="iterations_per_second" type="int" setter="set_iterations_per_second" getter="get_iterations_per_second"> + The number of fixed iterations per second (for fixed process and physics). + </member> + <member name="target_fps" type="int" setter="set_target_fps" getter="get_target_fps"> + The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit. + </member> + <member name="time_scale" type="float" setter="set_time_scale" getter="get_time_scale"> + 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. + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index e252f67774..ea35ef89f3 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Environment" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Environment" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Resource for environment nodes (like [WorldEnvironment]) that define multiple rendering options. </brief_description> @@ -12,6 +12,8 @@ - Adjustments </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/3d/environment_and_post_processing.html + http://docs.godotengine.org/en/3.0/tutorials/3d/high_dynamic_range.html </tutorials> <demos> </demos> diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 8c270ece4b..3ac2a7e643 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="File" inherits="Reference" category="Core" version="3.0-beta"> +<class name="File" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Type to handle file reading and writing operations. </brief_description> @@ -22,6 +22,7 @@ [/codeblock] </description> <tutorials> + http://docs.godotengine.org/en/3.0/getting_started/step_by_step/filesystem.html </tutorials> <demos> </demos> @@ -109,13 +110,6 @@ Returns the next 64 bits from the file as a floating point number. </description> </method> - <method name="get_endian_swap"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if endian swap is enabled for this file. - </description> - </method> <method name="get_error" qualifiers="const"> <return type="int" enum="Error"> </return> @@ -274,16 +268,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. </description> </method> - <method name="set_endian_swap"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - 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. - </description> - </method> <method name="store_16"> <return type="void"> </return> @@ -393,6 +377,12 @@ </description> </method> </methods> + <members> + <member name="endian_swap" type="bool" setter="set_endian_swap" getter="get_endian_swap"> + 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. + </member> + </members> <constants> <constant name="READ" value="1" enum="ModeFlags"> Opens the file for read operations. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 3387b4a2ed..cee64b7ade 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="FileDialog" inherits="ConfirmationDialog" category="Core" version="3.0-beta"> +<class name="FileDialog" inherits="ConfirmationDialog" category="Core" version="3.0-stable"> <brief_description> Dialog for selecting files or directories in the filesystem. </brief_description> @@ -33,27 +33,6 @@ <description> </description> </method> - <method name="get_current_dir" qualifiers="const"> - <return type="String"> - </return> - <description> - Get the current working directory of the file dialog. - </description> - </method> - <method name="get_current_file" qualifiers="const"> - <return type="String"> - </return> - <description> - Get the current selected file of the file dialog (empty if none). - </description> - </method> - <method name="get_current_path" qualifiers="const"> - <return type="String"> - </return> - <description> - Get the current selected path (directory and file) of the file dialog (empty if none). - </description> - </method> <method name="get_vbox"> <return type="VBoxContainer"> </return> @@ -68,37 +47,19 @@ Invalidate and update the current dialog content list. </description> </method> - <method name="set_current_dir"> - <return type="void"> - </return> - <argument index="0" name="dir" type="String"> - </argument> - <description> - Set the current working directory of the file dialog. - </description> - </method> - <method name="set_current_file"> - <return type="void"> - </return> - <argument index="0" name="file" type="String"> - </argument> - <description> - Set the current selected file name of the file dialog. - </description> - </method> - <method name="set_current_path"> - <return type="void"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - Set the current selected file path of the file dialog. - </description> - </method> </methods> <members> <member name="access" type="int" setter="set_access" getter="get_access" enum="FileDialog.Access"> </member> + <member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir"> + The current working directory of the file dialog. + </member> + <member name="current_file" type="String" setter="set_current_file" getter="get_current_file"> + The currently selected file of the file dialog. + </member> + <member name="current_path" type="String" setter="set_current_path" getter="get_current_path"> + The currently selected file path of the file dialog. + </member> <member name="filters" type="PoolStringArray" setter="set_filters" getter="get_filters"> </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode"> diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index bc4557a171..7190067b09 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Font" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Font" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Internationalized font and text drawing support. </brief_description> diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml index 802f35dd10..8ad6da9adc 100644 --- a/doc/classes/FuncRef.xml +++ b/doc/classes/FuncRef.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="FuncRef" inherits="Reference" category="Core" version="3.0-beta"> +<class name="FuncRef" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Reference to a function in an object. </brief_description> diff --git a/doc/classes/GIProbe.xml b/doc/classes/GIProbe.xml index 0644e3f24e..e9f1dfecaf 100644 --- a/doc/classes/GIProbe.xml +++ b/doc/classes/GIProbe.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GIProbe" inherits="VisualInstance" category="Core" version="3.0-beta"> +<class name="GIProbe" inherits="VisualInstance" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/3d/gi_probes.html </tutorials> <demos> </demos> diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml index aba59f57ea..32a891e277 100644 --- a/doc/classes/GIProbeData.xml +++ b/doc/classes/GIProbeData.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GIProbeData" inherits="Resource" category="Core" version="3.0-beta"> +<class name="GIProbeData" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -9,161 +9,31 @@ <demos> </demos> <methods> - <method name="get_bias" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_bounds" qualifiers="const"> - <return type="AABB"> - </return> - <description> - </description> - </method> - <method name="get_cell_size" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_dynamic_data" qualifiers="const"> - <return type="PoolIntArray"> - </return> - <description> - </description> - </method> - <method name="get_dynamic_range" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_energy" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_normal_bias" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_propagation" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_to_cell_xform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - </description> - </method> - <method name="is_compressed" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_interior" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_bias"> - <return type="void"> - </return> - <argument index="0" name="bias" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_bounds"> - <return type="void"> - </return> - <argument index="0" name="bounds" type="AABB"> - </argument> - <description> - </description> - </method> - <method name="set_cell_size"> - <return type="void"> - </return> - <argument index="0" name="cell_size" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_compress"> - <return type="void"> - </return> - <argument index="0" name="compress" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_dynamic_data"> - <return type="void"> - </return> - <argument index="0" name="dynamic_data" type="PoolIntArray"> - </argument> - <description> - </description> - </method> - <method name="set_dynamic_range"> - <return type="void"> - </return> - <argument index="0" name="dynamic_range" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_energy"> - <return type="void"> - </return> - <argument index="0" name="energy" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_interior"> - <return type="void"> - </return> - <argument index="0" name="interior" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_normal_bias"> - <return type="void"> - </return> - <argument index="0" name="bias" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_propagation"> - <return type="void"> - </return> - <argument index="0" name="propagation" type="float"> - </argument> - <description> - </description> - </method> - <method name="set_to_cell_xform"> - <return type="void"> - </return> - <argument index="0" name="to_cell_xform" type="Transform"> - </argument> - <description> - </description> - </method> </methods> + <members> + <member name="bias" type="float" setter="set_bias" getter="get_bias"> + </member> + <member name="bounds" type="AABB" setter="set_bounds" getter="get_bounds"> + </member> + <member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size"> + </member> + <member name="compress" type="bool" setter="set_compress" getter="is_compressed"> + </member> + <member name="dynamic_data" type="PoolIntArray" setter="set_dynamic_data" getter="get_dynamic_data"> + </member> + <member name="dynamic_range" type="int" setter="set_dynamic_range" getter="get_dynamic_range"> + </member> + <member name="energy" type="float" setter="set_energy" getter="get_energy"> + </member> + <member name="interior" type="bool" setter="set_interior" getter="is_interior"> + </member> + <member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias"> + </member> + <member name="propagation" type="float" setter="set_propagation" getter="get_propagation"> + </member> + <member name="to_cell_xform" type="Transform" setter="set_to_cell_xform" getter="get_to_cell_xform"> + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml index e44ae867d4..4be44b3819 100644 --- a/doc/classes/Generic6DOFJoint.xml +++ b/doc/classes/Generic6DOFJoint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Generic6DOFJoint" inherits="Joint" category="Core" version="3.0-beta"> +<class name="Generic6DOFJoint" inherits="Joint" category="Core" version="3.0-stable"> <brief_description> The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation. </brief_description> @@ -24,10 +24,10 @@ When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_x/force_limit" type="float" setter="set_param_x" getter="get_param_x"> - The maximum amount of force that can occur, when rotating arround x-axis. + The maximum amount of force that can occur, when rotating around x-axis. </member> <member name="angular_limit_x/lower_angle" type="float" setter="_set_angular_lo_limit_x" getter="_get_angular_lo_limit_x"> - The minimum rotation in negative direction to break loose and rotate arround the x-axis. + The minimum rotation in negative direction to break loose and rotate around the x-axis. </member> <member name="angular_limit_x/restitution" type="float" setter="set_param_x" getter="get_param_x"> The amount of rotational restitution across the x-axis. The lower, the more restitution occurs. @@ -36,7 +36,7 @@ The speed of all rotations across the x-axis. </member> <member name="angular_limit_x/upper_angle" type="float" setter="_set_angular_hi_limit_x" getter="_get_angular_hi_limit_x"> - The minimum rotation in positive direction to break loose and rotate arround the x-axis. + The minimum rotation in positive direction to break loose and rotate around the x-axis. </member> <member name="angular_limit_y/damping" type="float" setter="set_param_y" getter="get_param_y"> The amount of rotational damping across the y-axis. The lower, the more dampening occurs. @@ -48,10 +48,10 @@ When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_y/force_limit" type="float" setter="set_param_y" getter="get_param_y"> - The maximum amount of force that can occur, when rotating arround y-axis. + The maximum amount of force that can occur, when rotating around y-axis. </member> <member name="angular_limit_y/lower_angle" type="float" setter="_set_angular_lo_limit_y" getter="_get_angular_lo_limit_y"> - The minimum rotation in negative direction to break loose and rotate arround the y-axis. + The minimum rotation in negative direction to break loose and rotate around the y-axis. </member> <member name="angular_limit_y/restitution" type="float" setter="set_param_y" getter="get_param_y"> The amount of rotational restitution across the y-axis. The lower, the more restitution occurs. @@ -60,7 +60,7 @@ The speed of all rotations across the y-axis. </member> <member name="angular_limit_y/upper_angle" type="float" setter="_set_angular_hi_limit_y" getter="_get_angular_hi_limit_y"> - The minimum rotation in positive direction to break loose and rotate arround the y-axis. + The minimum rotation in positive direction to break loose and rotate around the y-axis. </member> <member name="angular_limit_z/damping" type="float" setter="set_param_z" getter="get_param_z"> The amount of rotational damping across the z-axis. The lower, the more dampening occurs. @@ -72,10 +72,10 @@ When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_z/force_limit" type="float" setter="set_param_z" getter="get_param_z"> - The maximum amount of force that can occur, when rotating arround z-axis. + The maximum amount of force that can occur, when rotating around z-axis. </member> <member name="angular_limit_z/lower_angle" type="float" setter="_set_angular_lo_limit_z" getter="_get_angular_lo_limit_z"> - The minimum rotation in negative direction to break loose and rotate arround the z-axis. + The minimum rotation in negative direction to break loose and rotate around the z-axis. </member> <member name="angular_limit_z/restitution" type="float" setter="set_param_z" getter="get_param_z"> The amount of rotational restitution across the z-axis. The lower, the more restitution occurs. @@ -84,7 +84,7 @@ The speed of all rotations across the z-axis. </member> <member name="angular_limit_z/upper_angle" type="float" setter="_set_angular_hi_limit_z" getter="_get_angular_hi_limit_z"> - The minimum rotation in positive direction to break loose and rotate arround the z-axis. + The minimum rotation in positive direction to break loose and rotate around the z-axis. </member> <member name="angular_motor_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> If [code]true[/code] a rotating motor at the x-axis is enabled. @@ -185,10 +185,10 @@ The amount of damping that happens at the linear motion across the axes. </constant> <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5" enum="Param"> - The minimum rotation in negative direction to break loose and rotate arround the axes. + The minimum rotation in negative direction to break loose and rotate around the axes. </constant> <constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6" enum="Param"> - The minimum rotation in positive direction to break loose and rotate arround the axes. + The minimum rotation in positive direction to break loose and rotate around the axes. </constant> <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7" enum="Param"> The speed of all rotations across the axes. @@ -200,7 +200,7 @@ The amount of rotational restitution across the axes. The lower, the more restitution occurs. </constant> <constant name="PARAM_ANGULAR_FORCE_LIMIT" value="10" enum="Param"> - The maximum amount of force that can occur, when rotating arround the axes. + The maximum amount of force that can occur, when rotating around the axes. </constant> <constant name="PARAM_ANGULAR_ERP" value="11" enum="Param"> When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index 3f25d04f16..b3f63daf9c 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Geometry" inherits="Object" category="Core" version="3.0-beta"> +<class name="Geometry" inherits="Object" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index 981873b1fe..8dd3c23ee2 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GeometryInstance" inherits="VisualInstance" category="Core" version="3.0-beta"> +<class name="GeometryInstance" inherits="VisualInstance" category="Core" version="3.0-stable"> <brief_description> Base node for geometry based visual instances. </brief_description> diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index b1a723ee47..8b4bf4d448 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Gradient" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Gradient" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Color interpolator node. </brief_description> diff --git a/doc/classes/GradientTexture.xml b/doc/classes/GradientTexture.xml index e28dd2ce42..127a6d8204 100644 --- a/doc/classes/GradientTexture.xml +++ b/doc/classes/GradientTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GradientTexture" inherits="Texture" category="Core" version="3.0-beta"> +<class name="GradientTexture" inherits="Texture" category="Core" version="3.0-stable"> <brief_description> Gradient filled texture. </brief_description> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 3bc7fed1d9..2090155e85 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GraphEdit" inherits="Control" category="Core" version="3.0-beta"> +<class name="GraphEdit" inherits="Control" category="Core" version="3.0-stable"> <brief_description> GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. </brief_description> @@ -12,6 +12,42 @@ <demos> </demos> <methods> + <method name="add_valid_connection_type"> + <return type="void"> + </return> + <argument index="0" name="from_type" type="int"> + </argument> + <argument index="1" name="to_type" type="int"> + </argument> + <description> + Makes possible the connection between two different slot types. The type is defined with the [method GraphNode.set_slot] method. + </description> + </method> + <method name="add_valid_left_disconnect_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="int"> + </argument> + <description> + Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type. + </description> + </method> + <method name="add_valid_right_disconnect_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="int"> + </argument> + <description> + Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type. + </description> + </method> + <method name="clear_connections"> + <return type="void"> + </return> + <description> + Remove all connections between nodes. + </description> + </method> <method name="connect_node"> <return type="int" enum="Error"> </return> @@ -49,26 +85,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" } </description> </method> - <method name="get_scroll_ofs" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the scroll offset. - </description> - </method> - <method name="get_snap" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_zoom" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the current zoom value. - </description> - </method> <method name="is_node_connected"> <return type="bool"> </return> @@ -84,70 +100,73 @@ Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. </description> </method> - <method name="is_right_disconnects_enabled" qualifiers="const"> + <method name="is_valid_connection_type" qualifiers="const"> <return type="bool"> </return> - <description> - Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise. - </description> - </method> - <method name="is_using_snap" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_right_disconnects"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> + <argument index="0" name="from_type" type="int"> </argument> - <description> - Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. - </description> - </method> - <method name="set_scroll_ofs"> - <return type="void"> - </return> - <argument index="0" name="ofs" type="Vector2"> + <argument index="1" name="to_type" type="int"> </argument> <description> + Returns whether it's possible to connect slots of the specified types. </description> </method> - <method name="set_selected"> + <method name="remove_valid_connection_type"> <return type="void"> </return> - <argument index="0" name="node" type="Node"> + <argument index="0" name="from_type" type="int"> + </argument> + <argument index="1" name="to_type" type="int"> </argument> <description> + Makes it not possible to connect between two different slot types. The type is defined with the [method GraphNode.set_slot] method. </description> </method> - <method name="set_snap"> + <method name="remove_valid_left_disconnect_type"> <return type="void"> </return> - <argument index="0" name="pixels" type="int"> + <argument index="0" name="type" type="int"> </argument> <description> + Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type. </description> </method> - <method name="set_use_snap"> + <method name="remove_valid_right_disconnect_type"> <return type="void"> </return> - <argument index="0" name="enable" type="bool"> + <argument index="0" name="type" type="int"> </argument> <description> + Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type. </description> </method> - <method name="set_zoom"> + <method name="set_selected"> <return type="void"> </return> - <argument index="0" name="p_zoom" type="float"> + <argument index="0" name="node" type="Node"> </argument> <description> - Set the zoom value of the GraphEdit. Zoom value is between [0.01; 1.728]. + Sets the specified [code]node[/code] as the one selected. </description> </method> </methods> + <members> + <member name="right_disconnects" type="bool" setter="set_right_disconnects" getter="is_right_disconnects_enabled"> + If [code]true[/code], enables disconnection of existing connections in the GraphEdit by dragging the right end. + </member> + <member name="scroll_offset" type="Vector2" setter="set_scroll_ofs" getter="get_scroll_ofs"> + The scroll offset. + </member> + <member name="snap_distance" type="int" setter="set_snap" getter="get_snap"> + The snapping distance in pixels. + </member> + <member name="use_snap" type="bool" setter="set_use_snap" getter="is_using_snap"> + If [code]true[/code], enables snapping. + </member> + <member name="zoom" type="float" setter="set_zoom" getter="get_zoom"> + The current zoom value. + </member> + </members> <signals> <signal name="_begin_node_move"> <description> diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index c1b18e4cd8..ce8cb053ce 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GraphNode" inherits="Container" category="Core" version="3.0-beta"> +<class name="GraphNode" inherits="Container" category="Core" version="3.0-stable"> <brief_description> A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. </brief_description> @@ -95,19 +95,6 @@ Return the type of the output connection 'idx'. </description> </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the offset of the GraphNode. - </description> - </method> - <method name="get_overlay" qualifiers="const"> - <return type="int" enum="GraphNode.Overlay"> - </return> - <description> - </description> - </method> <method name="get_slot_color_left" qualifiers="const"> <return type="Color"> </return> @@ -144,18 +131,6 @@ Return the (integer) type of right (output) 'idx' slot. </description> </method> - <method name="is_comment" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_selected"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="is_slot_enabled_left" qualifiers="const"> <return type="bool"> </return> @@ -174,39 +149,6 @@ Return true if right (output) slot 'idx' is enabled. False otherwise. </description> </method> - <method name="set_comment"> - <return type="void"> - </return> - <argument index="0" name="comment" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - Set the offset of the GraphNode. - </description> - </method> - <method name="set_overlay"> - <return type="void"> - </return> - <argument index="0" name="overlay" type="int" enum="GraphNode.Overlay"> - </argument> - <description> - </description> - </method> - <method name="set_selected"> - <return type="void"> - </return> - <argument index="0" name="selected" type="bool"> - </argument> - <description> - </description> - </method> <method name="set_slot"> <return type="void"> </return> @@ -233,8 +175,17 @@ </method> </methods> <members> + <member name="comment" type="bool" setter="set_comment" getter="is_comment"> + </member> + <member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> + 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]. + </member> + <member name="overlay" type="int" setter="set_overlay" getter="get_overlay" enum="GraphNode.Overlay"> + </member> <member name="resizable" type="bool" setter="set_resizable" getter="is_resizable"> </member> + <member name="selected" type="bool" setter="set_selected" getter="is_selected"> + </member> <member name="show_close" type="bool" setter="set_show_close_button" getter="is_close_button_visible"> </member> <member name="title" type="String" setter="set_title" getter="get_title"> diff --git a/doc/classes/GridContainer.xml b/doc/classes/GridContainer.xml index 9deec7e410..8463acc1d4 100644 --- a/doc/classes/GridContainer.xml +++ b/doc/classes/GridContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GridContainer" inherits="Container" category="Core" version="3.0-beta"> +<class name="GridContainer" inherits="Container" category="Core" version="3.0-stable"> <brief_description> Grid container used to arrange elements in a grid like layout </brief_description> diff --git a/doc/classes/GrooveJoint2D.xml b/doc/classes/GrooveJoint2D.xml index 6ccad9a155..c1aa10026c 100644 --- a/doc/classes/GrooveJoint2D.xml +++ b/doc/classes/GrooveJoint2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GrooveJoint2D" inherits="Joint2D" category="Core" version="3.0-beta"> +<class name="GrooveJoint2D" inherits="Joint2D" category="Core" version="3.0-stable"> <brief_description> Groove constraint for 2D physics. </brief_description> diff --git a/doc/classes/HBoxContainer.xml b/doc/classes/HBoxContainer.xml index c94aa709cb..3597b4d2d0 100644 --- a/doc/classes/HBoxContainer.xml +++ b/doc/classes/HBoxContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HBoxContainer" inherits="BoxContainer" category="Core" version="3.0-beta"> +<class name="HBoxContainer" inherits="BoxContainer" category="Core" version="3.0-stable"> <brief_description> Horizontal box container. </brief_description> diff --git a/doc/classes/HScrollBar.xml b/doc/classes/HScrollBar.xml index 0add27d996..ed0a5ae3ad 100644 --- a/doc/classes/HScrollBar.xml +++ b/doc/classes/HScrollBar.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HScrollBar" inherits="ScrollBar" category="Core" version="3.0-beta"> +<class name="HScrollBar" inherits="ScrollBar" category="Core" version="3.0-stable"> <brief_description> Horizontal scroll bar. </brief_description> diff --git a/doc/classes/HSeparator.xml b/doc/classes/HSeparator.xml index ee5422592f..ac02f76146 100644 --- a/doc/classes/HSeparator.xml +++ b/doc/classes/HSeparator.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HSeparator" inherits="Separator" category="Core" version="3.0-beta"> +<class name="HSeparator" inherits="Separator" category="Core" version="3.0-stable"> <brief_description> Horizontal separator. </brief_description> diff --git a/doc/classes/HSlider.xml b/doc/classes/HSlider.xml index a04ce73fcb..791bc5159b 100644 --- a/doc/classes/HSlider.xml +++ b/doc/classes/HSlider.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HSlider" inherits="Slider" category="Core" version="3.0-beta"> +<class name="HSlider" inherits="Slider" category="Core" version="3.0-stable"> <brief_description> Horizontal slider. </brief_description> diff --git a/doc/classes/HSplitContainer.xml b/doc/classes/HSplitContainer.xml index 4c1528f098..68a794eb9f 100644 --- a/doc/classes/HSplitContainer.xml +++ b/doc/classes/HSplitContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HSplitContainer" inherits="SplitContainer" category="Core" version="3.0-beta"> +<class name="HSplitContainer" inherits="SplitContainer" category="Core" version="3.0-stable"> <brief_description> Horizontal split container. </brief_description> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 80f6966e12..3fa780e892 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HTTPClient" inherits="Reference" category="Core" version="3.0-beta"> +<class name="HTTPClient" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Hyper-text transfer protocol client. </brief_description> @@ -10,6 +10,8 @@ For more information on HTTP, see https://developer.mozilla.org/en-US/docs/Web/HTTP (or read RFC 2616 to get it straight from the source: https://tools.ietf.org/html/rfc2616). </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/networking/http_client_class.html + http://docs.godotengine.org/en/3.0/tutorials/networking/ssl_certificates.html </tutorials> <demos> </demos> @@ -39,13 +41,6 @@ [code]verify_host[/code] will check the SSL identity of the host if set to [code]true[/code]. </description> </method> - <method name="get_connection" qualifiers="const"> - <return type="StreamPeer"> - </return> - <description> - Returns the current connection. - </description> - </method> <method name="get_response_body_length" qualifiers="const"> <return type="int"> </return> @@ -90,13 +85,6 @@ If [code]true[/code] this [code]HTTPClient[/code] has a response available. </description> </method> - <method name="is_blocking_mode_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - If [code]true[/code] blocking mode is enabled. - </description> - </method> <method name="is_response_chunked" qualifiers="const"> <return type="bool"> </return> @@ -172,24 +160,6 @@ Sends the body data raw, as a byte array and does not encode it in any way. </description> </method> - <method name="set_blocking_mode"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - If set to true, execution will block until all data is read from the response. - </description> - </method> - <method name="set_connection"> - <return type="void"> - </return> - <argument index="0" name="connection" type="StreamPeer"> - </argument> - <description> - Sets connection to use for this client. - </description> - </method> <method name="set_read_chunk_size"> <return type="void"> </return> @@ -200,6 +170,14 @@ </description> </method> </methods> + <members> + <member name="blocking_mode_enabled" type="bool" setter="set_blocking_mode" getter="is_blocking_mode_enabled"> + If [code]true[/code], execution will block until all data is read from the response. + </member> + <member name="connection" type="StreamPeer" setter="set_connection" getter="get_connection"> + The connection to use for this client. + </member> + </members> <constants> <constant name="METHOD_GET" value="0" enum="Method"> 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..8b8cc6b744 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HTTPRequest" inherits="Node" category="Core" version="3.0-beta"> +<class name="HTTPRequest" inherits="Node" category="Core" version="3.0-stable"> <brief_description> A node with the ability to send HTTP requests. </brief_description> @@ -8,6 +8,7 @@ Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/networking/ssl_certificates.html </tutorials> <demos> </demos> @@ -26,13 +27,6 @@ Returns the response body length. </description> </method> - <method name="get_download_file" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the file this request will download into. - </description> - </method> <method name="get_downloaded_bytes" qualifiers="const"> <return type="int"> </return> @@ -63,20 +57,14 @@ <description> </description> </method> - <method name="set_download_file"> - <return type="void"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - Sets the file to download into. Outputs the response body into the file if set. - </description> - </method> </methods> <members> <member name="body_size_limit" type="int" setter="set_body_size_limit" getter="get_body_size_limit"> Maximum allowed size for response bodies. </member> + <member name="download_file" type="String" setter="set_download_file" getter="get_download_file"> + The file to download into. Will output any received file into it. + </member> <member name="max_redirects" type="int" setter="set_max_redirects" getter="get_max_redirects"> Maximum number of allowed redirects. </member> diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml index 4a23f63d5a..367867dd00 100644 --- a/doc/classes/HingeJoint.xml +++ b/doc/classes/HingeJoint.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HingeJoint" inherits="Joint" category="Core" version="3.0-beta"> +<class name="HingeJoint" inherits="Joint" category="Core" version="3.0-stable"> <brief_description> A hinge between two 3D bodies. </brief_description> <description> - Normaly uses the z-axis of body A as the hinge axis, another axis can be specified when adding it manually though. + Normally uses the z-axis of body A as the hinge axis, another axis can be specified when adding it manually though. </description> <tutorials> </tutorials> @@ -40,12 +40,12 @@ Target speed for the motor. </member> <member name="params/bias" type="float" setter="set_param" getter="get_param"> - The speed with wich the two bodies get pulled together when they move in different directions. + The speed with which the two bodies get pulled together when they move in different directions. </member> </members> <constants> <constant name="PARAM_BIAS" value="0" enum="Param"> - The speed with wich the two bodies get pulled together when they move in different directions. + The speed with which the two bodies get pulled together when they move in different directions. </constant> <constant name="PARAM_LIMIT_UPPER" value="1" enum="Param"> The maximum rotation. only active if [member angular_limit/enable] is [code]true[/code]. diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml index cd669e3de1..d01d88590e 100644 --- a/doc/classes/IP.xml +++ b/doc/classes/IP.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="IP" inherits="Object" category="Core" version="3.0-beta"> +<class name="IP" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Internet protocol (IP) support functions like DNS resolution. </brief_description> diff --git a/doc/classes/IP_Unix.xml b/doc/classes/IP_Unix.xml index 1d376c7233..ba33793d72 100644 --- a/doc/classes/IP_Unix.xml +++ b/doc/classes/IP_Unix.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="IP_Unix" inherits="IP" category="Core" version="3.0-beta"> +<class name="IP_Unix" inherits="IP" category="Core" version="3.0-stable"> <brief_description> Unix IP support. See [IP]. </brief_description> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 80bef2b385..a38bfeb35e 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Image" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Image" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Image datatype. </brief_description> @@ -217,7 +217,7 @@ <return type="int" enum="Image.Format"> </return> <description> - Returns the image's raw data. + Returns the image’s format. See [code]FORMAT_*[/code] constants. </description> </method> <method name="get_height" qualifiers="const"> diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index a20af677cb..96261c8e12 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ImageTexture" inherits="Texture" category="Core" version="3.0-beta"> +<class name="ImageTexture" inherits="Texture" category="Core" version="3.0-stable"> <brief_description> A [Texture] based on an [Image]. </brief_description> @@ -46,20 +46,6 @@ Return the format of the [code]ImageTexture[/code], one of [Image].FORMAT_*. </description> </method> - <method name="get_lossy_storage_quality" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the storage quality for [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY. - </description> - </method> - <method name="get_storage" qualifiers="const"> - <return type="int" enum="ImageTexture.Storage"> - </return> - <description> - Return the storage type. One of [code]ImageTexture[/code].STORAGE_*. - </description> - </method> <method name="load"> <return type="void"> </return> @@ -78,15 +64,6 @@ Set the [Image] of this [code]ImageTexture[/code]. </description> </method> - <method name="set_lossy_storage_quality"> - <return type="void"> - </return> - <argument index="0" name="quality" type="float"> - </argument> - <description> - Set the storage quality in case of [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY. - </description> - </method> <method name="set_size_override"> <return type="void"> </return> @@ -96,16 +73,15 @@ Resizes the [code]ImageTexture[/code] to the specified dimensions. </description> </method> - <method name="set_storage"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="ImageTexture.Storage"> - </argument> - <description> - Set the storage type. One of [code]ImageTexture[/code].STORAGE_*. - </description> - </method> </methods> + <members> + <member name="lossy_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality"> + The storage quality for [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY. + </member> + <member name="storage" type="int" setter="set_storage" getter="get_storage" enum="ImageTexture.Storage"> + The storage type (raw, lossy, or compressed). + </member> + </members> <constants> <constant name="STORAGE_RAW" value="0" enum="Storage"> [Image] data is stored raw and unaltered. diff --git a/doc/classes/ImmediateGeometry.xml b/doc/classes/ImmediateGeometry.xml index 11b513fb84..0376854bb6 100644 --- a/doc/classes/ImmediateGeometry.xml +++ b/doc/classes/ImmediateGeometry.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ImmediateGeometry" inherits="GeometryInstance" category="Core" version="3.0-beta"> +<class name="ImmediateGeometry" inherits="GeometryInstance" category="Core" version="3.0-stable"> <brief_description> Draws simple geometry from code. </brief_description> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 79dc45fa1f..946b7b9bac 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Input" inherits="Object" category="Core" version="3.0-beta"> +<class name="Input" inherits="Object" category="Core" version="3.0-stable"> <brief_description> A Singleton that deals with inputs. </brief_description> @@ -17,7 +17,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - This will simulate pressing the specificed action. + This will simulate pressing the specified action. </description> </method> <method name="action_release"> diff --git a/doc/classes/InputDefault.xml b/doc/classes/InputDefault.xml index 28cba56334..b804c29cd0 100644 --- a/doc/classes/InputDefault.xml +++ b/doc/classes/InputDefault.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputDefault" inherits="Input" category="Core" version="3.0-beta"> +<class name="InputDefault" inherits="Input" category="Core" version="3.0-stable"> <brief_description> Default implementation of the [Input] class. </brief_description> diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index a8abe60f78..07372d382d 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEvent" inherits="Resource" category="Core" version="3.0-beta"> +<class name="InputEvent" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Generic input event </brief_description> @@ -7,7 +7,8 @@ Base class of all sort of input event. See [method Node._input]. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html + http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html + http://docs.godotengine.org/en/3.0/tutorials/2d/2d_transforms.html </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml index 9d05c44498..5ef1711e75 100644 --- a/doc/classes/InputEventAction.xml +++ b/doc/classes/InputEventAction.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventAction" inherits="InputEvent" category="Core" version="3.0-beta"> +<class name="InputEventAction" inherits="InputEvent" category="Core" version="3.0-stable"> <brief_description> Input event type for actions. </brief_description> @@ -7,7 +7,7 @@ Contains a generic action which can be targeted from several type of inputs. Actions can be created from the project settings menu [code]Project > Project Settings > Input Map[/code]. See [method Node._input]. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#actions + http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html#actions </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventGesture.xml b/doc/classes/InputEventGesture.xml index bf8f9667e3..4d82363b21 100644 --- a/doc/classes/InputEventGesture.xml +++ b/doc/classes/InputEventGesture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventGesture" inherits="InputEventWithModifiers" category="Core" version="3.0-beta"> +<class name="InputEventGesture" inherits="InputEventWithModifiers" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index 66c7320369..47ba2f08ca 100644 --- a/doc/classes/InputEventJoypadButton.xml +++ b/doc/classes/InputEventJoypadButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventJoypadButton" inherits="InputEvent" category="Core" version="3.0-beta"> +<class name="InputEventJoypadButton" inherits="InputEvent" category="Core" version="3.0-stable"> <brief_description> Input event for gamepad buttons. </brief_description> @@ -7,7 +7,7 @@ Input event type for gamepad buttons. For joysticks see [InputEventJoypadMotion]. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html + http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index f52225d302..7d40fcd4b3 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.0-beta"> +<class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.0-stable"> <brief_description> Input event type for gamepad joysticks and other motions. For buttons see [code]InputEventJoypadMotion[/code]. </brief_description> @@ -7,7 +7,7 @@ Stores information about joystick motions. One [code]InputEventJoypadMotion[/code] represents one axis at a time. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html + http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index c8cbab59d4..a930491beb 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventKey" inherits="InputEventWithModifiers" category="Core" version="3.0-beta"> +<class name="InputEventKey" inherits="InputEventWithModifiers" category="Core" version="3.0-stable"> <brief_description> Input event type for keyboard events. </brief_description> @@ -7,7 +7,7 @@ Stores key presses on the keyboard. Supports key presses, key releases and [member echo] events. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html + http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventMagnifyGesture.xml b/doc/classes/InputEventMagnifyGesture.xml index 796f9e6a2f..880da473a6 100644 --- a/doc/classes/InputEventMagnifyGesture.xml +++ b/doc/classes/InputEventMagnifyGesture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventMagnifyGesture" inherits="InputEventGesture" category="Core" version="3.0-beta"> +<class name="InputEventMagnifyGesture" inherits="InputEventGesture" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index 748cc4b9f9..ca29c23634 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventMouse" inherits="InputEventWithModifiers" category="Core" version="3.0-beta"> +<class name="InputEventMouse" inherits="InputEventWithModifiers" category="Core" version="3.0-stable"> <brief_description> Base input event type for mouse events. </brief_description> <description> - Stores general mouse events informations. + Stores general mouse events information. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html + http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html </tutorials> <demos> </demos> @@ -21,7 +21,7 @@ Mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position"> - Mouse local position relative to the [Viewport]. If used in [method Control._gui_input] the position is relative to the current [Control] wich is under the mouse. + Mouse local 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. </member> </members> <constants> diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml index cd1037b022..a8dc087eca 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.0-beta"> +<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.0-stable"> <brief_description> Input event type for mouse button events. </brief_description> <description> - Contains mouse click informations. See [method Node._input]. + Contains mouse click information. See [method Node._input]. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html + http://docs.godotengine.org/en/3.0/tutorials/inputs/mouse_and_input_coordinates.html </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index 192c8dbe16..2bd175348b 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventMouseMotion" inherits="InputEventMouse" category="Core" version="3.0-beta"> +<class name="InputEventMouseMotion" inherits="InputEventMouse" category="Core" version="3.0-stable"> <brief_description> Input event type for mouse motion events. </brief_description> <description> - Contains mouse motion informations. Supports relative, absolute positions and speed. See [method Node._input]. + Contains mouse motion information. Supports relative, absolute positions and speed. See [method Node._input]. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html + http://docs.godotengine.org/en/3.0/tutorials/inputs/mouse_and_input_coordinates.html </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventPanGesture.xml b/doc/classes/InputEventPanGesture.xml index a17f5823ba..1a16c0f385 100644 --- a/doc/classes/InputEventPanGesture.xml +++ b/doc/classes/InputEventPanGesture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventPanGesture" inherits="InputEventGesture" category="Core" version="3.0-beta"> +<class name="InputEventPanGesture" inherits="InputEventGesture" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/InputEventScreenDrag.xml b/doc/classes/InputEventScreenDrag.xml index 43553f97bd..a9780e280a 100644 --- a/doc/classes/InputEventScreenDrag.xml +++ b/doc/classes/InputEventScreenDrag.xml @@ -1,14 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventScreenDrag" inherits="InputEvent" category="Core" version="3.0-beta"> +<class name="InputEventScreenDrag" inherits="InputEvent" category="Core" version="3.0-stable"> <brief_description> Input event type for screen drag events. (only available on mobile devices) </brief_description> <description> - Contains screen drag informations. See [method Node._input]. + Contains screen drag information. See [method Node._input]. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html + http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventScreenTouch.xml b/doc/classes/InputEventScreenTouch.xml index 6f5ebc9481..783c36099b 100644 --- a/doc/classes/InputEventScreenTouch.xml +++ b/doc/classes/InputEventScreenTouch.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventScreenTouch" inherits="InputEvent" category="Core" version="3.0-beta"> +<class name="InputEventScreenTouch" inherits="InputEvent" category="Core" version="3.0-stable"> <brief_description> Input event type for screen touch events. (only available on mobile devices) @@ -8,7 +8,7 @@ Stores multi-touch press/release information. Supports touch press, touch release and [member index] for multi-touch count and order. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html + http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml index 70d2b57e8d..a1b1b6523f 100644 --- a/doc/classes/InputEventWithModifiers.xml +++ b/doc/classes/InputEventWithModifiers.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventWithModifiers" inherits="InputEvent" category="Core" version="3.0-beta"> +<class name="InputEventWithModifiers" inherits="InputEvent" category="Core" version="3.0-stable"> <brief_description> Base class for keys events with modifiers. </brief_description> <description> - Contains keys events informations with modifiers support like [code]SHIFT[/code] or [code]ALT[/code]. See [method Node._input]. + Contains keys events information with modifiers support like [code]SHIFT[/code] or [code]ALT[/code]. See [method Node._input]. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html + http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html </tutorials> <demos> </demos> diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index ff5491bde2..4cedd94094 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputMap" inherits="Object" category="Core" version="3.0-beta"> +<class name="InputMap" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Singleton that manages [InputEventAction]. </brief_description> @@ -7,7 +7,7 @@ Manages all [InputEventAction] which can be created/modified from the project settings menu [code]Project > Project Settings > Input Map[/code] or in code with [method add_action] and [method action_add_event]. See [method Node._input]. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#inputmap + http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html#inputmap </tutorials> <demos> </demos> diff --git a/doc/classes/InstancePlaceholder.xml b/doc/classes/InstancePlaceholder.xml index 570ce239ff..f698551d41 100644 --- a/doc/classes/InstancePlaceholder.xml +++ b/doc/classes/InstancePlaceholder.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InstancePlaceholder" inherits="Node" category="Core" version="3.0-beta"> +<class name="InstancePlaceholder" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Placeholder for the root [Node] of a [PackedScene]. </brief_description> diff --git a/doc/classes/InterpolatedCamera.xml b/doc/classes/InterpolatedCamera.xml index b268825efe..de84a7df6e 100644 --- a/doc/classes/InterpolatedCamera.xml +++ b/doc/classes/InterpolatedCamera.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InterpolatedCamera" inherits="Camera" category="Core" version="3.0-beta"> +<class name="InterpolatedCamera" inherits="Camera" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index f3d0c271ac..b94a06f170 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ItemList" inherits="Control" category="Core" version="3.0-beta"> +<class name="ItemList" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns. </brief_description> @@ -53,12 +53,6 @@ Ensure selection is visible, adjusting the scroll position as necessary. </description> </method> - <method name="get_fixed_icon_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> <method name="get_item_at_position" qualifiers="const"> <return type="int"> </return> @@ -198,14 +192,6 @@ Note: This method does not trigger the item selection signal. </description> </method> - <method name="set_fixed_icon_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - </description> - </method> <method name="set_item_custom_bg_color"> <return type="void"> </return> @@ -322,12 +308,18 @@ </method> </methods> <members> + <member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect"> + If [code]true[/code] the currently selected item may be selected again. + </member> <member name="allow_rmb_select" type="bool" setter="set_allow_rmb_select" getter="get_allow_rmb_select"> + If [code]true[/code] a right mouse button click can select items. </member> <member name="auto_height" type="bool" setter="set_auto_height" getter="has_auto_height"> </member> <member name="fixed_column_width" type="int" setter="set_fixed_column_width" getter="get_fixed_column_width"> </member> + <member name="fixed_icon_size" type="Vector2" setter="set_fixed_icon_size" getter="get_fixed_icon_size"> + </member> <member name="icon_mode" type="int" setter="set_icon_mode" getter="get_icon_mode" enum="ItemList.IconMode"> </member> <member name="icon_scale" type="float" setter="set_icon_scale" getter="get_icon_scale"> @@ -339,6 +331,7 @@ <member name="same_column_width" type="bool" setter="set_same_column_width" getter="is_same_column_width"> </member> <member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="ItemList.SelectMode"> + Allow single or multiple selection. See the [code]SELECT_*[/code] constants. </member> </members> <signals> diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index 28f04c3eb0..078c293fc0 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="JSON" inherits="Object" category="Core" version="3.0-beta"> +<class name="JSON" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Helper class for parsing JSON data. </brief_description> <description> - Helper class for parsing JSON data. For usage example, see [JSONParseResult]. + Helper class for parsing JSON data. For usage example and other important hints, see [JSONParseResult]. </description> <tutorials> </tutorials> diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index 835920818a..18313beaf8 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="JSONParseResult" inherits="Reference" category="Core" version="3.0-beta"> +<class name="JSONParseResult" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Data class wrapper for decoded JSON. </brief_description> <description> - Returned by [method JSON.parse], [code]JSONParseResult[/code] contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with [code]if json_result.error == 0[/code]. + Returned by [method JSON.parse], [code]JSONParseResult[/code] contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with [code]if json_result.error == OK[/code]. </description> <tutorials> </tutorials> @@ -24,11 +24,12 @@ </member> <member name="result" type="Variant" setter="set_result" getter="get_result"> A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces ([code]{}[/code]) a [Dictionary] will be returned, if JSON source starts with braces ([code][][/code]) an [Array] will be returned. - [i]Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types.[/i] + [i]Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types. + Note that JSON objects do not preserve key order like Godot dictionaries, thus you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements:[/i] [codeblock] - p = JSON.parse('["hello", "world", "!"]') - if typeof(p) == TYPE_ARRAY: - print(p[0]) # prints 'hello' + var p = JSON.parse('["hello", "world", "!"]') + if typeof(p.result) == TYPE_ARRAY: + print(p.result[0]) # prints 'hello' else: print("unexpected results") [/codeblock] diff --git a/doc/classes/JavaScript.xml b/doc/classes/JavaScript.xml index 027e4764ac..8183b48ece 100644 --- a/doc/classes/JavaScript.xml +++ b/doc/classes/JavaScript.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="JavaScript" inherits="Object" category="Core" version="3.0-beta"> +<class name="JavaScript" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Singleton that connects the engine with the browser's JavaScript context in HTML5 export. </brief_description> @@ -7,7 +7,7 @@ The JavaScript singleton is implemented only in HTML5 export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs. </description> <tutorials> - http://docs.godotengine.org/en/stable/learning/workflow/export/exporting_for_web.html#calling-javascript-from-script + http://docs.godotengine.org/en/3.0/getting_started/workflow/export/exporting_for_web.html#calling-javascript-from-script </tutorials> <demos> </demos> diff --git a/doc/classes/Joint.xml b/doc/classes/Joint.xml index 443aec21a8..8ead75d556 100644 --- a/doc/classes/Joint.xml +++ b/doc/classes/Joint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Joint" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="Joint" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Base class for all 3D joints </brief_description> @@ -23,7 +23,7 @@ The [Node], the second side of the Joint attaches to. </member> <member name="solver/priority" type="int" setter="set_solver_priority" getter="get_solver_priority"> - The order in wich the solver is executed compared to the other [Joints], the lower, the earlier. + The order in which the solver is executed compared to the other [Joints], the lower, the earlier. </member> </members> <constants> diff --git a/doc/classes/Joint2D.xml b/doc/classes/Joint2D.xml index dec965cd09..22f267f26f 100644 --- a/doc/classes/Joint2D.xml +++ b/doc/classes/Joint2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Joint2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="Joint2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Base node for all joint constraints in 2D physics. </brief_description> diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index 92d648537c..1735501a47 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicBody" inherits="PhysicsBody" category="Core" version="3.0-beta"> +<class name="KinematicBody" inherits="PhysicsBody" category="Core" version="3.0-stable"> <brief_description> Kinematic body 3D node. </brief_description> @@ -9,6 +9,7 @@ Kinematic Characters: KinematicBody also has an API for moving objects (the [method move_and_collide] and [method move_and_slide] methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/kinematic_character_2d.html </tutorials> <demos> </demos> @@ -26,7 +27,7 @@ <argument index="0" name="slide_idx" type="int"> </argument> <description> - Returns a [KinematicCollision], which contains information about a collision that occured during the last [method move_and_slide] call. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). + Returns a [KinematicCollision], which contains information about a collision that occurred during the last [method move_and_slide] call. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). </description> </method> <method name="get_slide_count" qualifiers="const"> @@ -84,9 +85,9 @@ [code]linear_velocity[/code] is a value in pixels per second. Unlike in for example [method move_and_collide], you should [i]not[/i] multiply it with [code]delta[/code] — this is done by the method. [code]floor_normal[/code] is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of [code]Vector3(0, 0, 0)[/code], everything is considered a wall. This is useful for topdown games. If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. - If the body collides, it will change direction a maximum of [code]max_bounces[/code] times before it stops. + If the body collides, it will change direction a maximum of [code]max_slides[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. - Returns the movement that remained when the body stopped. To get more detailed information about collisions that occured, use [method get_slide_collision]. + Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use [method get_slide_collision]. </description> </method> <method name="test_move"> diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index 8563b059f2..f7303c19c4 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-beta"> +<class name="KinematicBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-stable"> <brief_description> Kinematic body 2D node. </brief_description> @@ -26,7 +26,7 @@ <argument index="0" name="slide_idx" type="int"> </argument> <description> - Returns a [KinematicCollision2D], which contains information about a collision that occured during the last [method move_and_slide] call. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). + Returns a [KinematicCollision2D], which contains information about a collision that occurred during the last [method move_and_slide] call. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). </description> </method> <method name="get_slide_count" qualifiers="const"> @@ -86,7 +86,7 @@ If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. If the body collides, it will change direction a maximum of [code]max_bounces[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. - Returns the movement that remained when the body stopped. To get more detailed information about collisions that occured, use [method get_slide_collision]. + Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use [method get_slide_collision]. </description> </method> <method name="test_move"> diff --git a/doc/classes/KinematicCollision.xml b/doc/classes/KinematicCollision.xml index 9f25bece2c..613b135578 100644 --- a/doc/classes/KinematicCollision.xml +++ b/doc/classes/KinematicCollision.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicCollision" inherits="Reference" category="Core" version="3.0-beta"> +<class name="KinematicCollision" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Collision data for KinematicBody collisions. </brief_description> diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index 01b09f1c01..bb949877ad 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicCollision2D" inherits="Reference" category="Core" version="3.0-beta"> +<class name="KinematicCollision2D" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Collision data for KinematicBody2D collisions. </brief_description> diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 089b81164b..bbf83308de 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Label" inherits="Control" category="Core" version="3.0-beta"> +<class name="Label" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Displays plain text in a line or wrapped inside a rectangle. For formatted text, use [RichTextLabel]. </brief_description> <description> Label displays plain text on the screen. It gives you control over the horizontal and vertical alignment, and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics or other formatting. For that, use [RichTextLabel] instead. + Note that contrarily to most other [Control]s, Label's [member Control.mouse_filter] defaults to MOUSE_FILTER_IGNORE (i.e. it doesn't react to mouse input events). </description> <tutorials> </tutorials> @@ -32,13 +33,6 @@ Returns the total length of the text. </description> </method> - <method name="get_visible_characters" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the restricted number of characters to display. Returns -1 if unrestricted. - </description> - </method> <method name="get_visible_line_count" qualifiers="const"> <return type="int"> </return> @@ -46,15 +40,6 @@ Returns the number of lines shown. Useful if the [code]Label[/code] 's height cannot currently display all lines. </description> </method> - <method name="set_visible_characters"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - Restricts the number of characters to display. Set to -1 to disable. - </description> - </method> </methods> <members> <member name="align" type="int" setter="set_align" getter="get_align" enum="Label.Align"> @@ -84,6 +69,9 @@ <member name="valign" type="int" setter="set_valign" getter="get_valign" enum="Label.VAlign"> Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the [code]VALIGN_*[/code] constants. </member> + <member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters"> + Restricts the number of characters to display. Set to -1 to disable. + </member> </members> <constants> <constant name="ALIGN_LEFT" value="0" enum="Align"> diff --git a/doc/classes/LargeTexture.xml b/doc/classes/LargeTexture.xml index 9d79034dea..219943f021 100644 --- a/doc/classes/LargeTexture.xml +++ b/doc/classes/LargeTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LargeTexture" inherits="Texture" category="Core" version="3.0-beta"> +<class name="LargeTexture" inherits="Texture" category="Core" version="3.0-stable"> <brief_description> A Texture capable of storing many smaller Textures with offsets. </brief_description> diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index 4aa39ffff6..30722919d5 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Light" inherits="VisualInstance" category="Core" version="3.0-beta"> +<class name="Light" inherits="VisualInstance" category="Core" version="3.0-stable"> <brief_description> Provides a base class for different kinds of light nodes. </brief_description> @@ -7,6 +7,7 @@ Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html </tutorials> <demos> </demos> diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index fe1f25ad9e..019bf48082 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Light2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="Light2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Casts light in a 2D environment. </brief_description> diff --git a/doc/classes/LightOccluder2D.xml b/doc/classes/LightOccluder2D.xml index de42b2812c..4ea82918e1 100644 --- a/doc/classes/LightOccluder2D.xml +++ b/doc/classes/LightOccluder2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LightOccluder2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="LightOccluder2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Occludes light cast by a Light2D, casting shadows. </brief_description> diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index 9455882f02..a5eadae715 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Line2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="Line2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> A 2D line. </brief_description> @@ -71,7 +71,7 @@ The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. </member> <member name="joint_mode" type="int" setter="set_joint_mode" getter="get_joint_mode" enum="Line2D.LineJointMode"> - The style for the points inbetween the start and the end. + The style for the points between the start and the end. </member> <member name="points" type="PoolVector2Array" setter="set_points" getter="get_points"> The points that form the lines. The line is drawn between every point set in this array. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 4434a7b7e2..d82fafd4ec 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LineEdit" inherits="Control" category="Core" version="3.0-beta"> +<class name="LineEdit" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Control that provides single line string editing. </brief_description> @@ -34,13 +34,6 @@ Clears the current selection. </description> </method> - <method name="get_cursor_position" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the cursor position inside the [code]LineEdit[/code]. - </description> - </method> <method name="get_menu" qualifiers="const"> <return type="PopupMenu"> </return> @@ -81,15 +74,6 @@ Selects the whole [String]. </description> </method> - <method name="set_cursor_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="int"> - </argument> - <description> - Sets the cursor position inside the [code]LineEdit[/code]. The text may scroll if needed. - </description> - </method> </methods> <members> <member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align"> @@ -101,6 +85,9 @@ <member name="caret_blink_speed" type="float" setter="cursor_set_blink_speed" getter="cursor_get_blink_speed"> Duration (in seconds) of a caret's blinking cycle. </member> + <member name="caret_position" type="int" setter="set_cursor_position" getter="get_cursor_position"> + The cursor's position inside the [code]LineEdit[/code]. When set, the text may scroll to accommodate it. + </member> <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled"> If [code]true[/code] the context menu will appear when right clicked. </member> @@ -131,14 +118,14 @@ </members> <signals> <signal name="text_changed"> - <argument index="0" name="text" type="String"> + <argument index="0" name="new_text" type="String"> </argument> <description> Emitted when the text changes. </description> </signal> <signal name="text_entered"> - <argument index="0" name="text" type="String"> + <argument index="0" name="new_text" type="String"> </argument> <description> Emitted when the user presses KEY_ENTER on the [code]LineEdit[/code]. diff --git a/doc/classes/LineShape2D.xml b/doc/classes/LineShape2D.xml index e55676fd59..a6a1e7eb36 100644 --- a/doc/classes/LineShape2D.xml +++ b/doc/classes/LineShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LineShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> +<class name="LineShape2D" inherits="Shape2D" category="Core" version="3.0-stable"> <brief_description> Line shape for 2D collisions. </brief_description> diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index 82b3a90180..37bfb005ab 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LinkButton" inherits="BaseButton" category="Core" version="3.0-beta"> +<class name="LinkButton" inherits="BaseButton" category="Core" version="3.0-stable"> <brief_description> Simple button used to represent a link to some resource </brief_description> diff --git a/doc/classes/Listener.xml b/doc/classes/Listener.xml index 3b21e3fdac..5765e071a4 100644 --- a/doc/classes/Listener.xml +++ b/doc/classes/Listener.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Listener" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="Listener" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index c5a4e53907..5a49641531 100644 --- a/doc/classes/MainLoop.xml +++ b/doc/classes/MainLoop.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MainLoop" inherits="Object" category="Core" version="3.0-beta"> +<class name="MainLoop" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Main loop is the abstract main loop base class. </brief_description> diff --git a/doc/classes/MarginContainer.xml b/doc/classes/MarginContainer.xml index c56f9a5c58..25ac7c5668 100644 --- a/doc/classes/MarginContainer.xml +++ b/doc/classes/MarginContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MarginContainer" inherits="Container" category="Core" version="3.0-beta"> +<class name="MarginContainer" inherits="Container" category="Core" version="3.0-stable"> <brief_description> Simple margin container. </brief_description> diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index d83c81a960..554c32c893 100644 --- a/doc/classes/Marshalls.xml +++ b/doc/classes/Marshalls.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Marshalls" inherits="Reference" category="Core" version="3.0-beta"> +<class name="Marshalls" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Data transformation (marshalling) and encoding helpers. </brief_description> diff --git a/doc/classes/Material.xml b/doc/classes/Material.xml index 2b2f45e8be..5c31efc5e0 100644 --- a/doc/classes/Material.xml +++ b/doc/classes/Material.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Material" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Material" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Abstract base [Resource] for coloring and shading geometry. </brief_description> diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index af681c9456..5b15bba22a 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MenuButton" inherits="Button" category="Core" version="3.0-beta"> +<class name="MenuButton" inherits="Button" category="Core" version="3.0-stable"> <brief_description> Special button that brings up a [PopupMenu] when clicked. </brief_description> diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index 465b68171e..7fbc7768f7 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Mesh" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Mesh" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> A [Resource] that contains vertex-array based geometry. </brief_description> diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml index db20179116..720ab6f5d2 100644 --- a/doc/classes/MeshDataTool.xml +++ b/doc/classes/MeshDataTool.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MeshDataTool" inherits="Reference" category="Core" version="3.0-beta"> +<class name="MeshDataTool" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/MeshInstance.xml b/doc/classes/MeshInstance.xml index 9273e87430..3b9ed70e77 100644 --- a/doc/classes/MeshInstance.xml +++ b/doc/classes/MeshInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MeshInstance" inherits="GeometryInstance" category="Core" version="3.0-beta"> +<class name="MeshInstance" inherits="GeometryInstance" category="Core" version="3.0-stable"> <brief_description> Node that instances meshes into a scenario. </brief_description> diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index 3275969e78..774deab0ef 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MeshLibrary" inherits="Resource" category="Core" version="3.0-beta"> +<class name="MeshLibrary" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Library of meshes. </brief_description> diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index ff2d89b2ca..270da019eb 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MultiMesh" inherits="Resource" category="Core" version="3.0-beta"> +<class name="MultiMesh" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Provides high performance mesh instancing. </brief_description> diff --git a/doc/classes/MultiMeshInstance.xml b/doc/classes/MultiMeshInstance.xml index bad61fa254..aef372f810 100644 --- a/doc/classes/MultiMeshInstance.xml +++ b/doc/classes/MultiMeshInstance.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MultiMeshInstance" inherits="GeometryInstance" category="Core" version="3.0-beta"> +<class name="MultiMeshInstance" inherits="GeometryInstance" category="Core" version="3.0-stable"> <brief_description> Node that instances a [MultiMesh]. </brief_description> <description> - MultiMeshInstance is a [Node] that takes a [MultiMesh] resource and adds it to the current scenario by creating an instance of it (yes, this is an instance of instances). + [code]MultiMeshInstance[/code] is a specialized node to instance [GeometryInstance]s based on a [MultiMesh] resource. + This is useful to optimize the rendering of a high amount of instances of a given mesh (for example tree in a forest or grass strands). </description> <tutorials> </tutorials> @@ -14,6 +15,7 @@ </methods> <members> <member name="multimesh" type="MultiMesh" setter="set_multimesh" getter="get_multimesh"> + The [MultiMesh] resource that will be used and shared among all instances of the [code]MultiMeshInstance[/code]. </member> </members> <constants> diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index 74d59b2dd3..2ed02cad48 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Mutex" inherits="Reference" category="Core" version="3.0-beta"> +<class name="Mutex" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> A synchronization Mutex. </brief_description> diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index 8fe520f853..86302694a0 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Navigation" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="Navigation" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> A collection of [code]NavigationMesh[/code] resources and methods used for pathfinding. </brief_description> diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml index 18c15a616a..80d53c00a5 100644 --- a/doc/classes/Navigation2D.xml +++ b/doc/classes/Navigation2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Navigation2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="Navigation2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 55a3771d79..5cde8942d1 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NavigationMesh" inherits="Resource" category="Core" version="3.0-beta"> +<class name="NavigationMesh" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/NavigationMeshInstance.xml b/doc/classes/NavigationMeshInstance.xml index ddca9d747e..f329bad0eb 100644 --- a/doc/classes/NavigationMeshInstance.xml +++ b/doc/classes/NavigationMeshInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NavigationMeshInstance" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="NavigationMeshInstance" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 663ac4cd67..6e8154c4e5 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NavigationPolygon" inherits="Resource" category="Core" version="3.0-beta"> +<class name="NavigationPolygon" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/NavigationPolygonInstance.xml b/doc/classes/NavigationPolygonInstance.xml index ea314667ca..023f13de89 100644 --- a/doc/classes/NavigationPolygonInstance.xml +++ b/doc/classes/NavigationPolygonInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NavigationPolygonInstance" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="NavigationPolygonInstance" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index a7350b3863..8f746594bc 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NetworkedMultiplayerPeer" inherits="PacketPeer" category="Core" version="3.0-beta"> +<class name="NetworkedMultiplayerPeer" inherits="PacketPeer" category="Core" version="3.0-stable"> <brief_description> A high-level network interface to simplify multiplayer interactions. </brief_description> @@ -7,6 +7,7 @@ Manages the connection to network peers. Assigns unique IDs to each client connected to the server. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/networking/high_level_multiplayer.html </tutorials> <demos> </demos> @@ -32,13 +33,6 @@ Returns the ID of this [code]NetworkedMultiplayerPeer[/code]. </description> </method> - <method name="is_refusing_new_connections" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. - </description> - </method> <method name="poll"> <return type="void"> </return> @@ -46,15 +40,6 @@ Waits up to 1 second to receive a new network event. </description> </method> - <method name="set_refuse_new_connections"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - If [code]true[/code] this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. - </description> - </method> <method name="set_target_peer"> <return type="void"> </return> @@ -64,16 +49,15 @@ The peer to which packets will be sent. Default value: [code]0[/code]. </description> </method> - <method name="set_transfer_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="NetworkedMultiplayerPeer.TransferMode"> - </argument> - <description> - The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode]. - </description> - </method> </methods> + <members> + <member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections"> + If [code]true[/code] this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. + </member> + <member name="transfer_mode" type="int" setter="set_transfer_mode" getter="get_transfer_mode" enum="NetworkedMultiplayerPeer.TransferMode"> + The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode]. + </member> + </members> <signals> <signal name="connection_failed"> <description> diff --git a/doc/classes/Nil.xml b/doc/classes/Nil.xml index a30dae8af1..2e845d511a 100644 --- a/doc/classes/Nil.xml +++ b/doc/classes/Nil.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Nil" category="Built-In Types" version="3.0-beta"> +<class name="Nil" category="Built-In Types" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index b7440137c8..e67f0ea4a4 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NinePatchRect" inherits="Control" category="Core" version="3.0-beta"> +<class name="NinePatchRect" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Scalable texture-based frame that tiles the texture's centers and sides, but keeps the corners' original size. Perfect for panels and dialog boxes. </brief_description> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index e56733f102..46c8bf01a5 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Node" inherits="Object" category="Core" version="3.0-beta"> +<class name="Node" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Base class for all [i]scene[/i] objects. </brief_description> @@ -16,6 +16,7 @@ [b]Networking with nodes:[/b] After connecting to a server (or making one, see [NetworkedMultiplayerENet]) it is possible to use the built-in RPC (remote procedure call) system to communicate over the network. By calling [method rpc] with a method name, it will be called locally and in all connected peers (peers = clients and the server that accepts connections), with behaviour varying depending on the network mode ([method set_network_mode]) of the receiving peer. To identify which node receives the RPC call Godot will use its [NodePath] (make sure node names are the same on all peers). </description> <tutorials> + http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scenes_and_nodes.html </tutorials> <demos> </demos> @@ -32,8 +33,8 @@ <return type="void"> </return> <description> - Called when the node leaves the [SceneTree] (e.g. upon freeing, scene changing, or after calling [method remove_child] in a script). If the node has children, its [method _exit_tree] callback will be called last, after all its children have left the tree. - Corresponds to the NOTIFICATION_EXIT_TREE notification in [method Object._notification]. + Called when the node is about to leave the [SceneTree] (e.g. upon freeing, scene changing, or after calling [method remove_child] in a script). If the node has children, its [method _exit_tree] callback will be called last, after all its children have left the tree. + Corresponds to the NOTIFICATION_EXIT_TREE notification in [method Object._notification] and signal [signal tree_exiting]. To get notified when the node has already left the active tree, connect to the [signal tree_exited] </description> </method> <method name="_input" qualifiers="virtual"> @@ -43,7 +44,7 @@ </argument> <description> Called when there is an input event. The input event propagates through the node tree until a node consumes it. - It is only called if input processing is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_process_input]. + It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_input]. </description> </method> <method name="_physics_process" qualifiers="virtual"> @@ -53,7 +54,7 @@ </argument> <description> Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the [code]delta[/code] variable should be constant. - It is only called if physics processing is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_physics_process]. + It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_physics_process]. Corresponds to the NOTIFICATION_PHYSICS_PROCESS notification in [method Object._notification]. </description> </method> @@ -64,7 +65,7 @@ </argument> <description> Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the [code]delta[/code] time since the previous frame is not constant. - It is only called if processing is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_process]. + It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process]. Corresponds to the NOTIFICATION_PROCESS notification in [method Object._notification]. </description> </method> @@ -83,7 +84,7 @@ </argument> <description> Propagated to all nodes when the previous InputEvent is not consumed by any nodes. - It is only called if unhandled input processing is enabled, which is done automatically if this method is overriden, and can be toggled with [method set_process_unhandled_input]. + It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_input]. </description> </method> <method name="_unhandled_key_input" qualifiers="virtual"> @@ -184,13 +185,6 @@ Returns an array of references to node's children. </description> </method> - <method name="get_filename" qualifiers="const"> - <return type="String"> - </return> - <description> - 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]). - </description> - </method> <method name="get_groups" qualifiers="const"> <return type="Array"> </return> @@ -205,13 +199,6 @@ Returns the node's index, i.e. its position among the siblings of its parent. </description> </method> - <method name="get_name" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the name of the node. This name is unique among the siblings (other child nodes from the same parent). - </description> - </method> <method name="get_network_master" qualifiers="const"> <return type="int"> </return> @@ -255,13 +242,6 @@ <description> </description> </method> - <method name="get_owner" qualifiers="const"> - <return type="Node"> - </return> - <description> - Returns the node owner (see [method set_owner]). - </description> - </method> <method name="get_parent" qualifiers="const"> <return type="Node"> </return> @@ -659,24 +639,6 @@ Sets the folded state of the node in the Scene dock. </description> </method> - <method name="set_filename"> - <return type="void"> - </return> - <argument index="0" name="filename" type="String"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_name"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - 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. - </description> - </method> <method name="set_network_master"> <return type="void"> </return> @@ -688,22 +650,13 @@ 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). </description> </method> - <method name="set_owner"> - <return type="void"> - </return> - <argument index="0" name="owner" type="Node"> - </argument> - <description> - 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. - </description> - </method> <method name="set_physics_process"> <return type="void"> </return> <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, see [OS] to change) interval (and the [method _physics_process] callback will be called if exists). Enabled automatically if [method _physics_process] is overriden. Any calls to this before [method _ready] will be ignored. + Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, see [OS] to change) interval (and the [method _physics_process] callback will be called if exists). Enabled automatically if [method _physics_process] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_physics_process_internal"> @@ -720,7 +673,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). Enabled automatically if [method _process] is overriden. Any calls to this before [method _ready] will be ignored. + Enables or disables processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). Enabled automatically if [method _process] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_input"> @@ -729,7 +682,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables input processing. This is not required for GUI controls! Enabled automatically if [method _input] is overriden. Any calls to this before [method _ready] will be ignored. + Enables or disables input processing. This is not required for GUI controls! Enabled automatically if [method _input] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_internal"> @@ -746,7 +699,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a [Control]). Enabled automatically if [method _unhandled_input] is overriden. Any calls to this before [method _ready] will be ignored. + Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a [Control]). Enabled automatically if [method _unhandled_input] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_process_unhandled_key_input"> @@ -755,7 +708,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Enables unhandled key input processing. Enabled automatically if [method _unhandled_key_input] is overriden. Any calls to this before [method _ready] will be ignored. + Enables unhandled key input processing. Enabled automatically if [method _unhandled_key_input] is overridden. Any calls to this before [method _ready] will be ignored. </description> </method> <method name="set_scene_instance_load_placeholder"> @@ -768,6 +721,16 @@ </method> </methods> <members> + <member name="filename" type="String" setter="set_filename" getter="get_filename"> + When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. + </member> + <member name="name" type="String" setter="set_name" getter="get_name"> + 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 + </member> + <member name="owner" type="Node" setter="set_owner" getter="get_owner"> + 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. + </member> <member name="pause_mode" type="int" setter="set_pause_mode" getter="get_pause_mode" enum="Node.PauseMode"> </member> </members> @@ -784,7 +747,12 @@ </signal> <signal name="tree_exited"> <description> - Emitted when the node exits the tree. + Emitted after the node exits the tree and is no longer active. + </description> + </signal> + <signal name="tree_exiting"> + <description> + Emitted when the node is still active but about to exit the tree. This is the right place for de-initialization. </description> </signal> </signals> @@ -793,7 +761,7 @@ Notification received when the node enters a [SceneTree]. </constant> <constant name="NOTIFICATION_EXIT_TREE" value="11"> - Notification received when the node exits a [SceneTree]. + Notification received when the node is about to exit a [SceneTree]. </constant> <constant name="NOTIFICATION_MOVED_IN_PARENT" value="12"> Notification received when the node is moved in the parent. diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 5b7def99dc..f51c5abe18 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Node2D" inherits="CanvasItem" category="Core" version="3.0-beta"> +<class name="Node2D" inherits="CanvasItem" category="Core" version="3.0-stable"> <brief_description> A 2D game object, parent of all 2D related nodes. Has a position, rotation, scale and Z-index. </brief_description> @@ -7,6 +7,7 @@ A 2D game object, with a position, rotation and scale. All 2D physics nodes and sprites inherit from Node2D. Use Node2D as a parent node to move, scale and rotate children in a 2D project. Also gives control on the node's render order. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/2d/custom_drawing_in_2d.html </tutorials> <demos> </demos> @@ -38,12 +39,6 @@ Returns the [Transform2D] relative to this node's parent. </description> </method> - <method name="get_rotation" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="global_translate"> <return type="void"> </return> @@ -93,14 +88,6 @@ Applies a rotation to the node, in radians, starting from its current rotation. </description> </method> - <method name="set_rotation"> - <return type="void"> - </return> - <argument index="0" name="radians" type="float"> - </argument> - <description> - </description> - </method> <method name="to_global" qualifiers="const"> <return type="Vector2"> </return> @@ -148,6 +135,9 @@ <member name="position" type="Vector2" setter="set_position" getter="get_position"> Position, relative to the node's parent. </member> + <member name="rotation" type="float" setter="set_rotation" getter="get_rotation"> + Rotation in radians, relative to the node's parent. + </member> <member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees"> Rotation in degrees, relative to the node's parent. </member> diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index 8d5de705b5..6027f110da 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NodePath" category="Built-In Types" version="3.0-beta"> +<class name="NodePath" category="Built-In Types" version="3.0-stable"> <brief_description> Pre-parsed scene tree path. </brief_description> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 902bf4ebfa..a61b156b01 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="OS" inherits="Object" category="Core" version="3.0-beta"> +<class name="OS" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Operating System functions. </brief_description> @@ -87,7 +87,18 @@ <argument index="3" name="output" type="Array" default="[ ]"> </argument> <description> - Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. + Execute the file at the given path, optionally blocking until it returns. + Platform path resolution will take place. The resolved file must exist and be executable. + Returns a process id. + For example: + [codeblock] + var output = [] + var pid = OS.execute('ls', [], true, output) + [/codeblock] + If you wish to access a shell built-in or perform a composite command, a platform specific shell can be invoked. For example: + [codeblock] + var pid = OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output) + [/codeblock] </description> </method> <method name="find_scancode_from_string" qualifiers="const"> @@ -99,20 +110,6 @@ Returns the scancode of the given string (e.g. "Escape") </description> </method> - <method name="get_borderless_window" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns true if the current window is borderless. - </description> - </method> - <method name="get_clipboard" qualifiers="const"> - <return type="String"> - </return> - <description> - Get clipboard from the host OS. - </description> - </method> <method name="get_cmdline_args"> <return type="PoolStringArray"> </return> @@ -120,13 +117,6 @@ Returns the command line arguments passed to the engine. </description> </method> - <method name="get_current_screen" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the current screen index (0 padded). - </description> - </method> <method name="get_date" qualifiers="const"> <return type="Dictionary"> </return> @@ -178,12 +168,6 @@ Returns the path to the current engine executable. </description> </method> - <method name="get_exit_code" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> <method name="get_latin_keyboard_variant" qualifiers="const"> <return type="String"> </return> @@ -281,13 +265,6 @@ xxxhdpi - 640 dpi </description> </method> - <method name="get_screen_orientation" qualifiers="const"> - <return type="int" enum="OS.ScreenOrientation"> - </return> - <description> - Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class. - </description> - </method> <method name="get_screen_position" qualifiers="const"> <return type="Vector2"> </return> @@ -369,7 +346,8 @@ <return type="String"> </return> <description> - Returns a string that is unique to the device. Currently only works on Android and iOS. Returns empty string on other platforms. + Returns a string that is unique to the device. + Returns empty string on HTML5 and UWP which are not supported yet. </description> </method> <method name="get_unix_time" qualifiers="const"> @@ -403,20 +381,6 @@ <description> </description> </method> - <method name="get_window_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - 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. - </description> - </method> - <method name="get_window_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the size of the window (without counting window manager decorations). - </description> - </method> <method name="has_environment" qualifiers="const"> <return type="bool"> </return> @@ -464,20 +428,6 @@ Returns [code]false[/code] if the build is a release build. </description> </method> - <method name="is_in_low_processor_usage_mode" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if low cpu usage mode is enabled. - </description> - </method> - <method name="is_keep_screen_on" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the screen is being kept on. - </description> - </method> <method name="is_ok_left_and_cancel_right" qualifiers="const"> <return type="bool"> </return> @@ -508,41 +458,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. </description> </method> - <method name="is_vsync_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if synchronizing the framerate to the monitor's refresh rate is enabled. - </description> - </method> - <method name="is_window_fullscreen" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the window is in fullscreen mode. - </description> - </method> - <method name="is_window_maximized" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the window is maximized. - </description> - </method> - <method name="is_window_minimized" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the window is minimized. - </description> - </method> - <method name="is_window_resizable" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the window is resizable. - </description> - </method> <method name="kill"> <return type="int" enum="Error"> </return> @@ -636,42 +551,6 @@ Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX. </description> </method> - <method name="set_borderless_window"> - <return type="void"> - </return> - <argument index="0" name="borderless" type="bool"> - </argument> - <description> - Removes the window frame. - </description> - </method> - <method name="set_clipboard"> - <return type="void"> - </return> - <argument index="0" name="clipboard" type="String"> - </argument> - <description> - Sets clipboard to the OS. - </description> - </method> - <method name="set_current_screen"> - <return type="void"> - </return> - <argument index="0" name="screen" type="int"> - </argument> - <description> - Sets the current screen by index. - </description> - </method> - <method name="set_exit_code"> - <return type="void"> - </return> - <argument index="0" name="code" type="int"> - </argument> - <description> - Sets the exit code that will be returned by the game. - </description> - </method> <method name="set_icon"> <return type="void"> </return> @@ -689,33 +568,6 @@ <description> </description> </method> - <method name="set_keep_screen_on"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Sets keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS) - </description> - </method> - <method name="set_low_processor_usage_mode"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_screen_orientation"> - <return type="void"> - </return> - <argument index="0" name="orientation" type="int" enum="OS.ScreenOrientation"> - </argument> - <description> - Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class. - </description> - </method> <method name="set_thread_name"> <return type="int" enum="Error"> </return> @@ -734,69 +586,6 @@ Enables backup saves if [code]enabled[/code] is [code]true[/code]. </description> </method> - <method name="set_use_vsync"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - If [code]true[/code] the framerate will synchronize to the monitor's refresh rate. - </description> - </method> - <method name="set_window_fullscreen"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_window_maximized"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set [code]true[/code] to maximize the window. - </description> - </method> - <method name="set_window_minimized"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set [code]true[/code] to minimize the window. - </description> - </method> - <method name="set_window_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <description> - 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). - </description> - </method> - <method name="set_window_resizable"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Sets the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings. - </description> - </method> - <method name="set_window_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - Sets the window size to the specified size. - </description> - </method> <method name="set_window_title"> <return type="void"> </return> @@ -827,6 +616,46 @@ </description> </method> </methods> + <members> + <member name="clipboard" type="String" setter="set_clipboard" getter="get_clipboard"> + The clipboard from the host OS. Might be unavailable on some platforms. + </member> + <member name="current_screen" type="int" setter="set_current_screen" getter="get_current_screen"> + The current screen index (starting from 0). + </member> + <member name="exit_code" type="int" setter="set_exit_code" getter="get_exit_code"> + </member> + <member name="keep_screen_on" type="bool" setter="set_keep_screen_on" getter="is_keep_screen_on"> + </member> + <member name="low_processor_usage_mode" type="bool" setter="set_low_processor_usage_mode" getter="is_in_low_processor_usage_mode"> + </member> + <member name="screen_orientation" type="int" setter="set_screen_orientation" getter="get_screen_orientation" enum="_OS.ScreenOrientation"> + The current screen orientation. + </member> + <member name="vsync_enabled" type="bool" setter="set_use_vsync" getter="is_vsync_enabled"> + </member> + <member name="window_borderless" type="bool" setter="set_borderless_window" getter="get_borderless_window"> + If [code]true[/code], removes the window frame. + </member> + <member name="window_fullscreen" type="bool" setter="set_window_fullscreen" getter="is_window_fullscreen"> + If [code]true[/code], the window is fullscreen. + </member> + <member name="window_maximized" type="bool" setter="set_window_maximized" getter="is_window_maximized"> + If [code]true[/code], the window is maximized. + </member> + <member name="window_minimized" type="bool" setter="set_window_minimized" getter="is_window_minimized"> + If [code]true[/code], the window is minimized. + </member> + <member name="window_position" type="Vector2" setter="set_window_position" getter="get_window_position"> + 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. + </member> + <member name="window_resizable" type="bool" setter="set_window_resizable" getter="is_window_resizable"> + If [code]true[/code], the window is resizable by the user. + </member> + <member name="window_size" type="Vector2" setter="set_window_size" getter="get_window_size"> + The size of the window (without counting window manager decorations). + </member> + </members> <constants> <constant name="DAY_SUNDAY" value="0" enum="Weekday"> </constant> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 5d0e51c481..8a7006ea97 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Object" category="Core" version="3.0-beta"> +<class name="Object" category="Core" version="3.0-stable"> <brief_description> Base class for all non built-in types. </brief_description> diff --git a/doc/classes/OccluderPolygon2D.xml b/doc/classes/OccluderPolygon2D.xml index f11f82c7de..f16aca487e 100644 --- a/doc/classes/OccluderPolygon2D.xml +++ b/doc/classes/OccluderPolygon2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="OccluderPolygon2D" inherits="Resource" category="Core" version="3.0-beta"> +<class name="OccluderPolygon2D" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Defines a 2D polygon for LightOccluder2D. </brief_description> diff --git a/doc/classes/OmniLight.xml b/doc/classes/OmniLight.xml index f0c5c81a47..d4d00e2a9b 100644 --- a/doc/classes/OmniLight.xml +++ b/doc/classes/OmniLight.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="OmniLight" inherits="Light" category="Core" version="3.0-beta"> +<class name="OmniLight" inherits="Light" category="Core" version="3.0-stable"> <brief_description> OmniDirectional Light, such as a light bulb or a candle. </brief_description> @@ -7,6 +7,7 @@ An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html </tutorials> <demos> </demos> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index ff3e513c79..56f4aa2082 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="OptionButton" inherits="Button" category="Core" version="3.0-beta"> +<class name="OptionButton" inherits="Button" category="Core" version="3.0-stable"> <brief_description> Button control that provides selectable options when pressed. </brief_description> diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml index 0e297ba875..a04f9ef6fb 100644 --- a/doc/classes/PCKPacker.xml +++ b/doc/classes/PCKPacker.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PCKPacker" inherits="Reference" category="Core" version="3.0-beta"> +<class name="PCKPacker" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PHashTranslation.xml b/doc/classes/PHashTranslation.xml index 04220e5155..94fddad706 100644 --- a/doc/classes/PHashTranslation.xml +++ b/doc/classes/PHashTranslation.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PHashTranslation" inherits="Translation" category="Core" version="3.0-beta"> +<class name="PHashTranslation" inherits="Translation" category="Core" version="3.0-stable"> <brief_description> Optimized translation. </brief_description> diff --git a/doc/classes/PackedDataContainer.xml b/doc/classes/PackedDataContainer.xml index d4b7bc36c6..42d00e067b 100644 --- a/doc/classes/PackedDataContainer.xml +++ b/doc/classes/PackedDataContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PackedDataContainer" inherits="Resource" category="Core" version="3.0-beta"> +<class name="PackedDataContainer" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PackedDataContainerRef.xml b/doc/classes/PackedDataContainerRef.xml index 93a5bbb627..1adbbeb5a1 100644 --- a/doc/classes/PackedDataContainerRef.xml +++ b/doc/classes/PackedDataContainerRef.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PackedDataContainerRef" inherits="Reference" category="Core" version="3.0-beta"> +<class name="PackedDataContainerRef" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index 80ef3afdb1..a5877a66d2 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PackedScene" inherits="Resource" category="Core" version="3.0-beta"> +<class name="PackedScene" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> An abstraction of a serialized scene. </brief_description> diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index 57d88d7ff8..354ef1f3f3 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PacketPeer" inherits="Reference" category="Core" version="3.0-beta"> +<class name="PacketPeer" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Abstraction and base class for packet-based protocols. </brief_description> @@ -39,12 +39,6 @@ Get a Variant. </description> </method> - <method name="is_object_decoding_allowed" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="put_packet"> <return type="int" enum="Error"> </return> @@ -63,15 +57,11 @@ Send a Variant as a packet. </description> </method> - <method name="set_allow_object_decoding"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> </methods> + <members> + <member name="allow_object_decoding" type="bool" setter="set_allow_object_decoding" getter="is_object_decoding_allowed"> + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/PacketPeerStream.xml b/doc/classes/PacketPeerStream.xml index 5d320a09f8..b475c9d99e 100644 --- a/doc/classes/PacketPeerStream.xml +++ b/doc/classes/PacketPeerStream.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PacketPeerStream" inherits="PacketPeer" category="Core" version="3.0-beta"> +<class name="PacketPeerStream" inherits="PacketPeer" category="Core" version="3.0-stable"> <brief_description> Wrapper to use a PacketPeer over a StreamPeer. </brief_description> @@ -11,44 +11,16 @@ <demos> </demos> <methods> - <method name="get_input_buffer_max_size" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_output_buffer_max_size" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_input_buffer_max_size"> - <return type="void"> - </return> - <argument index="0" name="max_size_bytes" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_output_buffer_max_size"> - <return type="void"> - </return> - <argument index="0" name="max_size_bytes" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_stream_peer"> - <return type="void"> - </return> - <argument index="0" name="peer" type="Reference"> - </argument> - <description> - Set the [StreamPeer] object to be wrapped. - </description> - </method> </methods> + <members> + <member name="input_buffer_max_size" type="int" setter="set_input_buffer_max_size" getter="get_input_buffer_max_size"> + </member> + <member name="output_buffer_max_size" type="int" setter="set_output_buffer_max_size" getter="get_output_buffer_max_size"> + </member> + <member name="stream_peer" type="StreamPeer" setter="set_stream_peer" getter="get_stream_peer"> + The wrapped [StreamPeer] object. + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 838365bc87..d7b38297ba 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PacketPeerUDP" inherits="PacketPeer" category="Core" version="3.0-beta"> +<class name="PacketPeerUDP" inherits="PacketPeer" category="Core" version="3.0-stable"> <brief_description> UDP packet peer. </brief_description> diff --git a/doc/classes/Panel.xml b/doc/classes/Panel.xml index e0dc2cafce..38c605f8a4 100644 --- a/doc/classes/Panel.xml +++ b/doc/classes/Panel.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Panel" inherits="Control" category="Core" version="3.0-beta"> +<class name="Panel" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Provides an opaque background for [Control] children. </brief_description> diff --git a/doc/classes/PanelContainer.xml b/doc/classes/PanelContainer.xml index 2a3fb2eeb9..4c0875dea5 100644 --- a/doc/classes/PanelContainer.xml +++ b/doc/classes/PanelContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PanelContainer" inherits="Container" category="Core" version="3.0-beta"> +<class name="PanelContainer" inherits="Container" category="Core" version="3.0-stable"> <brief_description> Panel container type. </brief_description> diff --git a/doc/classes/PanoramaSky.xml b/doc/classes/PanoramaSky.xml index 6a26347120..b99f29e112 100644 --- a/doc/classes/PanoramaSky.xml +++ b/doc/classes/PanoramaSky.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PanoramaSky" inherits="Sky" category="Core" version="3.0-beta"> +<class name="PanoramaSky" inherits="Sky" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ParallaxBackground.xml b/doc/classes/ParallaxBackground.xml index da22f03845..0b9e3c9609 100644 --- a/doc/classes/ParallaxBackground.xml +++ b/doc/classes/ParallaxBackground.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ParallaxBackground" inherits="CanvasLayer" category="Core" version="3.0-beta"> +<class name="ParallaxBackground" inherits="CanvasLayer" category="Core" version="3.0-stable"> <brief_description> A node used to create a parallax scrolling background. </brief_description> diff --git a/doc/classes/ParallaxLayer.xml b/doc/classes/ParallaxLayer.xml index c70e6befc4..1feb3054f3 100644 --- a/doc/classes/ParallaxLayer.xml +++ b/doc/classes/ParallaxLayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ParallaxLayer" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="ParallaxLayer" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> A parallax scrolling layer to be used with [ParallaxBackground]. </brief_description> diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml index 2a5dcb26e8..bdf62f2b14 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Particles" inherits="GeometryInstance" category="Core" version="3.0-beta"> +<class name="Particles" inherits="GeometryInstance" category="Core" version="3.0-stable"> <brief_description> 3D particle emitter. </brief_description> diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml index 8b908a1fa2..20b9632c30 100644 --- a/doc/classes/Particles2D.xml +++ b/doc/classes/Particles2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Particles2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="Particles2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> 2D particle emitter. </brief_description> diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 42bc1b2d05..28ca512ec4 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ParticlesMaterial" inherits="Material" category="Core" version="3.0-beta"> +<class name="ParticlesMaterial" inherits="Material" category="Core" version="3.0-stable"> <brief_description> Particle properties for [Particles] and [Particles2D] nodes. </brief_description> diff --git a/doc/classes/Path.xml b/doc/classes/Path.xml index a5e690e121..0d931e12fd 100644 --- a/doc/classes/Path.xml +++ b/doc/classes/Path.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Path" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="Path" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Container for a [Curve3D]. </brief_description> diff --git a/doc/classes/Path2D.xml b/doc/classes/Path2D.xml index 832b86f516..e889027283 100644 --- a/doc/classes/Path2D.xml +++ b/doc/classes/Path2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Path2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="Path2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Contains a [Curve2D] path for [PathFollow2D] nodes to follow. </brief_description> diff --git a/doc/classes/PathFollow.xml b/doc/classes/PathFollow.xml index de7bb8715c..144afa21e7 100644 --- a/doc/classes/PathFollow.xml +++ b/doc/classes/PathFollow.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PathFollow" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="PathFollow" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Point sampler for a [Path]. </brief_description> @@ -12,122 +12,32 @@ <demos> </demos> <methods> - <method name="get_cubic_interpolation" qualifiers="const"> - <return type="bool"> - </return> - <description> - This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. - </description> - </method> - <method name="get_h_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the X displacement this node has from its parent [Path]. - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the distance along the path in 3D units. - </description> - </method> - <method name="get_rotation_mode" qualifiers="const"> - <return type="int" enum="PathFollow.RotationMode"> - </return> - <description> - Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode. - </description> - </method> - <method name="get_unit_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). - </description> - </method> - <method name="get_v_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the Y displacement this node has from its parent [Path]. - </description> - </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether this node wraps its offsets around, or truncates them to the path ends. - </description> - </method> - <method name="set_cubic_interpolation"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_h_offset"> - <return type="void"> - </return> - <argument index="0" name="h_offset" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_loop"> - <return type="void"> - </return> - <argument index="0" name="loop" type="bool"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_rotation_mode"> - <return type="void"> - </return> - <argument index="0" name="rotation_mode" type="int" enum="PathFollow.RotationMode"> - </argument> - <description> - Allows or forbids rotation on one or more axes, per the constants below. - </description> - </method> - <method name="set_unit_offset"> - <return type="void"> - </return> - <argument index="0" name="unit_offset" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_v_offset"> - <return type="void"> - </return> - <argument index="0" name="v_offset" type="float"> - </argument> - <description> - Moves this node in the Y axis, for the same reasons of [method set_h_offset]. - </description> - </method> </methods> + <members> + <member name="cubic_interp" type="bool" setter="set_cubic_interpolation" getter="get_cubic_interpolation"> + 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. + </member> + <member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset"> + The node's offset along the curve. + </member> + <member name="loop" type="bool" setter="set_loop" getter="has_loop"> + 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. + </member> + <member name="offset" type="float" setter="set_offset" getter="get_offset"> + 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. + </member> + <member name="rotation_mode" type="int" setter="set_rotation_mode" getter="get_rotation_mode" enum="PathFollow.RotationMode"> + Allows or forbids rotation on one or more axes, depending on the constants being used. + </member> + <member name="unit_offset" type="float" setter="set_unit_offset" getter="get_unit_offset"> + 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. + </member> + <member name="v_offset" type="float" setter="set_v_offset" getter="get_v_offset"> + The node's offset perpendicular to the curve. + </member> + </members> <constants> <constant name="ROTATION_NONE" value="0" enum="RotationMode"> Forbids the PathFollow to rotate. diff --git a/doc/classes/PathFollow2D.xml b/doc/classes/PathFollow2D.xml index 56bec3d719..2d844c22bb 100644 --- a/doc/classes/PathFollow2D.xml +++ b/doc/classes/PathFollow2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PathFollow2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="PathFollow2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Point sampler for a [Path2D]. </brief_description> @@ -12,122 +12,34 @@ <demos> </demos> <methods> - <method name="get_cubic_interpolation" qualifiers="const"> - <return type="bool"> - </return> - <description> - This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. - </description> - </method> - <method name="get_h_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the horizontal displacement this node has from its parent [Path2D]. - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the distance along the path in pixels. - </description> - </method> - <method name="get_unit_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). - </description> - </method> - <method name="get_v_offset" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the vertical displacement this node has from its parent [Path2D]. - </description> - </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether this node wraps its offsets around, or truncates them to the path ends. - </description> - </method> - <method name="is_rotating" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether this node rotates to follow the path. - </description> - </method> - <method name="set_cubic_interpolation"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_h_offset"> - <return type="void"> - </return> - <argument index="0" name="h_offset" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_loop"> - <return type="void"> - </return> - <argument index="0" name="loop" type="bool"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_offset"> - <return type="void"> - </return> - <argument index="0" name="offset" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_rotate"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - If set, this node rotates to follow the path, making its descendants rotate. - </description> - </method> - <method name="set_unit_offset"> - <return type="void"> - </return> - <argument index="0" name="unit_offset" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_v_offset"> - <return type="void"> - </return> - <argument index="0" name="v_offset" type="float"> - </argument> - <description> - Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset]. - </description> - </method> </methods> + <members> + <member name="cubic_interp" type="bool" setter="set_cubic_interpolation" getter="get_cubic_interpolation"> + 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. + </member> + <member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset"> + The node's offset along the curve. + </member> + <member name="lookahead" type="float" setter="set_lookahead" getter="get_lookahead"> + </member> + <member name="loop" type="bool" setter="set_loop" getter="has_loop"> + 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. + </member> + <member name="offset" type="float" setter="set_offset" getter="get_offset"> + The distance along the path in pixels. + </member> + <member name="rotate" type="bool" setter="set_rotate" getter="is_rotating"> + If [code]true[/code], this node rotates to follow the path, making its descendants rotate. + </member> + <member name="unit_offset" type="float" setter="set_unit_offset" getter="get_unit_offset"> + 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. + </member> + <member name="v_offset" type="float" setter="set_v_offset" getter="get_v_offset"> + The node's offset perpendicular to the curve. + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index 5781d6c604..18e45f7c3f 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Performance" inherits="Object" category="Core" version="3.0-beta"> +<class name="Performance" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Exposes performance related data. </brief_description> diff --git a/doc/classes/Physics2DDirectBodyState.xml b/doc/classes/Physics2DDirectBodyState.xml index a229ca494d..190325396d 100644 --- a/doc/classes/Physics2DDirectBodyState.xml +++ b/doc/classes/Physics2DDirectBodyState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DDirectBodyState" inherits="Object" category="Core" version="3.0-beta"> +<class name="Physics2DDirectBodyState" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Direct access object to a physics body in the [Physics2DServer]. </brief_description> @@ -11,13 +11,6 @@ <demos> </demos> <methods> - <method name="get_angular_velocity" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the angular velocity of the body. - </description> - </method> <method name="get_contact_collider" qualifiers="const"> <return type="RID"> </return> @@ -115,27 +108,6 @@ Return the local shape index of the collision. </description> </method> - <method name="get_inverse_inertia" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the inverse of the inertia of the body. - </description> - </method> - <method name="get_inverse_mass" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the inverse of the mass of the body. - </description> - </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the current linear velocity of the body. - </description> - </method> <method name="get_space_state"> <return type="Physics2DDirectSpaceState"> </return> @@ -143,41 +115,6 @@ Return the current state of space, useful for queries. </description> </method> - <method name="get_step" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the timestep (delta) used for the simulation. - </description> - </method> - <method name="get_total_angular_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the rate at which the body stops rotating, if there are not any other forces moving it. - </description> - </method> - <method name="get_total_gravity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the total gravity vector being currently applied to this body. - </description> - </method> - <method name="get_total_linear_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the rate at which the body stops moving, if there are not any other forces moving it. - </description> - </method> - <method name="get_transform" qualifiers="const"> - <return type="Transform2D"> - </return> - <description> - Return the transform matrix of the body. - </description> - </method> <method name="integrate_forces"> <return type="void"> </return> @@ -185,50 +122,39 @@ Call the built-in force integration code. </description> </method> - <method name="is_sleeping" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if this body is currently sleeping (not active). - </description> - </method> - <method name="set_angular_velocity"> - <return type="void"> - </return> - <argument index="0" name="velocity" type="float"> - </argument> - <description> - Change the angular velocity of the body. - </description> - </method> - <method name="set_linear_velocity"> - <return type="void"> - </return> - <argument index="0" name="velocity" type="Vector2"> - </argument> - <description> - Change the linear velocity of the body. - </description> - </method> - <method name="set_sleep_state"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set the sleeping state of the body, only affects character/rigid bodies. - </description> - </method> - <method name="set_transform"> - <return type="void"> - </return> - <argument index="0" name="transform" type="Transform2D"> - </argument> - <description> - Change the transform matrix of the body. - </description> - </method> </methods> + <members> + <member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity"> + The angular velocity of the body. + </member> + <member name="inverse_inertia" type="float" setter="" getter="get_inverse_inertia"> + The inverse of the inertia of the body. + </member> + <member name="inverse_mass" type="float" setter="" getter="get_inverse_mass"> + The inverse of the mass of the body. + </member> + <member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity"> + The linear velocity of the body. + </member> + <member name="sleeping" type="bool" setter="set_sleep_state" getter="is_sleeping"> + [code]true[/code] if this body is currently sleeping (not active). + </member> + <member name="step" type="float" setter="" getter="get_step"> + The timestep (delta) used for the simulation. + </member> + <member name="total_angular_damp" type="float" setter="" getter="get_total_angular_damp"> + The rate at which the body stops rotating, if there are not any other forces moving it. + </member> + <member name="total_gravity" type="Vector2" setter="" getter="get_total_gravity"> + The total gravity vector being currently applied to this body. + </member> + <member name="total_linear_damp" type="float" setter="" getter="get_total_linear_damp"> + The rate at which the body stops moving, if there are not any other forces moving it. + </member> + <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform"> + The transformation matrix of the body. + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/Physics2DDirectBodyStateSW.xml b/doc/classes/Physics2DDirectBodyStateSW.xml index 0ce51e2cf5..f6bcaef7be 100644 --- a/doc/classes/Physics2DDirectBodyStateSW.xml +++ b/doc/classes/Physics2DDirectBodyStateSW.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DDirectBodyStateSW" inherits="Physics2DDirectBodyState" category="Core" version="3.0-beta"> +<class name="Physics2DDirectBodyStateSW" inherits="Physics2DDirectBodyState" category="Core" version="3.0-stable"> <brief_description> Software implementation of [Physics2DDirectBodyState]. </brief_description> diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml index 2e2d8e95f9..5e0908f497 100644 --- a/doc/classes/Physics2DDirectSpaceState.xml +++ b/doc/classes/Physics2DDirectSpaceState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DDirectSpaceState" inherits="Object" category="Core" version="3.0-beta"> +<class name="Physics2DDirectSpaceState" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Direct access object to a space in the [Physics2DServer]. </brief_description> @@ -7,6 +7,7 @@ Direct access object to a space in the [Physics2DServer]. It's used mainly to do queries against objects and areas residing in a given space. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/ray-casting.html </tutorials> <demos> </demos> diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index 8bad396b84..c0316aa1bc 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DServer" inherits="Object" category="Core" version="3.0-beta"> +<class name="Physics2DServer" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Physics 2D Server. </brief_description> diff --git a/doc/classes/Physics2DServerSW.xml b/doc/classes/Physics2DServerSW.xml index 09fed88082..6942c5e3af 100644 --- a/doc/classes/Physics2DServerSW.xml +++ b/doc/classes/Physics2DServerSW.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DServerSW" inherits="Physics2DServer" category="Core" version="3.0-beta"> +<class name="Physics2DServerSW" inherits="Physics2DServer" category="Core" version="3.0-stable"> <brief_description> Software implementation of [Physics2DServer]. </brief_description> diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 93165afe60..7cd35f4167 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DShapeQueryParameters" inherits="Reference" category="Core" version="3.0-beta"> +<class name="Physics2DShapeQueryParameters" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Parameters to be sent to a 2D shape physics query. </brief_description> @@ -11,84 +11,6 @@ <demos> </demos> <methods> - <method name="get_collision_layer" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the physics layer the shape belongs to. - </description> - </method> - <method name="get_exclude" qualifiers="const"> - <return type="Array"> - </return> - <description> - Return the list of objects, or object [RID]s, that will be excluded from collisions. - </description> - </method> - <method name="get_margin" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the collision margin for the shape. - </description> - </method> - <method name="get_motion" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the current movement speed of the shape. - </description> - </method> - <method name="get_shape_rid" qualifiers="const"> - <return type="RID"> - </return> - <description> - Return the [RID] of the shape queried. - </description> - </method> - <method name="get_transform" qualifiers="const"> - <return type="Transform2D"> - </return> - <description> - Return the transform matrix of the shape queried. - </description> - </method> - <method name="set_collision_layer"> - <return type="void"> - </return> - <argument index="0" name="collision_layer" type="int"> - </argument> - <description> - Set the physics layer the shape belongs to. - </description> - </method> - <method name="set_exclude"> - <return type="void"> - </return> - <argument index="0" name="exclude" type="Array"> - </argument> - <description> - Set the list of objects, or object [RID]s, that will be excluded from collisions. - </description> - </method> - <method name="set_margin"> - <return type="void"> - </return> - <argument index="0" name="margin" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_motion"> - <return type="void"> - </return> - <argument index="0" name="motion" type="Vector2"> - </argument> - <description> - Set the current movement speed of the shape. - </description> - </method> <method name="set_shape"> <return type="void"> </return> @@ -98,25 +20,27 @@ Set the [Shape2D] that will be used for collision/intersection queries. </description> </method> - <method name="set_shape_rid"> - <return type="void"> - </return> - <argument index="0" name="shape" type="RID"> - </argument> - <description> - Set the [RID] of the shape to be used in queries. - </description> - </method> - <method name="set_transform"> - <return type="void"> - </return> - <argument index="0" name="transform" type="Transform2D"> - </argument> - <description> - Set the transformation matrix of the shape. This is necessary to set its position/rotation/scale. - </description> - </method> </methods> + <members> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> + The physics layer the query should be made on. + </member> + <member name="exclude" type="Array" setter="set_exclude" getter="get_exclude"> + The list of objects or object [RID]s, that will be excluded from collisions. + </member> + <member name="margin" type="float" setter="set_margin" getter="get_margin"> + The collision margin for the shape. + </member> + <member name="motion" type="Vector2" setter="set_motion" getter="get_motion"> + The motion of the shape being queried for. + </member> + <member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid"> + The [RID] of the queried shape. See [method set_shape] also. + </member> + <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform"> + the transform matrix of the queried shape. + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/Physics2DShapeQueryResult.xml b/doc/classes/Physics2DShapeQueryResult.xml index 5345ad161f..b080da43a2 100644 --- a/doc/classes/Physics2DShapeQueryResult.xml +++ b/doc/classes/Physics2DShapeQueryResult.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DShapeQueryResult" inherits="Reference" category="Core" version="3.0-beta"> +<class name="Physics2DShapeQueryResult" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Physics2DTestMotionResult.xml b/doc/classes/Physics2DTestMotionResult.xml index bc7cb68bc9..8b4260c484 100644 --- a/doc/classes/Physics2DTestMotionResult.xml +++ b/doc/classes/Physics2DTestMotionResult.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Physics2DTestMotionResult" inherits="Reference" category="Core" version="3.0-beta"> +<class name="Physics2DTestMotionResult" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -9,61 +9,27 @@ <demos> </demos> <methods> - <method name="get_collider" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="get_collider_id" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_collider_rid" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="get_collider_shape" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_collider_velocity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_collision_normal" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_collision_point" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_motion" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_motion_remainder" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> </methods> + <members> + <member name="collider" type="Object" setter="" getter="get_collider"> + </member> + <member name="collider_id" type="int" setter="" getter="get_collider_id"> + </member> + <member name="collider_rid" type="RID" setter="" getter="get_collider_rid"> + </member> + <member name="collider_shape" type="int" setter="" getter="get_collider_shape"> + </member> + <member name="collider_velocity" type="Vector2" setter="" getter="get_collider_velocity"> + </member> + <member name="collision_normal" type="Vector2" setter="" getter="get_collision_normal"> + </member> + <member name="collision_point" type="Vector2" setter="" getter="get_collision_point"> + </member> + <member name="motion" type="Vector2" setter="" getter="get_motion"> + </member> + <member name="motion_remainder" type="Vector2" setter="" getter="get_motion_remainder"> + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/PhysicsBody.xml b/doc/classes/PhysicsBody.xml index 79164215c8..27db2c8f07 100644 --- a/doc/classes/PhysicsBody.xml +++ b/doc/classes/PhysicsBody.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsBody" inherits="CollisionObject" category="Core" version="3.0-beta"> +<class name="PhysicsBody" inherits="CollisionObject" category="Core" version="3.0-stable"> <brief_description> Base class for all objects affected by physics in 3D space. </brief_description> @@ -7,6 +7,7 @@ PhysicsBody is an abstract base class for implementing a physics body. All *Body types inherit from it. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html </tutorials> <demos> </demos> diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index aaf782c245..34e86fa63a 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsBody2D" inherits="CollisionObject2D" category="Core" version="3.0-beta"> +<class name="PhysicsBody2D" inherits="CollisionObject2D" category="Core" version="3.0-stable"> <brief_description> Base class for all objects affected by physics in 2D space. </brief_description> @@ -7,6 +7,7 @@ PhysicsBody2D is an abstract base class for implementing a physics body. All *Body2D types inherit from it. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html </tutorials> <demos> </demos> diff --git a/doc/classes/PhysicsDirectBodyState.xml b/doc/classes/PhysicsDirectBodyState.xml index 1d588ecfff..1f9c492571 100644 --- a/doc/classes/PhysicsDirectBodyState.xml +++ b/doc/classes/PhysicsDirectBodyState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsDirectBodyState" inherits="Object" category="Core" version="3.0-beta"> +<class name="PhysicsDirectBodyState" inherits="Object" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -37,18 +37,6 @@ <description> </description> </method> - <method name="get_angular_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_center_of_mass" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> <method name="get_contact_collider" qualifiers="const"> <return type="RID"> </return> @@ -127,111 +115,55 @@ <description> </description> </method> - <method name="get_inverse_inertia" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_inverse_mass" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_principal_inertia_axes" qualifiers="const"> - <return type="Basis"> - </return> - <description> - </description> - </method> <method name="get_space_state"> <return type="PhysicsDirectSpaceState"> </return> <description> </description> </method> - <method name="get_step" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_total_angular_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_total_gravity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_total_linear_damp" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_transform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - </description> - </method> <method name="integrate_forces"> <return type="void"> </return> <description> </description> </method> - <method name="is_sleeping" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_angular_velocity"> - <return type="void"> - </return> - <argument index="0" name="velocity" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_linear_velocity"> - <return type="void"> - </return> - <argument index="0" name="velocity" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_sleep_state"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_transform"> - <return type="void"> - </return> - <argument index="0" name="transform" type="Transform"> - </argument> - <description> - </description> - </method> </methods> + <members> + <member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity"> + The angular velocity of the body. + </member> + <member name="center_of_mass" type="Vector3" setter="" getter="get_center_of_mass"> + </member> + <member name="inverse_inertia" type="Vector3" setter="" getter="get_inverse_inertia"> + The inverse of the inertia of the body. + </member> + <member name="inverse_mass" type="float" setter="" getter="get_inverse_mass"> + The inverse of the mass of the body. + </member> + <member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity"> + The linear velocity of the body. + </member> + <member name="principal_inertia_axes" type="Basis" setter="" getter="get_principal_inertia_axes"> + </member> + <member name="sleeping" type="bool" setter="set_sleep_state" getter="is_sleeping"> + [code]true[/code] if this body is currently sleeping (not active). + </member> + <member name="step" type="float" setter="" getter="get_step"> + The timestep (delta) used for the simulation. + </member> + <member name="total_angular_damp" type="float" setter="" getter="get_total_angular_damp"> + The rate at which the body stops rotating, if there are not any other forces moving it. + </member> + <member name="total_gravity" type="Vector3" setter="" getter="get_total_gravity"> + The total gravity vector being currently applied to this body. + </member> + <member name="total_linear_damp" type="float" setter="" getter="get_total_linear_damp"> + The rate at which the body stops moving, if there are not any other forces moving it. + </member> + <member name="transform" type="Transform" setter="set_transform" getter="get_transform"> + The transformation matrix of the body. + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/PhysicsDirectSpaceState.xml b/doc/classes/PhysicsDirectSpaceState.xml index d93550eb47..6c8d084f26 100644 --- a/doc/classes/PhysicsDirectSpaceState.xml +++ b/doc/classes/PhysicsDirectSpaceState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsDirectSpaceState" inherits="Object" category="Core" version="3.0-beta"> +<class name="PhysicsDirectSpaceState" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Direct access object to a space in the [PhysicsServer]. </brief_description> @@ -7,6 +7,7 @@ Direct access object to a space in the [PhysicsServer]. It's used mainly to do queries against objects and areas residing in a given space. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/ray-casting.html </tutorials> <demos> </demos> diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 534449a94b..9920d5364b 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsServer" inherits="Object" category="Core" version="3.0-beta"> +<class name="PhysicsServer" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Server interface for low level physics access. </brief_description> @@ -1199,7 +1199,7 @@ If above 0, this value is the maximum value for an impulse that this Joint puts on it's ends. </constant> <constant name="HINGE_JOINT_BIAS" value="0" enum="HingeJointParam"> - The speed with wich the two bodies get pulled together when they move in different directions. + The speed with which the two bodies get pulled together when they move in different directions. </constant> <constant name="HINGE_JOINT_LIMIT_UPPER" value="1" enum="HingeJointParam"> The maximum rotation across the Hinge. @@ -1234,7 +1234,7 @@ The minimum difference between the pivot points on their x-axis before damping happens. </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2" enum="SliderJointParam"> - A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. + A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value="3" enum="SliderJointParam"> The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. @@ -1243,7 +1243,7 @@ The amount of damping once the slider limits are surpassed. </constant> <constant name="SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value="5" enum="SliderJointParam"> - A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. + 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. </constant> <constant name="SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value="6" enum="SliderJointParam"> The amount of restitution inside the slider limits. @@ -1252,13 +1252,13 @@ The amount of damping inside the slider limits. </constant> <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value="8" enum="SliderJointParam"> - A factor applied to the movement accross axes orthogonal to the slider. + A factor applied to the movement across axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value="9" enum="SliderJointParam"> - The amount of restitution when movement is accross axes orthogonal to the slider. + The amount of restitution when movement is across axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value="10" enum="SliderJointParam"> - The amount of damping when movement is accross axes orthogonal to the slider. + The amount of damping when movement is across axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value="11" enum="SliderJointParam"> The upper limit of rotation in the slider. @@ -1323,7 +1323,7 @@ The maximum difference between the pivot points' axes. </constant> <constant name="G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS" value="2" enum="G6DOFJointAxisParam"> - A factor that gets applied to the movement accross the axes. The lower, the slower the movement. + A factor that gets applied to the movement across the axes. The lower, the slower the movement. </constant> <constant name="G6DOF_JOINT_LINEAR_RESTITUTION" value="3" enum="G6DOFJointAxisParam"> The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost. @@ -1332,25 +1332,25 @@ The amount of damping that happens at the linear motion across the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="5" enum="G6DOFJointAxisParam"> - The minimum rotation in negative direction to break loose and rotate arround the axes. + The minimum rotation in negative direction to break loose and rotate around the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="6" enum="G6DOFJointAxisParam"> - The minimum rotation in positive direction to break loose and rotate arround the axes. + The minimum rotation in positive direction to break loose and rotate around the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="7" enum="G6DOFJointAxisParam"> - A factor that gets multiplied onto all rotations accross the axes. + A factor that gets multiplied onto all rotations across the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="8" enum="G6DOFJointAxisParam"> - The amount of rotational damping accross the axes. The lower, the more dampening occurs. + The amount of rotational damping across the axes. The lower, the more dampening occurs. </constant> <constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="9" enum="G6DOFJointAxisParam"> - The amount of rotational restitution accross the axes. The lower, the more restitution occurs. + The amount of rotational restitution across the axes. The lower, the more restitution occurs. </constant> <constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="10" enum="G6DOFJointAxisParam"> - The maximum amount of force that can occur, when rotating arround the axes. + The maximum amount of force that can occur, when rotating around the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_ERP" value="11" enum="G6DOFJointAxisParam"> - When correcting the crossing of limits in rotation accross the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. + When correcting the crossing of limits in rotation across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </constant> <constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="12" enum="G6DOFJointAxisParam"> Target speed for the motor at the axes. diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml index 98d6846b13..3f68136285 100644 --- a/doc/classes/PhysicsShapeQueryParameters.xml +++ b/doc/classes/PhysicsShapeQueryParameters.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsShapeQueryParameters" inherits="Reference" category="Core" version="3.0-beta"> +<class name="PhysicsShapeQueryParameters" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -9,60 +9,6 @@ <demos> </demos> <methods> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_exclude" qualifiers="const"> - <return type="Array"> - </return> - <description> - </description> - </method> - <method name="get_margin" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="get_shape_rid" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="get_transform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - </description> - </method> - <method name="set_collision_mask"> - <return type="void"> - </return> - <argument index="0" name="collision_mask" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_exclude"> - <return type="void"> - </return> - <argument index="0" name="exclude" type="Array"> - </argument> - <description> - </description> - </method> - <method name="set_margin"> - <return type="void"> - </return> - <argument index="0" name="margin" type="float"> - </argument> - <description> - </description> - </method> <method name="set_shape"> <return type="void"> </return> @@ -71,23 +17,19 @@ <description> </description> </method> - <method name="set_shape_rid"> - <return type="void"> - </return> - <argument index="0" name="shape" type="RID"> - </argument> - <description> - </description> - </method> - <method name="set_transform"> - <return type="void"> - </return> - <argument index="0" name="transform" type="Transform"> - </argument> - <description> - </description> - </method> </methods> + <members> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + </member> + <member name="exclude" type="Array" setter="set_exclude" getter="get_exclude"> + </member> + <member name="margin" type="float" setter="set_margin" getter="get_margin"> + </member> + <member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid"> + </member> + <member name="transform" type="Transform" setter="set_transform" getter="get_transform"> + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/PhysicsShapeQueryResult.xml b/doc/classes/PhysicsShapeQueryResult.xml index d18d09b612..109074c35c 100644 --- a/doc/classes/PhysicsShapeQueryResult.xml +++ b/doc/classes/PhysicsShapeQueryResult.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsShapeQueryResult" inherits="Reference" category="Core" version="3.0-beta"> +<class name="PhysicsShapeQueryResult" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Result of a shape query in Physics2DServer. </brief_description> diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index 46e3d3c512..a8cc0ad9b3 100644 --- a/doc/classes/PinJoint.xml +++ b/doc/classes/PinJoint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PinJoint" inherits="Joint" category="Core" version="3.0-beta"> +<class name="PinJoint" inherits="Joint" category="Core" version="3.0-stable"> <brief_description> Pin Joint for 3D Shapes. </brief_description> @@ -14,11 +14,11 @@ </methods> <members> <member name="params/bias" type="float" setter="set_param" getter="get_param"> - The force with wich the pinned objects stay in positional relation to each other. + The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. </member> <member name="params/damping" type="float" setter="set_param" getter="get_param"> - The force with wich the pinned objects stay in velocity relation to each other. + The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. </member> <member name="params/impulse_clamp" type="float" setter="set_param" getter="get_param"> @@ -27,11 +27,11 @@ </members> <constants> <constant name="PARAM_BIAS" value="0" enum="Param"> - The force with wich the pinned objects stay in positional relation to each other. + The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. </constant> <constant name="PARAM_DAMPING" value="1" enum="Param"> - The force with wich the pinned objects stay in velocity relation to each other. + The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. </constant> <constant name="PARAM_IMPULSE_CLAMP" value="2" enum="Param"> diff --git a/doc/classes/PinJoint2D.xml b/doc/classes/PinJoint2D.xml index c8a886896e..08fb849523 100644 --- a/doc/classes/PinJoint2D.xml +++ b/doc/classes/PinJoint2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PinJoint2D" inherits="Joint2D" category="Core" version="3.0-beta"> +<class name="PinJoint2D" inherits="Joint2D" category="Core" version="3.0-stable"> <brief_description> Pin Joint for 2D Shapes. </brief_description> diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index c895850a64..b1984ec03f 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Plane" category="Built-In Types" version="3.0-beta"> +<class name="Plane" category="Built-In Types" version="3.0-stable"> <brief_description> Plane in hessian form. </brief_description> @@ -7,6 +7,7 @@ Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/math/index.html </tutorials> <demos> </demos> diff --git a/doc/classes/PlaneMesh.xml b/doc/classes/PlaneMesh.xml index 760d64d2de..cd97d5c6eb 100644 --- a/doc/classes/PlaneMesh.xml +++ b/doc/classes/PlaneMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PlaneMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> +<class name="PlaneMesh" inherits="PrimitiveMesh" category="Core" version="3.0-stable"> <brief_description> Class representing a planar [PrimitiveMesh]. </brief_description> diff --git a/doc/classes/PlaneShape.xml b/doc/classes/PlaneShape.xml index b3adf61d68..5912a2a91b 100644 --- a/doc/classes/PlaneShape.xml +++ b/doc/classes/PlaneShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PlaneShape" inherits="Shape" category="Core" version="3.0-beta"> +<class name="PlaneShape" inherits="Shape" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index f69010458e..8c68c06e65 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Polygon2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="Polygon2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> A 2D polygon. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_texture_rotation" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the rotation in radians of the texture polygon. - </description> - </method> - <method name="set_texture_rotation"> - <return type="void"> - </return> - <argument index="0" name="texture_rotation" type="float"> - </argument> - <description> - Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation. - </description> - </method> </methods> <members> <member name="antialiased" type="bool" setter="set_antialiased" getter="get_antialiased"> @@ -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]. </member> <member name="texture_rotation" type="float" setter="set_texture_rotation_degrees" getter="get_texture_rotation_degrees"> + The texture's rotation in radians. + </member> + <member name="texture_rotation_degrees" type="float" setter="set_texture_rotation_degrees" getter="get_texture_rotation_degrees"> The texture's rotation in degrees. </member> <member name="texture_scale" type="Vector2" setter="set_texture_scale" getter="get_texture_scale"> diff --git a/doc/classes/PolygonPathFinder.xml b/doc/classes/PolygonPathFinder.xml index 48c5625e6b..cea33fa5c8 100644 --- a/doc/classes/PolygonPathFinder.xml +++ b/doc/classes/PolygonPathFinder.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PolygonPathFinder" inherits="Resource" category="Core" version="3.0-beta"> +<class name="PolygonPathFinder" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml index 653ea958a3..5e80072d46 100644 --- a/doc/classes/PoolByteArray.xml +++ b/doc/classes/PoolByteArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolByteArray" category="Built-In Types" version="3.0-beta"> +<class name="PoolByteArray" category="Built-In Types" version="3.0-stable"> <brief_description> Raw byte array. </brief_description> diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml index 04267e0935..47fb38f440 100644 --- a/doc/classes/PoolColorArray.xml +++ b/doc/classes/PoolColorArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolColorArray" category="Built-In Types" version="3.0-beta"> +<class name="PoolColorArray" category="Built-In Types" version="3.0-stable"> <brief_description> Array of Colors </brief_description> diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml index 0baf194b52..c24d565db8 100644 --- a/doc/classes/PoolIntArray.xml +++ b/doc/classes/PoolIntArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolIntArray" category="Built-In Types" version="3.0-beta"> +<class name="PoolIntArray" category="Built-In Types" version="3.0-stable"> <brief_description> Integer Array. </brief_description> diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml index 0a6c855647..49f4ed85d2 100644 --- a/doc/classes/PoolRealArray.xml +++ b/doc/classes/PoolRealArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolRealArray" category="Built-In Types" version="3.0-beta"> +<class name="PoolRealArray" category="Built-In Types" version="3.0-stable"> <brief_description> Real Array. </brief_description> diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml index 37842c1c85..bc273e2fb6 100644 --- a/doc/classes/PoolStringArray.xml +++ b/doc/classes/PoolStringArray.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolStringArray" category="Built-In Types" version="3.0-beta"> +<class name="PoolStringArray" category="Built-In Types" version="3.0-stable"> <brief_description> String Array. </brief_description> diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml index a98f3d6d7e..d08cfbba33 100644 --- a/doc/classes/PoolVector2Array.xml +++ b/doc/classes/PoolVector2Array.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolVector2Array" category="Built-In Types" version="3.0-beta"> +<class name="PoolVector2Array" category="Built-In Types" version="3.0-stable"> <brief_description> An Array of Vector2. </brief_description> diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml index f3b3274e47..99d5929ded 100644 --- a/doc/classes/PoolVector3Array.xml +++ b/doc/classes/PoolVector3Array.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolVector3Array" category="Built-In Types" version="3.0-beta"> +<class name="PoolVector3Array" category="Built-In Types" version="3.0-stable"> <brief_description> An Array of Vector3. </brief_description> diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml index 930e646dee..0e6d6c844d 100644 --- a/doc/classes/Popup.xml +++ b/doc/classes/Popup.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Popup" inherits="Control" category="Core" version="3.0-beta"> +<class name="Popup" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Base container control for popups and dialogs. </brief_description> diff --git a/doc/classes/PopupDialog.xml b/doc/classes/PopupDialog.xml index 15df0e4ad2..b47674b588 100644 --- a/doc/classes/PopupDialog.xml +++ b/doc/classes/PopupDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PopupDialog" inherits="Popup" category="Core" version="3.0-beta"> +<class name="PopupDialog" inherits="Popup" category="Core" version="3.0-stable"> <brief_description> Base class for Popup Dialogs. </brief_description> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 13cf16d2ee..2ffdc07e1f 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PopupMenu" inherits="Popup" category="Core" version="3.0-beta"> +<class name="PopupMenu" inherits="Popup" category="Core" version="3.0-stable"> <brief_description> PopupMenu displays a list of options. </brief_description> @@ -233,12 +233,6 @@ <description> </description> </method> - <method name="is_hide_on_state_item_selection" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="is_item_checkable" qualifiers="const"> <return type="bool"> </return> @@ -272,7 +266,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item is a seperator. If it is, it would be displayed as a line. + Return whether the item is a separator. If it is, it would be displayed as a line. </description> </method> <method name="remove_item"> @@ -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. </description> </method> - <method name="set_hide_on_state_item_selection"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> <method name="set_item_accelerator"> <return type="void"> </return> @@ -322,7 +308,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> - Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line. + Mark the item at index "idx" as a separator, which means that it would be displayed as a mere line. </description> </method> <method name="set_item_checked"> @@ -455,6 +441,8 @@ </member> <member name="hide_on_item_selection" type="bool" setter="set_hide_on_item_selection" getter="is_hide_on_item_selection"> </member> + <member name="hide_on_state_item_selection" type="bool" setter="set_hide_on_state_item_selection" getter="is_hide_on_state_item_selection"> + </member> </members> <signals> <signal name="id_pressed"> diff --git a/doc/classes/PopupPanel.xml b/doc/classes/PopupPanel.xml index 179f91e74b..0de5319f59 100644 --- a/doc/classes/PopupPanel.xml +++ b/doc/classes/PopupPanel.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PopupPanel" inherits="Popup" category="Core" version="3.0-beta"> +<class name="PopupPanel" inherits="Popup" category="Core" version="3.0-stable"> <brief_description> Class for displaying popups with a panel background. </brief_description> diff --git a/doc/classes/Position2D.xml b/doc/classes/Position2D.xml index d222a5dc04..d06d9220a7 100644 --- a/doc/classes/Position2D.xml +++ b/doc/classes/Position2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Position2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="Position2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Generic 2D Position hint for editing. </brief_description> diff --git a/doc/classes/Position3D.xml b/doc/classes/Position3D.xml index a5b8a119ff..5f3aa004dc 100644 --- a/doc/classes/Position3D.xml +++ b/doc/classes/Position3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Position3D" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="Position3D" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Generic 3D Position hint for editing </brief_description> diff --git a/doc/classes/PrimitiveMesh.xml b/doc/classes/PrimitiveMesh.xml index e8ad23524f..7f0ee9ce37 100644 --- a/doc/classes/PrimitiveMesh.xml +++ b/doc/classes/PrimitiveMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PrimitiveMesh" inherits="Mesh" category="Core" version="3.0-beta"> +<class name="PrimitiveMesh" inherits="Mesh" category="Core" version="3.0-stable"> <brief_description> Base class for all primitive meshes. Handles applying a [Material] to a primitive mesh. </brief_description> diff --git a/doc/classes/PrismMesh.xml b/doc/classes/PrismMesh.xml index 38bb3a4eb6..389acc9320 100644 --- a/doc/classes/PrismMesh.xml +++ b/doc/classes/PrismMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PrismMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> +<class name="PrismMesh" inherits="PrimitiveMesh" category="Core" version="3.0-stable"> <brief_description> Class representing a prism-shaped [PrimitiveMesh]. </brief_description> diff --git a/doc/classes/ProceduralSky.xml b/doc/classes/ProceduralSky.xml index 2abd1104ce..9d7e590fa3 100644 --- a/doc/classes/ProceduralSky.xml +++ b/doc/classes/ProceduralSky.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ProceduralSky" inherits="Sky" category="Core" version="3.0-beta"> +<class name="ProceduralSky" inherits="Sky" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml index 7417ddb53e..321f27008d 100644 --- a/doc/classes/ProgressBar.xml +++ b/doc/classes/ProgressBar.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ProgressBar" inherits="Range" category="Core" version="3.0-beta"> +<class name="ProgressBar" inherits="Range" category="Core" version="3.0-stable"> <brief_description> General purpose progress bar. </brief_description> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index e28860a577..7d0856127c 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ProjectSettings" inherits="Object" category="Core" version="3.0-beta"> +<class name="ProjectSettings" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Contains global variables accessible from everywhere. </brief_description> <description> - Contains global variables accessible from everywhere. Use the normal [Object] API, such as "ProjectSettings.get(variable)", "ProjectSettings.set(variable,value)" or "ProjectSettings.has(variable)" to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options. + Contains global variables accessible from everywhere. Use "ProjectSettings.get_setting(variable)", "ProjectSettings.set_setting(variable,value)" or "ProjectSettings.has_setting(variable)" to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options. </description> <tutorials> </tutorials> diff --git a/doc/classes/ProximityGroup.xml b/doc/classes/ProximityGroup.xml index 42e2c5e690..b4a424dfdd 100644 --- a/doc/classes/ProximityGroup.xml +++ b/doc/classes/ProximityGroup.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ProximityGroup" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="ProximityGroup" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> General purpose proximity-detection node. </brief_description> @@ -21,30 +21,18 @@ <description> </description> </method> - <method name="set_dispatch_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_group_name"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> </methods> <members> + <member name="dispatch_mode" type="int" setter="set_dispatch_mode" getter="get_dispatch_mode" enum="ProximityGroup.DispatchMode"> + </member> <member name="grid_radius" type="Vector3" setter="set_grid_radius" getter="get_grid_radius"> </member> + <member name="group_name" type="String" setter="set_group_name" getter="get_group_name"> + </member> </members> <signals> <signal name="broadcast"> - <argument index="0" name="name" type="String"> + <argument index="0" name="group_name" type="String"> </argument> <argument index="1" name="parameters" type="Array"> </argument> @@ -53,5 +41,9 @@ </signal> </signals> <constants> + <constant name="MODE_PROXY" value="0" enum="DispatchMode"> + </constant> + <constant name="MODE_SIGNAL" value="1" enum="DispatchMode"> + </constant> </constants> </class> diff --git a/doc/classes/ProxyTexture.xml b/doc/classes/ProxyTexture.xml index 2cdcac8775..68f03ca4fa 100644 --- a/doc/classes/ProxyTexture.xml +++ b/doc/classes/ProxyTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ProxyTexture" inherits="Texture" category="Core" version="3.0-beta"> +<class name="ProxyTexture" inherits="Texture" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/QuadMesh.xml b/doc/classes/QuadMesh.xml index 78884d5492..f1b38d379a 100644 --- a/doc/classes/QuadMesh.xml +++ b/doc/classes/QuadMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="QuadMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> +<class name="QuadMesh" inherits="PrimitiveMesh" category="Core" version="3.0-stable"> <brief_description> Class representing a square mesh. </brief_description> diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index 9fab28c6c8..ead73d0267 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Quat" category="Built-In Types" version="3.0-beta"> +<class name="Quat" category="Built-In Types" version="3.0-stable"> <brief_description> Quaternion. </brief_description> diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index 0796e654c1..1510d75679 100644 --- a/doc/classes/RID.xml +++ b/doc/classes/RID.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RID" category="Built-In Types" version="3.0-beta"> +<class name="RID" category="Built-In Types" version="3.0-stable"> <brief_description> Handle for a [Resource]'s unique ID. </brief_description> diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index d86ff57661..8a0c831805 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Range" inherits="Control" category="Core" version="3.0-beta"> +<class name="Range" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Abstract base class for range-based controls. </brief_description> @@ -11,22 +11,6 @@ <demos> </demos> <methods> - <method name="get_as_ratio" qualifiers="const"> - <return type="float"> - </return> - <description> - Return value mapped to 0 to 1 range. - </description> - </method> - <method name="set_as_ratio"> - <return type="void"> - </return> - <argument index="0" name="value" type="float"> - </argument> - <description> - Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. - </description> - </method> <method name="share"> <return type="void"> </return> @@ -57,6 +41,9 @@ <member name="page" type="float" setter="set_page" getter="get_page"> 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]. </member> + <member name="ratio" type="float" setter="set_as_ratio" getter="get_as_ratio"> + The value mapped between 0 and 1. + </member> <member name="rounded" type="bool" setter="set_use_rounded_values" getter="is_using_rounded_values"> If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer. </member> diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index 20e262b664..09e0f8b643 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RayCast" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="RayCast" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Query the closest object intersecting a ray. </brief_description> diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 4e93260549..b76c880bb7 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RayCast2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="RayCast2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Query the closest object intersecting a ray. </brief_description> @@ -76,6 +76,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Return an individual bit on the collision mask. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -125,6 +126,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> </methods> diff --git a/doc/classes/RayShape.xml b/doc/classes/RayShape.xml index 94129dbafe..6d83ed2903 100644 --- a/doc/classes/RayShape.xml +++ b/doc/classes/RayShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RayShape" inherits="Shape" category="Core" version="3.0-beta"> +<class name="RayShape" inherits="Shape" category="Core" version="3.0-stable"> <brief_description> Ray shape for 3D collisions. </brief_description> diff --git a/doc/classes/RayShape2D.xml b/doc/classes/RayShape2D.xml index 748f5ea8b1..ce004b582b 100644 --- a/doc/classes/RayShape2D.xml +++ b/doc/classes/RayShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RayShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> +<class name="RayShape2D" inherits="Shape2D" category="Core" version="3.0-stable"> <brief_description> Ray shape for 2D collisions. </brief_description> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 4fc9e5bd71..6d953d2615 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Rect2" category="Built-In Types" version="3.0-beta"> +<class name="Rect2" category="Built-In Types" version="3.0-stable"> <brief_description> 2D Axis-aligned bounding box. </brief_description> @@ -7,6 +7,7 @@ Rect2 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/math/index.html </tutorials> <demos> </demos> diff --git a/doc/classes/RectangleShape2D.xml b/doc/classes/RectangleShape2D.xml index 13994edddf..4ecd0aadf4 100644 --- a/doc/classes/RectangleShape2D.xml +++ b/doc/classes/RectangleShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RectangleShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> +<class name="RectangleShape2D" inherits="Shape2D" category="Core" version="3.0-stable"> <brief_description> Rectangle shape for 2D collisions. </brief_description> diff --git a/doc/classes/Reference.xml b/doc/classes/Reference.xml index ec05b43bb0..ba769db5e7 100644 --- a/doc/classes/Reference.xml +++ b/doc/classes/Reference.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Reference" inherits="Object" category="Core" version="3.0-beta"> +<class name="Reference" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Base class for anything that keeps a reference count. </brief_description> diff --git a/doc/classes/ReferenceRect.xml b/doc/classes/ReferenceRect.xml index a0f56e078e..2a13eb3312 100644 --- a/doc/classes/ReferenceRect.xml +++ b/doc/classes/ReferenceRect.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ReferenceRect" inherits="Control" category="Core" version="3.0-beta"> +<class name="ReferenceRect" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Reference frame for GUI. </brief_description> diff --git a/doc/classes/ReflectionProbe.xml b/doc/classes/ReflectionProbe.xml index 21bd087407..5db9f32486 100644 --- a/doc/classes/ReflectionProbe.xml +++ b/doc/classes/ReflectionProbe.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ReflectionProbe" inherits="VisualInstance" category="Core" version="3.0-beta"> +<class name="ReflectionProbe" inherits="VisualInstance" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/3d/reflection_probes.html </tutorials> <demos> </demos> diff --git a/doc/classes/RemoteTransform.xml b/doc/classes/RemoteTransform.xml index c5643409ce..e9b8d2b746 100644 --- a/doc/classes/RemoteTransform.xml +++ b/doc/classes/RemoteTransform.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RemoteTransform" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="RemoteTransform" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> RemoteTransform leads the [Transform] of another [Spatial] derived Node in the scene. </brief_description> diff --git a/doc/classes/RemoteTransform2D.xml b/doc/classes/RemoteTransform2D.xml index 77308209ea..c6022fd1ff 100644 --- a/doc/classes/RemoteTransform2D.xml +++ b/doc/classes/RemoteTransform2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RemoteTransform2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="RemoteTransform2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> RemoteTransform2D leads the [Transform2D] of another [CanvasItem] derived Node in the scene. </brief_description> diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index 713fcab573..8113d81fbb 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Resource" inherits="Reference" category="Core" version="3.0-beta"> +<class name="Resource" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Base class for all resources. </brief_description> diff --git a/doc/classes/ResourceImporter.xml b/doc/classes/ResourceImporter.xml index 5474f09a7c..c68bdd613c 100644 --- a/doc/classes/ResourceImporter.xml +++ b/doc/classes/ResourceImporter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourceImporter" inherits="Reference" category="Core" version="3.0-beta"> +<class name="ResourceImporter" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ResourceInteractiveLoader.xml b/doc/classes/ResourceInteractiveLoader.xml index 13d701f3c6..8a8023c8ec 100644 --- a/doc/classes/ResourceInteractiveLoader.xml +++ b/doc/classes/ResourceInteractiveLoader.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourceInteractiveLoader" inherits="Reference" category="Core" version="3.0-beta"> +<class name="ResourceInteractiveLoader" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Interactive Resource Loader. </brief_description> diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 8d1ab1cd80..d4f61b7929 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourceLoader" inherits="Object" category="Core" version="3.0-beta"> +<class name="ResourceLoader" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Resource Loader. </brief_description> diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index c749529a19..868ca62963 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourcePreloader" inherits="Node" category="Core" version="3.0-beta"> +<class name="ResourcePreloader" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Resource Preloader Node. </brief_description> diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index c1a5921071..f4abe9f770 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourceSaver" inherits="Object" category="Core" version="3.0-beta"> +<class name="ResourceSaver" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Resource Saving Interface. </brief_description> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 5c04d3406e..24ae94d6db 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RichTextLabel" inherits="Control" category="Core" version="3.0-beta"> +<class name="RichTextLabel" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Label that displays rich text. </brief_description> @@ -8,6 +8,7 @@ Note that assignments to [member bbcode_text] clear the tag stack and reconstruct it from the property's contents. Any edits made to [member bbcode_text] will erase previous edits made from other manual sources such as [method append_bbcode] and the [code]push_*[/code] / [method pop] methods. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/gui/bbcode_in_richtextlabel.html </tutorials> <demos> </demos> @@ -53,20 +54,6 @@ Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line. </description> </method> - <method name="get_tab_size" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the number of spaces associated with a single tab length. Does not affect "\t" in text tags, only indent tags. - </description> - </method> - <method name="get_text"> - <return type="String"> - </return> - <description> - Returns the raw content of [member bbcode_text]. - </description> - </method> <method name="get_total_character_count" qualifiers="const"> <return type="int"> </return> @@ -88,34 +75,6 @@ Returns the number of visible lines. </description> </method> - <method name="is_meta_underlined" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the label underlines meta tags such as [url]{text}[/url]. - </description> - </method> - <method name="is_scroll_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the scrollbar is visible. Does not block scrolling completely. See [method scroll_to_line]. - </description> - </method> - <method name="is_scroll_following" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the window scrolls down to display new content automatically. - </description> - </method> - <method name="is_selection_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the label allows text selection. - </description> - </method> <method name="newline"> <return type="void"> </return> @@ -234,51 +193,6 @@ Scrolls the window's top line to match [code]line[/code]. </description> </method> - <method name="set_meta_underline"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - If [code]true[/code] will underline meta tags such as the [url] bbcode. Default value: [code]true[/code]. - </description> - </method> - <method name="set_scroll_active"> - <return type="void"> - </return> - <argument index="0" name="active" type="bool"> - </argument> - <description> - If [code]false[/code] the vertical scrollbar is hidden. Default value: [code]true[/code]. - </description> - </method> - <method name="set_scroll_follow"> - <return type="void"> - </return> - <argument index="0" name="follow" type="bool"> - </argument> - <description> - If [code]true[/code] the window scrolls to reveal new content. Default value: [code]false[/code]. - </description> - </method> - <method name="set_selection_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - If [code]true[/code] text can be selected. - </description> - </method> - <method name="set_tab_size"> - <return type="void"> - </return> - <argument index="0" name="spaces" type="int"> - </argument> - <description> - Sets the current tab length in spaces. Use with [method push_indent] to redefine indent length. - </description> - </method> <method name="set_table_column_expand"> <return type="void"> </return> @@ -294,15 +208,6 @@ Columns with a [code]false[/code] expand will not contribute to the total ratio. </description> </method> - <method name="set_text"> - <return type="void"> - </return> - <argument index="0" name="text" type="String"> - </argument> - <description> - 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]. - </description> - </method> </methods> <members> <member name="bbcode_enabled" type="bool" setter="set_use_bbcode" getter="is_using_bbcode"> @@ -311,12 +216,31 @@ <member name="bbcode_text" type="String" setter="set_bbcode" getter="get_bbcode"> 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. </member> + <member name="meta_underlined" type="bool" setter="set_meta_underline" getter="is_meta_underlined"> + If [code]true[/code], the label underlines meta tags such as [url]{text}[/url]. Default value: [code]true[/code]. + </member> <member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color"> If [code]true[/code] the label uses the custom font color. Default value: [code]false[/code]. </member> <member name="percent_visible" type="float" setter="set_percent_visible" getter="get_percent_visible"> The text's visibility, as a [float] between 0.0 and 1.0. </member> + <member name="scroll_active" type="bool" setter="set_scroll_active" getter="is_scroll_active"> + If [code]true[/code], the scrollbar is visible. Does not block scrolling completely. See [method scroll_to_line]. Default value: [code]true[/code]. + </member> + <member name="scroll_following" type="bool" setter="set_scroll_follow" getter="is_scroll_following"> + If [code]true[/code], the window scrolls down to display new content automatically. Default value: [code]false[/code]. + </member> + <member name="selection_enabled" type="bool" setter="set_selection_enabled" getter="is_selection_enabled"> + If [code]true[/code], the label allows text selection. + </member> + <member name="tab_size" type="int" setter="set_tab_size" getter="get_tab_size"> + The number of spaces associated with a single tab length. Does not affect "\t" in text tags, only indent tags. + </member> + <member name="text" type="String" setter="set_text" getter="get_text"> + 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]. + </member> <member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters"> The restricted number of characters to display in the label. </member> diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index 3c54f29c15..ad5da50dd6 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RigidBody" inherits="PhysicsBody" category="Core" version="3.0-beta"> +<class name="RigidBody" inherits="PhysicsBody" category="Core" version="3.0-stable"> <brief_description> Physics Body whose position is determined through physics simulation in 3D space. </brief_description> @@ -11,6 +11,7 @@ As a warning, don't change RigidBody's position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html </tutorials> <demos> </demos> @@ -32,14 +33,14 @@ <argument index="1" name="impulse" type="Vector3"> </argument> <description> - Apply a positioned impulse (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 once, and only once. Both the impulse and the offset from the body origin are in global coordinates. + Apply a positioned impulse (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 once, and only once. Both the impulse and the position are in global coordinates, and the position is relative to the object's origin. </description> </method> <method name="get_colliding_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. + Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. 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. </description> </method> <method name="set_axis_velocity"> diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index c11e118df5..67ae92c664 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RigidBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-beta"> +<class name="RigidBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-stable"> <brief_description> A body that is controlled by the 2D physics engine. </brief_description> @@ -49,50 +49,11 @@ 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. </description> </method> - <method name="get_applied_force" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the body's total applied force. - </description> - </method> - <method name="get_applied_torque" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the body's total applied torque. - </description> - </method> <method name="get_colliding_bodies" qualifiers="const"> <return type="Array"> </return> <description> - 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]. - </description> - </method> - <method name="get_inertia" qualifiers="const"> - <return type="float"> - </return> - <description> - 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. - </description> - </method> - <method name="set_applied_force"> - <return type="void"> - </return> - <argument index="0" name="force" type="Vector2"> - </argument> - <description> - Sets the applied force vector. This is the equivalent of firing a rocket: the force is applied constantly. - </description> - </method> - <method name="set_applied_torque"> - <return type="void"> - </return> - <argument index="0" name="torque" type="float"> - </argument> - <description> - Sets the applied torque. + 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. </description> </method> <method name="set_axis_velocity"> @@ -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. </description> </method> - <method name="set_inertia"> - <return type="void"> - </return> - <argument index="0" name="inertia" type="float"> - </argument> - <description> - 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. - </description> - </method> <method name="test_motion"> <return type="bool"> </return> @@ -134,6 +86,12 @@ <member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity"> The body's rotational velocity. </member> + <member name="applied_force" type="Vector2" setter="set_applied_force" getter="get_applied_force"> + The body's total applied force. + </member> + <member name="applied_torque" type="float" setter="set_applied_torque" getter="get_applied_torque"> + The body's total applied torque. + </member> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> The body's bounciness. Default value: [code]0[/code]. </member> @@ -159,6 +117,9 @@ <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale"> 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]. </member> + <member name="inertia" type="float" setter="set_inertia" getter="get_inertia"> + 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. + </member> <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp"> 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]. </member> diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index f5cf2dbee4..6fec02c392 100644 --- a/doc/classes/SceneState.xml +++ b/doc/classes/SceneState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SceneState" inherits="Reference" category="Core" version="3.0-beta"> +<class name="SceneState" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> A script interface to a scene file's data. </brief_description> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 3a4b843b06..0fe220ae48 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -1,10 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SceneTree" inherits="MainLoop" category="Core" version="3.0-beta"> +<class name="SceneTree" inherits="MainLoop" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> </description> <tutorials> + http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scene_tree.html + http://docs.godotengine.org/en/3.0/tutorials/viewports/multiple_resolutions.html </tutorials> <demos> </demos> @@ -57,18 +59,6 @@ <description> </description> </method> - <method name="get_current_scene" qualifiers="const"> - <return type="Node"> - </return> - <description> - </description> - </method> - <method name="get_edited_scene_root" qualifiers="const"> - <return type="Node"> - </return> - <description> - </description> - </method> <method name="get_frame" qualifiers="const"> <return type="int"> </return> @@ -101,12 +91,6 @@ <description> </description> </method> - <method name="get_root" qualifiers="const"> - <return type="Viewport"> - </return> - <description> - </description> - </method> <method name="get_rpc_sender_id" qualifiers="const"> <return type="int"> </return> @@ -128,18 +112,6 @@ Returns true if there is a [NetworkedMultiplayerPeer] set (with [method SceneTree.set_network_peer]). </description> </method> - <method name="is_debugging_collisions_hint" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_debugging_navigation_hint" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="is_input_handled"> <return type="bool"> </return> @@ -153,24 +125,6 @@ Returns true if this SceneTree's [NetworkedMultiplayerPeer] is in server mode (listening for connections). </description> </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_refusing_new_network_connections" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_using_font_oversampling" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="notify_group"> <return type="void"> </return> @@ -221,38 +175,6 @@ <description> </description> </method> - <method name="set_current_scene"> - <return type="void"> - </return> - <argument index="0" name="child_node" type="Node"> - </argument> - <description> - </description> - </method> - <method name="set_debug_collisions_hint"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_debug_navigation_hint"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_edited_scene_root"> - <return type="void"> - </return> - <argument index="0" name="scene" type="Node"> - </argument> - <description> - </description> - </method> <method name="set_group"> <return type="void"> </return> @@ -285,23 +207,6 @@ <description> </description> </method> - <method name="set_network_peer"> - <return type="void"> - </return> - <argument index="0" name="peer" type="NetworkedMultiplayerPeer"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_pause"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> <method name="set_quit_on_go_back"> <return type="void"> </return> @@ -310,14 +215,6 @@ <description> </description> </method> - <method name="set_refuse_new_network_connections"> - <return type="void"> - </return> - <argument index="0" name="refuse" type="bool"> - </argument> - <description> - </description> - </method> <method name="set_screen_stretch"> <return type="void"> </return> @@ -332,15 +229,28 @@ <description> </description> </method> - <method name="set_use_font_oversampling"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> </methods> + <members> + <member name="current_scene" type="Node" setter="set_current_scene" getter="get_current_scene"> + </member> + <member name="debug_collisions_hint" type="bool" setter="set_debug_collisions_hint" getter="is_debugging_collisions_hint"> + </member> + <member name="debug_navigation_hint" type="bool" setter="set_debug_navigation_hint" getter="is_debugging_navigation_hint"> + </member> + <member name="edited_scene_root" type="Node" setter="set_edited_scene_root" getter="get_edited_scene_root"> + </member> + <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> + 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. + </member> + <member name="paused" type="bool" setter="set_pause" getter="is_paused"> + </member> + <member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections"> + </member> + <member name="root" type="Viewport" setter="" getter="get_root"> + </member> + <member name="use_font_oversampling" type="bool" setter="set_use_font_oversampling" getter="is_using_font_oversampling"> + </member> + </members> <signals> <signal name="connected_to_server"> <description> diff --git a/doc/classes/SceneTreeTimer.xml b/doc/classes/SceneTreeTimer.xml index 0fdcb26e6e..f6b262d225 100644 --- a/doc/classes/SceneTreeTimer.xml +++ b/doc/classes/SceneTreeTimer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SceneTreeTimer" inherits="Reference" category="Core" version="3.0-beta"> +<class name="SceneTreeTimer" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -9,21 +9,11 @@ <demos> </demos> <methods> - <method name="get_time_left" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_time_left"> - <return type="void"> - </return> - <argument index="0" name="time" type="float"> - </argument> - <description> - </description> - </method> </methods> + <members> + <member name="time_left" type="float" setter="set_time_left" getter="get_time_left"> + </member> + </members> <signals> <signal name="timeout"> <description> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index c7df24879e..787d2c24bf 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Script" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Script" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> A class stored as a resource. </brief_description> @@ -8,6 +8,7 @@ The 'new' method of a script subclass creates a new instance. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. </description> <tutorials> + http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scripting.html </tutorials> <demos> </demos> @@ -31,13 +32,6 @@ <description> </description> </method> - <method name="get_source_code" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the script source code, or an empty string if source code is not available. - </description> - </method> <method name="has_script_signal" qualifiers="const"> <return type="bool"> </return> @@ -79,16 +73,12 @@ Reloads the script's class implementation. Returns an error code. </description> </method> - <method name="set_source_code"> - <return type="void"> - </return> - <argument index="0" name="source" type="String"> - </argument> - <description> - Sets the script source code. Does not reload the class implementation. - </description> - </method> </methods> + <members> + <member name="source_code" type="String" setter="set_source_code" getter="get_source_code"> + The script source code, or an empty string if source code is not available. When set, does not reload the class implementation automatically. + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 1e1a8d516e..89a8200d66 100644 --- a/doc/classes/ScriptEditor.xml +++ b/doc/classes/ScriptEditor.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ScriptEditor" inherits="PanelContainer" category="Core" version="3.0-beta"> +<class name="ScriptEditor" inherits="PanelContainer" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ScrollBar.xml b/doc/classes/ScrollBar.xml index f3c124b1ff..53b20e55d5 100644 --- a/doc/classes/ScrollBar.xml +++ b/doc/classes/ScrollBar.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ScrollBar" inherits="Range" category="Core" version="3.0-beta"> +<class name="ScrollBar" inherits="Range" category="Core" version="3.0-stable"> <brief_description> Base class for scroll bars. </brief_description> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 87ad7d57f5..a1e6441d1c 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ScrollContainer" inherits="Container" category="Core" version="3.0-beta"> +<class name="ScrollContainer" inherits="Container" category="Core" version="3.0-stable"> <brief_description> A helper node for displaying scrollable elements (e.g. lists). </brief_description> @@ -11,43 +11,19 @@ <demos> </demos> <methods> - <method name="get_h_scroll" qualifiers="const"> - <return type="int"> - </return> - <description> - Return current horizontal scroll value. - </description> - </method> - <method name="get_v_scroll" qualifiers="const"> - <return type="int"> - </return> - <description> - Return current vertical scroll value. - </description> - </method> - <method name="set_h_scroll"> - <return type="void"> - </return> - <argument index="0" name="val" type="int"> - </argument> - <description> - Set horizontal scroll value. - </description> - </method> - <method name="set_v_scroll"> - <return type="void"> - </return> - <argument index="0" name="val" type="int"> - </argument> - <description> - Set vertical scroll value. - </description> - </method> </methods> <members> - <member name="scroll_horizontal" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled"> + <member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll"> + The current horizontal scroll value. </member> - <member name="scroll_vertical" type="bool" setter="set_enable_v_scroll" getter="is_v_scroll_enabled"> + <member name="scroll_horizontal_enabled" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled"> + If [code]true[/code], enables horizontal scrolling. + </member> + <member name="scroll_vertical" type="int" setter="set_v_scroll" getter="get_v_scroll"> + The current horizontal scroll value. + </member> + <member name="scroll_vertical_enabled" type="bool" setter="set_enable_v_scroll" getter="is_v_scroll_enabled"> + If [code]true[/code], enables vertical scrolling. </member> </members> <constants> diff --git a/doc/classes/SegmentShape2D.xml b/doc/classes/SegmentShape2D.xml index dc02859251..56d9fe6d31 100644 --- a/doc/classes/SegmentShape2D.xml +++ b/doc/classes/SegmentShape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SegmentShape2D" inherits="Shape2D" category="Core" version="3.0-beta"> +<class name="SegmentShape2D" inherits="Shape2D" category="Core" version="3.0-stable"> <brief_description> Segment shape for 2D collisions. </brief_description> diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index c8206ff2c2..3d6f894f52 100644 --- a/doc/classes/Semaphore.xml +++ b/doc/classes/Semaphore.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Semaphore" inherits="Reference" category="Core" version="3.0-beta"> +<class name="Semaphore" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> A synchronization Semaphore. </brief_description> diff --git a/doc/classes/Separator.xml b/doc/classes/Separator.xml index ead641f860..20cf870d75 100644 --- a/doc/classes/Separator.xml +++ b/doc/classes/Separator.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Separator" inherits="Control" category="Core" version="3.0-beta"> +<class name="Separator" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Base class for separators. </brief_description> diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index 082c48dfce..28f06f0caa 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Shader" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Shader" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> To be changed, ignore. </brief_description> @@ -7,16 +7,11 @@ To be changed, ignore. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/shading/index.html </tutorials> <demos> </demos> <methods> - <method name="get_code" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> <method name="get_default_texture_param" qualifiers="const"> <return type="Texture"> </return> @@ -39,14 +34,6 @@ <description> </description> </method> - <method name="set_code"> - <return type="void"> - </return> - <argument index="0" name="code" type="String"> - </argument> - <description> - </description> - </method> <method name="set_default_texture_param"> <return type="void"> </return> @@ -58,6 +45,10 @@ </description> </method> </methods> + <members> + <member name="code" type="String" setter="set_code" getter="get_code"> + </member> + </members> <constants> <constant name="MODE_SPATIAL" value="0" enum="Mode"> </constant> diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 096d6d4332..893746ec31 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ShaderMaterial" inherits="Material" category="Core" version="3.0-beta"> +<class name="ShaderMaterial" inherits="Material" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -9,12 +9,6 @@ <demos> </demos> <methods> - <method name="get_shader" qualifiers="const"> - <return type="Shader"> - </return> - <description> - </description> - </method> <method name="get_shader_param" qualifiers="const"> <return type="Variant"> </return> @@ -23,14 +17,6 @@ <description> </description> </method> - <method name="set_shader"> - <return type="void"> - </return> - <argument index="0" name="shader" type="Shader"> - </argument> - <description> - </description> - </method> <method name="set_shader_param"> <return type="void"> </return> @@ -42,6 +28,10 @@ </description> </method> </methods> + <members> + <member name="shader" type="Shader" setter="set_shader" getter="get_shader"> + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/Shape.xml b/doc/classes/Shape.xml index 512961ed75..986d567c12 100644 --- a/doc/classes/Shape.xml +++ b/doc/classes/Shape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Shape" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Shape" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Base class for all 3D shape resources. </brief_description> @@ -7,6 +7,7 @@ Base class for all 3D shape resources. All 3D shapes that inherit from this can be set into a [PhysicsBody] or [Area]. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html </tutorials> <demos> </demos> diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index d4d043dfd8..d2366faa7f 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Shape2D" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Shape2D" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Base class for all 2D Shapes. </brief_description> @@ -7,6 +7,7 @@ Base class for all 2D Shapes. All 2D shape types inherit from this. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html </tutorials> <demos> </demos> diff --git a/doc/classes/ShortCut.xml b/doc/classes/ShortCut.xml index ce6a001279..f0908cfa44 100644 --- a/doc/classes/ShortCut.xml +++ b/doc/classes/ShortCut.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ShortCut" inherits="Resource" category="Core" version="3.0-beta"> +<class name="ShortCut" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> A shortcut for binding input. </brief_description> diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index 8bcc80de32..33022cca14 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Skeleton" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="Skeleton" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Skeleton for characters and animated objects. </brief_description> diff --git a/doc/classes/Sky.xml b/doc/classes/Sky.xml index 33f4a6059c..3cd3957f40 100644 --- a/doc/classes/Sky.xml +++ b/doc/classes/Sky.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Sky" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Sky" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> The base class for [PanoramaSky] and [ProceduralSky]. </brief_description> diff --git a/doc/classes/Slider.xml b/doc/classes/Slider.xml index 565d10497b..84c51572c3 100644 --- a/doc/classes/Slider.xml +++ b/doc/classes/Slider.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Slider" inherits="Range" category="Core" version="3.0-beta"> +<class name="Slider" inherits="Range" category="Core" version="3.0-stable"> <brief_description> Base class for GUI Sliders. </brief_description> diff --git a/doc/classes/SliderJoint.xml b/doc/classes/SliderJoint.xml index 4c794306e4..4507668292 100644 --- a/doc/classes/SliderJoint.xml +++ b/doc/classes/SliderJoint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SliderJoint" inherits="Joint" category="Core" version="3.0-beta"> +<class name="SliderJoint" inherits="Joint" category="Core" version="3.0-stable"> <brief_description> Piston kind of slider between two bodies in 3D. </brief_description> @@ -59,7 +59,7 @@ The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. </member> <member name="linear_limit/softness" type="float" setter="set_param" getter="get_param"> - A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. + A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. </member> <member name="linear_limit/upper_distance" type="float" setter="set_param" getter="get_param"> The maximum difference between the pivot points on their x-axis before damping happens. @@ -71,16 +71,16 @@ The amount of restitution inside the slider limits. </member> <member name="linear_motion/softness" type="float" setter="set_param" getter="get_param"> - A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. + 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. </member> <member name="linear_ortho/damping" type="float" setter="set_param" getter="get_param"> - The amount of damping when movement is accross axes orthogonal to the slider. + The amount of damping when movement is across axes orthogonal to the slider. </member> <member name="linear_ortho/restitution" type="float" setter="set_param" getter="get_param"> - The amount of restitution when movement is accross axes orthogonal to the slider. + The amount of restitution when movement is across axes orthogonal to the slider. </member> <member name="linear_ortho/softness" type="float" setter="set_param" getter="get_param"> - A factor applied to the movement accross axes orthogonal to the slider. + A factor applied to the movement across axes orthogonal to the slider. </member> </members> <constants> @@ -91,7 +91,7 @@ The minimum difference between the pivot points on their x-axis before damping happens. </constant> <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2" enum="Param"> - A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. + A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. </constant> <constant name="PARAM_LINEAR_LIMIT_RESTITUTION" value="3" enum="Param"> The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. @@ -100,7 +100,7 @@ The amount of damping once the slider limits are surpassed. </constant> <constant name="PARAM_LINEAR_MOTION_SOFTNESS" value="5" enum="Param"> - A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. + 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. </constant> <constant name="PARAM_LINEAR_MOTION_RESTITUTION" value="6" enum="Param"> The amount of restitution inside the slider limits. @@ -109,13 +109,13 @@ The amount of damping inside the slider limits. </constant> <constant name="PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value="8" enum="Param"> - A factor applied to the movement accross axes orthogonal to the slider. + A factor applied to the movement across axes orthogonal to the slider. </constant> <constant name="PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value="9" enum="Param"> - The amount of restitution when movement is accross axes orthogonal to the slider. + The amount of restitution when movement is across axes orthogonal to the slider. </constant> <constant name="PARAM_LINEAR_ORTHOGONAL_DAMPING" value="10" enum="Param"> - The amount of damping when movement is accross axes orthogonal to the slider. + The amount of damping when movement is across axes orthogonal to the slider. </constant> <constant name="PARAM_ANGULAR_LIMIT_UPPER" value="11" enum="Param"> The upper limit of rotation in the slider. diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index d0addcf9f9..26f6f4003b 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Spatial" inherits="Node" category="Core" version="3.0-beta"> +<class name="Spatial" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Most basic 3D game object, parent of all 3D related nodes. </brief_description> @@ -9,17 +9,11 @@ Affine operations (rotate, scale, translate) happen in parent's local coordinate system, unless the Spatial object is set as top level. Affine operations in this coordinate system correspond to direct affine operations on the Spatial's transform. The word local below refers to this coordinate system. The coordinate system that is attached to the Spatial object itself is referred to as object-local coordinate system. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/3d/introduction_to_3d.html </tutorials> <demos> </demos> <methods> - <method name="get_gizmo" qualifiers="const"> - <return type="SpatialGizmo"> - </return> - <description> - Returns the SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. - </description> - </method> <method name="get_parent_spatial" qualifiers="const"> <return type="Spatial"> </return> @@ -195,15 +189,6 @@ Makes the node ignore its parents transformations. Node transformations are only in global space. </description> </method> - <method name="set_gizmo"> - <return type="void"> - </return> - <argument index="0" name="gizmo" type="SpatialGizmo"> - </argument> - <description> - Set [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. - </description> - </method> <method name="set_identity"> <return type="void"> </return> @@ -289,6 +274,9 @@ </method> </methods> <members> + <member name="gizmo" type="SpatialGizmo" setter="set_gizmo" getter="get_gizmo"> + The SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. + </member> <member name="global_transform" type="Transform" setter="set_global_transform" getter="get_global_transform"> World space (global) [Transform] of this node. </member> diff --git a/doc/classes/SpatialGizmo.xml b/doc/classes/SpatialGizmo.xml index 8f614c6737..cf6f0efd46 100644 --- a/doc/classes/SpatialGizmo.xml +++ b/doc/classes/SpatialGizmo.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpatialGizmo" inherits="Reference" category="Core" version="3.0-beta"> +<class name="SpatialGizmo" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 403a6dc930..eef18c9892 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpatialMaterial" inherits="Material" category="Core" version="3.0-beta"> +<class name="SpatialMaterial" inherits="Material" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/3d/spatial_material.html </tutorials> <demos> </demos> diff --git a/doc/classes/SpatialVelocityTracker.xml b/doc/classes/SpatialVelocityTracker.xml index a58049a141..276b82899b 100644 --- a/doc/classes/SpatialVelocityTracker.xml +++ b/doc/classes/SpatialVelocityTracker.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpatialVelocityTracker" inherits="Reference" category="Core" version="3.0-beta"> +<class name="SpatialVelocityTracker" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -15,12 +15,6 @@ <description> </description> </method> - <method name="is_tracking_physics_step" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="reset"> <return type="void"> </return> @@ -29,14 +23,6 @@ <description> </description> </method> - <method name="set_track_physics_step"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> <method name="update_position"> <return type="void"> </return> @@ -46,6 +32,10 @@ </description> </method> </methods> + <members> + <member name="track_physics_step" type="bool" setter="set_track_physics_step" getter="is_tracking_physics_step"> + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/SphereMesh.xml b/doc/classes/SphereMesh.xml index 25ebaf1aaa..9f2d613267 100644 --- a/doc/classes/SphereMesh.xml +++ b/doc/classes/SphereMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SphereMesh" inherits="PrimitiveMesh" category="Core" version="3.0-beta"> +<class name="SphereMesh" inherits="PrimitiveMesh" category="Core" version="3.0-stable"> <brief_description> Class representing a spherical [PrimitiveMesh]. </brief_description> diff --git a/doc/classes/SphereShape.xml b/doc/classes/SphereShape.xml index c26d069310..a8df924bde 100644 --- a/doc/classes/SphereShape.xml +++ b/doc/classes/SphereShape.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SphereShape" inherits="Shape" category="Core" version="3.0-beta"> +<class name="SphereShape" inherits="Shape" category="Core" version="3.0-stable"> <brief_description> Sphere shape for 3D collisions. </brief_description> diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 806d36717a..1762a66302 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpinBox" inherits="Range" category="Core" version="3.0-beta"> +<class name="SpinBox" inherits="Range" category="Core" version="3.0-stable"> <brief_description> Numerical input text field. </brief_description> diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index 835a226a50..3a7f22693a 100644 --- a/doc/classes/SplitContainer.xml +++ b/doc/classes/SplitContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SplitContainer" inherits="Container" category="Core" version="3.0-beta"> +<class name="SplitContainer" inherits="Container" category="Core" version="3.0-stable"> <brief_description> Container for splitting and adjusting. </brief_description> diff --git a/doc/classes/SpotLight.xml b/doc/classes/SpotLight.xml index c66646114f..00991e75bc 100644 --- a/doc/classes/SpotLight.xml +++ b/doc/classes/SpotLight.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpotLight" inherits="Light" category="Core" version="3.0-beta"> +<class name="SpotLight" inherits="Light" category="Core" version="3.0-stable"> <brief_description> Spotlight [Light], such as a reflector spotlight or a lantern. </brief_description> @@ -7,6 +7,7 @@ A SpotLight light is a type of [Light] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of a spotlight. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html </tutorials> <demos> </demos> diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml index 655e98b3ed..c1afb35e09 100644 --- a/doc/classes/Sprite.xml +++ b/doc/classes/Sprite.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Sprite" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="Sprite" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> General purpose Sprite node. </brief_description> diff --git a/doc/classes/Sprite3D.xml b/doc/classes/Sprite3D.xml index d727725a95..ca0bd212aa 100644 --- a/doc/classes/Sprite3D.xml +++ b/doc/classes/Sprite3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Sprite3D" inherits="SpriteBase3D" category="Core" version="3.0-beta"> +<class name="Sprite3D" inherits="SpriteBase3D" category="Core" version="3.0-stable"> <brief_description> 2D Sprite node in 3D world. </brief_description> diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 580a467d6b..d91314e236 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpriteBase3D" inherits="GeometryInstance" category="Core" version="3.0-beta"> +<class name="SpriteBase3D" inherits="GeometryInstance" category="Core" version="3.0-stable"> <brief_description> 2D Sprite node in 3D environment. </brief_description> diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index 883a6d4fa8..f76212b0d2 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpriteFrames" inherits="Resource" category="Core" version="3.0-beta"> +<class name="SpriteFrames" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Sprite frame library for AnimatedSprite. </brief_description> diff --git a/doc/classes/StaticBody.xml b/doc/classes/StaticBody.xml index dd105589a6..e5b9d1c0d9 100644 --- a/doc/classes/StaticBody.xml +++ b/doc/classes/StaticBody.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StaticBody" inherits="PhysicsBody" category="Core" version="3.0-beta"> +<class name="StaticBody" inherits="PhysicsBody" category="Core" version="3.0-stable"> <brief_description> Static body for 3D Physics. </brief_description> diff --git a/doc/classes/StaticBody2D.xml b/doc/classes/StaticBody2D.xml index bf670a344f..d9e750f4f6 100644 --- a/doc/classes/StaticBody2D.xml +++ b/doc/classes/StaticBody2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StaticBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-beta"> +<class name="StaticBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-stable"> <brief_description> Static body for 2D Physics. </brief_description> diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index 8ecd9e5816..49aa26a601 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamPeer" inherits="Reference" category="Core" version="3.0-beta"> +<class name="StreamPeer" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Abstraction and base class for stream-based protocols. </brief_description> @@ -131,17 +131,10 @@ Get a Variant from the stream. </description> </method> - <method name="is_big_endian_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether this [code]StreamPeer[/code] is using big-endian format. - </description> - </method> <method name="put_16"> <return type="void"> </return> - <argument index="0" name="val" type="int"> + <argument index="0" name="value" type="int"> </argument> <description> Put a signed 16 bit value into the stream. @@ -150,7 +143,7 @@ <method name="put_32"> <return type="void"> </return> - <argument index="0" name="val" type="int"> + <argument index="0" name="value" type="int"> </argument> <description> Put a signed 32 bit value into the stream. @@ -159,7 +152,7 @@ <method name="put_64"> <return type="void"> </return> - <argument index="0" name="val" type="int"> + <argument index="0" name="value" type="int"> </argument> <description> Put a signed 64 bit value into the stream. @@ -168,7 +161,7 @@ <method name="put_8"> <return type="void"> </return> - <argument index="0" name="val" type="int"> + <argument index="0" name="value" type="int"> </argument> <description> Put a signed byte into the stream. @@ -186,7 +179,7 @@ <method name="put_double"> <return type="void"> </return> - <argument index="0" name="val" type="float"> + <argument index="0" name="value" type="float"> </argument> <description> Put a double-precision float into the stream. @@ -195,7 +188,7 @@ <method name="put_float"> <return type="void"> </return> - <argument index="0" name="val" type="float"> + <argument index="0" name="value" type="float"> </argument> <description> Put a single-precision float into the stream. @@ -213,7 +206,7 @@ <method name="put_u16"> <return type="void"> </return> - <argument index="0" name="val" type="int"> + <argument index="0" name="value" type="int"> </argument> <description> Put an unsigned 16 bit value into the stream. @@ -222,7 +215,7 @@ <method name="put_u32"> <return type="void"> </return> - <argument index="0" name="val" type="int"> + <argument index="0" name="value" type="int"> </argument> <description> Put an unsigned 32 bit value into the stream. @@ -231,7 +224,7 @@ <method name="put_u64"> <return type="void"> </return> - <argument index="0" name="val" type="int"> + <argument index="0" name="value" type="int"> </argument> <description> Put an unsigned 64 bit value into the stream. @@ -240,7 +233,7 @@ <method name="put_u8"> <return type="void"> </return> - <argument index="0" name="val" type="int"> + <argument index="0" name="value" type="int"> </argument> <description> Put an unsigned byte into the stream. @@ -249,7 +242,7 @@ <method name="put_utf8_string"> <return type="void"> </return> - <argument index="0" name="val" type="String"> + <argument index="0" name="value" type="String"> </argument> <description> Put a zero-terminated utf8 string into the stream. @@ -258,22 +251,18 @@ <method name="put_var"> <return type="void"> </return> - <argument index="0" name="val" type="Variant"> + <argument index="0" name="value" type="Variant"> </argument> <description> Put a Variant into the stream. </description> </method> - <method name="set_big_endian"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set this [code]StreamPeer[/code] to use big-endian format. Default is false. - </description> - </method> </methods> + <members> + <member name="big_endian" type="bool" setter="set_big_endian" getter="is_big_endian_enabled"> + If [code]true[/code], this [code]StreamPeer[/code] will using big-endian format for encoding and decoding. + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/StreamPeerBuffer.xml b/doc/classes/StreamPeerBuffer.xml index 66696ed416..2c95a8a3cf 100644 --- a/doc/classes/StreamPeerBuffer.xml +++ b/doc/classes/StreamPeerBuffer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamPeerBuffer" inherits="StreamPeer" category="Core" version="3.0-beta"> +<class name="StreamPeerBuffer" inherits="StreamPeer" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -21,12 +21,6 @@ <description> </description> </method> - <method name="get_data_array" qualifiers="const"> - <return type="PoolByteArray"> - </return> - <description> - </description> - </method> <method name="get_position" qualifiers="const"> <return type="int"> </return> @@ -55,15 +49,11 @@ <description> </description> </method> - <method name="set_data_array"> - <return type="void"> - </return> - <argument index="0" name="data" type="PoolByteArray"> - </argument> - <description> - </description> - </method> </methods> + <members> + <member name="data_array" type="PoolByteArray" setter="set_data_array" getter="get_data_array"> + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 55cb39e137..62e5240c7f 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamPeerSSL" inherits="StreamPeer" category="Core" version="3.0-beta"> +<class name="StreamPeerSSL" inherits="StreamPeer" category="Core" version="3.0-stable"> <brief_description> SSL Stream peer. </brief_description> @@ -7,6 +7,7 @@ SSL Stream peer. This object can be used to connect to SSL servers. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/networking/ssl_certificates.html </tutorials> <demos> </demos> @@ -46,6 +47,13 @@ Return the status of the connection, one of STATUS_* enum. </description> </method> + <method name="poll"> + <return type="void"> + </return> + <description> + Poll the connection to check for incoming bytes. Call this right before "get_available_bytes()" for it to work properly. + </description> + </method> </methods> <constants> <constant name="STATUS_DISCONNECTED" value="0" enum="Status"> diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 4c9812587a..73e9b97367 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamPeerTCP" inherits="StreamPeer" category="Core" version="3.0-beta"> +<class name="StreamPeerTCP" inherits="StreamPeer" category="Core" version="3.0-stable"> <brief_description> TCP Stream peer. </brief_description> @@ -29,6 +29,16 @@ Disconnect from host. </description> </method> + <method name="set_no_delay"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Disable Nagle algorithm to improve latency for small packets. + Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth. + </description> + </method> <method name="get_connected_host" qualifiers="const"> <return type="String"> </return> diff --git a/doc/classes/StreamTexture.xml b/doc/classes/StreamTexture.xml index 2e15070a8f..c37b5d6fe4 100644 --- a/doc/classes/StreamTexture.xml +++ b/doc/classes/StreamTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamTexture" inherits="Texture" category="Core" version="3.0-beta"> +<class name="StreamTexture" inherits="Texture" category="Core" version="3.0-stable"> <brief_description> A .stex texture. </brief_description> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 8bbd52b417..bad4ada144 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="String" category="Built-In Types" version="3.0-beta"> +<class name="String" category="Built-In Types" version="3.0-stable"> <brief_description> Built-in string class. </brief_description> @@ -277,6 +277,7 @@ <return type="String"> </return> <description> + Removes indentation from string. </description> </method> <method name="empty"> @@ -321,7 +322,7 @@ <argument index="0" name="what" type="String"> </argument> <description> - Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. </description> </method> <method name="findn"> @@ -343,7 +344,7 @@ <argument index="1" name="placeholder" type="String" default="{_}"> </argument> <description> - Formats the string by replacing all occurences of [code]placeholder[/code] with [code]values[/code]. + Formats the string by replacing all occurrences of [code]placeholder[/code] with [code]values[/code]. </description> </method> <method name="get_base_dir"> diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index 2759b5f430..a816b6a030 100644 --- a/doc/classes/StyleBox.xml +++ b/doc/classes/StyleBox.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StyleBox" inherits="Resource" category="Core" version="3.0-beta"> +<class name="StyleBox" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Base class for drawing stylized boxes for the UI. </brief_description> diff --git a/doc/classes/StyleBoxEmpty.xml b/doc/classes/StyleBoxEmpty.xml index 70d801e699..cd0bd9bf9d 100644 --- a/doc/classes/StyleBoxEmpty.xml +++ b/doc/classes/StyleBoxEmpty.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StyleBoxEmpty" inherits="StyleBox" category="Core" version="3.0-beta"> +<class name="StyleBoxEmpty" inherits="StyleBox" category="Core" version="3.0-stable"> <brief_description> Empty stylebox (does not display anything). </brief_description> diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index 16a1e72fce..2f26032c45 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StyleBoxFlat" inherits="StyleBox" category="Core" version="3.0-beta"> +<class name="StyleBoxFlat" inherits="StyleBox" category="Core" version="3.0-stable"> <brief_description> Customizable Stylebox with a given set of parameters. (no texture required) </brief_description> diff --git a/doc/classes/StyleBoxLine.xml b/doc/classes/StyleBoxLine.xml index e18af2334c..ddabe9aede 100644 --- a/doc/classes/StyleBoxLine.xml +++ b/doc/classes/StyleBoxLine.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StyleBoxLine" inherits="StyleBox" category="Core" version="3.0-beta"> +<class name="StyleBoxLine" inherits="StyleBox" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -9,24 +9,12 @@ <demos> </demos> <methods> - <method name="get_grow" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> - <method name="set_grow"> - <return type="void"> - </return> - <argument index="0" name="grow" type="float"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="color" type="Color" setter="set_color" getter="get_color"> </member> + <member name="grow" type="float" setter="set_grow" getter="get_grow"> + </member> <member name="thickness" type="int" setter="set_thickness" getter="get_thickness"> </member> <member name="vertical" type="bool" setter="set_vertical" getter="is_vertical"> diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index 2a7077bbff..8bac0fc77e 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StyleBoxTexture" inherits="StyleBox" category="Core" version="3.0-beta"> +<class name="StyleBoxTexture" inherits="StyleBox" category="Core" version="3.0-stable"> <brief_description> Texture Based 3x3 scale style. </brief_description> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 0916d0b928..64978a8bef 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SurfaceTool" inherits="Reference" category="Core" version="3.0-beta"> +<class name="SurfaceTool" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Helper tool to create geometry. </brief_description> diff --git a/doc/classes/TCP_Server.xml b/doc/classes/TCP_Server.xml index d3715ff545..b3db65de59 100644 --- a/doc/classes/TCP_Server.xml +++ b/doc/classes/TCP_Server.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TCP_Server" inherits="Reference" category="Core" version="3.0-beta"> +<class name="TCP_Server" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> TCP Server. </brief_description> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 350dd11e4d..9806c03349 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TabContainer" inherits="Control" category="Core" version="3.0-beta"> +<class name="TabContainer" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Tabbed Container. </brief_description> diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index fbda1aedb4..e4df4d0a31 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Tabs" inherits="Control" category="Core" version="3.0-beta"> +<class name="Tabs" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Tabs Control. </brief_description> @@ -35,12 +35,6 @@ <description> </description> </method> - <method name="get_tab_align" qualifiers="const"> - <return type="int" enum="Tabs.TabAlign"> - </return> - <description> - </description> - </method> <method name="get_tab_count" qualifiers="const"> <return type="int"> </return> @@ -105,14 +99,6 @@ <description> </description> </method> - <method name="set_tab_align"> - <return type="void"> - </return> - <argument index="0" name="align" type="int" enum="Tabs.TabAlign"> - </argument> - <description> - </description> - </method> <method name="set_tab_disabled"> <return type="void"> </return> @@ -149,6 +135,8 @@ </member> <member name="scrolling_enabled" type="bool" setter="set_scrolling_enabled" getter="get_scrolling_enabled"> </member> + <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="Tabs.TabAlign"> + </member> <member name="tab_close_display_policy" type="int" setter="set_tab_close_display_policy" getter="get_tab_close_display_policy" enum="Tabs.CloseButtonDisplayPolicy"> </member> </members> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index f4d80c46b4..f84ebede1c 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextEdit" inherits="Control" category="Core" version="3.0-beta"> +<class name="TextEdit" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Multiline text editing control. </brief_description> @@ -294,24 +294,6 @@ <description> </description> </method> - <method name="set_max_chars"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - Set the maximum amount of characters editable. - </description> - </method> - <method name="set_wrap"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Enable text wrapping when it goes beyond he edge of what is visible. - </description> - </method> <method name="toggle_fold_line"> <return type="void"> </return> @@ -384,6 +366,9 @@ String value of the [TextEdit]. </member> <member name="v_scroll_speed" type="float" setter="set_v_scroll_speed" getter="get_v_scroll_speed"> + If [code]true[/code], enables text wrapping when it goes beyond he edge of what is visible. + </member> + <member name="wrap_lines" type="bool" setter="set_wrap" getter="is_wrapping"> </member> </members> <signals> diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index bf27bc4768..f21b41f939 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Texture" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Texture" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Texture for 2D and 3D. </brief_description> @@ -71,13 +71,6 @@ <description> </description> </method> - <method name="get_flags" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the current texture flags. - </description> - </method> <method name="get_height" qualifiers="const"> <return type="int"> </return> @@ -105,17 +98,16 @@ <description> </description> </method> - <method name="set_flags"> - <return type="void"> - </return> - <argument index="0" name="flags" type="int"> - </argument> - <description> - Change the texture flags. - </description> - </method> </methods> + <members> + <member name="flags" type="int" setter="set_flags" getter="get_flags"> + The texture's flags. + </member> + </members> <constants> + <constant name="FLAGS_DEFAULT" value="7" enum="Flags"> + Default flags. Generate mipmaps, repeat, and filter are enabled. + </constant> <constant name="FLAG_MIPMAPS" value="1" enum="Flags"> Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. </constant> @@ -125,9 +117,6 @@ <constant name="FLAG_FILTER" value="4" enum="Flags"> Magnifying filter, to enable smooth zooming in of the texture. </constant> - <constant name="FLAGS_DEFAULT" value="7" enum="Flags"> - Default flags. Generate mipmaps, repeat, and filter are enabled. - </constant> <constant name="FLAG_ANISOTROPIC_FILTER" value="8" enum="Flags"> 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/TextureButton.xml b/doc/classes/TextureButton.xml index 9074966f4f..3bda04fe58 100644 --- a/doc/classes/TextureButton.xml +++ b/doc/classes/TextureButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextureButton" inherits="BaseButton" category="Core" version="3.0-beta"> +<class name="TextureButton" inherits="BaseButton" category="Core" version="3.0-stable"> <brief_description> Texture-based button. Supports Pressed, Hover, Disabled and Focused states. </brief_description> diff --git a/doc/classes/TextureProgress.xml b/doc/classes/TextureProgress.xml index c3046d7877..2456653786 100644 --- a/doc/classes/TextureProgress.xml +++ b/doc/classes/TextureProgress.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextureProgress" inherits="Range" category="Core" version="3.0-beta"> +<class name="TextureProgress" inherits="Range" category="Core" version="3.0-stable"> <brief_description> Texture-based progress bar. Useful for loading screens and life or stamina bars. </brief_description> diff --git a/doc/classes/TextureRect.xml b/doc/classes/TextureRect.xml index c1a5902448..8b0fc09a6d 100644 --- a/doc/classes/TextureRect.xml +++ b/doc/classes/TextureRect.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextureRect" inherits="Control" category="Core" version="3.0-beta"> +<class name="TextureRect" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Draws a sprite or a texture inside a User Interface. The texture can tile or not. </brief_description> diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index f6d3b97181..037f8cbd48 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Theme" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Theme" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Theme for controls. </brief_description> diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index c9b1d872bc..c3d1d1b24f 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Thread" inherits="Reference" category="Core" version="3.0-beta"> +<class name="Thread" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> A unit of execution in a process. </brief_description> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index daba0a0fc1..058a92d99c 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TileMap" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="TileMap" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Node for 2D tile-based maps. </brief_description> @@ -7,6 +7,7 @@ Node for 2D tile-based maps. Tilemaps use a [TileSet] which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/2d/using_tilemaps.html </tutorials> <demos> </demos> diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 716f89eab6..95a5e55176 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TileSet" inherits="Resource" category="Core" version="3.0-beta"> +<class name="TileSet" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Tile library for tilemaps. </brief_description> diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 09071b2ad1..383d3199f5 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Timer" inherits="Node" category="Core" version="3.0-beta"> +<class name="Timer" inherits="Node" category="Core" version="3.0-stable"> <brief_description> A countdown timer. </brief_description> @@ -11,20 +11,6 @@ <demos> </demos> <methods> - <method name="get_time_left" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the timer's remaining time in seconds. Returns 0 if the timer is inactive. - </description> - </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the timer is paused. - </description> - </method> <method name="is_stopped" qualifiers="const"> <return type="bool"> </return> @@ -32,15 +18,6 @@ Returns [code]true[/code] if the timer is stopped. </description> </method> - <method name="set_paused"> - <return type="void"> - </return> - <argument index="0" name="paused" type="bool"> - </argument> - <description> - 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. - </description> - </method> <method name="start"> <return type="void"> </return> @@ -64,9 +41,15 @@ <member name="one_shot" type="bool" setter="set_one_shot" getter="is_one_shot"> If [code]true[/code], Timer will stop when reaching 0. If [code]false[/code], it will restart. Default value: [code]false[/code]. </member> + <member name="paused" type="bool" setter="set_paused" getter="is_paused"> + If [code]true[/code], the timer is paused and will not process until it is unpaused again, even if [method start] is called. + </member> <member name="process_mode" type="int" setter="set_timer_process_mode" getter="get_timer_process_mode" enum="Timer.TimerProcessMode"> Processing mode. Uses TIMER_PROCESS_* constants as value. </member> + <member name="time_left" type="float" setter="" getter="get_time_left"> + The timer's remaining time in seconds. Returns 0 if the timer is inactive. + </member> <member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time"> Wait time in seconds. </member> diff --git a/doc/classes/ToolButton.xml b/doc/classes/ToolButton.xml index 512bbbf3f0..6597dc96e0 100644 --- a/doc/classes/ToolButton.xml +++ b/doc/classes/ToolButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ToolButton" inherits="Button" category="Core" version="3.0-beta"> +<class name="ToolButton" inherits="Button" category="Core" version="3.0-stable"> <brief_description> Flat button helper class. </brief_description> diff --git a/doc/classes/TouchScreenButton.xml b/doc/classes/TouchScreenButton.xml index 776765f84d..c187274a9d 100644 --- a/doc/classes/TouchScreenButton.xml +++ b/doc/classes/TouchScreenButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TouchScreenButton" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="TouchScreenButton" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Button for touch screen devices. </brief_description> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 83003cb357..cf1c9ea032 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Transform" category="Built-In Types" version="3.0-beta"> +<class name="Transform" category="Built-In Types" version="3.0-stable"> <brief_description> 3D Transformation. 3x4 matrix. </brief_description> @@ -7,6 +7,7 @@ Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a [Basis] "basis" and an [Vector3] "origin". It is similar to a 3x4 matrix. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/math/index.html </tutorials> <demos> </demos> @@ -142,7 +143,7 @@ <argument index="0" name="v" type="var"> </argument> <description> - Transforms the given vector "v" by this transform. + Transforms the given [Vector3], [Plane], or [AABB] by this transform. </description> </method> <method name="xform_inv"> @@ -151,7 +152,7 @@ <argument index="0" name="v" type="var"> </argument> <description> - Inverse-transforms the given vector "v" by this transform. + Inverse-transforms the given [Vector3], [Plane], or [AABB] by this transform. </description> </method> </methods> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index f4717aa995..e20f48ba14 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Transform2D" category="Built-In Types" version="3.0-beta"> +<class name="Transform2D" category="Built-In Types" version="3.0-stable"> <brief_description> 2D Transformation. 3x2 matrix. </brief_description> @@ -52,18 +52,18 @@ </description> </method> <method name="basis_xform"> - <return type="Transform2D"> + <return type="Vector2"> </return> - <argument index="0" name="v" type="var"> + <argument index="0" name="v" type="Vector2"> </argument> <description> Transforms the given vector by this transform's basis (no translation). </description> </method> <method name="basis_xform_inv"> - <return type="Transform2D"> + <return type="Vector2"> </return> - <argument index="0" name="v" type="var"> + <argument index="0" name="v" type="Vector2"> </argument> <description> Inverse-transforms the given vector by this transform's basis (no translation). @@ -143,21 +143,21 @@ </description> </method> <method name="xform"> - <return type="Transform2D"> + <return type="var"> </return> <argument index="0" name="v" type="var"> </argument> <description> - Transforms the given vector "v" by this transform. + Transforms the given [Vector2] or [Rect2] by this transform. </description> </method> <method name="xform_inv"> - <return type="Transform2D"> + <return type="var"> </return> <argument index="0" name="v" type="var"> </argument> <description> - Inverse-transforms the given vector "v" by this transform. + Inverse-transforms the given [Vector2] or [Rect2] by this transform. </description> </method> </methods> diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index cb49c66383..53106f9c08 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Translation" inherits="Resource" category="Core" version="3.0-beta"> +<class name="Translation" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Language Translation. </brief_description> diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index c9b5b46525..5b61f46f96 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TranslationServer" inherits="Object" category="Core" version="3.0-beta"> +<class name="TranslationServer" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Server that manages all translations. Translations can be set to it and removed from it. </brief_description> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index e26082c47e..09af7ee49a 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Tree" inherits="Control" category="Core" version="3.0-beta"> +<class name="Tree" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Control to show a tree of items. </brief_description> @@ -54,20 +54,6 @@ Makes the currently selected item visible. This will scroll the tree to make sure the selected item is visible. </description> </method> - <method name="get_allow_reselect" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if a cell that is currently already selected may be selected again. - </description> - </method> - <method name="get_allow_rmb_select" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if a right click can select items. - </description> - </method> <method name="get_column_at_position" qualifiers="const"> <return type="int"> </return> @@ -95,13 +81,6 @@ Returns the column's width in pixels. </description> </method> - <method name="get_columns" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the amount of columns. - </description> - </method> <method name="get_custom_popup_rect" qualifiers="const"> <return type="Rect2"> </return> @@ -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]. </description> </method> - <method name="get_drop_mode_flags" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the current drop mode's flags. - </description> - </method> <method name="get_drop_section_at_position" qualifiers="const"> <return type="int"> </return> @@ -202,31 +174,6 @@ Returns the current selection's column. </description> </method> - <method name="is_folding_hidden" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the folding arrow is hidden. - </description> - </method> - <method name="set_allow_reselect"> - <return type="void"> - </return> - <argument index="0" name="allow" type="bool"> - </argument> - <description> - If [code]true[/code] the currently selected cell may be selected again. - </description> - </method> - <method name="set_allow_rmb_select"> - <return type="void"> - </return> - <argument index="0" name="allow" type="bool"> - </argument> - <description> - If [code]true[/code] a right mouse button click can select items. - </description> - </method> <method name="set_column_expand"> <return type="void"> </return> @@ -269,52 +216,30 @@ If [code]true[/code] column titles are visible. </description> </method> - <method name="set_columns"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - Set the amount of columns. - </description> - </method> - <method name="set_drop_mode_flags"> - <return type="void"> - </return> - <argument index="0" name="flags" type="int"> - </argument> - <description> - Set the drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. - </description> - </method> - <method name="set_hide_folding"> - <return type="void"> - </return> - <argument index="0" name="hide" type="bool"> - </argument> - <description> - If [code]true[/code] the folding arrow is hidden. - </description> - </method> - <method name="set_hide_root"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - If [code]true[/code] the tree's root is hidden. - </description> - </method> - <method name="set_select_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Tree.SelectMode"> - </argument> - <description> - Allow single or multiple selection. See the [code]SELECT_*[/code] constants. - </description> - </method> </methods> + <members> + <member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect"> + If [code]true[/code] the currently selected cell may be selected again. + </member> + <member name="allow_rmb_select" type="bool" setter="set_allow_rmb_select" getter="get_allow_rmb_select"> + If [code]true[/code] a right mouse button click can select items. + </member> + <member name="columns" type="int" setter="set_columns" getter="get_columns"> + The amount of columns. + </member> + <member name="drop_mode_flags" type="int" setter="set_drop_mode_flags" getter="get_drop_mode_flags"> + The drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. + </member> + <member name="hide_folding" type="bool" setter="set_hide_folding" getter="is_folding_hidden"> + If [code]true[/code] the folding arrow is hidden. + </member> + <member name="hide_root" type="bool" setter="set_hide_root" getter="is_root_hidden"> + If [code]true[/code] the tree's root is hidden. + </member> + <member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="Tree.SelectMode"> + Allow single or multiple selection. See the [code]SELECT_*[/code] constants. + </member> + </members> <signals> <signal name="button_pressed"> <argument index="0" name="item" type="Object"> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 421185fe51..c41cfac37c 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TreeItem" inherits="Object" category="Core" version="3.0-beta"> +<class name="TreeItem" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Control for a single item inside a [Tree]. </brief_description> @@ -111,13 +111,6 @@ Returns the custom background color of column [code]column[/code]. </description> </method> - <method name="get_custom_minimum_height" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the custom minimum height. - </description> - </method> <method name="get_expand_right" qualifiers="const"> <return type="bool"> </return> @@ -260,13 +253,6 @@ Returns [code]true[/code] if the given column is checked. </description> </method> - <method name="is_collapsed"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if this TreeItem is collapsed. - </description> - </method> <method name="is_custom_set_as_button" qualifiers="const"> <return type="bool"> </return> @@ -284,13 +270,6 @@ Returns [code]true[/code] if column [code]column[/code] is editable. </description> </method> - <method name="is_folding_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if folding is disabled for this TreeItem. - </description> - </method> <method name="is_selectable" qualifiers="const"> <return type="bool"> </return> @@ -376,15 +355,6 @@ If [code]true[/code] the column [code]column[/code] is checked. </description> </method> - <method name="set_collapsed"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - If [code]true[/code] the TreeItem is collapsed. - </description> - </method> <method name="set_custom_as_button"> <return type="void"> </return> @@ -432,24 +402,6 @@ Sets the given column's custom draw callback to [code]callback[/code] method on [code]object[/code]. </description> </method> - <method name="set_custom_minimum_height"> - <return type="void"> - </return> - <argument index="0" name="height" type="int"> - </argument> - <description> - Sets the custom minimum height of this TreeItem. - </description> - </method> - <method name="set_disable_folding"> - <return type="void"> - </return> - <argument index="0" name="disable" type="bool"> - </argument> - <description> - If [code]true[/code] folding is disabled for this TreeItem. - </description> - </method> <method name="set_editable"> <return type="void"> </return> @@ -585,6 +537,17 @@ </description> </method> </methods> + <members> + <member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed"> + If [code]true[/code] the TreeItem is collapsed. + </member> + <member name="custom_minimum_height" type="int" setter="set_custom_minimum_height" getter="get_custom_minimum_height"> + The custom minimum height. + </member> + <member name="disable_folding" type="bool" setter="set_disable_folding" getter="is_folding_disabled"> + If [code]true[/code] folding is disabled for this TreeItem. + </member> + </members> <constants> <constant name="CELL_MODE_STRING" value="0" enum="TreeCellMode"> Cell contains a string. diff --git a/doc/classes/TriangleMesh.xml b/doc/classes/TriangleMesh.xml index adc9e00536..0a4ea1fa8f 100644 --- a/doc/classes/TriangleMesh.xml +++ b/doc/classes/TriangleMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TriangleMesh" inherits="Reference" category="Core" version="3.0-beta"> +<class name="TriangleMesh" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index a11580860a..d843c8341f 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Tween" inherits="Node" category="Core" version="3.0-beta"> +<class name="Tween" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Node useful for animations with unknown start and end points. </brief_description> @@ -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. </description> </method> - <method name="get_speed_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the speed that has been set from editor GUI or [method set_repeat]. - </description> - </method> <method name="interpolate_callback"> <return type="bool"> </return> @@ -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. </description> </method> - <method name="is_repeat" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns true if repeat has been set from editor GUI or [method set_repeat]. - </description> - </method> <method name="remove"> <return type="bool"> </return> @@ -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. </description> </method> - <method name="set_repeat"> - <return type="void"> - </return> - <argument index="0" name="repeat" type="bool"> - </argument> - <description> - Make the tween repeat after all tweens have finished. - </description> - </method> - <method name="set_speed_scale"> - <return type="void"> - </return> - <argument index="0" name="speed" type="float"> - </argument> - <description> - 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. - </description> - </method> <method name="start"> <return type="bool"> </return> @@ -371,12 +339,18 @@ <members> <member name="playback_process_mode" type="int" setter="set_tween_process_mode" getter="get_tween_process_mode" enum="Tween.TweenProcessMode"> </member> + <member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale"> + 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. + </member> + <member name="repeat" type="bool" setter="set_repeat" getter="is_repeat"> + If [code]true[/code], the tween will repeat. + </member> </members> <signals> <signal name="tween_completed"> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String"> + <argument index="1" name="key" type="NodePath"> </argument> <description> This signal is emitted when a tween ends. @@ -385,7 +359,7 @@ <signal name="tween_started"> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String"> + <argument index="1" name="key" type="NodePath"> </argument> <description> This signal is emitted when a tween starts. @@ -394,7 +368,7 @@ <signal name="tween_step"> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String"> + <argument index="1" name="key" type="NodePath"> </argument> <argument index="2" name="elapsed" type="float"> </argument> diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index 3cd88dafe3..c95723e083 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="UndoRedo" inherits="Object" category="Core" version="3.0-beta"> +<class name="UndoRedo" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Helper to manage UndoRedo in the editor or custom tools. </brief_description> diff --git a/doc/classes/VBoxContainer.xml b/doc/classes/VBoxContainer.xml index 7c943d5e5d..f92335eef1 100644 --- a/doc/classes/VBoxContainer.xml +++ b/doc/classes/VBoxContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VBoxContainer" inherits="BoxContainer" category="Core" version="3.0-beta"> +<class name="VBoxContainer" inherits="BoxContainer" category="Core" version="3.0-stable"> <brief_description> Vertical box container. </brief_description> diff --git a/doc/classes/VScrollBar.xml b/doc/classes/VScrollBar.xml index 23ded3a4b7..d533db98be 100644 --- a/doc/classes/VScrollBar.xml +++ b/doc/classes/VScrollBar.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VScrollBar" inherits="ScrollBar" category="Core" version="3.0-beta"> +<class name="VScrollBar" inherits="ScrollBar" category="Core" version="3.0-stable"> <brief_description> Vertical version of [ScrollBar], which goes from left (min) to right (max). </brief_description> diff --git a/doc/classes/VSeparator.xml b/doc/classes/VSeparator.xml index 931560855b..c6082a905d 100644 --- a/doc/classes/VSeparator.xml +++ b/doc/classes/VSeparator.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VSeparator" inherits="Separator" category="Core" version="3.0-beta"> +<class name="VSeparator" inherits="Separator" category="Core" version="3.0-stable"> <brief_description> Vertical version of [Separator]. </brief_description> diff --git a/doc/classes/VSlider.xml b/doc/classes/VSlider.xml index ed8940ed4e..b91c8a7c2a 100644 --- a/doc/classes/VSlider.xml +++ b/doc/classes/VSlider.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VSlider" inherits="Slider" category="Core" version="3.0-beta"> +<class name="VSlider" inherits="Slider" category="Core" version="3.0-stable"> <brief_description> Vertical slider. </brief_description> diff --git a/doc/classes/VSplitContainer.xml b/doc/classes/VSplitContainer.xml index 22f6bb449b..e6e6e189e8 100644 --- a/doc/classes/VSplitContainer.xml +++ b/doc/classes/VSplitContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VSplitContainer" inherits="SplitContainer" category="Core" version="3.0-beta"> +<class name="VSplitContainer" inherits="SplitContainer" category="Core" version="3.0-stable"> <brief_description> Vertical split container. </brief_description> diff --git a/doc/classes/Variant.xml b/doc/classes/Variant.xml index 12cbd276a1..f27f358015 100644 --- a/doc/classes/Variant.xml +++ b/doc/classes/Variant.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Variant" category="Core" version="3.0-beta"> +<class name="Variant" category="Core" version="3.0-stable"> <brief_description> The most important data type in Godot. </brief_description> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 5c1281b628..6a87bbf66c 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Vector2" category="Built-In Types" version="3.0-beta"> +<class name="Vector2" category="Built-In Types" version="3.0-stable"> <brief_description> Vector used for 2D Math. </brief_description> @@ -7,6 +7,7 @@ 2-element structure that can be used to represent positions in 2d-space, or any other pair of numeric values. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/math/index.html </tutorials> <demos> </demos> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index dff3d04b0c..0dc808329f 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Vector3" category="Built-In Types" version="3.0-beta"> +<class name="Vector3" category="Built-In Types" version="3.0-stable"> <brief_description> Vector class, which performs basic 3D vector math operations. </brief_description> @@ -7,6 +7,7 @@ Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/math/index.html </tutorials> <demos> </demos> @@ -215,7 +216,7 @@ <method name="snapped"> <return type="Vector3"> </return> - <argument index="0" name="by" type="float"> + <argument index="0" name="by" type="Vector3"> </argument> <description> Returns a copy of the vector, snapped to the lowest neared multiple. diff --git a/doc/classes/VehicleBody.xml b/doc/classes/VehicleBody.xml index 77916a7e9f..fe58806344 100644 --- a/doc/classes/VehicleBody.xml +++ b/doc/classes/VehicleBody.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VehicleBody" inherits="PhysicsBody" category="Core" version="3.0-beta"> +<class name="VehicleBody" inherits="RigidBody" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> @@ -9,27 +9,12 @@ <demos> </demos> <methods> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - Returns the VehicleBody's velocity vector. To get the absolute speed in scalar value, get the length of the return vector in pixels/second. Example: - [codeblock] - # vehicle is an instance of VehicleBody - var speed = vehicle.get_linear_velocity().length() - [/codeblock] - </description> - </method> </methods> <members> <member name="brake" type="float" setter="set_brake" getter="get_brake"> </member> <member name="engine_force" type="float" setter="set_engine_force" getter="get_engine_force"> </member> - <member name="friction" type="float" setter="set_friction" getter="get_friction"> - </member> - <member name="mass" type="float" setter="set_mass" getter="get_mass"> - </member> <member name="steering" type="float" setter="set_steering" getter="get_steering"> </member> </members> diff --git a/doc/classes/VehicleWheel.xml b/doc/classes/VehicleWheel.xml index 7c384886cb..e36a1abe9d 100644 --- a/doc/classes/VehicleWheel.xml +++ b/doc/classes/VehicleWheel.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VehicleWheel" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="VehicleWheel" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 281dc1f071..55755ca5df 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VideoPlayer" inherits="Control" category="Core" version="3.0-beta"> +<class name="VideoPlayer" inherits="Control" category="Core" version="3.0-stable"> <brief_description> Control to play video files. </brief_description> @@ -11,13 +11,6 @@ <demos> </demos> <methods> - <method name="get_buffering_msec" qualifiers="const"> - <return type="int"> - </return> - <description> - Get the amount of milliseconds to store in buffer while playing. - </description> - </method> <method name="get_stream_name" qualifiers="const"> <return type="String"> </return> @@ -25,13 +18,6 @@ Get the name of the video stream. </description> </method> - <method name="get_stream_position" qualifiers="const"> - <return type="float"> - </return> - <description> - Get the current position of the stream, in seconds. - </description> - </method> <method name="get_video_texture"> <return type="Texture"> </return> @@ -39,13 +25,6 @@ Get the current frame of the video as a [Texture]. </description> </method> - <method name="get_volume" qualifiers="const"> - <return type="float"> - </return> - <description> - Get the volume of the audio track as a linear value. - </description> - </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> @@ -60,33 +39,6 @@ Start the video playback. </description> </method> - <method name="set_buffering_msec"> - <return type="void"> - </return> - <argument index="0" name="msec" type="int"> - </argument> - <description> - Set the amount of milliseconds to buffer during playback. - </description> - </method> - <method name="set_stream_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="float"> - </argument> - <description> - Set the current position of the stream, in seconds. - </description> - </method> - <method name="set_volume"> - <return type="void"> - </return> - <argument index="0" name="volume" type="float"> - </argument> - <description> - Set the audio volume as a linear value. - </description> - </method> <method name="stop"> <return type="void"> </return> @@ -100,6 +52,9 @@ </member> <member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay"> </member> + <member name="buffering_msec" type="int" setter="set_buffering_msec" getter="get_buffering_msec"> + The amount of milliseconds to store in buffer while playing. + </member> <member name="bus" type="String" setter="set_bus" getter="get_bus"> </member> <member name="expand" type="bool" setter="set_expand" getter="has_expand"> @@ -108,6 +63,12 @@ </member> <member name="stream" type="VideoStream" setter="set_stream" getter="get_stream"> </member> + <member name="stream_position" type="float" setter="set_stream_position" getter="get_stream_position"> + The current position of the stream, in seconds. + </member> + <member name="volume" type="float" setter="set_volume" getter="get_volume"> + The volume of the audio track as a linear value. + </member> <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> </member> </members> diff --git a/doc/classes/VideoStream.xml b/doc/classes/VideoStream.xml index 9f0d9afa43..a4e4ee3452 100644 --- a/doc/classes/VideoStream.xml +++ b/doc/classes/VideoStream.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VideoStream" inherits="Resource" category="Core" version="3.0-beta"> +<class name="VideoStream" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index ad3903d549..0698a61529 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Viewport" inherits="Node" category="Core" version="3.0-beta"> +<class name="Viewport" inherits="Node" category="Core" version="3.0-stable"> <brief_description> Creates a sub-view into the screen. </brief_description> @@ -12,6 +12,8 @@ Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/2d/2d_transforms.html + http://docs.godotengine.org/en/3.0/tutorials/viewports/index.html </tutorials> <demos> </demos> @@ -37,13 +39,6 @@ Return the active 3D camera. </description> </method> - <method name="get_canvas_transform" qualifiers="const"> - <return type="Transform2D"> - </return> - <description> - Get the canvas transform of the viewport. - </description> - </method> <method name="get_final_transform" qualifiers="const"> <return type="Transform2D"> </return> @@ -51,13 +46,6 @@ Get the total transform of the viewport. </description> </method> - <method name="get_global_canvas_transform" qualifiers="const"> - <return type="Transform2D"> - </return> - <description> - Get the global canvas transform of the viewport. - </description> - </method> <method name="get_mouse_position" qualifiers="const"> <return type="Vector2"> </return> @@ -71,6 +59,7 @@ <argument index="0" name="info" type="int" enum="Viewport.RenderInfo"> </argument> <description> + Get the specific information about the viewport from rendering pipeline. </description> </method> <method name="get_size_override" qualifiers="const"> @@ -101,13 +90,6 @@ Return the final, visible rect in global screen coordinates. </description> </method> - <method name="get_world_2d" qualifiers="const"> - <return type="World2D"> - </return> - <description> - Return the 2D world of the viewport. - </description> - </method> <method name="gui_get_drag_data" qualifiers="const"> <return type="Variant"> </return> @@ -152,24 +134,6 @@ <description> </description> </method> - <method name="set_canvas_transform"> - <return type="void"> - </return> - <argument index="0" name="xform" type="Transform2D"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_global_canvas_transform"> - <return type="void"> - </return> - <argument index="0" name="xform" type="Transform2D"> - </argument> - <description> - Set the global canvas transform of the viewport. The canvas transform is relative to this. - </description> - </method> <method name="set_size_override"> <return type="void"> </return> @@ -192,14 +156,6 @@ Set whether the size override affects stretch as well. </description> </method> - <method name="set_world_2d"> - <return type="void"> - </return> - <argument index="0" name="world_2d" type="World2D"> - </argument> - <description> - </description> - </method> <method name="unhandled_input"> <return type="void"> </return> @@ -227,50 +183,82 @@ </methods> <members> <member name="arvr" type="bool" setter="set_use_arvr" getter="use_arvr"> + If [code]true[/code] the viewport will be used in AR/VR process. Default value: [code]false[/code]. </member> <member name="audio_listener_enable_2d" type="bool" setter="set_as_audio_listener_2d" getter="is_audio_listener_2d"> + If [code]true[/code] the viewport will process 2D audio streams. Default value: [code]false[/code]. </member> <member name="audio_listener_enable_3d" type="bool" setter="set_as_audio_listener" getter="is_audio_listener"> + If [code]true[/code] the viewport will process 3D audio streams. Default value: [code]false[/code]. + </member> + <member name="canvas_transform" type="Transform2D" setter="set_canvas_transform" getter="get_canvas_transform"> + 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. </member> <member name="debug_draw" type="int" setter="set_debug_draw" getter="get_debug_draw" enum="Viewport.DebugDraw"> + The overlay mode for test rendered geometry in debug purposes. Default value: [code]DEBUG_DRAW_DISABLED[/code]. </member> <member name="disable_3d" type="bool" setter="set_disable_3d" getter="is_3d_disabled"> + If [code]true[/code] the viewport will disable 3D rendering. For actual disabling use [code]usage[/code]. Default value: [code]false[/code]. + </member> + <member name="global_canvas_transform" type="Transform2D" setter="set_global_canvas_transform" getter="get_global_canvas_transform"> + The global canvas transform of the viewport. The canvas transform is relative to this. </member> <member name="gui_disable_input" type="bool" setter="set_disable_input" getter="is_input_disabled"> + If [code]true[/code] the viewport will not receive input event. Default value: [code]false[/code]. </member> <member name="gui_snap_controls_to_pixels" type="bool" setter="set_snap_controls_to_pixels" getter="is_snap_controls_to_pixels_enabled"> + If [code]true[/code] the GUI controls on the viewport will lay pixel perfectly. Default value: [code]true[/code]. </member> <member name="hdr" type="bool" setter="set_hdr" getter="get_hdr"> + If [code]true[/code] the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: [code]true[/code]. </member> <member name="msaa" type="int" setter="set_msaa" getter="get_msaa" enum="Viewport.MSAA"> + The multisample anti-aliasing mode. Default value: [code]MSAA_DISABLED[/code]. </member> <member name="own_world" type="bool" setter="set_use_own_world" getter="is_using_own_world"> + If [code]true[/code] the viewport will use [World] defined in [code]world[/code] property. Default value: [code]false[/code]. </member> <member name="physics_object_picking" type="bool" setter="set_physics_object_picking" getter="get_physics_object_picking"> + If [code]true[/code] the objects rendered by viewport become subjects of mouse picking process. Default value: [code]false[/code]. </member> <member name="render_target_clear_mode" type="int" setter="set_clear_mode" getter="get_clear_mode" enum="Viewport.ClearMode"> + The clear mode when viewport used as a render target. Default value: [code]CLEAR_MODE_ALWAYS[/code]. </member> <member name="render_target_update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="Viewport.UpdateMode"> + The update mode when viewport used as a render target. Default value: [code]UPDATE_WHEN_VISIBLE[/code]. </member> <member name="render_target_v_flip" type="bool" setter="set_vflip" getter="get_vflip"> + If [code]true[/code] the result of rendering will be flipped vertically. Default value: [code]false[/code]. </member> <member name="shadow_atlas_quad_0" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv"> + The subdivision amount of first quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_4[/code]. </member> <member name="shadow_atlas_quad_1" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv"> + The subdivision amount of second quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_4[/code]. </member> <member name="shadow_atlas_quad_2" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv"> + The subdivision amount of third quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_16[/code]. </member> <member name="shadow_atlas_quad_3" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv"> + The subdivision amount of fourth quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_64[/code]. </member> <member name="shadow_atlas_size" type="int" setter="set_shadow_atlas_size" getter="get_shadow_atlas_size"> + The resolution of shadow atlas. Both width and height is equal to one value. </member> <member name="size" type="Vector2" setter="set_size" getter="get_size"> + The width and height of viewport. </member> <member name="transparent_bg" type="bool" setter="set_transparent_background" getter="has_transparent_background"> + If [code]true[/code] the viewport should render its background as transparent. Default value: [code]false[/code]. </member> <member name="usage" type="int" setter="set_usage" getter="get_usage" enum="Viewport.Usage"> + The rendering mode of viewport. Default value: [code]USAGE_3D[/code]. </member> <member name="world" type="World" setter="set_world" getter="get_world"> + The custom [World] which can be used as 3D environment source. + </member> + <member name="world_2d" type="World2D" setter="set_world_2d" getter="get_world_2d"> + The custom [World2D] which can be used as 2D environment source. </member> </members> <signals> @@ -291,6 +279,7 @@ Update the render target only when it is visible. This is the default value. </constant> <constant name="UPDATE_ALWAYS" value="3" enum="UpdateMode"> + Always update the render target. </constant> <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED" value="0" enum="ShadowAtlasQuadrantSubdiv"> </constant> @@ -307,30 +296,42 @@ <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1024" value="6" enum="ShadowAtlasQuadrantSubdiv"> </constant> <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_MAX" value="7" enum="ShadowAtlasQuadrantSubdiv"> + Enum limiter. Do not use it directly. </constant> <constant name="RENDER_INFO_OBJECTS_IN_FRAME" value="0" enum="RenderInfo"> + Amount of objects in frame. </constant> <constant name="RENDER_INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo"> + Amount of vertices in frame. </constant> <constant name="RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo"> + Amount of material changes in frame. </constant> <constant name="RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3" enum="RenderInfo"> + Amount of shader changes in frame. </constant> <constant name="RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4" enum="RenderInfo"> + Amount of surface changes in frame. </constant> <constant name="RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5" enum="RenderInfo"> + Amount of draw calls in frame. </constant> <constant name="RENDER_INFO_MAX" value="6" enum="RenderInfo"> + Enum limiter. Do not use it directly. </constant> <constant name="DEBUG_DRAW_DISABLED" value="0" enum="DebugDraw"> + Objects are displayed normally. </constant> <constant name="DEBUG_DRAW_UNSHADED" value="1" enum="DebugDraw"> + Objects are displayed without light information. </constant> <constant name="DEBUG_DRAW_OVERDRAW" value="2" enum="DebugDraw"> </constant> <constant name="DEBUG_DRAW_WIREFRAME" value="3" enum="DebugDraw"> + Objects are displayed in wireframe style. </constant> <constant name="MSAA_DISABLED" value="0" enum="MSAA"> + Multisample anti-aliasing mode disabled. This is the default value. </constant> <constant name="MSAA_2X" value="1" enum="MSAA"> </constant> diff --git a/doc/classes/ViewportContainer.xml b/doc/classes/ViewportContainer.xml index 19d4e462c9..a2cd9a0217 100644 --- a/doc/classes/ViewportContainer.xml +++ b/doc/classes/ViewportContainer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ViewportContainer" inherits="Container" category="Core" version="3.0-beta"> +<class name="ViewportContainer" inherits="Container" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ViewportTexture.xml b/doc/classes/ViewportTexture.xml index e6a2b212bf..5943759c55 100644 --- a/doc/classes/ViewportTexture.xml +++ b/doc/classes/ViewportTexture.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ViewportTexture" inherits="Texture" category="Core" version="3.0-beta"> +<class name="ViewportTexture" inherits="Texture" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 67137e1408..faf0451bae 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core" version="3.0-beta"> +<class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core" version="3.0-stable"> <brief_description> Enable certain nodes only when visible. </brief_description> diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index 45e15eb4b3..acd9d86c2a 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.0-beta"> +<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.0-stable"> <brief_description> Enable certain nodes only when visible. </brief_description> diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml index 9e1c326633..94b08b78ed 100644 --- a/doc/classes/VisibilityNotifier.xml +++ b/doc/classes/VisibilityNotifier.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> Detects when the node is visible on screen. </brief_description> diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml index 327812db23..bcd52cf9ca 100644 --- a/doc/classes/VisibilityNotifier2D.xml +++ b/doc/classes/VisibilityNotifier2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Detects when the node is visible on screen. </brief_description> diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index bd66880719..1c54cb53ac 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualInstance" inherits="Spatial" category="Core" version="3.0-beta"> +<class name="VisualInstance" inherits="Spatial" category="Core" version="3.0-stable"> <brief_description> </brief_description> <description> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 28fb83d572..a546b86c57 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualServer" inherits="Object" category="Core" version="3.0-beta"> +<class name="VisualServer" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Server for anything visible. </brief_description> @@ -204,7 +204,7 @@ <argument index="4" name="antialiased" type="bool" default="false"> </argument> <description> - Adds a polyline, which is a line from mutliple points with a width, to the [CanvasItem]'s draw commands. + Adds a polyline, which is a line from multiple points with a width, to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_add_primitive"> @@ -669,7 +669,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> - The shadow mask. binary about wich layers this canvas light affects wich canvas item's shadows. See [LightOccluder2D] for more information on light masks. + The shadow mask. binary about which layers this canvas light affects which canvas item's shadows. See [LightOccluder2D] for more information on light masks. </description> </method> <method name="canvas_light_set_layer_range"> @@ -913,7 +913,7 @@ Syncronizes threads. </description> </method> - <method name="free"> + <method name="free_rid"> <return type="void"> </return> <argument index="0" name="rid" type="RID"> @@ -1506,7 +1506,7 @@ <argument index="1" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> </argument> <description> - Returns a copy of a texture's image unless it's a CubeMap, in wich case it returns the [RID] of the image at one of the cubes sides. + Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the [RID] of the image at one of the cubes sides. </description> </method> <method name="texture_get_flags" qualifiers="const"> @@ -2155,10 +2155,10 @@ Primitive to draw consists of triangles. </constant> <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5" enum="PrimitiveType"> - Primitive to draw consists of a triangle strip (the last 3 verticies are always combined to make a triangle). + Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle). </constant> <constant name="PRIMITIVE_TRIANGLE_FAN" value="6" enum="PrimitiveType"> - Primitive to draw consists of a triangle strip (the last 2 verticies are always combined with the first to make a triangle). + Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle). </constant> <constant name="PRIMITIVE_MAX" value="7" enum="PrimitiveType"> Marks the primitive types endpoint. used internally. diff --git a/doc/classes/WeakRef.xml b/doc/classes/WeakRef.xml index 0641dc1349..0c4801b66e 100644 --- a/doc/classes/WeakRef.xml +++ b/doc/classes/WeakRef.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="WeakRef" inherits="Reference" category="Core" version="3.0-beta"> +<class name="WeakRef" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Holds an [Object], but does not contribute to the reference count if the object is a reference. </brief_description> diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml index 5bdcfe238d..891e489be5 100644 --- a/doc/classes/WindowDialog.xml +++ b/doc/classes/WindowDialog.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="WindowDialog" inherits="Popup" category="Core" version="3.0-beta"> +<class name="WindowDialog" inherits="Popup" category="Core" version="3.0-stable"> <brief_description> Base class for window dialogs. </brief_description> diff --git a/doc/classes/World.xml b/doc/classes/World.xml index 9011d39669..cad286a1ac 100644 --- a/doc/classes/World.xml +++ b/doc/classes/World.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="World" inherits="Resource" category="Core" version="3.0-beta"> +<class name="World" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Class that has everything pertaining to a world. </brief_description> @@ -7,39 +7,28 @@ Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Spatial nodes register their resources into the current world. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/ray-casting.html </tutorials> <demos> </demos> <methods> - <method name="get_direct_space_state"> - <return type="PhysicsDirectSpaceState"> - </return> - <description> - Returns the World's physics space. - </description> - </method> - <method name="get_scenario" qualifiers="const"> - <return type="RID"> - </return> - <description> - Returns the World's visual scenario. - </description> - </method> - <method name="get_space" qualifiers="const"> - <return type="RID"> - </return> - <description> - Returns the World's sound space. - </description> - </method> </methods> <members> + <member name="direct_space_state" type="PhysicsDirectSpaceState" setter="" getter="get_direct_space_state"> + The World's physics direct space state, used for making various queries. Might be used only during [code]_physics_process[/code]. + </member> <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> The World's [Environment]. </member> <member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_environment"> The World's fallback_environment will be used if the World's [Environment] fails or is missing. </member> + <member name="scenario" type="RID" setter="" getter="get_scenario"> + The World's visual scenario. + </member> + <member name="space" type="RID" setter="" getter="get_space"> + The World's physics space. + </member> </members> <constants> </constants> diff --git a/doc/classes/World2D.xml b/doc/classes/World2D.xml index 93c88968ac..1a2745e6cb 100644 --- a/doc/classes/World2D.xml +++ b/doc/classes/World2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="World2D" inherits="Resource" category="Core" version="3.0-beta"> +<class name="World2D" inherits="Resource" category="Core" version="3.0-stable"> <brief_description> Class that has everything pertaining to a 2D world. </brief_description> @@ -7,32 +7,23 @@ Class that has everything pertaining to a 2D world. A physics space, a visual scenario and a sound space. 2D nodes register their resources into the current 2D world. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/physics/ray-casting.html </tutorials> <demos> </demos> <methods> - <method name="get_canvas"> - <return type="RID"> - </return> - <description> - Retrieve the [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing. - </description> - </method> - <method name="get_direct_space_state"> - <return type="Physics2DDirectSpaceState"> - </return> - <description> - Retrieve the state of this world's physics space. This allows arbitrary querying for collision. - </description> - </method> - <method name="get_space"> - <return type="RID"> - </return> - <description> - 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. - </description> - </method> </methods> + <members> + <member name="canvas" type="RID" setter="" getter="get_canvas"> + The [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing. + </member> + <member name="direct_space_state" type="Physics2DDirectSpaceState" setter="" getter="get_direct_space_state"> + The state of this world's physics space. This allows arbitrary querying for collision. + </member> + <member name="space" type="RID" setter="" getter="get_space"> + 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. + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml index 44f2086e51..468e618e72 100644 --- a/doc/classes/WorldEnvironment.xml +++ b/doc/classes/WorldEnvironment.xml @@ -1,12 +1,15 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="WorldEnvironment" inherits="Node" category="Core" version="3.0-beta"> +<class name="WorldEnvironment" inherits="Node" category="Core" version="3.0-stable"> <brief_description> - Sets environment properties for the entire scene + Default environment properties for the entire scene (post-processing effects, lightning and background settings). </brief_description> <description> - The [code]WorldEnvironment[/code] node can be added to a scene in order to set default [Environment] variables for the scene. The [code]WorldEnvironment[/code] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [code]WorldEnvironment[/code] may be instanced in a given scene at a time. The [code]WorldEnvironment[/code] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). + The [code]WorldEnvironment[/code] node is used to configure the default [Environment] for the scene. + The parameters defined in the [code]WorldEnvironment[/code] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [code]WorldEnvironment[/code] may be instanced in a given scene at a time. + The [code]WorldEnvironment[/code] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). Usually, these are added in order to improve the realism/color balance of the scene. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/3d/environment_and_post_processing.html </tutorials> <demos> </demos> @@ -14,6 +17,7 @@ </methods> <members> <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> + The [Environment] resource used by this [code]WorldEnvironment[/code], defining the default properties. </member> </members> <constants> diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml index 2665e594e0..a404074401 100644 --- a/doc/classes/XMLParser.xml +++ b/doc/classes/XMLParser.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="XMLParser" inherits="Reference" category="Core" version="3.0-beta"> +<class name="XMLParser" inherits="Reference" category="Core" version="3.0-stable"> <brief_description> Low-level class for creating parsers for XML files. </brief_description> diff --git a/doc/classes/YSort.xml b/doc/classes/YSort.xml index b1a8980141..e4818df62b 100644 --- a/doc/classes/YSort.xml +++ b/doc/classes/YSort.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="YSort" inherits="Node2D" category="Core" version="3.0-beta"> +<class name="YSort" inherits="Node2D" category="Core" version="3.0-stable"> <brief_description> Sort all child nodes based on their Y positions. </brief_description> diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml index 2437d53bda..cce5dd3b45 100644 --- a/doc/classes/bool.xml +++ b/doc/classes/bool.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="bool" category="Built-In Types" version="3.0-beta"> +<class name="bool" category="Built-In Types" version="3.0-stable"> <brief_description> Boolean built-in type </brief_description> diff --git a/doc/classes/float.xml b/doc/classes/float.xml index e7c46beb37..812bd9b3a9 100644 --- a/doc/classes/float.xml +++ b/doc/classes/float.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="float" category="Built-In Types" version="3.0-beta"> +<class name="float" category="Built-In Types" version="3.0-stable"> <brief_description> Float built-in type </brief_description> diff --git a/doc/classes/int.xml b/doc/classes/int.xml index a59bce0309..49b8b3949a 100644 --- a/doc/classes/int.xml +++ b/doc/classes/int.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="int" category="Built-In Types" version="3.0-beta"> +<class name="int" category="Built-In Types" version="3.0-stable"> <brief_description> Integer built-in type. </brief_description> |