diff options
Diffstat (limited to 'doc')
501 files changed, 9735 insertions, 1410 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index 2444dc4cba..2cfdfafea1 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="@GDScript" category="Core" version="3.1-dev"> +<class name="@GDScript" category="Core" version="3.1"> <brief_description> Built-in GDScript functions. </brief_description> <description> - This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects. + List of core built-in GDScript functions. Math functions and other utilities. Everything else is provided by objects. (Keywords: builtin, built in, global functions.) </description> <tutorials> </tutorials> @@ -202,7 +202,7 @@ </description> </method> <method name="convert"> - <return type="Object"> + <return type="Variant"> </return> <argument index="0" name="what" type="Variant"> </argument> @@ -326,7 +326,8 @@ <argument index="0" name="s" type="float"> </argument> <description> - Raises the Euler's constant [b]e[/b] to the power of [code]s[/code] and returns it. [b]e[/b] has an approximate value of 2.71828. + The natural exponential function. It raises the mathematical constant [b]e[/b] to the power of [code]s[/code] and returns it. + [b]e[/b] has an approximate value of 2.71828. [codeblock] a = exp(2) # approximately 7.39 [/codeblock] @@ -393,7 +394,7 @@ </description> </method> <method name="funcref"> - <return type="Object"> + <return type="FuncRef"> </return> <argument index="0" name="instance" type="Object"> </argument> @@ -410,6 +411,12 @@ [/codeblock] </description> </method> + <method name="get_stack"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="hash"> <return type="int"> </return> @@ -484,6 +491,14 @@ Returns True/False whether [code]s[/code] is an infinity value (either positive infinity or negative infinity). </description> </method> + <method name="is_instance_valid"> + <return type="bool"> + </return> + <argument index="0" name="instance" type="Object"> + </argument> + <description> + </description> + </method> <method name="is_nan"> <return type="bool"> </return> @@ -499,7 +514,8 @@ <argument index="0" name="var" type="Variant"> </argument> <description> - Returns length of Variant [code]var[/code]. Length is the character count of String, element count of Array, size of Dictionary, etc. Note: Generates a fatal error if Variant can not provide a length. + Returns length of Variant [code]var[/code]. Length is the character count of String, element count of Array, size of Dictionary, etc. + [b]Note:[/b] Generates a fatal error if Variant can not provide a length. [codeblock] a = [1, 2, 3, 4] len(a) # returns 4 @@ -509,9 +525,9 @@ <method name="lerp"> <return type="float"> </return> - <argument index="0" name="from" type="float"> + <argument index="0" name="from" type="Variant"> </argument> - <argument index="1" name="to" type="float"> + <argument index="1" name="to" type="Variant"> </argument> <argument index="2" name="weight" type="float"> </argument> @@ -532,12 +548,13 @@ </description> </method> <method name="load"> - <return type="Object"> + <return type="Resource"> </return> <argument index="0" name="path" type="String"> </argument> <description> - Loads a resource from the filesystem located at [code]path[/code]. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". + Loads a resource from the filesystem located at [code]path[/code]. + [b]Note:[/b] Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". [codeblock] # load a scene called main located in the root of the project directory var main = load("res://main.tscn") @@ -550,7 +567,8 @@ <argument index="0" name="s" type="float"> </argument> <description> - Natural logarithm. The amount of time needed to reach a certain level of continuous growth. Note: This is not the same as the log function on your calculator which is a base 10 logarithm. + Natural logarithm. The amount of time needed to reach a certain level of continuous growth. + [b]Note:[/b] This is not the same as the log function on your calculator which is a base 10 logarithm. [codeblock] log(10) # returns 2.302585 [/codeblock] @@ -649,7 +667,8 @@ <argument index="0" name="path" type="String"> </argument> <description> - Returns a resource from the filesystem that is loaded during script parsing. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". + Returns a resource from the filesystem that is loaded during script parsing. + [b]Note:[/b] Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". [codeblock] # load a scene called main located in the root of the project directory var main = preload("res://main.tscn") @@ -667,6 +686,12 @@ [/codeblock] </description> </method> + <method name="print_debug" qualifiers="vararg"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="print_stack"> <return type="void"> </return> @@ -1067,7 +1092,7 @@ </description> </method> <method name="weakref"> - <return type="Object"> + <return type="WeakRef"> </return> <argument index="0" name="obj" type="Object"> </argument> @@ -1136,8 +1161,9 @@ <argument index="1" name="signal" type="String" default=""""> </argument> <description> - Stops the function execution and returns the current state. Call [method GDScriptFunctionState.resume] on the state to resume execution. This invalidates the state. - Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emitted. + Stops the function execution and returns the current suspended state to the calling function. + From the caller, call [method GDScriptFunctionState.resume] on the state to resume execution. This invalidates the state. Within the resumed function, [code]yield()[/code] returns whatever was passed to the [code]resume()[/code] function call. + If passed an object and a signal, the execution is resumed when the object emits the given signal. In this case, [code]yield()[/code] returns the argument passed to [code]emit_signal()[/code] if the signal takes only one argument, or an array containing all the arguments passed to [code]emit_signal()[/code] if the signal takes multiple arguments. </description> </method> </methods> diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index a434c68a4f..d2c6a853ad 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.1-dev"> +<class name="@GlobalScope" category="Core" version="3.1"> <brief_description> Global scope constants and variables. </brief_description> @@ -29,9 +29,6 @@ <member name="Geometry" type="Geometry" setter="" getter=""> [Geometry] singleton </member> - <member name="GodotSharp" type="GodotSharp" setter="" getter=""> - [GodotSharp] singleton - </member> <member name="IP" type="IP" setter="" getter=""> [IP] singleton </member> @@ -886,6 +883,10 @@ <constant name="BUTTON_MIDDLE" value="3" enum="ButtonList"> Middle Mouse Button </constant> + <constant name="BUTTON_XBUTTON1" value="8" enum="ButtonList"> + </constant> + <constant name="BUTTON_XBUTTON2" value="9" enum="ButtonList"> + </constant> <constant name="BUTTON_WHEEL_UP" value="4" enum="ButtonList"> Mouse wheel up </constant> @@ -907,6 +908,10 @@ <constant name="BUTTON_MASK_MIDDLE" value="4" enum="ButtonList"> Middle Mouse Button Mask </constant> + <constant name="BUTTON_MASK_XBUTTON1" value="128" enum="ButtonList"> + </constant> + <constant name="BUTTON_MASK_XBUTTON2" value="256" enum="ButtonList"> + </constant> <constant name="JOY_BUTTON_0" value="0" enum="JoystickList"> Joypad Button 0 </constant> @@ -1076,6 +1081,20 @@ <constant name="JOY_ANALOG_R2" value="7" enum="JoystickList"> Joypad Right Analog Trigger </constant> + <constant name="MIDI_MESSAGE_NOTE_OFF" value="8" enum="MidiMessageList"> + </constant> + <constant name="MIDI_MESSAGE_NOTE_ON" value="9" enum="MidiMessageList"> + </constant> + <constant name="MIDI_MESSAGE_AFTERTOUCH" value="10" enum="MidiMessageList"> + </constant> + <constant name="MIDI_MESSAGE_CONTROL_CHANGE" value="11" enum="MidiMessageList"> + </constant> + <constant name="MIDI_MESSAGE_PROGRAM_CHANGE" value="12" enum="MidiMessageList"> + </constant> + <constant name="MIDI_MESSAGE_CHANNEL_PRESSURE" value="13" enum="MidiMessageList"> + </constant> + <constant name="MIDI_MESSAGE_PITCH_BEND" value="14" enum="MidiMessageList"> + </constant> <constant name="OK" value="0" enum="Error"> Functions that return Error return OK when no error occurred. Most functions don't return errors and/or just print errors to STDOUT. </constant> @@ -1243,12 +1262,14 @@ </constant> <constant name="PROPERTY_HINT_MULTILINE_TEXT" value="18" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="19" enum="PropertyHint"> + <constant name="PROPERTY_HINT_PLACEHOLDER_TEXT" value="19" enum="PropertyHint"> + </constant> + <constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="20" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="20" enum="PropertyHint"> + <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="21" enum="PropertyHint"> Hints that the image is compressed using lossy compression. </constant> - <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="21" enum="PropertyHint"> + <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="22" enum="PropertyHint"> Hints that the image is compressed using lossless compression. </constant> <constant name="PROPERTY_USAGE_STORAGE" value="1" enum="PropertyUsageFlags"> diff --git a/doc/classes/@NativeScript.xml b/doc/classes/@NativeScript.xml index cc4e97314e..2bf1dc7a7c 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.1-dev"> +<class name="@NativeScript" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/@VisualScript.xml b/doc/classes/@VisualScript.xml index f3a951f722..d4a924a259 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.1-dev"> +<class name="@VisualScript" category="Core" version="3.1"> <brief_description> Built-in visual script functions. </brief_description> diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index c0eb8cb417..b9061e0b87 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.1-dev"> +<class name="AABB" category="Built-In Types" version="3.1"> <brief_description> Axis-Aligned Bounding Box. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/math/index.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/ARVRAnchor.xml b/doc/classes/ARVRAnchor.xml index 735b1a8e8f..fa93d9668c 100644 --- a/doc/classes/ARVRAnchor.xml +++ b/doc/classes/ARVRAnchor.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRAnchor" inherits="Spatial" category="Core" version="3.1-dev"> +<class name="ARVRAnchor" inherits="Spatial" category="Core" version="3.1"> <brief_description> - Anchor point in AR Space + Anchor point in AR Space. </brief_description> <description> The ARVR Anchor point is a spatial node that maps a real world location identified by the AR platform to a position within the game world. For example, as long as plane detection in ARKit is on, ARKit will identify and update the position of planes (tables, floors, etc) and create anchors for them. diff --git a/doc/classes/ARVRCamera.xml b/doc/classes/ARVRCamera.xml index e8cf433e2b..e74b435e11 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.1-dev"> +<class name="ARVRCamera" inherits="Camera" category="Core" version="3.1"> <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 e9d8f9d568..9c306c3ea4 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.1-dev"> +<class name="ARVRController" inherits="Spatial" category="Core" version="3.1"> <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 ed59b4329b..413370ed0b 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.1-dev"> +<class name="ARVRInterface" inherits="Reference" category="Core" version="3.1"> <brief_description> Base class for ARVR interface implementation. </brief_description> diff --git a/doc/classes/ARVROrigin.xml b/doc/classes/ARVROrigin.xml index 1b998815aa..80626338f2 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.1-dev"> +<class name="ARVROrigin" inherits="Spatial" category="Core" version="3.1"> <brief_description> Our origin point in AR/VR. </brief_description> diff --git a/doc/classes/ARVRPositionalTracker.xml b/doc/classes/ARVRPositionalTracker.xml index 2d1e85e4c4..e703de36f4 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.1-dev"> +<class name="ARVRPositionalTracker" inherits="Object" category="Core" version="3.1"> <brief_description> A tracked object </brief_description> diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index 8e5dc146ad..a7d3e46684 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.1-dev"> +<class name="ARVRServer" inherits="Object" category="Core" version="3.1"> <brief_description> This is our AR/VR Server. </brief_description> @@ -36,6 +36,13 @@ Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it. </description> </method> + <method name="get_hmd_transform"> + <return type="Transform"> + </return> + <description> + Returns the primary interface's transformation. + </description> + </method> <method name="get_interface" qualifiers="const"> <return type="ARVRInterface"> </return> @@ -59,6 +66,24 @@ Returns a list of available interfaces with both id and name of the interface. </description> </method> + <method name="get_last_commit_usec"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_last_frame_usec"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_last_process_usec"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_reference_frame" qualifiers="const"> <return type="Transform"> </return> @@ -82,17 +107,10 @@ Get the number of trackers currently registered. </description> </method> - <method name="set_primary_interface"> - <return type="void"> - </return> - <argument index="0" name="interface" type="ARVRInterface"> - </argument> - <description> - Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces. - </description> - </method> </methods> <members> + <member name="primary_interface" type="ARVRInterface" setter="set_primary_interface" getter="get_primary_interface"> + </member> <member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale"> Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. </member> diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index 1a192f861b..482566ee9f 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.1-dev"> +<class name="AStar" inherits="Reference" category="Core" version="3.1"> <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 614e2e9430..7e871d68cb 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.1-dev"> +<class name="AcceptDialog" inherits="WindowDialog" category="Core" version="3.1"> <brief_description> Base dialog for user notification. </brief_description> @@ -21,7 +21,7 @@ <argument index="2" name="action" type="String" default=""""> </argument> <description> - Adds a button with label [i]text[/i] and a custom [i]action[/i] to the dialog and returns the created button. [i]action[/i] will be passed to the [custom_action] signal when pressed. + Adds a button with label [i]text[/i] and a custom [i]action[/i] to the dialog and returns the created button. [i]action[/i] will be passed to the [signal custom_action] signal when pressed. If [code]true[/code], [i]right[/i] will place the button to the right of any sibling buttons. Default value: [code]false[/code]. </description> </method> @@ -60,7 +60,8 @@ </methods> <members> <member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok"> - If [code]true[/code] the dialog is hidden when accepted. Default value: [code]true[/code]. + If [code]true[/code] the dialog is hidden when the OK button is pressed. You can set it to [code]false[/code] if you want to do e.g. input validation when receiving the [signal confirmed] signal, and handle hiding the dialog in your own logic. Default value: [code]true[/code]. + Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example [FileDialog] defaults to [code]false[/code], and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in [FileDialog] to disable hiding the dialog when pressing OK. </member> <member name="dialog_text" type="String" setter="set_text" getter="get_text"> The text displayed by this dialog. @@ -69,7 +70,7 @@ <signals> <signal name="confirmed"> <description> - Emitted when the dialog is accepted. + Emitted when the dialog is accepted, i.e. the OK button is pressed. </description> </signal> <signal name="custom_action"> diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml index a4892a4c71..a41ed0e689 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.1-dev"> +<class name="AnimatedSprite" inherits="Node2D" category="Core" version="3.1"> <brief_description> Sprite node that can use multiple textures for animation. </brief_description> @@ -60,6 +60,8 @@ <member name="playing" type="bool" setter="_set_playing" getter="_is_playing"> If [code]true[/code] the [member animation] is currently playing. </member> + <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> + </member> </members> <signals> <signal name="animation_finished"> diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index 358524d761..733d565676 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.1-dev"> +<class name="AnimatedSprite3D" inherits="SpriteBase3D" category="Core" version="3.1"> <brief_description> 2D sprite node in 3D world, that can use multiple 2D textures for animation. </brief_description> diff --git a/doc/classes/AnimatedTexture.xml b/doc/classes/AnimatedTexture.xml new file mode 100644 index 0000000000..f874c43ef1 --- /dev/null +++ b/doc/classes/AnimatedTexture.xml @@ -0,0 +1,1045 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimatedTexture" inherits="Texture" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="fps" type="float" setter="set_fps" getter="get_fps"> + </member> + <member name="frame_0/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_0/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_1/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_1/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_10/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_10/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_100/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_100/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_101/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_101/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_102/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_102/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_103/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_103/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_104/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_104/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_105/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_105/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_106/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_106/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_107/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_107/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_108/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_108/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_109/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_109/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_11/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_11/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_110/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_110/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_111/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_111/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_112/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_112/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_113/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_113/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_114/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_114/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_115/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_115/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_116/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_116/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_117/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_117/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_118/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_118/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_119/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_119/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_12/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_12/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_120/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_120/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_121/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_121/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_122/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_122/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_123/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_123/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_124/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_124/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_125/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_125/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_126/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_126/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_127/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_127/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_128/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_128/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_129/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_129/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_13/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_13/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_130/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_130/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_131/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_131/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_132/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_132/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_133/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_133/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_134/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_134/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_135/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_135/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_136/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_136/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_137/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_137/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_138/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_138/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_139/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_139/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_14/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_14/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_140/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_140/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_141/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_141/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_142/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_142/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_143/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_143/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_144/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_144/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_145/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_145/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_146/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_146/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_147/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_147/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_148/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_148/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_149/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_149/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_15/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_15/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_150/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_150/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_151/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_151/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_152/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_152/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_153/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_153/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_154/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_154/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_155/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_155/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_156/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_156/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_157/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_157/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_158/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_158/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_159/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_159/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_16/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_16/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_160/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_160/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_161/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_161/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_162/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_162/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_163/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_163/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_164/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_164/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_165/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_165/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_166/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_166/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_167/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_167/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_168/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_168/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_169/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_169/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_17/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_17/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_170/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_170/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_171/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_171/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_172/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_172/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_173/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_173/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_174/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_174/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_175/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_175/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_176/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_176/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_177/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_177/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_178/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_178/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_179/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_179/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_18/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_18/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_180/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_180/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_181/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_181/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_182/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_182/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_183/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_183/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_184/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_184/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_185/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_185/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_186/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_186/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_187/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_187/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_188/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_188/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_189/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_189/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_19/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_19/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_190/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_190/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_191/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_191/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_192/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_192/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_193/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_193/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_194/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_194/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_195/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_195/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_196/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_196/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_197/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_197/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_198/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_198/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_199/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_199/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_2/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_2/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_20/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_20/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_200/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_200/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_201/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_201/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_202/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_202/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_203/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_203/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_204/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_204/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_205/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_205/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_206/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_206/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_207/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_207/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_208/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_208/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_209/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_209/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_21/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_21/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_210/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_210/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_211/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_211/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_212/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_212/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_213/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_213/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_214/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_214/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_215/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_215/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_216/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_216/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_217/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_217/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_218/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_218/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_219/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_219/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_22/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_22/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_220/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_220/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_221/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_221/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_222/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_222/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_223/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_223/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_224/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_224/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_225/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_225/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_226/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_226/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_227/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_227/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_228/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_228/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_229/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_229/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_23/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_23/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_230/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_230/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_231/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_231/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_232/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_232/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_233/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_233/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_234/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_234/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_235/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_235/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_236/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_236/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_237/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_237/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_238/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_238/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_239/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_239/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_24/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_24/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_240/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_240/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_241/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_241/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_242/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_242/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_243/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_243/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_244/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_244/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_245/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_245/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_246/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_246/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_247/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_247/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_248/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_248/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_249/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_249/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_25/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_25/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_250/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_250/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_251/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_251/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_252/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_252/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_253/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_253/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_254/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_254/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_255/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_255/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_26/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_26/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_27/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_27/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_28/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_28/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_29/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_29/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_3/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_3/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_30/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_30/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_31/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_31/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_32/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_32/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_33/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_33/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_34/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_34/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_35/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_35/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_36/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_36/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_37/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_37/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_38/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_38/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_39/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_39/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_4/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_4/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_40/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_40/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_41/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_41/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_42/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_42/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_43/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_43/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_44/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_44/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_45/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_45/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_46/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_46/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_47/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_47/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_48/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_48/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_49/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_49/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_5/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_5/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_50/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_50/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_51/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_51/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_52/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_52/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_53/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_53/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_54/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_54/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_55/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_55/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_56/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_56/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_57/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_57/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_58/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_58/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_59/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_59/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_6/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_6/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_60/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_60/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_61/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_61/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_62/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_62/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_63/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_63/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_64/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_64/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_65/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_65/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_66/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_66/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_67/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_67/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_68/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_68/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_69/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_69/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_7/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_7/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_70/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_70/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_71/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_71/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_72/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_72/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_73/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_73/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_74/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_74/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_75/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_75/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_76/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_76/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_77/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_77/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_78/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_78/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_79/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_79/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_8/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_8/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_80/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_80/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_81/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_81/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_82/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_82/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_83/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_83/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_84/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_84/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_85/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_85/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_86/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_86/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_87/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_87/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_88/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_88/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_89/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_89/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_9/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_9/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_90/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_90/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_91/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_91/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_92/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_92/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_93/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_93/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_94/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_94/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_95/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_95/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_96/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_96/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_97/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_97/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_98/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_98/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frame_99/delay_sec" type="float" setter="set_frame_delay" getter="get_frame_delay"> + </member> + <member name="frame_99/texture" type="Texture" setter="set_frame_texture" getter="get_frame_texture"> + </member> + <member name="frames" type="int" setter="set_frames" getter="get_frames"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 96e78bae9d..74c6796b06 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.1-dev"> +<class name="Animation" inherits="Resource" category="Core" version="3.1"> <brief_description> Contains data used to animate everything in the engine. </brief_description> @@ -8,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/animation/index.html</link> </tutorials> <demos> </demos> @@ -24,6 +24,214 @@ Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration. </description> </method> + <method name="animation_track_get_key_animation" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="animation_track_insert_key"> + <return type="int"> + </return> + <argument index="0" name="track" type="int"> + </argument> + <argument index="1" name="time" type="float"> + </argument> + <argument index="2" name="animation" type="String"> + </argument> + <description> + </description> + </method> + <method name="animation_track_set_key_animation"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <argument index="2" name="animation" type="String"> + </argument> + <description> + </description> + </method> + <method name="audio_track_get_key_end_offset" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="audio_track_get_key_start_offset" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="audio_track_get_key_stream" qualifiers="const"> + <return type="Resource"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="audio_track_insert_key"> + <return type="int"> + </return> + <argument index="0" name="track" type="int"> + </argument> + <argument index="1" name="time" type="float"> + </argument> + <argument index="2" name="stream" type="Resource"> + </argument> + <argument index="3" name="start_offset" type="float" default="0"> + </argument> + <argument index="4" name="end_offset" type="float" default="0"> + </argument> + <description> + </description> + </method> + <method name="audio_track_set_key_end_offset"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <argument index="2" name="offset" type="float"> + </argument> + <description> + </description> + </method> + <method name="audio_track_set_key_start_offset"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <argument index="2" name="offset" type="float"> + </argument> + <description> + </description> + </method> + <method name="audio_track_set_key_stream"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <argument index="2" name="stream" type="Resource"> + </argument> + <description> + </description> + </method> + <method name="bezier_track_get_key_in_handle" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="bezier_track_get_key_out_handle" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="bezier_track_get_key_value" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="bezier_track_insert_key"> + <return type="int"> + </return> + <argument index="0" name="track" type="int"> + </argument> + <argument index="1" name="time" type="float"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <argument index="3" name="in_handle" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <argument index="4" name="out_handle" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <description> + </description> + </method> + <method name="bezier_track_interpolate" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="track" type="int"> + </argument> + <argument index="1" name="time" type="float"> + </argument> + <description> + </description> + </method> + <method name="bezier_track_set_key_in_handle"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <argument index="2" name="in_handle" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="bezier_track_set_key_out_handle"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <argument index="2" name="out_handle" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="bezier_track_set_key_value"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + </description> + </method> <method name="clear"> <return type="void"> </return> @@ -344,7 +552,18 @@ <argument index="1" name="path" type="NodePath"> </argument> <description> - Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local" + Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". + [b]Example:[/b] "character/skeleton:ankle" or "character/mesh:transform/local". + </description> + </method> + <method name="track_swap"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="with_idx" type="int"> + </argument> + <description> </description> </method> <method name="transform_track_insert_key"> @@ -430,6 +649,12 @@ <constant name="TYPE_METHOD" value="2" enum="TrackType"> Method tracks call functions with given arguments per key. </constant> + <constant name="TYPE_BEZIER" value="3" enum="TrackType"> + </constant> + <constant name="TYPE_AUDIO" value="4" enum="TrackType"> + </constant> + <constant name="TYPE_ANIMATION" value="5" enum="TrackType"> + </constant> <constant name="INTERPOLATION_NEAREST" value="0" enum="InterpolationType"> No interpolation (nearest value). </constant> @@ -448,5 +673,7 @@ <constant name="UPDATE_TRIGGER" value="2" enum="UpdateMode"> Update at the keyframes. </constant> + <constant name="UPDATE_CAPTURE" value="3" enum="UpdateMode"> + </constant> </constants> </class> diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml new file mode 100644 index 0000000000..d9bad150df --- /dev/null +++ b/doc/classes/AnimationNode.xml @@ -0,0 +1,179 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNode" inherits="Resource" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_input"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="blend_animation"> + <return type="void"> + </return> + <argument index="0" name="animation" type="String"> + </argument> + <argument index="1" name="time" type="float"> + </argument> + <argument index="2" name="delta" type="float"> + </argument> + <argument index="3" name="seeked" type="bool"> + </argument> + <argument index="4" name="blend" type="float"> + </argument> + <description> + </description> + </method> + <method name="blend_input"> + <return type="float"> + </return> + <argument index="0" name="input_index" type="int"> + </argument> + <argument index="1" name="time" type="float"> + </argument> + <argument index="2" name="seek" type="bool"> + </argument> + <argument index="3" name="blend" type="float"> + </argument> + <argument index="4" name="filter" type="int" enum="AnimationNode.FilterAction" default="0"> + </argument> + <argument index="5" name="optimize" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="blend_node"> + <return type="float"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="node" type="AnimationNode"> + </argument> + <argument index="2" name="time" type="float"> + </argument> + <argument index="3" name="seek" type="bool"> + </argument> + <argument index="4" name="blend" type="float"> + </argument> + <argument index="5" name="filter" type="int" enum="AnimationNode.FilterAction" default="0"> + </argument> + <argument index="6" name="optimize" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="get_caption" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_input_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_input_name"> + <return type="String"> + </return> + <argument index="0" name="input" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_parameter" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_filter" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="is_path_filtered" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="process" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="time" type="float"> + </argument> + <argument index="1" name="seek" type="bool"> + </argument> + <description> + </description> + </method> + <method name="remove_input"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_filter_path"> + <return type="void"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_parameter"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="filter_enabled" type="bool" setter="set_filter_enabled" getter="is_filter_enabled"> + </member> + </members> + <signals> + <signal name="removed_from_graph"> + <description> + </description> + </signal> + <signal name="tree_changed"> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="FILTER_IGNORE" value="0" enum="FilterAction"> + </constant> + <constant name="FILTER_PASS" value="1" enum="FilterAction"> + </constant> + <constant name="FILTER_STOP" value="2" enum="FilterAction"> + </constant> + <constant name="FILTER_BLEND" value="3" enum="FilterAction"> + </constant> + </constants> +</class> diff --git a/doc/classes/AnimationNodeAdd2.xml b/doc/classes/AnimationNodeAdd2.xml new file mode 100644 index 0000000000..9297faa1b7 --- /dev/null +++ b/doc/classes/AnimationNodeAdd2.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeAdd2" inherits="AnimationNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeAdd3.xml b/doc/classes/AnimationNodeAdd3.xml new file mode 100644 index 0000000000..deb8d74a38 --- /dev/null +++ b/doc/classes/AnimationNodeAdd3.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeAdd3" inherits="AnimationNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeAnimation.xml b/doc/classes/AnimationNodeAnimation.xml new file mode 100644 index 0000000000..22f5e0838e --- /dev/null +++ b/doc/classes/AnimationNodeAnimation.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeAnimation" inherits="AnimationRootNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_playback_time" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="animation" type="String" setter="set_animation" getter="get_animation"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeBlend2.xml b/doc/classes/AnimationNodeBlend2.xml new file mode 100644 index 0000000000..42bb12d9d0 --- /dev/null +++ b/doc/classes/AnimationNodeBlend2.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeBlend2" inherits="AnimationNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeBlend3.xml b/doc/classes/AnimationNodeBlend3.xml new file mode 100644 index 0000000000..cd3d9f9bc8 --- /dev/null +++ b/doc/classes/AnimationNodeBlend3.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeBlend3" inherits="AnimationNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeBlendSpace1D.xml b/doc/classes/AnimationNodeBlendSpace1D.xml new file mode 100644 index 0000000000..2113948b2e --- /dev/null +++ b/doc/classes/AnimationNodeBlendSpace1D.xml @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeBlendSpace1D" inherits="AnimationRootNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_blend_point"> + <return type="void"> + </return> + <argument index="0" name="node" type="AnimationRootNode"> + </argument> + <argument index="1" name="pos" type="float"> + </argument> + <argument index="2" name="at_index" type="int" default="-1"> + </argument> + <description> + </description> + </method> + <method name="get_blend_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_blend_point_node" qualifiers="const"> + <return type="AnimationRootNode"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_blend_point_position" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_blend_point"> + <return type="void"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_blend_point_node"> + <return type="void"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="node" type="AnimationRootNode"> + </argument> + <description> + </description> + </method> + <method name="set_blend_point_position"> + <return type="void"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="pos" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="max_space" type="float" setter="set_max_space" getter="get_max_space"> + </member> + <member name="min_space" type="float" setter="set_min_space" getter="get_min_space"> + </member> + <member name="snap" type="float" setter="set_snap" getter="get_snap"> + </member> + <member name="value_label" type="String" setter="set_value_label" getter="get_value_label"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeBlendSpace2D.xml b/doc/classes/AnimationNodeBlendSpace2D.xml new file mode 100644 index 0000000000..39d780b6ef --- /dev/null +++ b/doc/classes/AnimationNodeBlendSpace2D.xml @@ -0,0 +1,129 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeBlendSpace2D" inherits="AnimationRootNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_blend_point"> + <return type="void"> + </return> + <argument index="0" name="node" type="AnimationRootNode"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="at_index" type="int" default="-1"> + </argument> + <description> + </description> + </method> + <method name="add_triangle"> + <return type="void"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <argument index="2" name="z" type="int"> + </argument> + <argument index="3" name="at_index" type="int" default="-1"> + </argument> + <description> + </description> + </method> + <method name="get_blend_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_blend_point_node" qualifiers="const"> + <return type="AnimationRootNode"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_blend_point_position" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_triangle_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_triangle_point"> + <return type="int"> + </return> + <argument index="0" name="triangle" type="int"> + </argument> + <argument index="1" name="point" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_blend_point"> + <return type="void"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_triangle"> + <return type="void"> + </return> + <argument index="0" name="triangle" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_blend_point_node"> + <return type="void"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="node" type="AnimationRootNode"> + </argument> + <description> + </description> + </method> + <method name="set_blend_point_position"> + <return type="void"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="auto_triangles" type="bool" setter="set_auto_triangles" getter="get_auto_triangles"> + </member> + <member name="max_space" type="Vector2" setter="set_max_space" getter="get_max_space"> + </member> + <member name="min_space" type="Vector2" setter="set_min_space" getter="get_min_space"> + </member> + <member name="snap" type="Vector2" setter="set_snap" getter="get_snap"> + </member> + <member name="x_label" type="String" setter="set_x_label" getter="get_x_label"> + </member> + <member name="y_label" type="String" setter="set_y_label" getter="get_y_label"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeBlendTree.xml b/doc/classes/AnimationNodeBlendTree.xml new file mode 100644 index 0000000000..cd28232908 --- /dev/null +++ b/doc/classes/AnimationNodeBlendTree.xml @@ -0,0 +1,117 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeBlendTree" inherits="AnimationRootNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_node"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="node" type="AnimationNode"> + </argument> + <argument index="2" name="position" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <description> + </description> + </method> + <method name="connect_node"> + <return type="void"> + </return> + <argument index="0" name="input_node" type="String"> + </argument> + <argument index="1" name="input_index" type="int"> + </argument> + <argument index="2" name="output_node" type="String"> + </argument> + <description> + </description> + </method> + <method name="disconnect_node"> + <return type="void"> + </return> + <argument index="0" name="input_node" type="String"> + </argument> + <argument index="1" name="input_index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node" qualifiers="const"> + <return type="AnimationNode"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_node_position" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_node" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_node"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="rename_node"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_node_position"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="position" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="graph_offset" type="Vector2" setter="set_graph_offset" getter="get_graph_offset"> + </member> + </members> + <constants> + <constant name="CONNECTION_OK" value="0"> + </constant> + <constant name="CONNECTION_ERROR_NO_INPUT" value="1"> + </constant> + <constant name="CONNECTION_ERROR_NO_INPUT_INDEX" value="2"> + </constant> + <constant name="CONNECTION_ERROR_NO_OUTPUT" value="3"> + </constant> + <constant name="CONNECTION_ERROR_SAME_NODE" value="4"> + </constant> + <constant name="CONNECTION_ERROR_CONNECTION_EXISTS" value="5"> + </constant> + </constants> +</class> diff --git a/doc/classes/AnimationNodeOneShot.xml b/doc/classes/AnimationNodeOneShot.xml new file mode 100644 index 0000000000..12cb9775a2 --- /dev/null +++ b/doc/classes/AnimationNodeOneShot.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeOneShot" inherits="AnimationNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_mix_mode" qualifiers="const"> + <return type="int" enum="AnimationNodeOneShot.MixMode"> + </return> + <description> + </description> + </method> + <method name="set_mix_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="AnimationNodeOneShot.MixMode"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="autorestart" type="bool" setter="set_autorestart" getter="has_autorestart"> + </member> + <member name="autorestart_delay" type="float" setter="set_autorestart_delay" getter="get_autorestart_delay"> + </member> + <member name="autorestart_random_delay" type="float" setter="set_autorestart_random_delay" getter="get_autorestart_random_delay"> + </member> + <member name="fadein_time" type="float" setter="set_fadein_time" getter="get_fadein_time"> + </member> + <member name="fadeout_time" type="float" setter="set_fadeout_time" getter="get_fadeout_time"> + </member> + <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync"> + </member> + </members> + <constants> + <constant name="MIX_MODE_BLEND" value="0" enum="MixMode"> + </constant> + <constant name="MIX_MODE_ADD" value="1" enum="MixMode"> + </constant> + </constants> +</class> diff --git a/doc/classes/AnimationNodeOutput.xml b/doc/classes/AnimationNodeOutput.xml new file mode 100644 index 0000000000..98a41bc9cb --- /dev/null +++ b/doc/classes/AnimationNodeOutput.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeOutput" inherits="AnimationNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml new file mode 100644 index 0000000000..ed4098d938 --- /dev/null +++ b/doc/classes/AnimationNodeStateMachine.xml @@ -0,0 +1,199 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeStateMachine" inherits="AnimationRootNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_node"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="node" type="AnimationNode"> + </argument> + <argument index="2" name="position" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <description> + </description> + </method> + <method name="add_transition"> + <return type="void"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="to" type="String"> + </argument> + <argument index="2" name="transition" type="AnimationNodeStateMachineTransition"> + </argument> + <description> + </description> + </method> + <method name="get_end_node" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_graph_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_node" qualifiers="const"> + <return type="AnimationNode"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_node_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="node" type="AnimationNode"> + </argument> + <description> + </description> + </method> + <method name="get_node_position" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_start_node" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_transition" qualifiers="const"> + <return type="AnimationNodeStateMachineTransition"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_transition_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_transition_from" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_transition_to" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="has_node" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_transition" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="to" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_node"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_transition"> + <return type="void"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="to" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_transition_by_index"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="rename_node"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_end_node"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_graph_offset"> + <return type="void"> + </return> + <argument index="0" name="name" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_node_position"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="position" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_start_node"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml new file mode 100644 index 0000000000..6bf9504efb --- /dev/null +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeStateMachinePlayback" inherits="Resource" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_current_node" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_travel_path" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + </description> + </method> + <method name="is_playing" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="start"> + <return type="void"> + </return> + <argument index="0" name="node" type="String"> + </argument> + <description> + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="travel"> + <return type="void"> + </return> + <argument index="0" name="to_node" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeStateMachineTransition.xml b/doc/classes/AnimationNodeStateMachineTransition.xml new file mode 100644 index 0000000000..e07a9fc980 --- /dev/null +++ b/doc/classes/AnimationNodeStateMachineTransition.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeStateMachineTransition" inherits="Resource" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="advance_condition" type="String" setter="set_advance_condition" getter="get_advance_condition"> + </member> + <member name="auto_advance" type="bool" setter="set_auto_advance" getter="has_auto_advance"> + </member> + <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> + </member> + <member name="priority" type="int" setter="set_priority" getter="get_priority"> + </member> + <member name="switch_mode" type="int" setter="set_switch_mode" getter="get_switch_mode" enum="AnimationNodeStateMachineTransition.SwitchMode"> + </member> + <member name="xfade_time" type="float" setter="set_xfade_time" getter="get_xfade_time"> + </member> + </members> + <signals> + <signal name="advance_condition_changed"> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="SWITCH_MODE_IMMEDIATE" value="0" enum="SwitchMode"> + </constant> + <constant name="SWITCH_MODE_SYNC" value="1" enum="SwitchMode"> + </constant> + <constant name="SWITCH_MODE_AT_END" value="2" enum="SwitchMode"> + </constant> + </constants> +</class> diff --git a/doc/classes/AnimationNodeTimeScale.xml b/doc/classes/AnimationNodeTimeScale.xml new file mode 100644 index 0000000000..226c855b83 --- /dev/null +++ b/doc/classes/AnimationNodeTimeScale.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeTimeScale" inherits="AnimationNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeTimeSeek.xml b/doc/classes/AnimationNodeTimeSeek.xml new file mode 100644 index 0000000000..707b09a4a5 --- /dev/null +++ b/doc/classes/AnimationNodeTimeSeek.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeTimeSeek" inherits="AnimationNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeTransition.xml b/doc/classes/AnimationNodeTransition.xml new file mode 100644 index 0000000000..317bc5ed69 --- /dev/null +++ b/doc/classes/AnimationNodeTransition.xml @@ -0,0 +1,149 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeTransition" inherits="AnimationNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="input_0/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_0/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_1/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_1/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_10/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_10/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_11/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_11/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_12/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_12/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_13/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_13/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_14/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_14/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_15/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_15/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_16/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_16/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_17/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_17/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_18/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_18/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_19/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_19/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_2/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_2/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_20/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_20/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_21/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_21/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_22/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_22/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_23/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_23/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_24/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_24/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_25/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_25/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_26/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_26/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_27/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_27/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_28/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_28/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_29/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_29/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_3/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_3/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_30/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_30/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_31/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_31/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_4/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_4/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_5/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_5/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_6/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_6/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_7/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_7/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_8/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_8/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_9/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> + </member> + <member name="input_9/name" type="String" setter="set_input_caption" getter="get_input_caption"> + </member> + <member name="input_count" type="int" setter="set_enabled_inputs" getter="get_enabled_inputs"> + </member> + <member name="xfade_time" type="float" setter="set_cross_fade_time" getter="get_cross_fade_time"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index d791cd88dd..6dc91a234a 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.1-dev"> +<class name="AnimationPlayer" inherits="Node" category="Core" version="3.1"> <brief_description> Container and player of [Animation] resources. </brief_description> @@ -7,8 +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 + <link>http://docs.godotengine.org/en/3.0/getting_started/step_by_step/animations.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/animation/index.html</link> </tutorials> <demos> </demos> @@ -103,6 +103,13 @@ Get the blend time (in seconds) between two animations, referenced by their names. </description> </method> + <method name="get_playing_speed" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the actual playing speed of current animation or 0 if not playing. This speed is the [code]playback_speed[/code] property multiplied by [code]custom_speed[/code] argument specified when calling the [code]play[/code] method. + </description> + </method> <method name="has_animation" qualifiers="const"> <return type="bool"> </return> @@ -131,8 +138,7 @@ <argument index="3" name="from_end" type="bool" default="false"> </argument> <description> - Play the animation with key [code]name[/code]. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the - animation backwards. + Play the animation with key [code]name[/code]. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. </description> </method> <method name="play_backwards"> @@ -265,6 +271,10 @@ Notifies when an animation starts playing. </description> </signal> + <signal name="caches_cleared"> + <description> + </description> + </signal> </signals> <constants> <constant name="ANIMATION_PROCESS_PHYSICS" value="0" enum="AnimationProcessMode"> @@ -273,5 +283,8 @@ <constant name="ANIMATION_PROCESS_IDLE" value="1" enum="AnimationProcessMode"> Process animation during the idle process. </constant> + <constant name="ANIMATION_PROCESS_MANUAL" value="2" enum="AnimationProcessMode"> + Do not process animation. Use the 'advance' method to process the animation manually. + </constant> </constants> </class> diff --git a/doc/classes/AnimationRootNode.xml b/doc/classes/AnimationRootNode.xml new file mode 100644 index 0000000000..dab2c12373 --- /dev/null +++ b/doc/classes/AnimationRootNode.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationRootNode" inherits="AnimationNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationTrackEditPlugin.xml b/doc/classes/AnimationTrackEditPlugin.xml new file mode 100644 index 0000000000..f322a556b1 --- /dev/null +++ b/doc/classes/AnimationTrackEditPlugin.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationTrackEditPlugin" inherits="Reference" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml new file mode 100644 index 0000000000..9a6a75079c --- /dev/null +++ b/doc/classes/AnimationTree.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationTree" inherits="Node" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="advance"> + <return type="void"> + </return> + <argument index="0" name="delta" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_root_motion_transform" qualifiers="const"> + <return type="Transform"> + </return> + <description> + </description> + </method> + <method name="rename_parameter"> + <return type="void"> + </return> + <argument index="0" name="old_name" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="active" type="bool" setter="set_active" getter="is_active"> + </member> + <member name="anim_player" type="NodePath" setter="set_animation_player" getter="get_animation_player"> + </member> + <member name="process_mode" type="int" setter="set_process_mode" getter="get_process_mode" enum="AnimationTree.AnimationProcessMode"> + </member> + <member name="root_motion_track" type="NodePath" setter="set_root_motion_track" getter="get_root_motion_track"> + </member> + <member name="tree_root" type="AnimationNode" setter="set_tree_root" getter="get_tree_root"> + </member> + </members> + <constants> + <constant name="ANIMATION_PROCESS_PHYSICS" value="0" enum="AnimationProcessMode"> + </constant> + <constant name="ANIMATION_PROCESS_IDLE" value="1" enum="AnimationProcessMode"> + </constant> + <constant name="ANIMATION_PROCESS_MANUAL" value="2" enum="AnimationProcessMode"> + </constant> + </constants> +</class> diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index ca743bfb29..8c32d5f6a3 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AnimationTreePlayer" inherits="Node" category="Core" version="3.1-dev"> +<class name="AnimationTreePlayer" inherits="Node" category="Core" version="3.1"> <brief_description> Animation Player that uses a node graph for blending Animations. </brief_description> @@ -50,6 +50,14 @@ Returns the name of the [member master_player]'s [Animation] bound to this animation node. </description> </method> + <method name="animation_node_get_position" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + </description> + </method> <method name="animation_node_set_animation"> <return type="void"> </return> diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index 3c8a6a9269..5c56b5e21b 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.1-dev"> +<class name="Area" inherits="CollisionObject" category="Core" version="3.1"> <brief_description> General purpose area node for detection and 3D physics influence. </brief_description> @@ -192,7 +192,7 @@ <argument index="0" name="body" type="Object"> </argument> <description> - Emitted when a [PhysicsBody2D] object exits. + Emitted when a [PhysicsBody] object exits. </description> </signal> <signal name="body_shape_entered"> @@ -205,7 +205,7 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - Emitted when a [PhysicsBody2D] object enters, reporting which shapes overlapped. + Emitted when a [PhysicsBody] object enters, reporting which shapes overlapped. </description> </signal> <signal name="body_shape_exited"> @@ -218,7 +218,7 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - Emitted when a [PhysicsBody2D] object exits, reporting which shapes were overlapping. + Emitted when a [PhysicsBody] object exits, reporting which shapes were overlapping. </description> </signal> </signals> diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 3cfabee27f..c50ccefc4c 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.1-dev"> +<class name="Area2D" inherits="CollisionObject2D" category="Core" version="3.1"> <brief_description> 2D area for detection and 2D physics influence. </brief_description> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 1e129d70d0..9c5ae8ebd0 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -1,10 +1,19 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Array" category="Built-In Types" version="3.1-dev"> +<class name="Array" category="Built-In Types" version="3.1"> <brief_description> Generic array datatype. </brief_description> <description> - Generic array, contains several elements of any type, accessible by numerical index starting at 0. Negative indices can be used to count from the right, like in Python. Arrays are always passed by reference. + Generic array, contains several elements of any type, accessible by a numerical index starting at 0. Negative indices can be used to count from the back, like in Python (-1 is the last element, -2 the second to last, etc.). Example: + [codeblock] + var array = ["One", 2, 3, "Four"] + print(array[0]) # One + print(array[2]) # 3 + print(array[-1]) # Four + array[2] = "Three" + print(array[-2]) # Three + [/codeblock] + Arrays are always passed by reference. </description> <tutorials> </tutorials> @@ -131,8 +140,11 @@ <method name="duplicate"> <return type="Array"> </return> + <argument index="0" name="deep" type="bool" default="False"> + </argument> <description> - Returns a copy of this [code]Array[/code]. + Returns a copy of the array. + If [code]deep[/code] is [code]true[/code], a deep copy is be performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If [code]false[/code], a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array. </description> </method> <method name="empty"> @@ -265,6 +277,11 @@ Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> </method> + <method name="shuffle"> + <description> + Shuffle the array such that the items will have a random order. + </description> + </method> <method name="size"> <return type="int"> </return> @@ -274,7 +291,7 @@ </method> <method name="sort"> <description> - Sort the array using natural order and return reference to the array. + Sort the array using natural order. </description> </method> <method name="sort_custom"> @@ -283,7 +300,8 @@ <argument index="1" name="func" type="String"> </argument> <description> - Sort the array using a custom method and return reference to the array. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. + Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. + [b]Note:[/b] you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. [codeblock] class MyCustomSorter: static func sort(a, b): @@ -296,11 +314,6 @@ [/codeblock] </description> </method> - <method name="shuffle"> - <description> - Shuffle the array such that the items will have a random order. - </description> - </method> </methods> <constants> </constants> diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 9ea76e2702..1e2478dd14 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.1-dev"> +<class name="ArrayMesh" inherits="Mesh" category="Core" version="3.1"> <brief_description> </brief_description> <description> @@ -26,29 +26,35 @@ </argument> <argument index="2" name="blend_shapes" type="Array" default="[ ]"> </argument> - <argument index="3" name="compress_flags" type="int" default="97792"> + <argument index="3" name="compress_flags" type="int" default="97280"> </argument> <description> - Create a new surface ([method get_surface_count] that will become surf_idx for this. - Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). + Creates a new surface. + Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. See [Mesh] for details. (As a note, when using indices, it is recommended to only use points, lines or triangles). [method get_surface_count] will become the surf_idx for this new surface. + The [code]arrays[/code] argument is an array of arrays. See [enum ArrayType] for the values used in this array. For example, [code]arrays[0][/code] is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for [code]ARRAY_INDEX[/code] if it is used. + Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data, and the index array defines the order of the vertices. + Godot uses clockwise winding order for front faces of triangle primitive modes. </description> </method> <method name="center_geometry"> <return type="void"> </return> <description> + Centers the geometry. </description> </method> <method name="clear_blend_shapes"> <return type="void"> </return> <description> + Remove all blend shapes from this [code]ArrayMesh[/code]. </description> </method> <method name="get_blend_shape_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of blend shapes that the [code]ArrayMesh[/code] holds. </description> </method> <method name="get_blend_shape_name" qualifiers="const"> @@ -57,6 +63,7 @@ <argument index="0" name="index" type="int"> </argument> <description> + Returns the name of the blend shape at this index. </description> </method> <method name="get_surface_count" qualifiers="const"> @@ -69,17 +76,28 @@ <method name="lightmap_unwrap"> <return type="int" enum="Error"> </return> - <argument index="0" name="arg0" type="Transform"> + <argument index="0" name="transform" type="Transform"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="texel_size" type="float"> </argument> <description> + Will perform a UV unwrap on the [code]ArrayMesh[/code] to prepare the mesh for lightmapping. </description> </method> <method name="regen_normalmaps"> <return type="void"> </return> <description> + Will regenerate normal maps for the [code]ArrayMesh[/code]. + </description> + </method> + <method name="surface_find_by_name" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Return the index of the first surface with this name held within this [code]ArrayMesh[/code]. If none are found -1 is returned. </description> </method> <method name="surface_get_array_index_len" qualifiers="const"> @@ -88,7 +106,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the length in indices of the index array in the requested surface (see [method add_surface]). + Return the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_get_array_len" qualifiers="const"> @@ -97,7 +115,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the length in vertices of the vertex array in the requested surface (see [method add_surface]). + Return the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_get_arrays" qualifiers="const"> @@ -106,6 +124,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> + Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_get_blend_shape_arrays" qualifiers="const"> @@ -114,6 +133,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> + Returns the blend shape arrays for the requested surface. </description> </method> <method name="surface_get_format" qualifiers="const"> @@ -122,7 +142,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the format mask of the requested surface (see [method add_surface]). + Return the format mask of the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_get_material" qualifiers="const"> @@ -140,6 +160,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> + Get the name assigned to this surface. </description> </method> <method name="surface_get_primitive_type" qualifiers="const"> @@ -148,7 +169,7 @@ <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the primitive type of the requested surface (see [method add_surface]). + Return the primitive type of the requested surface (see [method add_surface_from_arrays]). </description> </method> <method name="surface_remove"> @@ -168,6 +189,7 @@ <argument index="1" name="material" type="Material"> </argument> <description> + Set a [Material] for a given surface. Surface will be rendered using this material. </description> </method> <method name="surface_set_name"> @@ -178,7 +200,7 @@ <argument index="1" name="name" type="String"> </argument> <description> - Set a [Material] for a given surface. Surface will be rendered using this material. + Set a name for a given surface. </description> </method> <method name="surface_update_region"> @@ -198,6 +220,7 @@ <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"> + An overriding bounding box for this mesh. </member> </members> <constants> @@ -232,7 +255,8 @@ Array of bone weights, as a float array. Each element in groups of 4 floats. </constant> <constant name="ARRAY_INDEX" value="8" enum="ArrayType"> - Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size. + [Array] of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the *i*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices. + For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line. </constant> <constant name="ARRAY_MAX" value="9" enum="ArrayType"> </constant> diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index 77ddbb3343..409c40e809 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.1-dev"> +<class name="AtlasTexture" inherits="Texture" category="Core" version="3.1"> <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 c4e111a792..c43da3e233 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.1-dev"> +<class name="AudioBusLayout" inherits="Resource" category="Core" version="3.1"> <brief_description> Stores information about the audiobusses. </brief_description> diff --git a/doc/classes/AudioEffect.xml b/doc/classes/AudioEffect.xml index 4d33b458a0..acbc96e70e 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.1-dev"> +<class name="AudioEffect" inherits="Resource" category="Core" version="3.1"> <brief_description> Audio Effect For Audio. </brief_description> diff --git a/doc/classes/AudioEffectAmplify.xml b/doc/classes/AudioEffectAmplify.xml index 2c0cbff8b4..3582ddc4f7 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.1-dev"> +<class name="AudioEffectAmplify" inherits="AudioEffect" category="Core" version="3.1"> <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 c9e9520dfe..9eba806ad5 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.1-dev"> +<class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" category="Core" version="3.1"> <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 cc8e351586..11aab3e86d 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.1-dev"> +<class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" category="Core" version="3.1"> <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 6890fc92d9..43e14b3964 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.1-dev"> +<class name="AudioEffectChorus" inherits="AudioEffect" category="Core" version="3.1"> <brief_description> Adds a chorus audio effect. </brief_description> diff --git a/doc/classes/AudioEffectCompressor.xml b/doc/classes/AudioEffectCompressor.xml index 33225a64ab..fa81bcf030 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.1-dev"> +<class name="AudioEffectCompressor" inherits="AudioEffect" category="Core" version="3.1"> <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 1c5757eca3..7c9d11111c 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.1-dev"> +<class name="AudioEffectDelay" inherits="AudioEffect" category="Core" version="3.1"> <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 c33dced31e..74d12df554 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.1-dev"> +<class name="AudioEffectDistortion" inherits="AudioEffect" category="Core" version="3.1"> <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 f6f44f2cb6..35a6f7557d 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.1-dev"> +<class name="AudioEffectEQ" inherits="AudioEffect" category="Core" version="3.1"> <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 201a26843c..daca342ace 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.1-dev"> +<class name="AudioEffectEQ10" inherits="AudioEffectEQ" category="Core" version="3.1"> <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. @@ -16,7 +16,6 @@ Band 8 : 4000 Hz Band 9 : 8000 Hz Band 10 : 16000 Hz - See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ21]. </description> <tutorials> diff --git a/doc/classes/AudioEffectEQ21.xml b/doc/classes/AudioEffectEQ21.xml index df0a536157..99d35604fc 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.1-dev"> +<class name="AudioEffectEQ21" inherits="AudioEffectEQ" category="Core" version="3.1"> <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. @@ -27,7 +27,6 @@ Band 19 : 11000 Hz Band 20 : 16000 Hz Band 21 : 22000 Hz - See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ10]. </description> <tutorials> diff --git a/doc/classes/AudioEffectEQ6.xml b/doc/classes/AudioEffectEQ6.xml index fe17a35d64..047c4c960f 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.1-dev"> +<class name="AudioEffectEQ6" inherits="AudioEffectEQ" category="Core" version="3.1"> <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. @@ -12,7 +12,6 @@ Band 4 : 1000 Hz Band 5 : 3200 Hz Band 6 : 10000 Hz - See also [AudioEffectEQ], [AudioEffectEQ10], [AudioEffectEQ21]. </description> <tutorials> diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml index 75dc9b292d..5a86c092a0 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.1-dev"> +<class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.1"> <brief_description> Adds a filter to the Audio Bus. </brief_description> diff --git a/doc/classes/AudioEffectHighPassFilter.xml b/doc/classes/AudioEffectHighPassFilter.xml index 148ab83cb6..3d487fc783 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.1-dev"> +<class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" category="Core" version="3.1"> <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 e52578dc3a..ca2312ba6a 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.1-dev"> +<class name="AudioEffectHighShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/AudioEffectLimiter.xml b/doc/classes/AudioEffectLimiter.xml index 6c61300e34..9e791f02d7 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.1-dev"> +<class name="AudioEffectLimiter" inherits="AudioEffect" category="Core" version="3.1"> <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 cc357ae9ee..3facd8b665 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.1-dev"> +<class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" category="Core" version="3.1"> <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 be9bde1b69..aadbf30eaa 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.1-dev"> +<class name="AudioEffectLowShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/AudioEffectNotchFilter.xml b/doc/classes/AudioEffectNotchFilter.xml index 7aec435bfa..741931f262 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.1-dev"> +<class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" category="Core" version="3.1"> <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 a75918958e..cbd14de905 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.1-dev"> +<class name="AudioEffectPanner" inherits="AudioEffect" category="Core" version="3.1"> <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 e276ed14b6..10566d089b 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.1-dev"> +<class name="AudioEffectPhaser" inherits="AudioEffect" category="Core" version="3.1"> <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 4e4658580a..99095bae44 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.1-dev"> +<class name="AudioEffectPitchShift" inherits="AudioEffect" category="Core" version="3.1"> <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/AudioEffectRecord.xml b/doc/classes/AudioEffectRecord.xml new file mode 100644 index 0000000000..b7771fc9c5 --- /dev/null +++ b/doc/classes/AudioEffectRecord.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectRecord" inherits="AudioEffect" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_recording" qualifiers="const"> + <return type="AudioStreamSample"> + </return> + <description> + </description> + </method> + <method name="is_recording_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_recording_active"> + <return type="void"> + </return> + <argument index="0" name="record" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectReverb.xml b/doc/classes/AudioEffectReverb.xml index 8453e4b11b..fb2009105d 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.1-dev"> +<class name="AudioEffectReverb" inherits="AudioEffect" category="Core" version="3.1"> <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. diff --git a/doc/classes/AudioEffectStereoEnhance.xml b/doc/classes/AudioEffectStereoEnhance.xml index 508dc96fb0..ae296d81a0 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.1-dev"> +<class name="AudioEffectStereoEnhance" inherits="AudioEffect" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 9618f0b066..37756bcfd8 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.1-dev"> +<class name="AudioServer" inherits="Object" category="Core" version="3.1"> <brief_description> Server interface for low level audio access. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/audio/audio_buses.html</link> </tutorials> <demos> </demos> @@ -34,6 +34,26 @@ Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code]. </description> </method> + <method name="capture_get_device"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="capture_get_device_list"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="capture_set_device"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> <method name="generate_bus_layout" qualifiers="const"> <return type="AudioBusLayout"> </return> @@ -126,6 +146,18 @@ Returns the volume of the bus at index [code]bus_idx[/code] in dB. </description> </method> + <method name="get_device"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_device_list"> + <return type="Array"> + </return> + <description> + </description> + </method> <method name="get_mix_rate" qualifiers="const"> <return type="float"> </return> @@ -313,6 +345,14 @@ Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code]. </description> </method> + <method name="set_device"> + <return type="void"> + </return> + <argument index="0" name="device" type="String"> + </argument> + <description> + </description> + </method> <method name="swap_bus_effects"> <return type="void"> </return> diff --git a/doc/classes/AudioStream.xml b/doc/classes/AudioStream.xml index cbb16c3198..753a506058 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.1-dev"> +<class name="AudioStream" inherits="Resource" category="Core" version="3.1"> <brief_description> Base class for audio streams. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/audio/audio_streams.html</link> </tutorials> <demos> </demos> @@ -16,6 +16,7 @@ <return type="float"> </return> <description> + Returns the length of the audio stream in seconds. </description> </method> </methods> diff --git a/doc/classes/AudioStreamMicrophone.xml b/doc/classes/AudioStreamMicrophone.xml new file mode 100644 index 0000000000..079555d17e --- /dev/null +++ b/doc/classes/AudioStreamMicrophone.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioStreamMicrophone" inherits="AudioStream" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioStreamPlayback.xml b/doc/classes/AudioStreamPlayback.xml index a27ab1d3a2..0960935ad9 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.1-dev"> +<class name="AudioStreamPlayback" inherits="Reference" category="Core" version="3.1"> <brief_description> Meta class for playing back audio. </brief_description> diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index f7c8f76182..26d0b1a83d 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.1-dev"> +<class name="AudioStreamPlayer" inherits="Node" category="Core" version="3.1"> <brief_description> Plays back audio. </brief_description> @@ -7,8 +7,8 @@ Plays background audio. </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 + <link>http://docs.godotengine.org/en/latest/learning/features/audio/index.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/audio/audio_streams.html</link> </tutorials> <demos> </demos> @@ -17,7 +17,7 @@ <return type="float"> </return> <description> - Returns the position in the [AudioStream]. + Returns the position in the [AudioStream] in seconds. </description> </method> <method name="play"> @@ -57,6 +57,7 @@ If the audio configuration has more than two speakers, this sets the target channels. See [code]MIX_TARGET_*[/code] constants. </member> <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale"> + Changes the pitch and the tempo of the audio. </member> <member name="playing" type="bool" setter="_set_playing" getter="is_playing"> If [code]true[/code] audio is playing. @@ -64,6 +65,8 @@ <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream"> The [AudioStream] object to be played. </member> + <member name="stream_paused" type="bool" setter="set_stream_paused" getter="get_stream_paused"> + </member> <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> Volume of sound, in dB. </member> diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 6594c9c8b9..5cc87e0e7a 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.1-dev"> +<class name="AudioStreamPlayer2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> Plays audio in 2D. </brief_description> @@ -7,8 +7,8 @@ Plays audio that dampens with distance from screen center. </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 + <link>http://docs.godotengine.org/en/latest/learning/features/audio/index.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/audio/audio_streams.html</link> </tutorials> <demos> </demos> @@ -63,6 +63,7 @@ Maximum distance from which audio is still hearable. </member> <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale"> + Changes the pitch and the tempo of the audio. </member> <member name="playing" type="bool" setter="_set_playing" getter="is_playing"> If [code]true[/code] audio is playing. @@ -70,6 +71,8 @@ <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream"> The [AudioStream] object to be played. </member> + <member name="stream_paused" type="bool" setter="set_stream_paused" getter="get_stream_paused"> + </member> <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> Base volume without dampening. </member> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 7eb1ff2b91..e61515ffc0 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -1,14 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamPlayer3D" inherits="Spatial" category="Core" version="3.1-dev"> +<class name="AudioStreamPlayer3D" inherits="Spatial" category="Core" version="3.1"> <brief_description> - Plays 3D sound in 3D space + Plays 3D sound in 3D space. </brief_description> <description> Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. </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 + <link>http://docs.godotengine.org/en/latest/learning/features/audio/index.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/audio/audio_streams.html</link> </tutorials> <demos> </demos> @@ -87,6 +87,7 @@ Decides if audio should pause when source is outside of 'max_distance' range. </member> <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale"> + Changes the pitch and the tempo of the audio. </member> <member name="playing" type="bool" setter="_set_playing" getter="is_playing"> If [code]true[/code], audio is playing. @@ -94,6 +95,8 @@ <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream"> The [AudioStream] object to be played. </member> + <member name="stream_paused" type="bool" setter="set_stream_paused" getter="get_stream_paused"> + </member> <member name="unit_db" type="float" setter="set_unit_db" getter="get_unit_db"> Base sound level unaffected by dampening, in dB. </member> diff --git a/doc/classes/AudioStreamRandomPitch.xml b/doc/classes/AudioStreamRandomPitch.xml index 362504d00d..992c731d47 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.1-dev"> +<class name="AudioStreamRandomPitch" inherits="AudioStream" category="Core" version="3.1"> <brief_description> Plays audio with random pitch tweaking. </brief_description> diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 224d1802dd..9e56cc6016 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.1-dev"> +<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.1"> <brief_description> Plays audio. </brief_description> @@ -11,8 +11,19 @@ <demos> </demos> <methods> + <method name="save_to_wav"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> </methods> <members> + <member name="data" type="PoolByteArray" setter="set_data" getter="get_data"> + Contains the audio data in bytes. + </member> <member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format"> Audio format. See FORMAT_* constants for values. </member> diff --git a/doc/classes/BackBufferCopy.xml b/doc/classes/BackBufferCopy.xml index 05a10da3ac..62c97feaf9 100644 --- a/doc/classes/BackBufferCopy.xml +++ b/doc/classes/BackBufferCopy.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BackBufferCopy" inherits="Node2D" category="Core" version="3.1-dev"> +<class name="BackBufferCopy" inherits="Node2D" category="Core" version="3.1"> <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. + Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with [code]SCREEN_TEXTURE[/code] in the [code]texture()[/code] function. </brief_description> <description> - Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Accessing this buffer is done with the texscreen() shader instruction. + Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Use [code]SCREEN_TEXTURE[/code] in the [code]texture()[/code] function to access the buffer. </description> <tutorials> </tutorials> diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml index 98ba28adeb..966b6dd7c4 100644 --- a/doc/classes/BakedLightmap.xml +++ b/doc/classes/BakedLightmap.xml @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BakedLightmap" inherits="VisualInstance" category="Core" version="3.1-dev"> +<class name="BakedLightmap" inherits="VisualInstance" category="Core" version="3.1"> <brief_description> + Prerendered indirect light map for a scene. </brief_description> <description> + Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the [GIProbe] approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time. </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/3d/baked_lightmaps.html + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/baked_lightmaps.html</link> </tutorials> <demos> </demos> @@ -29,36 +31,49 @@ </methods> <members> <member name="bake_cell_size" type="float" setter="set_bake_cell_size" getter="get_bake_cell_size"> + Grid subdivision size for lightmapper calculation. Default value of [code]0.25[/code] will work for most cases. Increase for better lighting on small details or if your scene is very large. </member> <member name="bake_energy" type="float" setter="set_energy" getter="get_energy"> </member> <member name="bake_extents" type="Vector3" setter="set_extents" getter="get_extents"> + Size of affected area. </member> <member name="bake_hdr" type="bool" setter="set_hdr" getter="is_hdr"> + If [code]true[/code] lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller lightmap. Default value:[code]false[/code]. </member> <member name="bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="BakedLightmap.BakeMode"> + Lightmapping mode. See [enum BakeMode]. </member> <member name="bake_propagation" type="float" setter="set_propagation" getter="get_propagation"> </member> <member name="bake_quality" type="int" setter="set_bake_quality" getter="get_bake_quality" enum="BakedLightmap.BakeQuality"> + Three quality modes are available. Higher quality requires more rendering time. See [enum BakeQuality]. </member> <member name="capture_cell_size" type="float" setter="set_capture_cell_size" getter="get_capture_cell_size"> + Grid size used for real-time capture information on dynamic objects. Cannot be larger than [member bake_cell_size]. </member> <member name="image_path" type="String" setter="set_image_path" getter="get_image_path"> + Location where lightmaps will be saved. </member> <member name="light_data" type="BakedLightmapData" setter="set_light_data" getter="get_light_data"> + The calculated light data. </member> </members> <constants> <constant name="BAKE_QUALITY_LOW" value="0" enum="BakeQuality"> + Lowest bake quality mode. Fastest to calculate. </constant> <constant name="BAKE_QUALITY_MEDIUM" value="1" enum="BakeQuality"> + Default bake quality mode. </constant> <constant name="BAKE_QUALITY_HIGH" value="2" enum="BakeQuality"> + Highest bake quality mode. Takes longer to calculate. </constant> <constant name="BAKE_MODE_CONE_TRACE" value="0" enum="BakeMode"> + Less precise but faster bake mode. </constant> <constant name="BAKE_MODE_RAY_TRACE" value="1" enum="BakeMode"> + More precise bake mode but can take considerably longer to bake. </constant> <constant name="BAKE_ERROR_OK" value="0" enum="BakeError"> </constant> diff --git a/doc/classes/BakedLightmapData.xml b/doc/classes/BakedLightmapData.xml index 49f09dc32b..8ee10b0b8b 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.1-dev"> +<class name="BakedLightmapData" inherits="Resource" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 0af7b6993c..3ff8634010 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.1-dev"> +<class name="BaseButton" inherits="Control" category="Core" version="3.1"> <brief_description> Base class for different kinds of buttons. </brief_description> @@ -15,7 +15,7 @@ <return type="void"> </return> <description> - Called when button is pressed. + Called when the button is pressed. </description> </method> <method name="_toggled" qualifiers="virtual"> @@ -24,7 +24,7 @@ <argument index="0" name="button_pressed" type="bool"> </argument> <description> - Called when button is toggled (only if toggle_mode is active). + Called when the button is toggled (only if toggle_mode is active). </description> </method> <method name="get_draw_mode" qualifiers="const"> @@ -38,7 +38,7 @@ <return type="bool"> </return> <description> - Return true if mouse entered the button before it exit. + Return true if the mouse has entered the button and has not left it yet. </description> </method> </methods> @@ -46,6 +46,10 @@ <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode"> Determines when the button is considered clicked, one of the ACTION_MODE_* constants. </member> + <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask"> + Binary mask to choose which mouse buttons this button will respond to. + To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT. + </member> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> If [code]true[/code] the button is in disabled state and can't be clicked or toggled. </member> diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 2bca7d7c1b..fe8debe1a9 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -1,13 +1,15 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Basis" category="Built-In Types" version="3.1-dev"> +<class name="Basis" category="Built-In Types" version="3.1"> <brief_description> 3x3 matrix datatype. </brief_description> <description> - 3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized. Almost always used as orthogonal basis for a [Transform]. + 3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized (due to scaling). Almost always used as orthogonal basis for a [Transform]. For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S). </description> <tutorials> + <link>http://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html</link> + <link>http://docs.godotengine.org/en/latest/tutorials/math/rotations.html</link> </tutorials> <demos> </demos> @@ -104,7 +106,7 @@ <argument index="1" name="phi" type="float"> </argument> <description> - Introduce an additional rotation around the given axis by phi (radians). Only relevant when the matrix is being used as a part of [Transform]. The axis must be a normalized vector. + Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector. </description> </method> <method name="scaled"> @@ -113,7 +115,18 @@ <argument index="0" name="scale" type="Vector3"> </argument> <description> - Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of [Transform]. + Introduce an additional scaling specified by the given 3D scaling factor. + </description> + </method> + <method name="slerp"> + <return type="Basis"> + </return> + <argument index="0" name="b" type="Basis"> + </argument> + <argument index="1" name="t" type="float"> + </argument> + <description> + Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix. </description> </method> <method name="tdotx"> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index 1d2fc950f0..7fe6a2acef 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.1-dev"> +<class name="BitMap" inherits="Resource" category="Core" version="3.1"> <brief_description> Boolean matrix. </brief_description> @@ -25,8 +25,10 @@ </return> <argument index="0" name="image" type="Image"> </argument> + <argument index="1" name="threshold" type="float" default="0.1"> + </argument> <description> - Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is 0, and true in other case. + Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is equal to [code]threshold[/code] or less, and true in other case. </description> </method> <method name="get_bit" qualifiers="const"> @@ -52,6 +54,26 @@ Returns the amount of bitmap elements that are set to true. </description> </method> + <method name="grow_mask"> + <return type="void"> + </return> + <argument index="0" name="pixels" type="int"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="opaque_to_polygons" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="rect" type="Rect2"> + </argument> + <argument index="1" name="epsilon" type="float" default="2.0"> + </argument> + <description> + </description> + </method> <method name="set_bit"> <return type="void"> </return> diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml index cff8951a4c..c943caf636 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.1-dev"> +<class name="BitmapFont" inherits="Font" category="Core" version="3.1"> <brief_description> Renders text using [code]*.fnt[/code] fonts. </brief_description> diff --git a/doc/classes/Bone2D.xml b/doc/classes/Bone2D.xml new file mode 100644 index 0000000000..7e714305cd --- /dev/null +++ b/doc/classes/Bone2D.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Bone2D" inherits="Node2D" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="apply_rest"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_index_in_skeleton" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_skeleton_rest" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="default_length" type="float" setter="set_default_length" getter="get_default_length"> + </member> + <member name="rest" type="Transform2D" setter="set_rest" getter="get_rest"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/BoneAttachment.xml b/doc/classes/BoneAttachment.xml index 3b7cd3fff2..a85453a415 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.1-dev"> +<class name="BoneAttachment" inherits="Spatial" category="Core" version="3.1"> <brief_description> A node that will attach to a bone. </brief_description> diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml index 542703bae7..3fbad58a24 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.1-dev"> +<class name="BoxContainer" inherits="Container" category="Core" version="3.1"> <brief_description> Base class for box containers. </brief_description> diff --git a/doc/classes/BoxShape.xml b/doc/classes/BoxShape.xml index 33ba197bec..d98a188870 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.1-dev"> +<class name="BoxShape" inherits="Shape" category="Core" version="3.1"> <brief_description> Box shape resource. </brief_description> diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index 7783951cf9..382a538f2b 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.1-dev"> +<class name="Button" inherits="BaseButton" category="Core" version="3.1"> <brief_description> Standard themed Button. </brief_description> diff --git a/doc/classes/ButtonGroup.xml b/doc/classes/ButtonGroup.xml index ebeb1e0aa0..e839c3e750 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.1-dev"> +<class name="ButtonGroup" inherits="Resource" category="Core" version="3.1"> <brief_description> Group of Buttons. </brief_description> diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml new file mode 100644 index 0000000000..9d3dc5d70a --- /dev/null +++ b/doc/classes/CPUParticles.xml @@ -0,0 +1,197 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CPUParticles" inherits="GeometryInstance" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="convert_from_particles"> + <return type="void"> + </return> + <argument index="0" name="particles" type="Node"> + </argument> + <description> + </description> + </method> + <method name="restart"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="amount" type="int" setter="set_amount" getter="get_amount"> + </member> + <member name="angle" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angle_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> + </member> + <member name="angle_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="angular_velocity" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> + </member> + <member name="angular_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="anim_loop" type="bool" setter="set_particle_flag" getter="get_particle_flag"> + </member> + <member name="anim_offset" type="float" setter="set_param" getter="get_param"> + </member> + <member name="anim_offset_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> + </member> + <member name="anim_offset_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="anim_speed" type="float" setter="set_param" getter="get_param"> + </member> + <member name="anim_speed_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> + </member> + <member name="anim_speed_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="color" type="Color" setter="set_color" getter="get_color"> + </member> + <member name="color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp"> + </member> + <member name="damping" type="float" setter="set_param" getter="get_param"> + </member> + <member name="damping_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> + </member> + <member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="CPUParticles.DrawOrder"> + </member> + <member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents"> + </member> + <member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors"> + </member> + <member name="emission_normals" type="PoolVector3Array" setter="set_emission_normals" getter="get_emission_normals"> + </member> + <member name="emission_points" type="PoolVector3Array" setter="set_emission_points" getter="get_emission_points"> + </member> + <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles.EmissionShape"> + </member> + <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius"> + </member> + <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting"> + </member> + <member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio"> + </member> + <member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps"> + </member> + <member name="flag_align_y" type="bool" setter="set_particle_flag" getter="get_particle_flag"> + </member> + <member name="flag_disable_z" type="bool" setter="set_particle_flag" getter="get_particle_flag"> + </member> + <member name="flag_rotate_y" type="bool" setter="set_particle_flag" getter="get_particle_flag"> + </member> + <member name="flatness" type="float" setter="set_flatness" getter="get_flatness"> + </member> + <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta"> + </member> + <member name="gravity" type="Vector3" setter="set_gravity" getter="get_gravity"> + </member> + <member name="hue_variation" type="float" setter="set_param" getter="get_param"> + </member> + <member name="hue_variation_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> + </member> + <member name="hue_variation_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="initial_velocity" type="float" setter="set_param" getter="get_param"> + </member> + <member name="initial_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime"> + </member> + <member name="linear_accel" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> + </member> + <member name="linear_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates"> + </member> + <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> + </member> + <member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot"> + </member> + <member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time"> + </member> + <member name="radial_accel" type="float" setter="set_param" getter="get_param"> + </member> + <member name="radial_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> + </member> + <member name="radial_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio"> + </member> + <member name="scale" type="float" setter="set_param" getter="get_param"> + </member> + <member name="scale_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> + </member> + <member name="scale_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> + </member> + <member name="spread" type="float" setter="set_spread" getter="get_spread"> + </member> + <member name="tangential_accel" type="float" setter="set_param" getter="get_param"> + </member> + <member name="tangential_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> + </member> + <member name="tangential_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + </members> + <constants> + <constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder"> + </constant> + <constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder"> + </constant> + <constant name="DRAW_ORDER_VIEW_DEPTH" value="2" enum="DrawOrder"> + </constant> + <constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter"> + </constant> + <constant name="PARAM_ANGULAR_VELOCITY" value="1" enum="Parameter"> + </constant> + <constant name="PARAM_LINEAR_ACCEL" value="2" enum="Parameter"> + </constant> + <constant name="PARAM_RADIAL_ACCEL" value="3" enum="Parameter"> + </constant> + <constant name="PARAM_TANGENTIAL_ACCEL" value="4" enum="Parameter"> + </constant> + <constant name="PARAM_DAMPING" value="5" enum="Parameter"> + </constant> + <constant name="PARAM_ANGLE" value="6" enum="Parameter"> + </constant> + <constant name="PARAM_SCALE" value="7" enum="Parameter"> + </constant> + <constant name="PARAM_HUE_VARIATION" value="8" enum="Parameter"> + </constant> + <constant name="PARAM_ANIM_SPEED" value="9" enum="Parameter"> + </constant> + <constant name="PARAM_ANIM_OFFSET" value="10" enum="Parameter"> + </constant> + <constant name="PARAM_MAX" value="11" enum="Parameter"> + </constant> + <constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0" enum="Flags"> + </constant> + <constant name="FLAG_ROTATE_Y" value="1" enum="Flags"> + </constant> + <constant name="FLAG_MAX" value="4" enum="Flags"> + </constant> + <constant name="EMISSION_SHAPE_POINT" value="0" enum="EmissionShape"> + </constant> + <constant name="EMISSION_SHAPE_SPHERE" value="1" enum="EmissionShape"> + </constant> + <constant name="EMISSION_SHAPE_BOX" value="2" enum="EmissionShape"> + </constant> + <constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape"> + </constant> + <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape"> + </constant> + </constants> +</class> diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index 226277d178..c7eb365891 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.1-dev"> +<class name="Camera" inherits="Spatial" category="Core" version="3.1"> <brief_description> Camera node, displays from a point of view. </brief_description> @@ -14,15 +14,25 @@ <method name="clear_current"> <return type="void"> </return> + <argument index="0" name="enable_next" type="bool" default="true"> + </argument> <description> - If this is the current Camera, remove it from being current. If it is inside the node tree, request to make the next Camera current, if any. + If this is the current Camera, remove it from being current. If [code]enable_next[/code] is true, request to make the next Camera current, if any. </description> </method> <method name="get_camera_transform" qualifiers="const"> <return type="Transform"> </return> <description> - Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. + Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. + </description> + </method> + <method name="get_cull_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> </description> </method> <method name="is_position_behind" qualifiers="const"> @@ -31,14 +41,14 @@ <argument index="0" name="world_point" type="Vector3"> </argument> <description> - Returns [code]true[/code] if the given position is behind the Camera. + Returns [code]true[/code] if the given position is behind the Camera. Note that a position which returns [code]false[/code] may still be outside the Camera's field of view. </description> </method> <method name="make_current"> <return type="void"> </return> <description> - Make this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. + Makes this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. </description> </method> <method name="project_local_ray_normal" qualifiers="const"> @@ -56,7 +66,7 @@ <argument index="0" name="screen_point" type="Vector2"> </argument> <description> - Returns how a 2D coordinate in the Viewport rectangle maps to a 3D point in worldspace. + Returns the 3D point in worldspace that maps to the given 2D coordinate in the [Viewport] rectangle. </description> </method> <method name="project_ray_normal" qualifiers="const"> @@ -77,6 +87,16 @@ Returns a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. </description> </method> + <method name="set_cull_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_orthogonal"> <return type="void"> </return> @@ -87,7 +107,7 @@ <argument index="2" name="z_far" type="float"> </argument> <description> - Set the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) + Sets the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) </description> </method> <method name="set_perspective"> @@ -100,7 +120,7 @@ <argument index="2" name="z_far" type="float"> </argument> <description> - Set the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. + Sets the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. </description> </method> <method name="unproject_position" qualifiers="const"> @@ -109,7 +129,7 @@ <argument index="0" name="world_point" type="Vector3"> </argument> <description> - Returns how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle. + Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in worldspace. </description> </method> </methods> @@ -124,7 +144,7 @@ If not [code]DOPPLER_TRACKING_DISABLED[/code] this Camera will simulate the Doppler effect for objects changed in particular [code]_process[/code] methods. Default value: [code]DOPPLER_TRACKING_DISABLED[/code]. </member> <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> - Set the [Environment] to use for this Camera. + The [Environment] to use for this Camera. </member> <member name="far" type="float" setter="set_zfar" getter="get_zfar"> The distance to the far culling boundary for this Camera relative to its local z-axis. @@ -133,10 +153,10 @@ The camera's field of view angle (in degrees). Only applicable in perspective mode. Since [member keep_aspect] locks one axis, [code]fov[/code] sets the other axis' field of view angle. </member> <member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset"> - The horizontal (X) offset of the Camear viewport. + The horizontal (X) offset of the Camera viewport. </member> <member name="keep_aspect" type="int" setter="set_keep_aspect_mode" getter="get_keep_aspect_mode" enum="Camera.KeepAspect"> - The axis to lock during [member fov]/[member size] adjustments. + The axis to lock during [member fov]/[member size] adjustments. Can be either [code]KEEP_WIDTH[/code] or [code]KEEP_HEIGHT[/code]. </member> <member name="near" type="float" setter="set_znear" getter="get_znear"> The distance to the near culling boundary for this Camera relative to its local z-axis. @@ -148,7 +168,7 @@ The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since [member keep_aspect] locks on axis, [code]size[/code] sets the other axis' size length. </member> <member name="v_offset" type="float" setter="set_v_offset" getter="get_v_offset"> - The horizontal (Y) offset of the Camear viewport. + The vertical (Y) offset of the Camera viewport. </member> </members> <constants> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 9ab1c63c1f..39cc1b84b3 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.1-dev"> +<class name="Camera2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> Camera node for 2D scenes. </brief_description> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index e3bf2b9577..a04e38af5c 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.1-dev"> +<class name="CanvasItem" inherits="Node" category="Core" version="3.1"> <brief_description> Base class of anything 2D. </brief_description> @@ -11,8 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/2d/2d_transforms.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/2d/custom_drawing_in_2d.html</link> </tutorials> <demos> </demos> @@ -90,6 +90,18 @@ Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. </description> </method> + <method name="draw_mesh"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="Mesh"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <argument index="2" name="normal_map" type="Texture" default="null"> + </argument> + <description> + </description> + </method> <method name="draw_multiline"> <return type="void"> </return> @@ -120,6 +132,18 @@ Draws multiple, parallel lines with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. </description> </method> + <method name="draw_multimesh"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="Mesh"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <argument index="2" name="normal_map" type="Texture" default="null"> + </argument> + <description> + </description> + </method> <method name="draw_polygon"> <return type="void"> </return> @@ -542,6 +566,9 @@ <constant name="BLEND_MODE_PREMULT_ALPHA" value="4" enum="BlendMode"> Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. </constant> + <constant name="BLEND_MODE_DISABLED" value="5" enum="BlendMode"> + Disable blending mode. Colors including alpha are written as is. Only applicable for render targets with a transparent background. No lighting will be applied. + </constant> <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29"> Canvas item transform has changed. Only received if requested. </constant> diff --git a/doc/classes/CanvasItemMaterial.xml b/doc/classes/CanvasItemMaterial.xml index 1a2c61000e..fe7194dcfe 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.1-dev"> +<class name="CanvasItemMaterial" inherits="Material" category="Core" version="3.1"> <brief_description> A material for [CanvasItem]s. </brief_description> diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index d66ea5acdb..d4412e15c9 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.1-dev"> +<class name="CanvasLayer" inherits="Node" category="Core" version="3.1"> <brief_description> Canvas drawing layer. </brief_description> @@ -7,17 +7,17 @@ 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/2d/2d_transforms.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/2d/canvas_layers.html</link> </tutorials> <demos> </demos> <methods> - <method name="get_world_2d" qualifiers="const"> - <return type="World2D"> + <method name="get_canvas" qualifiers="const"> + <return type="RID"> </return> <description> - Return the [World2D] used by this layer. + Returns the RID of the canvas used by this layer. </description> </method> </methods> diff --git a/doc/classes/CanvasModulate.xml b/doc/classes/CanvasModulate.xml index 1595b90ca5..7740423cf5 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.1-dev"> +<class name="CanvasModulate" inherits="Node2D" category="Core" version="3.1"> <brief_description> Tint the entire canvas. </brief_description> diff --git a/doc/classes/CapsuleMesh.xml b/doc/classes/CapsuleMesh.xml index 988c500d52..3500701290 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.1-dev"> +<class name="CapsuleMesh" inherits="PrimitiveMesh" category="Core" version="3.1"> <brief_description> Class representing a capsule-shaped [PrimitiveMesh]. </brief_description> diff --git a/doc/classes/CapsuleShape.xml b/doc/classes/CapsuleShape.xml index c0c5e4e1f2..0c00288783 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.1-dev"> +<class name="CapsuleShape" inherits="Shape" category="Core" version="3.1"> <brief_description> Capsule shape for collisions. </brief_description> diff --git a/doc/classes/CapsuleShape2D.xml b/doc/classes/CapsuleShape2D.xml index eaa7eef8cc..f05b194601 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.1-dev"> +<class name="CapsuleShape2D" inherits="Shape2D" category="Core" version="3.1"> <brief_description> Capsule shape for 2D collisions. </brief_description> @@ -17,7 +17,7 @@ The capsule's height. </member> <member name="radius" type="float" setter="set_radius" getter="get_radius"> - The capsules's radius. + The capsule's radius. </member> </members> <constants> diff --git a/doc/classes/CenterContainer.xml b/doc/classes/CenterContainer.xml index fd2d8ee9e7..41c8cf7100 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.1-dev"> +<class name="CenterContainer" inherits="Container" category="Core" version="3.1"> <brief_description> Keeps children controls centered. </brief_description> diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index f2aae0a674..fb2cf64d98 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CheckBox" inherits="Button" category="Core" version="3.1-dev"> +<class name="CheckBox" inherits="Button" category="Core" version="3.1"> <brief_description> - Binary choice user interface widget + Binary choice user interface widget. </brief_description> <description> A checkbox allows the user to make a binary choice (choosing only one of two possible options), for example Answer 'yes' or 'no'. diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml index 1ad7f9cc68..deba9a17b6 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.1-dev"> +<class name="CheckButton" inherits="Button" category="Core" version="3.1"> <brief_description> Checkable button. </brief_description> diff --git a/doc/classes/CircleShape2D.xml b/doc/classes/CircleShape2D.xml index 8736cd47e5..db84c82e48 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.1-dev"> +<class name="CircleShape2D" inherits="Shape2D" category="Core" version="3.1"> <brief_description> Circular shape for 2D collisions. </brief_description> diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 05f2f6472e..e215585b74 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.1-dev"> +<class name="ClassDB" inherits="Object" category="Core" version="3.1"> <brief_description> Class information repository. </brief_description> @@ -112,7 +112,7 @@ <argument index="1" name="no_inheritance" type="bool" default="false"> </argument> <description> - Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a [Dictionary] as described in [class_get_signal]. + Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a [Dictionary] as described in [method class_get_signal]. </description> </method> <method name="class_has_integer_constant" qualifiers="const"> diff --git a/doc/classes/CollisionObject.xml b/doc/classes/CollisionObject.xml index 8529c68b11..22b9725121 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.1-dev"> +<class name="CollisionObject" inherits="Spatial" category="Core" version="3.1"> <brief_description> Base node for collision objects. </brief_description> diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index 2e361b5ac1..1ef72c0ca2 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.1-dev"> +<class name="CollisionObject2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> Base node for 2D collision objects. </brief_description> diff --git a/doc/classes/CollisionPolygon.xml b/doc/classes/CollisionPolygon.xml index b0f1142ac5..28e9ba4217 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.1-dev"> +<class name="CollisionPolygon" inherits="Spatial" category="Core" version="3.1"> <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 8ef50cb4e0..5b940e7ff1 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.1-dev"> +<class name="CollisionPolygon2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> Defines a 2D collision polygon. </brief_description> diff --git a/doc/classes/CollisionShape.xml b/doc/classes/CollisionShape.xml index 7afd455ebd..682c9340df 100644 --- a/doc/classes/CollisionShape.xml +++ b/doc/classes/CollisionShape.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionShape" inherits="Spatial" category="Core" version="3.1-dev"> +<class name="CollisionShape" inherits="Spatial" category="Core" version="3.1"> <brief_description> Node that represents collision shape data in 3D space. </brief_description> <description> - 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. + 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 create a 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/CollisionShape2D.xml b/doc/classes/CollisionShape2D.xml index 7b3cddf4aa..3312fad99c 100644 --- a/doc/classes/CollisionShape2D.xml +++ b/doc/classes/CollisionShape2D.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CollisionShape2D" inherits="Node2D" category="Core" version="3.1-dev"> +<class name="CollisionShape2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> Node that represents collision shape data in 2D space. </brief_description> <description> - 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. + 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 create a 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 8113ee3415..b66239181a 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Color" category="Built-In Types" version="3.1-dev"> +<class name="Color" category="Built-In Types" version="3.1"> <brief_description> Color in RGBA format with some support for ARGB format. </brief_description> <description> A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate(color)) may accept values > 1. - You can also create a color from standardised color names with [method @GDScript.ColorN]. + You can also create a color from standardised color names with Color.ColorN (e.g. Color.green) or [method @GDScript.ColorN]. </description> <tutorials> </tutorials> @@ -15,67 +15,67 @@ <method name="Color"> <return type="Color"> </return> - <argument index="0" name="r" type="float"> - </argument> - <argument index="1" name="g" type="float"> - </argument> - <argument index="2" name="b" type="float"> - </argument> - <argument index="3" name="a" type="float"> + <argument index="0" name="from" type="String"> </argument> <description> - Constructs a color from an RGBA profile using values between 0 and 1 (float). + Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also [method @GDScript.ColorN]. + The following string formats are supported: + [code]"#ff00ff00"[/code] - ARGB format with '#' + [code]"ff00ff00"[/code] - ARGB format + [code]"#ff00ff"[/code] - RGB format with '#' + [code]"ff00ff"[/code] - RGB format [codeblock] - var c = Color(0.2, 1.0, .7, .8) # a color of an RGBA(51, 255, 178, 204) + # The following code creates the same color of an RGBA(178, 217, 10, 255) + var c1 = Color("#ffb2d90a") # ARGB format with '#' + var c2 = Color("ffb2d90a") # ARGB format + var c3 = Color("#b2d90a") # RGB format with '#' + var c4 = Color("b2d90a") # RGB format [/codeblock] </description> </method> <method name="Color"> <return type="Color"> </return> - <argument index="0" name="r" type="float"> - </argument> - <argument index="1" name="g" type="float"> - </argument> - <argument index="2" name="b" type="float"> + <argument index="0" name="from" type="int"> </argument> <description> - Constructs a color from an RGB profile using values between 0 and 1 (float). Alpha will always be 1. + Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile). [codeblock] - var c = Color(0.2, 1.0, .7) # a color of an RGBA(51, 255, 178, 255) + var c = Color(274) # a color of an RGBA(0, 0, 1, 18) [/codeblock] </description> </method> <method name="Color"> <return type="Color"> </return> - <argument index="0" name="from" type="int"> + <argument index="0" name="r" type="float"> + </argument> + <argument index="1" name="g" type="float"> + </argument> + <argument index="2" name="b" type="float"> </argument> <description> - Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile). + Constructs a color from an RGB profile using values between 0 and 1 (float). Alpha will always be 1. [codeblock] - var c = Color(274) # a color of an RGBA(0, 0, 1, 18) + var c = Color(0.2, 1.0, .7) # a color of an RGBA(51, 255, 178, 255) [/codeblock] </description> </method> <method name="Color"> <return type="Color"> </return> - <argument index="0" name="from" type="String"> + <argument index="0" name="r" type="float"> + </argument> + <argument index="1" name="g" type="float"> + </argument> + <argument index="2" name="b" type="float"> + </argument> + <argument index="3" name="a" type="float"> </argument> <description> - Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also [method @GDScript.ColorN]. - The following string formats are supported: - [code]"#ff00ff00"[/code] - ARGB format with '#' - [code]"ff00ff00"[/code] - ARGB format - [code]"#ff00ff"[/code] - RGB format with '#' - [code]"ff00ff"[/code] - RGB format + Constructs a color from an RGBA profile using values between 0 and 1 (float). [codeblock] - # The following code creates the same color of an RGBA(178, 217, 10, 255) - var c1 = Color("#ffb2d90a") # ARGB format with '#' - var c2 = Color("ffb2d90a") # ARGB format - var c3 = Color("#b2d90a") # RGB format with '#' - var c4 = Color("b2d90a") # RGB format + var c = Color(0.2, 1.0, .7, .8) # a color of an RGBA(51, 255, 178, 204) [/codeblock] </description> </method> @@ -117,6 +117,24 @@ [/codeblock] </description> </method> + <method name="from_hsv"> + <return type="Color"> + </return> + <argument index="0" name="h" type="float"> + </argument> + <argument index="1" name="s" type="float"> + </argument> + <argument index="2" name="v" type="float"> + </argument> + <argument index="3" name="a" type="float" default="1"> + </argument> + <description> + Constructs a color from an HSV profile. [code]h[/code], [code]s[/code], and [code]v[/code] are values between 0 and 1. + [codeblock] + var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8) + [/codeblock] + </description> + </method> <method name="gray"> <return type="float"> </return> @@ -169,14 +187,47 @@ [/codeblock] </description> </method> + <method name="to_abgr32"> + <return type="int"> + </return> + <description> + Returns the color's 32-bit integer in ABGR format (each byte represents a component of the ABGR profile). ABGR is the reversed version of the default format. + [codeblock] + var c = Color(1, .5, .2) + print(c.to_abgr32()) # Prints 4281565439 + [/codeblock] + </description> + </method> + <method name="to_abgr64"> + <return type="int"> + </return> + <description> + Returns the color's 64-bit integer in ABGR format (each word represents a component of the ABGR profile). ABGR is the reversed version of the default format. + [codeblock] + var c = Color(1, .5, .2) + print(c.to_abgr64()) # Prints -225178692812801 + [/codeblock] + </description> + </method> <method name="to_argb32"> <return type="int"> </return> <description> - Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). More compatible with DirectX. + Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). ARGB is more compatible with DirectX. + [codeblock] + var c = Color(1, .5, .2) + print(c.to_argb32()) # Prints 4294934323 + [/codeblock] + </description> + </method> + <method name="to_argb64"> + <return type="int"> + </return> + <description> + Returns the color's 64-bit integer in ARGB format (each word represents a component of the ARGB profile). ARGB is more compatible with DirectX. [codeblock] var c = Color(1, .5, .2) - print(str(c.to_32())) # prints 4294934323 + print(c.to_argb64()) # Prints -2147470541 [/codeblock] </description> </method> @@ -199,12 +250,22 @@ <return type="int"> </return> <description> - Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). + Returns the color's 32-bit integer in RGBA format (each byte represents a component of the RGBA profile). RGBA is the format that Godot uses by default. + [codeblock] + var c = Color(1, .5, .2) + print(c.to_rgba32()) # Prints 4286526463 + [/codeblock] + </description> + </method> + <method name="to_rgba64"> + <return type="int"> + </return> + <description> + Returns the color's 64-bit integer in RGBA format (each word represents a component of the RGBA profile). RGBA is the format that Godot uses by default. [codeblock] var c = Color(1, .5, .2) - print(str(c.to_32())) # prints 4294934323 + print(c.to_rgba64()) # Prints -140736629309441 [/codeblock] - [i]This is same as [method to_argb32] but may be changed later to support RGBA format instead[/i]. </description> </method> </methods> @@ -244,5 +305,295 @@ </member> </members> <constants> + <constant name="gray" value="Color( 0.75, 0.75, 0.75, 1 )"> + </constant> + <constant name="aliceblue" value="Color( 0.94, 0.97, 1, 1 )"> + </constant> + <constant name="antiquewhite" value="Color( 0.98, 0.92, 0.84, 1 )"> + </constant> + <constant name="aqua" value="Color( 0, 1, 1, 1 )"> + </constant> + <constant name="aquamarine" value="Color( 0.5, 1, 0.83, 1 )"> + </constant> + <constant name="azure" value="Color( 0.94, 1, 1, 1 )"> + </constant> + <constant name="beige" value="Color( 0.96, 0.96, 0.86, 1 )"> + </constant> + <constant name="bisque" value="Color( 1, 0.89, 0.77, 1 )"> + </constant> + <constant name="black" value="Color( 0, 0, 0, 1 )"> + </constant> + <constant name="blanchedalmond" value="Color( 1, 0.92, 0.8, 1 )"> + </constant> + <constant name="blue" value="Color( 0, 0, 1, 1 )"> + </constant> + <constant name="blueviolet" value="Color( 0.54, 0.17, 0.89, 1 )"> + </constant> + <constant name="brown" value="Color( 0.65, 0.16, 0.16, 1 )"> + </constant> + <constant name="burlywood" value="Color( 0.87, 0.72, 0.53, 1 )"> + </constant> + <constant name="cadetblue" value="Color( 0.37, 0.62, 0.63, 1 )"> + </constant> + <constant name="chartreuse" value="Color( 0.5, 1, 0, 1 )"> + </constant> + <constant name="chocolate" value="Color( 0.82, 0.41, 0.12, 1 )"> + </constant> + <constant name="coral" value="Color( 1, 0.5, 0.31, 1 )"> + </constant> + <constant name="cornflower" value="Color( 0.39, 0.58, 0.93, 1 )"> + </constant> + <constant name="cornsilk" value="Color( 1, 0.97, 0.86, 1 )"> + </constant> + <constant name="crimson" value="Color( 0.86, 0.08, 0.24, 1 )"> + </constant> + <constant name="cyan" value="Color( 0, 1, 1, 1 )"> + </constant> + <constant name="darkblue" value="Color( 0, 0, 0.55, 1 )"> + </constant> + <constant name="darkcyan" value="Color( 0, 0.55, 0.55, 1 )"> + </constant> + <constant name="darkgoldenrod" value="Color( 0.72, 0.53, 0.04, 1 )"> + </constant> + <constant name="darkgray" value="Color( 0.66, 0.66, 0.66, 1 )"> + </constant> + <constant name="darkgreen" value="Color( 0, 0.39, 0, 1 )"> + </constant> + <constant name="darkkhaki" value="Color( 0.74, 0.72, 0.42, 1 )"> + </constant> + <constant name="darkmagenta" value="Color( 0.55, 0, 0.55, 1 )"> + </constant> + <constant name="darkolivegreen" value="Color( 0.33, 0.42, 0.18, 1 )"> + </constant> + <constant name="darkorange" value="Color( 1, 0.55, 0, 1 )"> + </constant> + <constant name="darkorchid" value="Color( 0.6, 0.2, 0.8, 1 )"> + </constant> + <constant name="darkred" value="Color( 0.55, 0, 0, 1 )"> + </constant> + <constant name="darksalmon" value="Color( 0.91, 0.59, 0.48, 1 )"> + </constant> + <constant name="darkseagreen" value="Color( 0.56, 0.74, 0.56, 1 )"> + </constant> + <constant name="darkslateblue" value="Color( 0.28, 0.24, 0.55, 1 )"> + </constant> + <constant name="darkslategray" value="Color( 0.18, 0.31, 0.31, 1 )"> + </constant> + <constant name="darkturquoise" value="Color( 0, 0.81, 0.82, 1 )"> + </constant> + <constant name="darkviolet" value="Color( 0.58, 0, 0.83, 1 )"> + </constant> + <constant name="deeppink" value="Color( 1, 0.08, 0.58, 1 )"> + </constant> + <constant name="deepskyblue" value="Color( 0, 0.75, 1, 1 )"> + </constant> + <constant name="dimgray" value="Color( 0.41, 0.41, 0.41, 1 )"> + </constant> + <constant name="dodgerblue" value="Color( 0.12, 0.56, 1, 1 )"> + </constant> + <constant name="firebrick" value="Color( 0.7, 0.13, 0.13, 1 )"> + </constant> + <constant name="floralwhite" value="Color( 1, 0.98, 0.94, 1 )"> + </constant> + <constant name="forestgreen" value="Color( 0.13, 0.55, 0.13, 1 )"> + </constant> + <constant name="fuchsia" value="Color( 1, 0, 1, 1 )"> + </constant> + <constant name="gainsboro" value="Color( 0.86, 0.86, 0.86, 1 )"> + </constant> + <constant name="ghostwhite" value="Color( 0.97, 0.97, 1, 1 )"> + </constant> + <constant name="gold" value="Color( 1, 0.84, 0, 1 )"> + </constant> + <constant name="goldenrod" value="Color( 0.85, 0.65, 0.13, 1 )"> + </constant> + <constant name="green" value="Color( 0, 1, 0, 1 )"> + </constant> + <constant name="greenyellow" value="Color( 0.68, 1, 0.18, 1 )"> + </constant> + <constant name="honeydew" value="Color( 0.94, 1, 0.94, 1 )"> + </constant> + <constant name="hotpink" value="Color( 1, 0.41, 0.71, 1 )"> + </constant> + <constant name="indianred" value="Color( 0.8, 0.36, 0.36, 1 )"> + </constant> + <constant name="indigo" value="Color( 0.29, 0, 0.51, 1 )"> + </constant> + <constant name="ivory" value="Color( 1, 1, 0.94, 1 )"> + </constant> + <constant name="khaki" value="Color( 0.94, 0.9, 0.55, 1 )"> + </constant> + <constant name="lavender" value="Color( 0.9, 0.9, 0.98, 1 )"> + </constant> + <constant name="lavenderblush" value="Color( 1, 0.94, 0.96, 1 )"> + </constant> + <constant name="lawngreen" value="Color( 0.49, 0.99, 0, 1 )"> + </constant> + <constant name="lemonchiffon" value="Color( 1, 0.98, 0.8, 1 )"> + </constant> + <constant name="lightblue" value="Color( 0.68, 0.85, 0.9, 1 )"> + </constant> + <constant name="lightcoral" value="Color( 0.94, 0.5, 0.5, 1 )"> + </constant> + <constant name="lightcyan" value="Color( 0.88, 1, 1, 1 )"> + </constant> + <constant name="lightgoldenrod" value="Color( 0.98, 0.98, 0.82, 1 )"> + </constant> + <constant name="lightgray" value="Color( 0.83, 0.83, 0.83, 1 )"> + </constant> + <constant name="lightgreen" value="Color( 0.56, 0.93, 0.56, 1 )"> + </constant> + <constant name="lightpink" value="Color( 1, 0.71, 0.76, 1 )"> + </constant> + <constant name="lightsalmon" value="Color( 1, 0.63, 0.48, 1 )"> + </constant> + <constant name="lightseagreen" value="Color( 0.13, 0.7, 0.67, 1 )"> + </constant> + <constant name="lightskyblue" value="Color( 0.53, 0.81, 0.98, 1 )"> + </constant> + <constant name="lightslategray" value="Color( 0.47, 0.53, 0.6, 1 )"> + </constant> + <constant name="lightsteelblue" value="Color( 0.69, 0.77, 0.87, 1 )"> + </constant> + <constant name="lightyellow" value="Color( 1, 1, 0.88, 1 )"> + </constant> + <constant name="lime" value="Color( 0, 1, 0, 1 )"> + </constant> + <constant name="limegreen" value="Color( 0.2, 0.8, 0.2, 1 )"> + </constant> + <constant name="linen" value="Color( 0.98, 0.94, 0.9, 1 )"> + </constant> + <constant name="magenta" value="Color( 1, 0, 1, 1 )"> + </constant> + <constant name="maroon" value="Color( 0.69, 0.19, 0.38, 1 )"> + </constant> + <constant name="mediumaquamarine" value="Color( 0.4, 0.8, 0.67, 1 )"> + </constant> + <constant name="mediumblue" value="Color( 0, 0, 0.8, 1 )"> + </constant> + <constant name="mediumorchid" value="Color( 0.73, 0.33, 0.83, 1 )"> + </constant> + <constant name="mediumpurple" value="Color( 0.58, 0.44, 0.86, 1 )"> + </constant> + <constant name="mediumseagreen" value="Color( 0.24, 0.7, 0.44, 1 )"> + </constant> + <constant name="mediumslateblue" value="Color( 0.48, 0.41, 0.93, 1 )"> + </constant> + <constant name="mediumspringgreen" value="Color( 0, 0.98, 0.6, 1 )"> + </constant> + <constant name="mediumturquoise" value="Color( 0.28, 0.82, 0.8, 1 )"> + </constant> + <constant name="mediumvioletred" value="Color( 0.78, 0.08, 0.52, 1 )"> + </constant> + <constant name="midnightblue" value="Color( 0.1, 0.1, 0.44, 1 )"> + </constant> + <constant name="mintcream" value="Color( 0.96, 1, 0.98, 1 )"> + </constant> + <constant name="mistyrose" value="Color( 1, 0.89, 0.88, 1 )"> + </constant> + <constant name="moccasin" value="Color( 1, 0.89, 0.71, 1 )"> + </constant> + <constant name="navajowhite" value="Color( 1, 0.87, 0.68, 1 )"> + </constant> + <constant name="navyblue" value="Color( 0, 0, 0.5, 1 )"> + </constant> + <constant name="oldlace" value="Color( 0.99, 0.96, 0.9, 1 )"> + </constant> + <constant name="olive" value="Color( 0.5, 0.5, 0, 1 )"> + </constant> + <constant name="olivedrab" value="Color( 0.42, 0.56, 0.14, 1 )"> + </constant> + <constant name="orange" value="Color( 1, 0.65, 0, 1 )"> + </constant> + <constant name="orangered" value="Color( 1, 0.27, 0, 1 )"> + </constant> + <constant name="orchid" value="Color( 0.85, 0.44, 0.84, 1 )"> + </constant> + <constant name="palegoldenrod" value="Color( 0.93, 0.91, 0.67, 1 )"> + </constant> + <constant name="palegreen" value="Color( 0.6, 0.98, 0.6, 1 )"> + </constant> + <constant name="paleturquoise" value="Color( 0.69, 0.93, 0.93, 1 )"> + </constant> + <constant name="palevioletred" value="Color( 0.86, 0.44, 0.58, 1 )"> + </constant> + <constant name="papayawhip" value="Color( 1, 0.94, 0.84, 1 )"> + </constant> + <constant name="peachpuff" value="Color( 1, 0.85, 0.73, 1 )"> + </constant> + <constant name="peru" value="Color( 0.8, 0.52, 0.25, 1 )"> + </constant> + <constant name="pink" value="Color( 1, 0.75, 0.8, 1 )"> + </constant> + <constant name="plum" value="Color( 0.87, 0.63, 0.87, 1 )"> + </constant> + <constant name="powderblue" value="Color( 0.69, 0.88, 0.9, 1 )"> + </constant> + <constant name="purple" value="Color( 0.63, 0.13, 0.94, 1 )"> + </constant> + <constant name="rebeccapurple" value="Color( 0.4, 0.2, 0.6, 1 )"> + </constant> + <constant name="red" value="Color( 1, 0, 0, 1 )"> + </constant> + <constant name="rosybrown" value="Color( 0.74, 0.56, 0.56, 1 )"> + </constant> + <constant name="royalblue" value="Color( 0.25, 0.41, 0.88, 1 )"> + </constant> + <constant name="saddlebrown" value="Color( 0.55, 0.27, 0.07, 1 )"> + </constant> + <constant name="salmon" value="Color( 0.98, 0.5, 0.45, 1 )"> + </constant> + <constant name="sandybrown" value="Color( 0.96, 0.64, 0.38, 1 )"> + </constant> + <constant name="seagreen" value="Color( 0.18, 0.55, 0.34, 1 )"> + </constant> + <constant name="seashell" value="Color( 1, 0.96, 0.93, 1 )"> + </constant> + <constant name="sienna" value="Color( 0.63, 0.32, 0.18, 1 )"> + </constant> + <constant name="silver" value="Color( 0.75, 0.75, 0.75, 1 )"> + </constant> + <constant name="skyblue" value="Color( 0.53, 0.81, 0.92, 1 )"> + </constant> + <constant name="slateblue" value="Color( 0.42, 0.35, 0.8, 1 )"> + </constant> + <constant name="slategray" value="Color( 0.44, 0.5, 0.56, 1 )"> + </constant> + <constant name="snow" value="Color( 1, 0.98, 0.98, 1 )"> + </constant> + <constant name="springgreen" value="Color( 0, 1, 0.5, 1 )"> + </constant> + <constant name="steelblue" value="Color( 0.27, 0.51, 0.71, 1 )"> + </constant> + <constant name="tan" value="Color( 0.82, 0.71, 0.55, 1 )"> + </constant> + <constant name="teal" value="Color( 0, 0.5, 0.5, 1 )"> + </constant> + <constant name="thistle" value="Color( 0.85, 0.75, 0.85, 1 )"> + </constant> + <constant name="tomato" value="Color( 1, 0.39, 0.28, 1 )"> + </constant> + <constant name="turquoise" value="Color( 0.25, 0.88, 0.82, 1 )"> + </constant> + <constant name="violet" value="Color( 0.93, 0.51, 0.93, 1 )"> + </constant> + <constant name="webgray" value="Color( 0.5, 0.5, 0.5, 1 )"> + </constant> + <constant name="webgreen" value="Color( 0, 0.5, 0, 1 )"> + </constant> + <constant name="webmaroon" value="Color( 0.5, 0, 0, 1 )"> + </constant> + <constant name="webpurple" value="Color( 0.5, 0, 0.5, 1 )"> + </constant> + <constant name="wheat" value="Color( 0.96, 0.87, 0.7, 1 )"> + </constant> + <constant name="white" value="Color( 1, 1, 1, 1 )"> + </constant> + <constant name="whitesmoke" value="Color( 0.96, 0.96, 0.96, 1 )"> + </constant> + <constant name="yellow" value="Color( 1, 1, 0, 1 )"> + </constant> + <constant name="yellowgreen" value="Color( 0.6, 0.8, 0.2, 1 )"> + </constant> </constants> </class> diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index a2b6e1ae04..4d52eacba8 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ColorPicker" inherits="BoxContainer" category="Core" version="3.1-dev"> +<class name="ColorPicker" inherits="BoxContainer" category="Core" version="3.1"> <brief_description> Color picker control. </brief_description> <description> - This is a simple color picker [Control]. It's useful for selecting a color from an RGB/RGBA colorspace. + [Control] node displaying a color picker widget. It's useful for selecting a color from an RGB/RGBA colorspace. </description> <tutorials> </tutorials> @@ -17,7 +17,7 @@ <argument index="0" name="color" type="Color"> </argument> <description> - 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. + Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for [i]this[/i] color picker. </description> </method> </methods> @@ -25,11 +25,14 @@ <member name="color" type="Color" setter="set_pick_color" getter="get_pick_color"> The currently selected color. </member> + <member name="deferred_mode" type="bool" setter="set_deferred_mode" getter="is_deferred_mode"> + If [code]true[/code] the color will apply only after the user releases the mouse button, otherwise it will apply immediatly even in mouse motion event (which can cause performance issues). + </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). + 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). + 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> diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 227d979c64..6ac2911c11 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -1,28 +1,28 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ColorPickerButton" inherits="Button" category="Core" version="3.1-dev"> +<class name="ColorPickerButton" inherits="Button" category="Core" version="3.1"> <brief_description> - Button that pops out a [ColorPicker] + Button that pops out a [ColorPicker]. </brief_description> <description> - Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility + Encapsulates a [ColorPicker] making it accesible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility. </description> <tutorials> </tutorials> <demos> </demos> <methods> - <method name="get_picker" qualifiers="const"> + <method name="get_picker"> <return type="ColorPicker"> </return> <description> - Returns the [code]ColorPicker[/code] that this [code]ColorPickerButton[/code] toggles. + Returns the [ColorPicker] that this node toggles. </description> </method> - <method name="get_popup" qualifiers="const"> + <method name="get_popup"> <return type="PopupPanel"> </return> <description> - Returns the control's [PopupPanel] which allows you to connect to Popup Signals. This allows you to handle events when the ColorPicker is shown or hidden. + Returns the control's [PopupPanel] which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. </description> </method> </methods> @@ -42,6 +42,10 @@ Emitted when the color changes. </description> </signal> + <signal name="popup_closed"> + <description> + </description> + </signal> </signals> <constants> </constants> diff --git a/doc/classes/ColorRect.xml b/doc/classes/ColorRect.xml index 468d9b0687..e1bffb719e 100644 --- a/doc/classes/ColorRect.xml +++ b/doc/classes/ColorRect.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ColorRect" inherits="Control" category="Core" version="3.1-dev"> +<class name="ColorRect" inherits="Control" category="Core" version="3.1"> <brief_description> - Colored rect for canvas. + Colored rectangle. </brief_description> <description> - An object that is represented on the canvas as a rect with color. [Color] is used to set or get color info for the rect. + Displays a colored rectangle. </description> <tutorials> </tutorials> @@ -14,9 +14,9 @@ </methods> <members> <member name="color" type="Color" setter="set_frame_color" getter="get_frame_color"> - The color to fill the [code]ColorRect[/code]. + The fill color. [codeblock] - $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect node's color to red + $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect's color to red. [/codeblock] </member> </members> diff --git a/doc/classes/ConcavePolygonShape.xml b/doc/classes/ConcavePolygonShape.xml index b838e21318..f4958d88d0 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.1-dev"> +<class name="ConcavePolygonShape" inherits="Shape" category="Core" version="3.1"> <brief_description> Concave polygon shape. </brief_description> diff --git a/doc/classes/ConcavePolygonShape2D.xml b/doc/classes/ConcavePolygonShape2D.xml index 30dc887f3f..a653872353 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.1-dev"> +<class name="ConcavePolygonShape2D" inherits="Shape2D" category="Core" version="3.1"> <brief_description> Concave polygon 2D shape resource for physics. </brief_description> diff --git a/doc/classes/ConeTwistJoint.xml b/doc/classes/ConeTwistJoint.xml index 93901dc3c4..d6b2f191a4 100644 --- a/doc/classes/ConeTwistJoint.xml +++ b/doc/classes/ConeTwistJoint.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConeTwistJoint" inherits="Joint" category="Core" version="3.1-dev"> +<class name="ConeTwistJoint" inherits="Joint" category="Core" version="3.1"> <brief_description> - A twist joint between two 3D bodies + A twist joint between two 3D bodies. </brief_description> <description> The joint can rotate the bodies across an axis defined by the local x-axes of the [Joint]. diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index b46e96c2a0..ec0381bda5 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.1-dev"> +<class name="ConfigFile" inherits="Reference" category="Core" version="3.1"> <brief_description> Helper class to handle INI-style files. </brief_description> @@ -117,7 +117,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Assigns a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a [code]null[/code] value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. + Assigns a value to the specified key of the specified section. If the section and/or the key do not exist, they are created. Passing a [code]null[/code] value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. </description> </method> </methods> diff --git a/doc/classes/ConfirmationDialog.xml b/doc/classes/ConfirmationDialog.xml index 1641b5df6f..461f48420a 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.1-dev"> +<class name="ConfirmationDialog" inherits="AcceptDialog" category="Core" version="3.1"> <brief_description> Dialog for confirmation of actions. </brief_description> diff --git a/doc/classes/Container.xml b/doc/classes/Container.xml index b6afaa6bac..db365db233 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.1-dev"> +<class name="Container" inherits="Control" category="Core" version="3.1"> <brief_description> Base node for containers. </brief_description> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 46b2642b89..4301102e4a 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Control" inherits="CanvasItem" category="Core" version="3.1-dev"> +<class name="Control" inherits="CanvasItem" category="Core" version="3.1"> <brief_description> - All User Interface nodes inherit from Control. Features anchors and margins to adapt its position and size to its parent. + All User Interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent. </brief_description> <description> Base class for all User Interface or [i]UI[/i] related nodes. [code]Control[/code] features a bounding rectangle that defines its extents, an anchor position relative to its parent and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change. @@ -13,17 +13,23 @@ [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 + <link>http://docs.godotengine.org/en/3.0/tutorials/gui/index.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/2d/custom_drawing_in_2d.html</link> </tutorials> <demos> </demos> <methods> + <method name="_clips_input" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="_get_minimum_size" qualifiers="virtual"> <return type="Vector2"> </return> <description> - Returns the minimum size this Control can shrink to. The node can never be smaller than this minimum size. + Returns the minimum size for this control. See [member rect_min_size]. </description> </method> <method name="_gui_input" qualifiers="virtual"> @@ -36,6 +42,14 @@ Replaces Godot 2's [code]_input_event[/code]. </description> </method> + <method name="_make_custom_tooltip" qualifiers="virtual"> + <return type="Object"> + </return> + <argument index="0" name="for_text" type="String"> + </argument> + <description> + </description> + </method> <method name="accept_event"> <return type="void"> </return> @@ -51,7 +65,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Overrides the color in the [theme] resource the node uses. + Overrides the color in the [member theme] resource the node uses. </description> </method> <method name="add_constant_override"> @@ -62,7 +76,7 @@ <argument index="1" name="constant" type="int"> </argument> <description> - Overrides an integer constant in the [Theme] resource the node uses. If the [code]constant[/code] is invalid, Godot clears the override. See [member Theme.INVALID_CONSTANT] for more information. + Overrides an integer constant in the [member theme] resource the node uses. If the [code]constant[/code] is invalid, Godot clears the override. See [member Theme.INVALID_CONSTANT] for more information. </description> </method> <method name="add_font_override"> @@ -73,7 +87,7 @@ <argument index="1" name="font" type="Font"> </argument> <description> - Overrides the [code]name[/code] font in the [theme] resource the node uses. If [code]font[/code] is empty, Godot clears the override. + Overrides the [code]name[/code] font in the [member theme] resource the node uses. If [code]font[/code] is empty, Godot clears the override. </description> </method> <method name="add_icon_override"> @@ -84,7 +98,7 @@ <argument index="1" name="texture" type="Texture"> </argument> <description> - Overrides the [code]name[/code] icon in the [theme] resource the node uses. If [code]icon[/code] is empty, Godot clears the override. + Overrides the [code]name[/code] icon in the [member theme] resource the node uses. If [code]icon[/code] is empty, Godot clears the override. </description> </method> <method name="add_shader_override"> @@ -95,7 +109,7 @@ <argument index="1" name="shader" type="Shader"> </argument> <description> - Overrides the [code]name[/code] shader in the [theme] resource the node uses. If [code]shader[/code] is empty, Godot clears the override. + Overrides the [code]name[/code] shader in the [member theme] resource the node uses. If [code]shader[/code] is empty, Godot clears the override. </description> </method> <method name="add_stylebox_override"> @@ -106,7 +120,7 @@ <argument index="1" name="stylebox" type="StyleBox"> </argument> <description> - Overrides the [code]name[/code] [Stylebox] in the [theme] resource the node uses. If [code]stylebox[/code] is empty, Godot clears the override. + Overrides the [code]name[/code] [Stylebox] in the [member theme] resource the node uses. If [code]stylebox[/code] is empty, Godot clears the override. </description> </method> <method name="can_drop_data" qualifiers="virtual"> @@ -117,6 +131,16 @@ <argument index="1" name="data" type="Variant"> </argument> <description> + Godot calls this method to test if [code]data[/code] from a control's [method get_drag_data] can be dropped at [code]position[/code]. [code]position[/code] is local to this control. + This method should only be used to test the data. Process the data in [method drop_data]. + [codeblock] + extends Control + + func can_drop_data(position, data): + # check position if it is relevant to you + # otherwise just check data + return typeof(data) == TYPE_DICTIONARY and data.has('expected') + [/codeblock] </description> </method> <method name="drop_data" qualifiers="virtual"> @@ -127,6 +151,16 @@ <argument index="1" name="data" type="Variant"> </argument> <description> + Godot calls this method to pass you the [code]data[/code] from a control's [method get_drag_data] result. Godot first calls [method can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control. + [codeblock] + extends ColorRect + + func can_drop_data(position, data): + return typeof(data) == TYPE_DICTIONARY and data.has('color') + + func drop_data(position, data): + color = data['color'] + [/codeblock] </description> </method> <method name="force_drag"> @@ -137,12 +171,15 @@ <argument index="1" name="preview" type="Control"> </argument> <description> + Forces drag and bypasses [method get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control. + The methods [method can_drop_data] and [method drop_data] must be implemented on controls that want to receive drop data. </description> </method> <method name="get_begin" qualifiers="const"> <return type="Vector2"> </return> <description> + Returns [member margin_left] and [member margin_top]. See also [member rect_position]. </description> </method> <method name="get_color" qualifiers="const"> @@ -177,7 +214,7 @@ <argument index="0" name="position" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Returns the mouse cursor shape the control displays on mouse hover, one of the [code]CURSOR_*[/code] constants. + Returns the mouse cursor shape the control displays on mouse hover. See [enum CursorShape]. </description> </method> <method name="get_drag_data" qualifiers="virtual"> @@ -186,20 +223,30 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> + Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Return null if there is no data to drag. Controls that want to receive drop data should implement [method can_drop_data] and [method drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. + A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. + [codeblock] + extends Control + + func get_drag_data(position): + var mydata = make_data() + set_drag_preview(make_preview(mydata)) + return mydata + [/codeblock] </description> </method> <method name="get_end" qualifiers="const"> <return type="Vector2"> </return> <description> - Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). + Returns [member margin_right] and [member margin_bottom]. </description> </method> <method name="get_focus_owner" qualifiers="const"> <return type="Control"> </return> <description> - Return which control is owning the keyboard focus, or null if no one. + Returns the control that has the keyboard focus or [code]null[/code] if none. </description> </method> <method name="get_font" qualifiers="const"> @@ -216,7 +263,7 @@ <return type="Rect2"> </return> <description> - Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_position], [method get_size]). + Returns the position and size of the control relative to the top-left corner of the screen. See [member rect_position] and [member rect_size]. </description> </method> <method name="get_icon" qualifiers="const"> @@ -233,33 +280,35 @@ <return type="Vector2"> </return> <description> - Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. + Returns the minimum size for this control. See [member rect_min_size]. </description> </method> <method name="get_parent_area_size" qualifiers="const"> <return type="Vector2"> </return> <description> + Returns the width/height occupied in the parent control. </description> </method> <method name="get_parent_control" qualifiers="const"> <return type="Control"> </return> <description> + Returns the parent control node. </description> </method> <method name="get_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [method get_position], [method get_size]). + Returns the position and size of the control relative to the top-left corner of the parent Control. See [member rect_position] and [member rect_size]. </description> </method> <method name="get_rotation" qualifiers="const"> <return type="float"> </return> <description> - Return the rotation (in radians) + Returns the rotation (in radians). </description> </method> <method name="get_stylebox" qualifiers="const"> @@ -278,7 +327,7 @@ <argument index="0" name="at_position" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Return the tooltip, which will appear when the cursor is resting over this control. + Returns the tooltip, which will appear when the cursor is resting over this control. </description> </method> <method name="grab_click_focus"> @@ -334,7 +383,7 @@ <return type="bool"> </return> <description> - Return whether the Control is the current focused control (see [method set_focus_mode]). + Returns [code]true[/code] if this is the current focused control. See [member focus_mode]. </description> </method> <method name="has_font" qualifiers="const"> @@ -417,7 +466,7 @@ <return type="void"> </return> <description> - Give up the focus, no other control will be able to receive keyboard input. + Give up the focus. No other control will be able to receive keyboard input. </description> </method> <method name="set_anchor"> @@ -476,7 +525,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). + Sets [member margin_left] and [member margin_top] at the same time. </description> </method> <method name="set_drag_forwarding"> @@ -485,6 +534,28 @@ <argument index="0" name="target" type="Control"> </argument> <description> + Forwards the handling of this control's drag and drop to [code]target[/code] control. + Forwarding can be implemented in the target control similar to the methods [method get_drag_data], [method can_drop_data], and [method drop_data] but with two differences: + 1. The function name must be suffixed with [b]_fw[/b] + 2. The function must take an extra argument that is the control doing the forwarding + [codeblock] + # ThisControl.gd + extends Control + func _ready(): + set_drag_forwarding(target_control) + + # TargetControl.gd + extends Control + func can_drop_data_fw(position, data, from_control): + return true + + func drop_data_fw(position, data, from_control): + my_handle_data(data) + + func get_drag_data_fw(position, from_control): + set_drag_preview(my_preview) + return my_data() + [/codeblock] </description> </method> <method name="set_drag_preview"> @@ -493,6 +564,7 @@ <argument index="0" name="control" type="Control"> </argument> <description> + Shows the given control at the mouse pointer. A good time to call this method is in [method get_drag_data]. </description> </method> <method name="set_end"> @@ -501,7 +573,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]). + Sets [member margin_right] and [member margin_bottom] at the same time. </description> </method> <method name="set_margins_preset"> @@ -522,7 +594,7 @@ <argument index="0" name="radians" type="float"> </argument> <description> - Set the rotation (in radians). + Sets the rotation (in radians). </description> </method> <method name="show_modal"> @@ -531,7 +603,7 @@ <argument index="0" name="exclusive" type="bool" default="false"> </argument> <description> - Display a Control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. + Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. </description> </method> <method name="warp_mouse"> @@ -598,6 +670,7 @@ </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. + [b]Note:[/b] On Linux, shapes may vary depending on the cursor theme of the system. </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 [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. @@ -689,22 +762,22 @@ </signals> <constants> <constant name="FOCUS_NONE" value="0" enum="FocusMode"> - The node cannot grab focus. Use with [member set_focus_mode]. + The node cannot grab focus. Use with [member focus_mode]. </constant> <constant name="FOCUS_CLICK" value="1" enum="FocusMode"> - The node can only grab focus on mouse clicks. Use with [member set_focus_mode]. + The node can only grab focus on mouse clicks. Use with [member focus_mode]. </constant> <constant name="FOCUS_ALL" value="2" enum="FocusMode"> - The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with [member set_focus_mode]. + The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with [member focus_mode]. </constant> <constant name="NOTIFICATION_RESIZED" value="40"> Sent when the node changes size. Use [member rect_size] to get the new size. </constant> <constant name="NOTIFICATION_MOUSE_ENTER" value="41"> - Sent when the mouse pointer enters the node's [code]Rect[/code] area. + Sent when the mouse pointer enters the node. </constant> <constant name="NOTIFICATION_MOUSE_EXIT" value="42"> - Sent when the mouse pointer exits the node's [code]Rect[/code] area. + Sent when the mouse pointer exits the node. </constant> <constant name="NOTIFICATION_FOCUS_ENTER" value="43"> Sent when the node grabs focus. @@ -713,11 +786,15 @@ Sent when the node loses focus. </constant> <constant name="NOTIFICATION_THEME_CHANGED" value="45"> - Sent when the node's [member theme] changes, right before Godot redraws the [code]Control[/code]. Happens when you call one of the [code]add_*_override[/code] + Sent when the node's [member theme] changes, right before Godot redraws the control. Happens when you call one of the [code]add_*_override[/code] </constant> <constant name="NOTIFICATION_MODAL_CLOSE" value="46"> Sent when an open modal dialog closes. See [member show_modal]. </constant> + <constant name="NOTIFICATION_SCROLL_BEGIN" value="47"> + </constant> + <constant name="NOTIFICATION_SCROLL_END" value="48"> + </constant> <constant name="CURSOR_ARROW" value="0" enum="CursorShape"> Show the system's arrow mouse cursor when the user hovers the node. Use with [method set_default_cursor_shape]. </constant> @@ -835,7 +912,7 @@ Sets the node's size flags to both fill and expand. See the 2 constants above for more information. </constant> <constant name="SIZE_SHRINK_CENTER" value="4" enum="SizeFlags"> - Tells the parent [Container] to center the node in itself. It centers the [code]Control[/code] based on its bounding box, so it doesn't work with the fill or expand size flags. Use with [member size_flags_horizontal] and [member size_flags_vertical]. + Tells the parent [Container] to center the node in itself. It centers the control based on its bounding box, so 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="SIZE_SHRINK_END" value="8" enum="SizeFlags"> 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]. @@ -853,6 +930,8 @@ </constant> <constant name="GROW_DIRECTION_END" value="1" enum="GrowDirection"> </constant> + <constant name="GROW_DIRECTION_BOTH" value="2" enum="GrowDirection"> + </constant> <constant name="ANCHOR_BEGIN" value="0" enum="Anchor"> Snaps one of the 4 anchor's sides to the origin of the node's [code]Rect[/code], in the top left. Use it with one of the [code]anchor_*[/code] member variables, like [member anchor_left]. To change all 4 anchors at once, use [method set_anchors_preset]. </constant> diff --git a/doc/classes/ConvexPolygonShape.xml b/doc/classes/ConvexPolygonShape.xml index ac25fb8cb6..757b053ffe 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.1-dev"> +<class name="ConvexPolygonShape" inherits="Shape" category="Core" version="3.1"> <brief_description> Convex polygon shape for 3D physics. </brief_description> diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml index 3da9d28a8f..6b31149c2f 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.1-dev"> +<class name="ConvexPolygonShape2D" inherits="Shape2D" category="Core" version="3.1"> <brief_description> Convex Polygon Shape for 2D physics. </brief_description> diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml index edc4a165fc..ac5359738e 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.1-dev"> +<class name="CubeMap" inherits="Resource" category="Core" version="3.1"> <brief_description> A CubeMap is a 6 sided 3D texture. </brief_description> diff --git a/doc/classes/CubeMesh.xml b/doc/classes/CubeMesh.xml index e26e73e861..cef412bbde 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.1-dev"> +<class name="CubeMesh" inherits="PrimitiveMesh" category="Core" version="3.1"> <brief_description> Generate an axis-aligned cuboid [PrimitiveMesh]. </brief_description> diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index a430041571..c7f2f7bb8d 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.1-dev"> +<class name="Curve" inherits="Resource" category="Core" version="3.1"> <brief_description> A mathematic curve. </brief_description> diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index c53f07d406..26de8be42c 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.1-dev"> +<class name="Curve2D" inherits="Resource" category="Core" version="3.1"> <brief_description> Describes a Bezier curve in 2D space. </brief_description> @@ -49,6 +49,26 @@ Returns the cache of points as a [PoolVector2Array]. </description> </method> + <method name="get_closest_offset" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="to_point" type="Vector2"> + </argument> + <description> + Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked]. + [code]to_point[/code] must be in this curve's local space. + </description> + </method> + <method name="get_closest_point" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="to_point" type="Vector2"> + </argument> + <description> + Returns the closest point (in curve's local space) to [code]to_point[/code]. + [code]to_point[/code] must be in this curve's local space. + </description> + </method> <method name="get_point_count" qualifiers="const"> <return type="int"> </return> diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 1afa315465..1355c74faf 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.1-dev"> +<class name="Curve3D" inherits="Resource" category="Core" version="3.1"> <brief_description> Describes a Bezier curve in 3D space. </brief_description> @@ -56,6 +56,34 @@ Returns the cache of tilts as a [RealArray]. </description> </method> + <method name="get_baked_up_vectors" qualifiers="const"> + <return type="PoolVector3Array"> + </return> + <description> + Returns the cache of up vectors as a [PoolVector3Array]. + If [member up_vector_enabled] is [code]false[/code], the cache will be empty. + </description> + </method> + <method name="get_closest_offset" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="to_point" type="Vector3"> + </argument> + <description> + Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in one of the interpolate_baked* methods. + [code]to_point[/code] must be in this curve's local space. + </description> + </method> + <method name="get_closest_point" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="to_point" type="Vector3"> + </argument> + <description> + Returns the closest point (in curve's local space) to [code]to_point[/code]. + [code]to_point[/code] must be in this curve's local space. + </description> + </method> <method name="get_point_count" qualifiers="const"> <return type="int"> </return> @@ -124,6 +152,19 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). </description> </method> + <method name="interpolate_baked_up_vector" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <argument index="1" name="apply_tilt" type="bool" default="false"> + </argument> + <description> + Returns an up vector within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve. + To do that, it finds the two cached up vectors where the [code]offset[/code] lies between, then interpolates the values. If [code]apply_tilt[/code] is [code]true[/code], an interpolated tilt is applied to the interpolated up vector. + If the curve has no up vectors, the function sends an error to the console, and returns (0, 1, 0). + </description> + </method> <method name="interpolatef" qualifiers="const"> <return type="Vector3"> </return> @@ -184,7 +225,7 @@ </argument> <description> Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console. - The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow], this tilt is an offset over the natural tilt the PathFollow calculates. + The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow] or [OrientedPathFollow], this tilt is an offset over the natural tilt the [PathFollow] or [OrientedPathFollow] calculates. </description> </method> <method name="tessellate" qualifiers="const"> @@ -206,6 +247,9 @@ <member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval"> The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. </member> + <member name="up_vector_enabled" type="bool" setter="set_up_vector_enabled" getter="is_up_vector_enabled"> + If [code]true[/code], the curve will bake up vectors used for orientation. See [OrientedPathFollow]. Changing it forces the cache to be recomputed. + </member> </members> <constants> </constants> diff --git a/doc/classes/CurveTexture.xml b/doc/classes/CurveTexture.xml index 67a21957ee..10e8a61f99 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.1-dev"> +<class name="CurveTexture" inherits="Texture" category="Core" version="3.1"> <brief_description> A texture that shows a curve. </brief_description> diff --git a/doc/classes/CylinderMesh.xml b/doc/classes/CylinderMesh.xml index 997180a17c..623830371a 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.1-dev"> +<class name="CylinderMesh" inherits="PrimitiveMesh" category="Core" version="3.1"> <brief_description> Class representing a cylindrical [PrimitiveMesh]. </brief_description> diff --git a/doc/classes/CylinderShape.xml b/doc/classes/CylinderShape.xml new file mode 100644 index 0000000000..a63cc8831e --- /dev/null +++ b/doc/classes/CylinderShape.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CylinderShape" inherits="Shape" category="Core" version="3.1"> + <brief_description> + Cylinder shape for collisions. + </brief_description> + <description> + Cylinder shape for collisions. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="height" type="float" setter="set_height" getter="get_height"> + The cylinder's height. + </member> + <member name="radius" type="float" setter="set_radius" getter="get_radius"> + The cylinder's radius. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/DampedSpringJoint2D.xml b/doc/classes/DampedSpringJoint2D.xml index 55c6914c01..12e29cec32 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.1-dev"> +<class name="DampedSpringJoint2D" inherits="Joint2D" category="Core" version="3.1"> <brief_description> Damped spring constraint for 2D physics. </brief_description> diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index c63e440a57..800a76ccf1 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.1-dev"> +<class name="Dictionary" category="Built-In Types" version="3.1"> <brief_description> Dictionary type. </brief_description> @@ -19,7 +19,10 @@ <method name="duplicate"> <return type="Dictionary"> </return> + <argument index="0" name="deep" type="bool" default="False"> + </argument> <description> + Creates a copy of the dictionary, and returns it. </description> </method> <method name="empty"> @@ -30,6 +33,8 @@ </description> </method> <method name="erase"> + <return type="bool"> + </return> <argument index="0" name="key" type="var"> </argument> <description> diff --git a/doc/classes/DirectionalLight.xml b/doc/classes/DirectionalLight.xml index d777018ec9..2dc522083d 100644 --- a/doc/classes/DirectionalLight.xml +++ b/doc/classes/DirectionalLight.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="DirectionalLight" inherits="Light" category="Core" version="3.1-dev"> +<class name="DirectionalLight" inherits="Light" category="Core" version="3.1"> <brief_description> - Directional Light, such as the Sun or the Moon. + Directional light from a distance, as from the Sun. </brief_description> <description> - 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. + A directional light is a type of [Light] node that models an infinite number of parallel rays covering the entire scene. It is used for 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html</link> </tutorials> <demos> </demos> @@ -15,34 +15,48 @@ </methods> <members> <member name="directional_shadow_bias_split_scale" type="float" setter="set_param" getter="get_param"> + Amount of extra bias for shadow splits that are far away. If self shadowing occurs only on the splits far away, this value can fix them. </member> <member name="directional_shadow_blend_splits" type="bool" setter="set_blend_splits" getter="is_blend_splits_enabled"> + If [code]true[/code] shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:[code]false[/code]. </member> <member name="directional_shadow_depth_range" type="int" setter="set_shadow_depth_range" getter="get_shadow_depth_range" enum="DirectionalLight.ShadowDepthRange"> + Optimizes shadow rendering for detail versus movement. See [enum ShadowDepthRange]. </member> <member name="directional_shadow_max_distance" type="float" setter="set_param" getter="get_param"> + The maximum distance for shadow splits. </member> <member name="directional_shadow_mode" type="int" setter="set_shadow_mode" getter="get_shadow_mode" enum="DirectionalLight.ShadowMode"> + The light's shadow rendering algorithm. See [enum ShadowMode]. </member> <member name="directional_shadow_normal_bias" type="float" setter="set_param" getter="get_param"> + Can be used to fix special cases of self shadowing when objects are perpendicular to the light. </member> <member name="directional_shadow_split_1" type="float" setter="set_param" getter="get_param"> + The distance from camera to shadow split 1. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_*_SPLITS. </member> <member name="directional_shadow_split_2" type="float" setter="set_param" getter="get_param"> + The distance from shadow split 1 to split 2. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_*_SPLITS. </member> <member name="directional_shadow_split_3" type="float" setter="set_param" getter="get_param"> + The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_4_SPLITS. </member> </members> <constants> <constant name="SHADOW_ORTHOGONAL" value="0" enum="ShadowMode"> + Renders the entire scene's shadow map from an orthogonal point of view. May result in blockier shadows on close objects. </constant> <constant name="SHADOW_PARALLEL_2_SPLITS" value="1" enum="ShadowMode"> + Splits the view frustum in 2 areas, each with its own shadow map. </constant> <constant name="SHADOW_PARALLEL_4_SPLITS" value="2" enum="ShadowMode"> + Splits the view frustum in 4 areas, each with its own shadow map. </constant> <constant name="SHADOW_DEPTH_RANGE_STABLE" value="0" enum="ShadowDepthRange"> + Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Default value. </constant> <constant name="SHADOW_DEPTH_RANGE_OPTIMIZED" value="1" enum="ShadowDepthRange"> + Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges. </constant> </constants> </class> diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index 01590344cf..d8ad208fa7 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.1-dev"> +<class name="Directory" inherits="Reference" category="Core" version="3.1"> <brief_description> Type used to handle the filesystem. </brief_description> @@ -23,7 +23,7 @@ [/codeblock] </description> <tutorials> - http://docs.godotengine.org/en/3.0/getting_started/step_by_step/filesystem.html + <link>http://docs.godotengine.org/en/3.0/getting_started/step_by_step/filesystem.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index a56a08e7f6..2e2904c16c 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.1-dev"> +<class name="DynamicFont" inherits="Font" category="Core" version="3.1"> <brief_description> DynamicFont renders vector font files at runtime. </brief_description> @@ -73,6 +73,10 @@ <member name="font_data" type="DynamicFontData" setter="set_font_data" getter="get_font_data"> The font data. </member> + <member name="outline_color" type="Color" setter="set_outline_color" getter="get_outline_color"> + </member> + <member name="outline_size" type="int" setter="set_outline_size" getter="get_outline_size"> + </member> <member name="size" type="int" setter="set_size" getter="get_size"> The font size. </member> diff --git a/doc/classes/DynamicFontData.xml b/doc/classes/DynamicFontData.xml index 6113b0616b..7b34d02316 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.1-dev"> +<class name="DynamicFontData" inherits="Resource" category="Core" version="3.1"> <brief_description> Used with [DynamicFont] to describe the location of a font file. </brief_description> @@ -16,7 +16,19 @@ <member name="font_path" type="String" setter="set_font_path" getter="get_font_path"> The path to the vector font file. </member> + <member name="hinting" type="int" setter="set_hinting" getter="get_hinting" enum="DynamicFontData.Hinting"> + The font hinting mode used by FreeType. + </member> </members> <constants> + <constant name="HINTING_NONE" value="0" enum="Hinting"> + Disable font hinting (smoother but less crisp). + </constant> + <constant name="HINTING_LIGHT" value="1" enum="Hinting"> + Use the light font hinting mode. + </constant> + <constant name="HINTING_NORMAL" value="2" enum="Hinting"> + Use the default font hinting mode (crisper but less smooth). + </constant> </constants> </class> diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index 68999c2ae4..a6b72d08ff 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.1-dev"> +<class name="EditorExportPlugin" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index da1dbb9327..fed9e264db 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.1-dev"> +<class name="EditorFileDialog" inherits="ConfirmationDialog" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index f5a3bf7eca..ade6d2034d 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.1-dev"> +<class name="EditorFileSystem" inherits="Node" category="Core" version="3.1"> <brief_description> Resource filesystem, as the editor sees it. </brief_description> @@ -73,6 +73,12 @@ Update a file information. Call this if an external program (not Godot) modified the file. </description> </method> + <method name="update_script_classes"> + <return type="void"> + </return> + <description> + </description> + </method> </methods> <signals> <signal name="filesystem_changed"> @@ -87,6 +93,10 @@ Remitted if a resource is reimported. </description> </signal> + <signal name="script_classes_updated"> + <description> + </description> + </signal> <signal name="sources_changed"> <argument index="0" name="exist" type="bool"> </argument> diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index 295a4d094f..bb3ff91639 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.1-dev"> +<class name="EditorFileSystemDirectory" inherits="Object" category="Core" version="3.1"> <brief_description> A diretory for the resource filesystem. </brief_description> @@ -63,6 +63,22 @@ Returns the path to the file at index [code]idx[/code]. </description> </method> + <method name="get_file_script_class_extends" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_file_script_class_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> <method name="get_file_type" qualifiers="const"> <return type="String"> </return> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index fa22691a83..b21d402468 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -1,14 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorImportPlugin" inherits="Reference" category="Core" version="3.1-dev"> +<class name="EditorImportPlugin" inherits="Reference" category="Core" version="3.1"> <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> <description> EditorImportPlugins provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. Register your [EditorPlugin] with [method EditorPlugin.add_import_plugin]. - EditorImportPlugins work by associating with specific file extensions and a resource type. See [method get_recognized_extension] and [method get_resource_type]). They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the [code].import[/code] directory. - - Below is an example EditorImportPlugin that imports a [Mesh] from a file with the extension ".special" or ".spec": [codeblock] tool @@ -38,19 +35,20 @@ func get_import_options(i): return [{"name": "my_option", "default_value": false}] - func load(src, dst, opts, r_platform_variants, r_gen_files): + func import(source_file, save_path, options, r_platform_variants, r_gen_files): var file = File.new() - if file.open(src, File.READ) != OK: + if file.open(source_file, File.READ) != OK: return FAILED var mesh = Mesh.new() - var save = dst + "." + get_save_extension() - ResourceSaver.save(file, mesh) + var filename = save_path + "." + get_save_extension() + ResourceSaver.save(filename, mesh) return OK [/codeblock] </description> <tutorials> + <link>http://docs.godotengine.org/en/3.0/tutorials/plugins/editor/import_plugins.html</link> </tutorials> <demos> </demos> @@ -122,7 +120,7 @@ <return type="String"> </return> <description> - Get the godot resource type associated with this loader. e.g. "Mesh" or "Animation". + Get the Godot resource type associated with this loader. e.g. "Mesh" or "Animation". </description> </method> <method name="get_save_extension" qualifiers="virtual"> diff --git a/doc/classes/EditorInspector.xml b/doc/classes/EditorInspector.xml new file mode 100644 index 0000000000..a2a39fc8b6 --- /dev/null +++ b/doc/classes/EditorInspector.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorInspector" inherits="ScrollContainer" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="refresh"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <signals> + <signal name="object_id_selected"> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="property_edited"> + <argument index="0" name="property" type="String"> + </argument> + <description> + </description> + </signal> + <signal name="property_keyed"> + <argument index="0" name="property" type="String"> + </argument> + <description> + </description> + </signal> + <signal name="property_selected"> + <argument index="0" name="property" type="String"> + </argument> + <description> + </description> + </signal> + <signal name="resource_selected"> + <argument index="0" name="res" type="Object"> + </argument> + <argument index="1" name="prop" type="String"> + </argument> + <description> + </description> + </signal> + <signal name="restart_requested"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml new file mode 100644 index 0000000000..9bda768b14 --- /dev/null +++ b/doc/classes/EditorInspectorPlugin.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorInspectorPlugin" inherits="Reference" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_custom_control"> + <return type="void"> + </return> + <argument index="0" name="control" type="Control"> + </argument> + <description> + </description> + </method> + <method name="add_property_editor"> + <return type="void"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="editor" type="Control"> + </argument> + <description> + </description> + </method> + <method name="add_property_editor_for_multiple_properties"> + <return type="void"> + </return> + <argument index="0" name="label" type="String"> + </argument> + <argument index="1" name="properties" type="PoolStringArray"> + </argument> + <argument index="2" name="editor" type="Control"> + </argument> + <description> + </description> + </method> + <method name="can_handle" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <description> + </description> + </method> + <method name="parse_begin" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <description> + </description> + </method> + <method name="parse_category" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="category" type="String"> + </argument> + <description> + </description> + </method> + <method name="parse_end" qualifiers="virtual"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="parse_property" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <argument index="2" name="path" type="String"> + </argument> + <argument index="3" name="hint" type="int"> + </argument> + <argument index="4" name="hint_text" type="String"> + </argument> + <argument index="5" name="usage" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index 0731c332ad..19bd7e6d52 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorInterface" inherits="Node" category="Core" version="3.1-dev"> +<class name="EditorInterface" inherits="Node" category="Core" version="3.1"> <brief_description> Editor interface and main components. </brief_description> <description> - Editor interface. Allows saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects and provides access to [EditorSettings], [EditorFileSystem], [EditorResourcePreview]\ er, [ScriptEditor], the editor viewport, as well as information about scenes. Also see [EditorPlugin] and [EditorScript]. + Editor interface. Allows saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects and provides access to [EditorSettings], [EditorFileSystem], [EditorResourcePreview], [ScriptEditor], the editor viewport, as well as information about scenes. Also see [EditorPlugin] and [EditorScript]. </description> <tutorials> </tutorials> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index b7f7d74f54..62fc56e990 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.1-dev"> +<class name="EditorPlugin" inherits="Node" category="Core" version="3.1"> <brief_description> Used by the editor to extend its functionality. </brief_description> @@ -7,11 +7,22 @@ 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 + <link>http://docs.godotengine.org/en/3.0/development/plugins/index.html</link> </tutorials> <demos> </demos> <methods> + <method name="add_autoload_singleton"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="path" type="String"> + </argument> + <description> + Add a script at [code]path[/code] to the Autoload list as [code]name[/code]. + </description> + </method> <method name="add_control_to_bottom_panel"> <return type="ToolButton"> </return> @@ -70,7 +81,7 @@ <method name="add_export_plugin"> <return type="void"> </return> - <argument index="0" name="exporter" type="EditorExportPlugin"> + <argument index="0" name="plugin" type="EditorExportPlugin"> </argument> <description> </description> @@ -83,6 +94,14 @@ <description> </description> </method> + <method name="add_inspector_plugin"> + <return type="void"> + </return> + <argument index="0" name="plugin" type="EditorInspectorPlugin"> + </argument> + <description> + </description> + </method> <method name="add_scene_import_plugin"> <return type="void"> </return> @@ -91,6 +110,21 @@ <description> </description> </method> + <method name="add_tool_menu_item"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="handler" type="Object"> + </argument> + <argument index="2" name="callback" type="String"> + </argument> + <argument index="3" name="ud" type="Variant" default="null"> + </argument> + <description> + Adds a custom menu to 'Project > Tools' as [code]name[/code] that calls [code]callback[/code] on an instance of [code]handler[/code] with a parameter [code]ud[/code] when user activates it. + </description> + </method> <method name="add_tool_submenu_item"> <return type="void"> </return> @@ -109,20 +143,17 @@ This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. </description> </method> - <method name="clear" qualifiers="virtual"> - <return type="void"> + <method name="build" qualifiers="virtual"> + <return type="bool"> </return> <description> - Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. </description> </method> - <method name="create_spatial_gizmo" qualifiers="virtual"> - <return type="EditorSpatialGizmo"> + <method name="clear" qualifiers="virtual"> + <return type="void"> </return> - <argument index="0" name="for_spatial" type="Spatial"> - </argument> <description> - This is used for plugins that create gizmos used by the spatial editor. Just check that the node passed in the "for_spatial" argument matches your plugin. + Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. </description> </method> <method name="edit" qualifiers="virtual"> @@ -195,6 +226,13 @@ <description> </description> </method> + <method name="get_script_create_dialog"> + <return type="ScriptCreateDialog"> + </return> + <description> + Gets the Editor's dialogue used for making scripts. Note that users can configure it before use. + </description> + </method> <method name="get_state" qualifiers="virtual"> <return type="Dictionary"> </return> @@ -265,6 +303,15 @@ Queue save the project's editor layout. </description> </method> + <method name="remove_autoload_singleton"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Remove an Autoload [code]name[/code] from the list. + </description> + </method> <method name="remove_control_from_bottom_panel"> <return type="void"> </return> @@ -306,7 +353,7 @@ <method name="remove_export_plugin"> <return type="void"> </return> - <argument index="0" name="exporter" type="EditorExportPlugin"> + <argument index="0" name="plugin" type="EditorExportPlugin"> </argument> <description> </description> @@ -319,6 +366,14 @@ <description> </description> </method> + <method name="remove_inspector_plugin"> + <return type="void"> + </return> + <argument index="0" name="plugin" type="EditorInspectorPlugin"> + </argument> + <description> + </description> + </method> <method name="remove_scene_import_plugin"> <return type="void"> </return> @@ -327,6 +382,15 @@ <description> </description> </method> + <method name="remove_tool_menu_item"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Removes a menu [code]name[/code] from 'Project > Tools'. + </description> + </method> <method name="save_external_data" qualifiers="virtual"> <return type="void"> </return> @@ -380,6 +444,12 @@ Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins. </description> </signal> + <signal name="resource_saved"> + <argument index="0" name="resource" type="Object"> + </argument> + <description> + </description> + </signal> <signal name="scene_changed"> <argument index="0" name="scene_root" type="Object"> </argument> diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml new file mode 100644 index 0000000000..32d3a2703d --- /dev/null +++ b/doc/classes/EditorProperty.xml @@ -0,0 +1,117 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorProperty" inherits="Container" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_edited_object"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_edited_property"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_tooltip_text" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="update_property" qualifiers="virtual"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="checkable" type="bool" setter="set_checkable" getter="is_checkable"> + </member> + <member name="checked" type="bool" setter="set_checked" getter="is_checked"> + </member> + <member name="draw_red" type="bool" setter="set_draw_red" getter="is_draw_red"> + </member> + <member name="keying" type="bool" setter="set_keying" getter="is_keying"> + </member> + <member name="label" type="String" setter="set_label" getter="get_label"> + </member> + <member name="read_only" type="bool" setter="set_read_only" getter="is_read_only"> + </member> + </members> + <signals> + <signal name="multiple_properties_changed"> + <argument index="0" name="properties" type="PoolStringArray"> + </argument> + <argument index="1" name="value" type="Array"> + </argument> + <description> + </description> + </signal> + <signal name="object_id_selected"> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="property_changed"> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="value" type="Nil"> + </argument> + <description> + </description> + </signal> + <signal name="property_checked"> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="bool" type="String"> + </argument> + <description> + </description> + </signal> + <signal name="property_keyed"> + <argument index="0" name="property" type="String"> + </argument> + <description> + </description> + </signal> + <signal name="property_keyed_with_value"> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="value" type="Nil"> + </argument> + <description> + </description> + </signal> + <signal name="resource_selected"> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="resource" type="Object"> + </argument> + <description> + </description> + </signal> + <signal name="selected"> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="focusable_idx" type="int"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorResourceConversionPlugin.xml b/doc/classes/EditorResourceConversionPlugin.xml index 240d82d5d2..ad0b7b0586 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.1-dev"> +<class name="EditorResourceConversionPlugin" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index 6ec7f8a088..3b3e8a8369 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.1-dev"> +<class name="EditorResourcePreview" inherits="Node" category="Core" version="3.1"> <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 80aa185bb6..fb9af47b1f 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.1-dev"> +<class name="EditorResourcePreviewGenerator" inherits="Reference" category="Core" version="3.1"> <brief_description> Custom generator of previews. </brief_description> diff --git a/doc/classes/EditorSceneImporter.xml b/doc/classes/EditorSceneImporter.xml index 340ea30ad0..6394dfdfe9 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.1-dev"> +<class name="EditorSceneImporter" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/EditorScenePostImport.xml b/doc/classes/EditorScenePostImport.xml index 8e7c79db84..09cae25403 100644 --- a/doc/classes/EditorScenePostImport.xml +++ b/doc/classes/EditorScenePostImport.xml @@ -1,20 +1,56 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorScenePostImport" inherits="Reference" category="Core" version="3.1-dev"> +<class name="EditorScenePostImport" inherits="Reference" category="Core" version="3.1"> <brief_description> + Post process scenes after import </brief_description> <description> + The imported scene can be automatically modified right after import by specifying a 'custom script' that inherits from this class. The [method post_import]-method receives the imported scene's root-node and returns the modified version of the scene </description> <tutorials> + <link>http://docs.godotengine.org/en/latest/learning/workflow/assets/importing_scenes.html?highlight=post%20import</link> </tutorials> <demos> + [codeblock] +tool # needed so it runs in editor +extends EditorScenePostImport + +# This sample changes all node names + +# get called right after the scene is imported and gets the root-node +func post_import(scene): + # change all node names to "modified_[oldnodename]" + iterate(scene) + return scene # remember to return the imported scene + +func iterate(node): + if node!=null: + node.name = "modified_"+node.name + for child in node.get_children(): + iterate(child) +[/codeblock] </demos> <methods> + <method name="get_source_file" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the source-file-path which got imported (e.g. [code]res://scene.dae[/code] ) + </description> + </method> + <method name="get_source_folder" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the resource-folder the imported scene-file is located in + </description> + </method> <method name="post_import" qualifiers="virtual"> - <return type="void"> + <return type="Object"> </return> <argument index="0" name="scene" type="Object"> </argument> <description> + Gets called after the scene got imported and has to return the modified version of the scene </description> </method> </methods> diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index fa7a74460f..1c22095b37 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.1-dev"> +<class name="EditorScript" inherits="Reference" category="Core" version="3.1"> <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 325fae0fe9..4edd8583a0 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.1-dev"> +<class name="EditorSelection" inherits="Object" category="Core" version="3.1"> <brief_description> Manages the SceneTree selection in the editor. </brief_description> diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index ef50c34792..bd85075b7e 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.1-dev"> +<class name="EditorSettings" inherits="Resource" category="Core" version="3.1"> <brief_description> Object that holds the project-independent editor settings. </brief_description> @@ -55,6 +55,18 @@ Get the list of favorite directories for this project. </description> </method> + <method name="get_project_metadata" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="section" type="String"> + </argument> + <argument index="1" name="key" type="String"> + </argument> + <argument index="2" name="default" type="Variant" default="null"> + </argument> + <description> + </description> + </method> <method name="get_project_settings_dir" qualifiers="const"> <return type="String"> </return> @@ -131,6 +143,18 @@ <description> </description> </method> + <method name="set_project_metadata"> + <return type="void"> + </return> + <argument index="0" name="section" type="String"> + </argument> + <argument index="1" name="key" type="String"> + </argument> + <argument index="2" name="data" type="Variant"> + </argument> + <description> + </description> + </method> <method name="set_recent_dirs"> <return type="void"> </return> diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index 3895f8a2e7..2081ae7a4d 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.1-dev"> +<class name="EditorSpatialGizmo" inherits="SpatialGizmo" category="Core" version="3.1"> <brief_description> Custom gizmo for editing Spatial objects. </brief_description> @@ -24,8 +24,6 @@ </return> <argument index="0" name="triangles" type="TriangleMesh"> </argument> - <argument index="1" name="bounds" type="AABB"> - </argument> <description> Add collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw]. </description> @@ -35,9 +33,11 @@ </return> <argument index="0" name="handles" type="PoolVector3Array"> </argument> - <argument index="1" name="billboard" type="bool" default="false"> + <argument index="1" name="material" type="Material"> </argument> - <argument index="2" name="secondary" type="bool" default="false"> + <argument index="2" name="billboard" type="bool" default="false"> + </argument> + <argument index="3" name="secondary" type="bool" default="false"> </argument> <description> Add a list of handles (points) which can be used to deform the object being edited. @@ -140,6 +140,14 @@ The [Camera] is also provided so screen coordinates can be converted to raycasts. </description> </method> + <method name="set_hidden"> + <return type="void"> + </return> + <argument index="0" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_spatial_node"> <return type="void"> </return> diff --git a/doc/classes/EncodedObjectAsID.xml b/doc/classes/EncodedObjectAsID.xml index 5b1b370fe0..8e6a117ea2 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.1-dev"> +<class name="EncodedObjectAsID" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index d4fb66540b..f921b76b21 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.1-dev"> +<class name="Engine" inherits="Object" category="Core" version="3.1"> <brief_description> Access to basic engine properties. </brief_description> @@ -11,6 +11,34 @@ <demos> </demos> <methods> + <method name="get_author_info" qualifiers="const"> + <return type="Dictionary"> + </return> + <description> + Returns engine author information in a Dictionary. + "lead_developers" - Array of Strings, lead developer names + "founders" - Array of Strings, founder names + "project_managers" - Array of Strings, project manager names + "developers" - Array of Strings, developer names + </description> + </method> + <method name="get_copyright_info" qualifiers="const"> + <return type="Array"> + </return> + <description> + Returns an Array of copyright information Dictionaries. + "name" - String, component name + "parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component + </description> + </method> + <method name="get_donor_info" qualifiers="const"> + <return type="Dictionary"> + </return> + <description> + Returns a Dictionary of Arrays of donor names. + {"platinum_sponsors", "gold_sponsors", "mini_sponsors", "gold_donors", "silver_donors", "bronze_donors"} + </description> + </method> <method name="get_frames_drawn"> <return type="int"> </return> @@ -25,6 +53,20 @@ Returns the frames per second of the running game. </description> </method> + <method name="get_license_info" qualifiers="const"> + <return type="Dictionary"> + </return> + <description> + Returns Dictionary of licenses used by Godot and included third party components. + </description> + </method> + <method name="get_license_text" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns Godot license text. + </description> + </method> <method name="get_main_loop" qualifiers="const"> <return type="MainLoop"> </return> @@ -45,10 +87,9 @@ </return> <description> Returns the current engine version information in a Dictionary. - - "major" - Holds the major version number as a String - "minor" - Holds the minor version number as a String - "patch" - Holds the patch version number as a String + "major" - Holds the major version number as an int + "minor" - Holds the minor version number as an int + "patch" - Holds the patch version number as an int "status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String "build" - Holds the build name (e.g. "custom-build") as a String "string" - major + minor + patch + status + build in a single String @@ -77,6 +118,8 @@ <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="physics_jitter_fix" type="float" setter="set_physics_jitter_fix" getter="get_physics_jitter_fix"> + </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> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index db87720e30..566322e6c5 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -1,19 +1,20 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Environment" inherits="Resource" category="Core" version="3.1-dev"> +<class name="Environment" inherits="Resource" category="Core" version="3.1"> <brief_description> Resource for environment nodes (like [WorldEnvironment]) that define multiple rendering options. </brief_description> <description> - Resource for environment nodes (like [WorldEnvironment]) that define multiple environment operations (such as background [Sky] or [Color], ambient light, fog, depth-of-field...). These parameters affect the final render of the scene. The order of these operations is: - - DOF Blur + Resource for environment nodes (like [WorldEnvironment]) that define multiple environment operations (such as background [Sky] or [Color], ambient light, fog, depth-of-field...). These parameters affect the final render of the scene. The order of these operations is: + + - DOF Blur - Motion Blur - Bloom - Tonemap (auto exposure) - 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/environment_and_post_processing.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/high_dynamic_range.html</link> </tutorials> <demos> </demos> @@ -202,6 +203,8 @@ </member> <member name="ss_reflections_roughness" type="bool" setter="set_ssr_rough" getter="is_ssr_rough"> </member> + <member name="ssao_ao_channel_affect" type="float" setter="set_ssao_ao_channel_affect" getter="get_ssao_ao_channel_affect"> + </member> <member name="ssao_bias" type="float" setter="set_ssao_bias" getter="get_ssao_bias"> </member> <member name="ssao_blur" type="int" setter="set_ssao_blur" getter="is_ssao_blur_enabled" enum="Environment.SSAOBlur"> diff --git a/doc/classes/Expression.xml b/doc/classes/Expression.xml new file mode 100644 index 0000000000..d5b831a61a --- /dev/null +++ b/doc/classes/Expression.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Expression" inherits="Reference" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="execute"> + <return type="Variant"> + </return> + <argument index="0" name="inputs" type="Array" default="[ ]"> + </argument> + <argument index="1" name="base_instance" type="Object" default="null"> + </argument> + <argument index="2" name="show_error" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="get_error_text" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="has_execute_failed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="parse"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="expression" type="String"> + </argument> + <argument index="1" name="input_names" type="PoolStringArray" default="PoolStringArray( )"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 4074c236eb..20054ac9dc 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.1-dev"> +<class name="File" inherits="Reference" category="Core" version="3.1"> <brief_description> Type to handle file reading and writing operations. </brief_description> @@ -9,20 +9,20 @@ [codeblock] func save(content): var file = File.new() - file.open("user://save_game.dat", file.WRITE) + file.open("user://save_game.dat", File.WRITE) file.store_string(content) file.close() func load(): var file = File.new() - file.open("user://save_game.dat", file.READ) + file.open("user://save_game.dat", File.READ) var content = file.get_as_text() file.close() return content [/codeblock] </description> <tutorials> - http://docs.godotengine.org/en/3.0/getting_started/step_by_step/filesystem.html + <link>http://docs.godotengine.org/en/3.0/getting_started/step_by_step/filesystem.html</link> </tutorials> <demos> </demos> @@ -163,6 +163,20 @@ Returns a [String] saved in Pascal format from the file. </description> </method> + <method name="get_path" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the path as a [String] for the current open file. + </description> + </method> + <method name="get_path_absolute" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the absolute path as a [String] for the current open file. + </description> + </method> <method name="get_position" qualifiers="const"> <return type="int"> </return> diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 50deecee72..247228d265 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.1-dev"> +<class name="FileDialog" inherits="ConfirmationDialog" category="Core" version="3.1"> <brief_description> Dialog for selecting files or directories in the filesystem. </brief_description> @@ -33,6 +33,12 @@ <description> </description> </method> + <method name="get_line_edit"> + <return type="LineEdit"> + </return> + <description> + </description> + </method> <method name="get_vbox"> <return type="VBoxContainer"> </return> diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index a6ab2e3a77..3e47b167ef 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.1-dev"> +<class name="Font" inherits="Resource" category="Core" version="3.1"> <brief_description> Internationalized font and text drawing support. </brief_description> @@ -24,6 +24,8 @@ </argument> <argument index="4" name="clip_w" type="int" default="-1"> </argument> + <argument index="5" name="outline_modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> <description> Draw "string" into a canvas item using the font at a given position, with "modulate" color, and optionally clipping the width. "position" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. </description> @@ -41,6 +43,8 @@ </argument> <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> + <argument index="5" name="outline" type="bool" default="false"> + </argument> <description> Draw character "char" into a canvas item using the font at a given position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "position" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. </description> @@ -75,6 +79,12 @@ Return the size of a string, taking kerning and advance into account. </description> </method> + <method name="has_outline" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_distance_field_hint" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml index ff37408dcd..02b9dcfd88 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.1-dev"> +<class name="FuncRef" inherits="Reference" category="Core" version="3.1"> <brief_description> Reference to a function in an object. </brief_description> diff --git a/doc/classes/GIProbe.xml b/doc/classes/GIProbe.xml index ffe01c37af..77dea73564 100644 --- a/doc/classes/GIProbe.xml +++ b/doc/classes/GIProbe.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GIProbe" inherits="VisualInstance" category="Core" version="3.1-dev"> +<class name="GIProbe" inherits="VisualInstance" category="Core" version="3.1"> <brief_description> </brief_description> <description> </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/3d/gi_probes.html + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/gi_probes.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml index 97193600aa..b2186d7647 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.1-dev"> +<class name="GIProbeData" inherits="Resource" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml index ffcc6e2a0c..0863ead4ec 100644 --- a/doc/classes/Generic6DOFJoint.xml +++ b/doc/classes/Generic6DOFJoint.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Generic6DOFJoint" inherits="Joint" category="Core" version="3.1-dev"> +<class name="Generic6DOFJoint" inherits="Joint" category="Core" version="3.1"> <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> <description> - The first 3 dof axes are linear axes, which represent translation of Bodies, and the latter 3 dof axes represent the angular motion. Each axis can be either locked, or limited. + The first 3 DOF axes are linear axes, which represent translation of Bodies, and the latter 3 DOF axes represent the angular motion. Each axis can be either locked, or limited. </description> <tutorials> </tutorials> @@ -18,7 +18,7 @@ The lower, the longer an impulse from one side takes to travel to the other side. </member> <member name="angular_limit_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> - If [code]true[/code] rotation across the x-axis is enabled. + If [code]true[/code] rotation across the x-axis is limited. </member> <member name="angular_limit_x/erp" type="float" setter="set_param_x" getter="get_param_x"> When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. @@ -42,7 +42,7 @@ The amount of rotational damping across the y-axis. The lower, the more dampening occurs. </member> <member name="angular_limit_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> - If [code]true[/code] rotation across the y-axis is enabled. + If [code]true[/code] rotation across the y-axis is limited. </member> <member name="angular_limit_y/erp" type="float" setter="set_param_y" getter="get_param_y"> When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. @@ -66,7 +66,7 @@ The amount of rotational damping across the z-axis. The lower, the more dampening occurs. </member> <member name="angular_limit_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> - If [code]true[/code] rotation across the z-axis is enabled. + If [code]true[/code] rotation across the z-axis is limited. </member> <member name="angular_limit_z/erp" type="float" setter="set_param_z" getter="get_param_z"> When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. @@ -117,7 +117,7 @@ The amount of damping that happens at the x-motion. </member> <member name="linear_limit_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> - If [code]true[/code] the linear motion across the x-axis is enabled. + If [code]true[/code] the linear motion across the x-axis is limited. </member> <member name="linear_limit_x/lower_distance" type="float" setter="set_param_x" getter="get_param_x"> The minimum difference between the pivot points' x-axis. @@ -135,7 +135,7 @@ The amount of damping that happens at the y-motion. </member> <member name="linear_limit_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> - If [code]true[/code] the linear motion across the y-axis is enabled. + If [code]true[/code] the linear motion across the y-axis is limited. </member> <member name="linear_limit_y/lower_distance" type="float" setter="set_param_y" getter="get_param_y"> The minimum difference between the pivot points' y-axis. @@ -153,7 +153,7 @@ The amount of damping that happens at the z-motion. </member> <member name="linear_limit_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> - If [code]true[/code] the linear motion across the z-axis is enabled. + If [code]true[/code] the linear motion across the z-axis is limited. </member> <member name="linear_limit_z/lower_distance" type="float" setter="set_param_z" getter="get_param_z"> The minimum difference between the pivot points' z-axis. @@ -167,6 +167,33 @@ <member name="linear_limit_z/upper_distance" type="float" setter="set_param_z" getter="get_param_z"> The maximum difference between the pivot points' z-axis. </member> + <member name="linear_motor_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> + If [code]true[/code] then there is a linear motor on the x-axis. It will attempt to reach the target velocity while staying within the force limits. + </member> + <member name="linear_motor_x/force_limit" type="float" setter="set_param_x" getter="get_param_x"> + The maximum force the linear motor can apply on the x-axis while trying to reach the target velocity. + </member> + <member name="linear_motor_x/target_velocity" type="float" setter="set_param_x" getter="get_param_x"> + The speed that the linear motor will attempt to reach on the x-axis. + </member> + <member name="linear_motor_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> + If [code]true[/code] then there is a linear motor on the y-axis. It will attempt to reach the target velocity while staying within the force limits. + </member> + <member name="linear_motor_y/force_limit" type="float" setter="set_param_y" getter="get_param_y"> + The maximum force the linear motor can apply on the y-axis while trying to reach the target velocity. + </member> + <member name="linear_motor_y/target_velocity" type="float" setter="set_param_y" getter="get_param_y"> + The speed that the linear motor will attempt to reach on the y-axis. + </member> + <member name="linear_motor_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> + If [code]true[/code] then there is a linear motor on the z-axis. It will attempt to reach the target velocity while staying within the force limits. + </member> + <member name="linear_motor_z/force_limit" type="float" setter="set_param_z" getter="get_param_z"> + The maximum force the linear motor can apply on the z-axis while trying to reach the target velocity. + </member> + <member name="linear_motor_z/target_velocity" type="float" setter="set_param_z" getter="get_param_z"> + The speed that the linear motor will attempt to reach on the z-axis. + </member> </members> <constants> <constant name="PARAM_LINEAR_LOWER_LIMIT" value="0" enum="Param"> @@ -184,34 +211,40 @@ <constant name="PARAM_LINEAR_DAMPING" value="4" enum="Param"> The amount of damping that happens at the linear motion across the axes. </constant> - <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5" enum="Param"> + <constant name="PARAM_LINEAR_MOTOR_TARGET_VELOCITY" value="5" enum="Param"> + The velocity the linear motor will try to reach. + </constant> + <constant name="PARAM_LINEAR_MOTOR_FORCE_LIMIT" value="6" enum="Param"> + The maximum force the linear motor will apply while trying to reach the velocity target. + </constant> + <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="7" enum="Param"> 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"> + <constant name="PARAM_ANGULAR_UPPER_LIMIT" value="8" enum="Param"> 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"> + <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="9" enum="Param"> The speed of all rotations across the axes. </constant> - <constant name="PARAM_ANGULAR_DAMPING" value="8" enum="Param"> + <constant name="PARAM_ANGULAR_DAMPING" value="10" enum="Param"> The amount of rotational damping across the axes. The lower, the more dampening occurs. </constant> - <constant name="PARAM_ANGULAR_RESTITUTION" value="9" enum="Param"> + <constant name="PARAM_ANGULAR_RESTITUTION" value="11" enum="Param"> 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"> + <constant name="PARAM_ANGULAR_FORCE_LIMIT" value="12" enum="Param"> The maximum amount of force that can occur, when rotating around the axes. </constant> - <constant name="PARAM_ANGULAR_ERP" value="11" enum="Param"> + <constant name="PARAM_ANGULAR_ERP" value="13" enum="Param"> When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </constant> - <constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="12" enum="Param"> + <constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="14" enum="Param"> Target speed for the motor at the axes. </constant> - <constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="13" enum="Param"> + <constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="15" enum="Param"> Maximum acceleration for the motor at the axes. </constant> - <constant name="PARAM_MAX" value="14" enum="Param"> + <constant name="PARAM_MAX" value="16" enum="Param"> End flag of PARAM_* constants, used internally. </constant> <constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="Flag"> @@ -223,7 +256,9 @@ <constant name="FLAG_ENABLE_MOTOR" value="2" enum="Flag"> If [code]set[/code] there is a rotational motor across these axes. </constant> - <constant name="FLAG_MAX" value="3" enum="Flag"> + <constant name="FLAG_ENABLE_LINEAR_MOTOR" value="3" enum="Flag"> + </constant> + <constant name="FLAG_MAX" value="4" enum="Flag"> End flag of FLAG_* constants, used internally. </constant> </constants> diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index ad30829b5d..ea2e2f7595 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.1-dev"> +<class name="Geometry" inherits="Object" category="Core" version="3.1"> <brief_description> </brief_description> <description> @@ -160,6 +160,21 @@ <description> </description> </method> + <method name="line_intersects_line_2d"> + <return type="Variant"> + </return> + <argument index="0" name="from_a" type="Vector2"> + </argument> + <argument index="1" name="dir_a" type="Vector2"> + </argument> + <argument index="2" name="from_b" type="Vector2"> + </argument> + <argument index="3" name="dir_b" type="Vector2"> + </argument> + <description> + Checks if the two lines ([code]from_a[/code], [code]dir_a[/code]) and ([code]from_b[/code], [code]dir_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns an empty [Variant]. Note that the lines are specified using direction vectors, not end points. + </description> + </method> <method name="make_atlas"> <return type="Dictionary"> </return> diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index 3575754d51..8831805dde 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.1-dev"> +<class name="GeometryInstance" inherits="VisualInstance" category="Core" version="3.1"> <brief_description> Base node for geometry based visual instances. </brief_description> @@ -59,7 +59,7 @@ Will allow the GeometryInstance to be used when baking lights using a [GIProbe] and/or any other form of baked lighting. Added documentation for GeometryInstance and VisualInstance </constant> - <constant name="FLAG_MAX" value="1" enum="Flags"> + <constant name="FLAG_MAX" value="2" enum="Flags"> </constant> </constants> </class> diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index 2a7e6e1de2..df4a507b65 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.1-dev"> +<class name="Gradient" inherits="Resource" category="Core" version="3.1"> <brief_description> Color interpolator node. </brief_description> diff --git a/doc/classes/GradientTexture.xml b/doc/classes/GradientTexture.xml index 483dee92b6..9d2465e23d 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.1-dev"> +<class name="GradientTexture" inherits="Texture" category="Core" version="3.1"> <brief_description> Gradient filled texture. </brief_description> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index dde00f85da..48e3c295f1 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.1-dev"> +<class name="GraphEdit" inherits="Control" category="Core" version="3.1"> <brief_description> GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. </brief_description> @@ -85,6 +85,12 @@ 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_zoom_hbox"> + <return type="HBoxContainer"> + </return> + <description> + </description> + </method> <method name="is_node_connected"> <return type="bool"> </return> @@ -140,6 +146,22 @@ 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_connection_activity"> + <return type="void"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="from_port" type="int"> + </argument> + <argument index="2" name="to" type="String"> + </argument> + <argument index="3" name="to_port" type="int"> + </argument> + <argument index="4" name="amount" type="float"> + </argument> + <description> + </description> + </method> <method name="set_selected"> <return type="void"> </return> @@ -228,6 +250,7 @@ <argument index="0" name="node" type="Object"> </argument> <description> + Emitted when a GraphNode is selected. </description> </signal> <signal name="popup_request"> @@ -247,6 +270,8 @@ <constants> </constants> <theme_items> + <theme_item name="activity" type="Color"> + </theme_item> <theme_item name="bezier_len_neg" type="int"> </theme_item> <theme_item name="bezier_len_pos" type="int"> @@ -261,6 +286,10 @@ </theme_item> <theme_item name="more" type="Texture"> </theme_item> + <theme_item name="port_grab_distance_horizontal" type="int"> + </theme_item> + <theme_item name="port_grab_distance_vertical" type="int"> + </theme_item> <theme_item name="reset" type="Texture"> </theme_item> <theme_item name="snap" type="Texture"> diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index 6b581771e0..4c39720d69 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.1-dev"> +<class name="GraphNode" inherits="Container" category="Core" version="3.1"> <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> diff --git a/doc/classes/GridContainer.xml b/doc/classes/GridContainer.xml index 414b7c27e7..8a8a9a2d24 100644 --- a/doc/classes/GridContainer.xml +++ b/doc/classes/GridContainer.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GridContainer" inherits="Container" category="Core" version="3.1-dev"> +<class name="GridContainer" inherits="Container" category="Core" version="3.1"> <brief_description> - Grid container used to arrange elements in a grid like layout + Grid container used to arrange elements in a grid like layout. </brief_description> <description> Grid container will arrange its children in a grid like structure, the grid columns are specified using the [method set_columns] method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container. @@ -11,6 +11,16 @@ <demos> </demos> <methods> + <method name="get_child_control_at_cell"> + <return type="Control"> + </return> + <argument index="0" name="row" type="int"> + </argument> + <argument index="1" name="column" type="int"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="columns" type="int" setter="set_columns" getter="get_columns"> diff --git a/doc/classes/GrooveJoint2D.xml b/doc/classes/GrooveJoint2D.xml index 30497d243e..a15c658f78 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.1-dev"> +<class name="GrooveJoint2D" inherits="Joint2D" category="Core" version="3.1"> <brief_description> Groove constraint for 2D physics. </brief_description> diff --git a/doc/classes/HBoxContainer.xml b/doc/classes/HBoxContainer.xml index 7c73583d58..9c86f17ef1 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.1-dev"> +<class name="HBoxContainer" inherits="BoxContainer" category="Core" version="3.1"> <brief_description> Horizontal box container. </brief_description> diff --git a/doc/classes/HScrollBar.xml b/doc/classes/HScrollBar.xml index 20edc86747..61759c4f94 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.1-dev"> +<class name="HScrollBar" inherits="ScrollBar" category="Core" version="3.1"> <brief_description> Horizontal scroll bar. </brief_description> diff --git a/doc/classes/HSeparator.xml b/doc/classes/HSeparator.xml index e410aa4d86..1a9cf25857 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.1-dev"> +<class name="HSeparator" inherits="Separator" category="Core" version="3.1"> <brief_description> Horizontal separator. </brief_description> diff --git a/doc/classes/HSlider.xml b/doc/classes/HSlider.xml index 70070d612b..6d5acded3c 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.1-dev"> +<class name="HSlider" inherits="Slider" category="Core" version="3.1"> <brief_description> Horizontal slider. </brief_description> diff --git a/doc/classes/HSplitContainer.xml b/doc/classes/HSplitContainer.xml index 7adf7d9d19..45b99c85a6 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.1-dev"> +<class name="HSplitContainer" inherits="SplitContainer" category="Core" version="3.1"> <brief_description> Horizontal split container. </brief_description> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 2dcfb6c7d9..08e2f649a0 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.1-dev"> +<class name="HTTPClient" inherits="Reference" category="Core" version="3.1"> <brief_description> Hyper-text transfer protocol client. </brief_description> @@ -10,8 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/networking/http_client_class.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/networking/ssl_certificates.html</link> </tutorials> <demos> </demos> @@ -111,6 +111,12 @@ String queryString = httpClient.query_string_from_dict(fields) returns:= "username=user&password=pass" [/codeblock] + Furthermore, if a key has a null value, only the key itself is added, without equal sign and value. If the value is an array, for each value in it a pair with the same key is added. + [codeblock] + var fields = {"single": 123, "not_valued": null, "multiple": [22, 33, 44]} + String queryString = httpClient.query_string_from_dict(fields) + returns:= "single=123&not_valued&multiple=22&multiple=33&multiple=44" + [/codeblock] </description> </method> <method name="read_response_body_chunk"> diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index a6fd229ac9..c5bb10a23a 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.1-dev"> +<class name="HTTPRequest" inherits="Node" category="Core" version="3.1"> <brief_description> A node with the ability to send HTTP requests. </brief_description> @@ -8,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/networking/ssl_certificates.html</link> </tutorials> <demos> </demos> @@ -55,6 +55,8 @@ <argument index="4" name="request_data" type="String" default=""""> </argument> <description> + Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request]. + Returns [code]OK[/code] if request is successfully created. (Does not imply that the server has responded), [code]ERR_UNCONFIGURED[/code] if not in the tree, [code]ERR_BUSY[/code] if still processing previous request, [code]ERR_INVALID_PARAMETER[/code] if given string is not a valid URL format, or [code]ERR_CANT_CONNECT[/code] if not using thread and the [HTTPClient] cannot connect to host. </description> </method> </methods> diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml index 01e88f1de6..3c5719056b 100644 --- a/doc/classes/HingeJoint.xml +++ b/doc/classes/HingeJoint.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HingeJoint" inherits="Joint" category="Core" version="3.1-dev"> +<class name="HingeJoint" inherits="Joint" category="Core" version="3.1"> <brief_description> A hinge between two 3D bodies. </brief_description> diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml index c8f2d3970b..bcb15e44fc 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.1-dev"> +<class name="IP" inherits="Object" category="Core" version="3.1"> <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 7360067ecf..0dd4455562 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.1-dev"> +<class name="IP_Unix" inherits="IP" category="Core" version="3.1"> <brief_description> Unix IP support. See [IP]. </brief_description> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index c4e0d55010..55693bd49c 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.1-dev"> +<class name="Image" inherits="Resource" category="Core" version="3.1"> <brief_description> Image datatype. </brief_description> @@ -67,6 +67,14 @@ Blits [code]src_rect[/code] area from [code]src[/code] image to this image at the coordinates given by [code]dst[/code]. [code]src[/code] pixel is copied onto [code]dst[/code] if the corresponding [code]mask[/code] pixel's alpha value is not 0. [code]src[/code] image and [code]mask[/code] image [b]must[/b] have the same size (width and height) but they can have different formats. </description> </method> + <method name="bumpmap_to_normalmap"> + <return type="void"> + </return> + <argument index="0" name="bump_scale" type="float" default="1.0"> + </argument> + <description> + </description> + </method> <method name="clear_mipmaps"> <return type="void"> </return> @@ -202,6 +210,8 @@ <method name="generate_mipmaps"> <return type="int" enum="Error"> </return> + <argument index="0" name="renormalize" type="bool" default="false"> + </argument> <description> Generates mipmaps for the image. Mipmaps are pre-calculated and lower resolution copies of the image. Mipmaps are automatically used if the image needs to be scaled down when rendered. This improves image quality and the performance of the rendering. Returns an error if the image is compressed, in a custom format or if the image's width/height is 0. </description> @@ -247,6 +257,14 @@ Returns the color of the pixel at [code](x, y)[/code] if the image is locked. If the image is unlocked it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code]. </description> </method> + <method name="get_pixelv" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="src" type="Vector2"> + </argument> + <description> + </description> + </method> <method name="get_rect" qualifiers="const"> <return type="Image"> </return> @@ -320,6 +338,7 @@ <argument index="0" name="buffer" type="PoolByteArray"> </argument> <description> + Loads an image from the binary contents of a JPEG file. </description> </method> <method name="load_png_from_buffer"> @@ -328,6 +347,16 @@ <argument index="0" name="buffer" type="PoolByteArray"> </argument> <description> + Loads an image from the binary contents of a PNG file. + </description> + </method> + <method name="load_webp_from_buffer"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="buffer" type="PoolByteArray"> + </argument> + <description> + Loads an image from the binary contents of a WebP file. </description> </method> <method name="lock"> @@ -373,6 +402,12 @@ Resizes the image to the nearest power of 2 for the width and height. If [code]square[/code] is [code]true[/code] then set width and height to be the same. </description> </method> + <method name="rgbe_to_srgb"> + <return type="Image"> + </return> + <description> + </description> + </method> <method name="save_png" qualifiers="const"> <return type="int" enum="Error"> </return> @@ -403,6 +438,16 @@ [/codeblock] </description> </method> + <method name="set_pixelv"> + <return type="void"> + </return> + <argument index="0" name="dst" type="Vector2"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> <method name="shrink_x2"> <return type="void"> </return> @@ -436,74 +481,109 @@ <constant name="FORMAT_LA8" value="1" enum="Format"> </constant> <constant name="FORMAT_R8" value="2" enum="Format"> + OpenGL texture format RED with a single component and a bitdepth of 8. </constant> <constant name="FORMAT_RG8" value="3" enum="Format"> + OpenGL texture format RG with two components and a bitdepth of 8 for each. </constant> <constant name="FORMAT_RGB8" value="4" enum="Format"> + OpenGL texture format RGB with three components, each with a bitdepth of 8. </constant> <constant name="FORMAT_RGBA8" value="5" enum="Format"> + OpenGL texture format RGBA with four components, each with a bitdepth of 8. </constant> <constant name="FORMAT_RGBA4444" value="6" enum="Format"> + OpenGL texture format RGBA with four components, each with a bitdepth of 4. </constant> <constant name="FORMAT_RGBA5551" value="7" enum="Format"> + OpenGL texture format GL_RGB5_A1 where 5 bits of depth for each component of RGB and one bit for alpha. </constant> <constant name="FORMAT_RF" value="8" enum="Format"> + OpenGL texture format GL_R32F where there's one component, a 32-bit floating-point value. </constant> <constant name="FORMAT_RGF" value="9" enum="Format"> + OpenGL texture format GL_RG32F where there are two components, each a 32-bit floating-point values. </constant> <constant name="FORMAT_RGBF" value="10" enum="Format"> + OpenGL texture format GL_RGB32F where there are three components, each a 32-bit floating-point values. </constant> <constant name="FORMAT_RGBAF" value="11" enum="Format"> + OpenGL texture format GL_RGBA32F where there are four components, each a 32-bit floating-point values. </constant> <constant name="FORMAT_RH" value="12" enum="Format"> + OpenGL texture format GL_R32F where there's one component, a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGH" value="13" enum="Format"> + OpenGL texture format GL_RG32F where there's two components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBH" value="14" enum="Format"> + OpenGL texture format GL_RGB32F where there's three components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBAH" value="15" enum="Format"> + OpenGL texture format GL_RGBA32F where there's four components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBE9995" value="16" enum="Format"> + A special OpenGL texture format where the three color components have 9 bits of precision and all three share a single exponent. </constant> <constant name="FORMAT_DXT1" value="17" enum="Format"> + The S3TC texture format that uses Block Compression 1, and is the smallest variation of S3TC, only providing 1 bit of alpha and color data being premultiplied with alpha. More information can be found at https://www.khronos.org/opengl/wiki/S3_Texture_Compression. </constant> <constant name="FORMAT_DXT3" value="18" enum="Format"> + The S3TC texture format that uses Block Compression 2, and color data is interpreted as not having been premultiplied by alpha. Well suited for images with sharp alpha transitions between translucent and opaque areas. </constant> <constant name="FORMAT_DXT5" value="19" enum="Format"> + The S3TC texture format also known as Block Compression 3 or BC3 that contains 64 bits of alpha channel data followed by 64 bits of DXT1-encoded color data. Color data is not premultiplied by alpha, same as DXT3. DXT5 generally produces superior results for transparency gradients than DXT3. </constant> <constant name="FORMAT_RGTC_R" value="20" enum="Format"> + Texture format that uses Red Green Texture Compression, normalizing the red channel data using the same compression algorithm that DXT5 uses for the alpha channel. More information can be found here https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression. </constant> <constant name="FORMAT_RGTC_RG" value="21" enum="Format"> + Texture format that uses Red Green Texture Compression, normalizing the red and green channel data using the same compression algorithm that DXT5 uses for the alpha channel. </constant> <constant name="FORMAT_BPTC_RGBA" value="22" enum="Format"> + Texture format that uses BPTC compression with unsigned normalized RGBA components. More information can be found at https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression. </constant> <constant name="FORMAT_BPTC_RGBF" value="23" enum="Format"> + Texture format that uses BPTC compression with signed floating-point RGB components. </constant> <constant name="FORMAT_BPTC_RGBFU" value="24" enum="Format"> + Texture format that uses BPTC compression with unsigned floating-point RGB components. </constant> <constant name="FORMAT_PVRTC2" value="25" enum="Format"> + Texture format used on PowerVR-supported mobile platforms, uses 2 bit color depth with no alpha. More information on PVRTC can be found here https://en.wikipedia.org/wiki/PVRTC. </constant> <constant name="FORMAT_PVRTC2A" value="26" enum="Format"> + Same as PVRTC2, but with an alpha component. </constant> <constant name="FORMAT_PVRTC4" value="27" enum="Format"> + Similar to PVRTC2, but with 4 bit color depth and no alpha. </constant> <constant name="FORMAT_PVRTC4A" value="28" enum="Format"> + Same as PVRTC4, but with an alpha component. </constant> <constant name="FORMAT_ETC" value="29" enum="Format"> + Ericsson Texture Compression format, also referred to as 'ETC1', and is part of the OpenGL ES graphics standard. An overview of the format is given at https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC1. </constant> <constant name="FORMAT_ETC2_R11" value="30" enum="Format"> + Ericsson Texture Compression format 2 variant R11_EAC, which provides one channel of unsigned data. </constant> <constant name="FORMAT_ETC2_R11S" value="31" enum="Format"> + Ericsson Texture Compression format 2 variant SIGNED_R11_EAC, which provides one channel of signed data. </constant> <constant name="FORMAT_ETC2_RG11" value="32" enum="Format"> + Ericsson Texture Compression format 2 variant RG11_EAC, which provides two channels of unsigned data. </constant> <constant name="FORMAT_ETC2_RG11S" value="33" enum="Format"> + Ericsson Texture Compression format 2 variant SIGNED_RG11_EAC, which provides two channels of signed data. </constant> <constant name="FORMAT_ETC2_RGB8" value="34" enum="Format"> + Ericsson Texture Compression format 2 variant RGB8, which is a followup of ETC1 and compresses RGB888 data. </constant> <constant name="FORMAT_ETC2_RGBA8" value="35" enum="Format"> + Ericsson Texture Compression format 2 variant RGBA8, which compresses RGBA8888 data with full alpha support. </constant> <constant name="FORMAT_ETC2_RGB8A1" value="36" enum="Format"> + Ericsson Texture Compression format 2 variant RGB8_PUNCHTHROUGH_ALPHA1, which compresses RGBA data to make alpha either fully transparent or fully opaque. </constant> <constant name="FORMAT_MAX" value="37" enum="Format"> </constant> @@ -513,6 +593,12 @@ </constant> <constant name="INTERPOLATE_CUBIC" value="2" enum="Interpolation"> </constant> + <constant name="INTERPOLATE_TRILINEAR" value="3" enum="Interpolation"> + Performs bilinear separately on the two most suited mipmap levels, then linearly interpolates between them. + It's slower than [code]INTERPOLATE_BILINEAR[/code], but produces higher quality results, with much less aliasing artifacts. + If the image does not have mipmaps, they will be generated and used internally, but no mipmaps will be generated on the resulting image. (Note that if you intend to scale multiple copies of the original image, it's better to call [code]generate_mipmaps[/code] on it in advance, to avoid wasting processing power in generating them again and again.) + On the other hand, if the image already has mipmaps, they will be used, and a new set will be generated for the resulting image. + </constant> <constant name="ALPHA_NONE" value="0" enum="AlphaMode"> </constant> <constant name="ALPHA_BIT" value="1" enum="AlphaMode"> diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index f7f211861d..0bff3317db 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.1-dev"> +<class name="ImageTexture" inherits="Texture" category="Core" version="3.1"> <brief_description> A [Texture] based on an [Image]. </brief_description> @@ -47,12 +47,12 @@ </description> </method> <method name="load"> - <return type="void"> + <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> <description> - Load an [code]ImageTexture[/code]. + Load an [code]ImageTexture[/code] from a file path. </description> </method> <method name="set_data"> diff --git a/doc/classes/ImmediateGeometry.xml b/doc/classes/ImmediateGeometry.xml index 1cb86bc07f..29d05bf877 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.1-dev"> +<class name="ImmediateGeometry" inherits="GeometryInstance" category="Core" version="3.1"> <brief_description> Draws simple geometry from code. </brief_description> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 6ec6f08804..a4346c1485 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.1-dev"> +<class name="Input" inherits="Object" category="Core" version="3.1"> <brief_description> A Singleton that deals with inputs. </brief_description> @@ -7,6 +7,7 @@ A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap]. </description> <tutorials> + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/index.html</link> </tutorials> <demos> </demos> @@ -44,7 +45,15 @@ <return type="Vector3"> </return> <description> - If the device has an accelerometer, this will return the movement. + If the device has an accelerometer, this will return the acceleration. Otherwise, it returns an empty [Vector3]. + </description> + </method> + <method name="get_action_strength" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> </description> </method> <method name="get_connected_joypads"> @@ -58,13 +67,14 @@ <return type="Vector3"> </return> <description> + If the device has an accelerometer, this will return the gravity. Otherwise, it returns an empty [Vector3]. </description> </method> <method name="get_gyroscope" qualifiers="const"> <return type="Vector3"> </return> <description> - If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's x, y, and z axis. + If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's x, y, and z axis. Otherwise, it returns an empty [Vector3]. </description> </method> <method name="get_joy_axis" qualifiers="const"> @@ -180,7 +190,8 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns [code]true[/code] when you start pressing the action event. + Returns [code]true[/code] when the user starts pressing the action event, meaning it's true only on the frame that the user pressed down the button. + This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. </description> </method> <method name="is_action_just_released" qualifiers="const"> @@ -189,7 +200,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns [code]true[/code] when you stop pressing the action event. + Returns [code]true[/code] when the user stops pressing the action event, meaning it's true only on the frame that the user released the button. </description> </method> <method name="is_action_pressed" qualifiers="const"> @@ -259,6 +270,7 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> + Feeds an [InputEvent] to the game. Can be used to artificially trigger input events from code. </description> </method> <method name="remove_joy_mapping"> @@ -280,7 +292,15 @@ <argument index="2" name="hotspot" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. See enum [code]CURSOR_*[/code] for the list of shapes. + Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See enum [code]CURSOR_*[/code] for the list of shapes. + </description> + </method> + <method name="set_default_cursor_shape"> + <return type="void"> + </return> + <argument index="0" name="shape" type="int" enum="Input.CursorShape" default="0"> + </argument> + <description> </description> </method> <method name="set_mouse_mode"> @@ -329,12 +349,12 @@ </methods> <signals> <signal name="joy_connection_changed"> - <argument index="0" name="index" type="int"> + <argument index="0" name="device" type="int"> </argument> <argument index="1" name="connected" type="bool"> </argument> <description> - Emitted when a joypad device has been connected or disconnected + Emitted when a joypad device has been connected or disconnected. </description> </signal> </signals> @@ -349,40 +369,58 @@ Captures the mouse. The mouse will be hidden and unable to leave the game window. But it will still register movement and mouse button presses. </constant> <constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode"> + Makes the mouse cursor visible but confines it to the game window. </constant> <constant name="CURSOR_ARROW" value="0" enum="CursorShape"> + Arrow cursor. Standard, default pointing cursor. </constant> <constant name="CURSOR_IBEAM" value="1" enum="CursorShape"> + I-beam cursor. Usually used to show where the text cursor will appear when the mouse is clicked. </constant> <constant name="CURSOR_POINTING_HAND" value="2" enum="CursorShape"> + Pointing hand cursor. Usually used to indicate the pointer is over a link or other interactable item. </constant> <constant name="CURSOR_CROSS" value="3" enum="CursorShape"> + Cross cursor. Typically appears over regions in which a drawing operation can be performance or for selections. </constant> <constant name="CURSOR_WAIT" value="4" enum="CursorShape"> + Wait cursor. Indicates that the application is busy performing an operation. </constant> <constant name="CURSOR_BUSY" value="5" enum="CursorShape"> + Busy cursor. See [code]CURSOR_WAIT[/code]. </constant> <constant name="CURSOR_DRAG" value="6" enum="CursorShape"> + Drag cursor. Usually displayed when dragging something. </constant> <constant name="CURSOR_CAN_DROP" value="7" enum="CursorShape"> + Can drop cursor. Usually displayed when dragging something to indicate that it can be dropped at the current position. </constant> <constant name="CURSOR_FORBIDDEN" value="8" enum="CursorShape"> + Forbidden cursor. Indicates that the current action is forbidden (for example, when dragging something) or that the control at a position is disabled. </constant> <constant name="CURSOR_VSIZE" value="9" enum="CursorShape"> + Vertical resize mouse cursor. A double headed vertical arrow. It tells the user they can resize the window or the panel vertically. </constant> <constant name="CURSOR_HSIZE" value="10" enum="CursorShape"> + Horizontal resize mouse cursor. A double headed horizontal arrow. It tells the user they can resize the window or the panel horizontally. </constant> <constant name="CURSOR_BDIAGSIZE" value="11" enum="CursorShape"> + Window resize mouse cursor. The cursor is a double headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically. </constant> <constant name="CURSOR_FDIAGSIZE" value="12" enum="CursorShape"> + Window resize mouse cursor. The cursor is a double headed arrow that goes from the top left to the bottom right, the opposite of [code]CURSOR_BDIAGSIZE[/code]. It tells the user they can resize the window or the panel both horizontally and vertically. </constant> <constant name="CURSOR_MOVE" value="13" enum="CursorShape"> + Move cursor. Indicates that something can be moved. </constant> <constant name="CURSOR_VSPLIT" value="14" enum="CursorShape"> + Vertical split mouse cursor. On Windows, it's the same as [code]CURSOR_VSIZE[/code]. </constant> <constant name="CURSOR_HSPLIT" value="15" enum="CursorShape"> + Horizontal split mouse cursor. On Windows, it's the same as [code]CURSOR_HSIZE[/code]. </constant> <constant name="CURSOR_HELP" value="16" enum="CursorShape"> + Help cursor. Usually a question mark. </constant> </constants> </class> diff --git a/doc/classes/InputDefault.xml b/doc/classes/InputDefault.xml index b82904c023..27bfff2e67 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.1-dev"> +<class name="InputDefault" inherits="Input" category="Core" version="3.1"> <brief_description> Default implementation of the [Input] class. </brief_description> diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 41defdcb7f..993d62d188 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.1-dev"> +<class name="InputEvent" inherits="Resource" category="Core" version="3.1"> <brief_description> Generic input event </brief_description> @@ -7,26 +7,25 @@ Base class of all sort of input event. See [method Node._input]. </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html - http://docs.godotengine.org/en/3.0/tutorials/2d/2d_transforms.html + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/2d/2d_transforms.html</link> </tutorials> <demos> </demos> <methods> - <method name="action_match" qualifiers="const"> - <return type="bool"> + <method name="as_text" qualifiers="const"> + <return type="String"> </return> - <argument index="0" name="event" type="InputEvent"> - </argument> <description> - Returns [code]true[/code] if this event matches [code]event[/code]. + Returns a [String] representation of the event. </description> </method> - <method name="as_text" qualifiers="const"> - <return type="String"> + <method name="get_action_strength" qualifiers="const"> + <return type="float"> </return> + <argument index="0" name="action" type="String"> + </argument> <description> - Returns a [String] representation of the event. </description> </method> <method name="is_action" qualifiers="const"> diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml index f0c6cf59be..16000231cb 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.1-dev"> +<class name="InputEventAction" inherits="InputEvent" category="Core" version="3.1"> <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/3.0/tutorials/inputs/inputevent.html#actions + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html#actions</link> </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventGesture.xml b/doc/classes/InputEventGesture.xml index 20410a8d5e..eb1e613b7c 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.1-dev"> +<class name="InputEventGesture" inherits="InputEventWithModifiers" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index 2c7c41d9e0..adaeae685e 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.1-dev"> +<class name="InputEventJoypadButton" inherits="InputEvent" category="Core" version="3.1"> <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/3.0/tutorials/inputs/inputevent.html + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html</link> </tutorials> <demos> </demos> @@ -15,7 +15,7 @@ </methods> <members> <member name="button_index" type="int" setter="set_button_index" getter="get_button_index"> - Button identifier. One of the [code]JOY_BUTTON_*[/code] constants from [@global Scope]. + Button identifier. One of the [code]JOY_BUTTON_*[/code] constants from [@GlobalScope]. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> If [code]true[/code] the button's state is pressed. If [code]false[/code] the button's state is released. diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index cdcab3fcab..f86aec4ce0 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.1-dev"> +<class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.1"> <brief_description> Input event type for gamepad joysticks and other motions. For buttons see [code]InputEventJoypadButton[/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/3.0/tutorials/inputs/inputevent.html + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html</link> </tutorials> <demos> </demos> @@ -15,7 +15,7 @@ </methods> <members> <member name="axis" type="int" setter="set_axis" getter="get_axis"> - Axis identifier. Use one of the [code]JOY_AXIS_*[/code] constants in [@global Scope]. + Axis identifier. Use one of the [code]JOY_AXIS_*[/code] constants in [@GlobalScope]. </member> <member name="axis_value" type="float" setter="set_axis_value" getter="get_axis_value"> Current position of the joystick on the given axis. The value ranges from [code]-1.0[/code] to [code]1.0[/code]. A value of [code]0[/code] means the axis is in its resting position. diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 1cd00e1042..a013ee6266 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.1-dev"> +<class name="InputEventKey" inherits="InputEventWithModifiers" category="Core" version="3.1"> <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/3.0/tutorials/inputs/inputevent.html + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html</link> </tutorials> <demos> </demos> @@ -16,6 +16,7 @@ <return type="int"> </return> <description> + Returns the scancode combined with modifier keys such as [code]Shift[/code] or [code]Alt[/code]. See also [InputEventWithModifiers]. </description> </method> </methods> @@ -27,7 +28,7 @@ If [code]true[/code] the key's state is pressed. If [code]false[/code] the key's state is released. </member> <member name="scancode" type="int" setter="set_scancode" getter="get_scancode"> - Key scancode, one of the [code]KEY_*[/code] constants in [@global Scope]. + Key scancode, one of the [code]KEY_*[/code] constants in [@GlobalScope]. </member> <member name="unicode" type="int" setter="set_unicode" getter="get_unicode"> Key unicode identifier when relevant. diff --git a/doc/classes/InputEventMagnifyGesture.xml b/doc/classes/InputEventMagnifyGesture.xml index 06beaa84f9..e9a0149c56 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.1-dev"> +<class name="InputEventMagnifyGesture" inherits="InputEventGesture" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index 5d50d32d44..06de96890a 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventMouse" inherits="InputEventWithModifiers" category="Core" version="3.1-dev"> +<class name="InputEventMouse" inherits="InputEventWithModifiers" category="Core" version="3.1"> <brief_description> Base input event type for mouse events. </brief_description> @@ -7,7 +7,7 @@ Stores general mouse events information. </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml index bbdd2aff4e..50641dceed 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.1-dev"> +<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.1"> <brief_description> Input event type for mouse button events. </brief_description> @@ -7,7 +7,7 @@ Contains mouse click information. See [method Node._input]. </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/inputs/mouse_and_input_coordinates.html + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/mouse_and_input_coordinates.html</link> </tutorials> <demos> </demos> @@ -21,7 +21,7 @@ If [code]true[/code] the mouse button's state is a double-click. If [code]false[/code] the mouse button's state is released. </member> <member name="factor" type="float" setter="set_factor" getter="get_factor"> - TO TALK in PR, reduz said : i think it's used for apple touch but i don't remember what it does + Magnitude. Amount (or delta) of the event. Used for scroll events, indicates scroll amount (vertically or horizontally). Only supported on some platforms, sensitivity varies by platform. May be 0 if not supported. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> If [code]true[/code] the mouse button's state is pressed. If [code]false[/code] the mouse button's state is released. diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index 96160dc699..05e3e79d26 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventMouseMotion" inherits="InputEventMouse" category="Core" version="3.1-dev"> +<class name="InputEventMouseMotion" inherits="InputEventMouse" category="Core" version="3.1"> <brief_description> Input event type for mouse motion events. </brief_description> @@ -7,7 +7,7 @@ Contains mouse motion information. Supports relative, absolute positions and speed. See [method Node._input]. </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/inputs/mouse_and_input_coordinates.html + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/mouse_and_input_coordinates.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventPanGesture.xml b/doc/classes/InputEventPanGesture.xml index 06edf36d06..063986ae65 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.1-dev"> +<class name="InputEventPanGesture" inherits="InputEventGesture" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/InputEventScreenDrag.xml b/doc/classes/InputEventScreenDrag.xml index fd7ec15acc..f777d90ccb 100644 --- a/doc/classes/InputEventScreenDrag.xml +++ b/doc/classes/InputEventScreenDrag.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventScreenDrag" inherits="InputEvent" category="Core" version="3.1-dev"> +<class name="InputEventScreenDrag" inherits="InputEvent" category="Core" version="3.1"> <brief_description> Input event type for screen drag events. (only available on mobile devices) @@ -8,7 +8,7 @@ Contains screen drag information. See [method Node._input]. </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventScreenTouch.xml b/doc/classes/InputEventScreenTouch.xml index 019332ec26..39cd0a9657 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.1-dev"> +<class name="InputEventScreenTouch" inherits="InputEvent" category="Core" version="3.1"> <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/3.0/tutorials/inputs/inputevent.html + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml index a31df65ffb..9c1814fedd 100644 --- a/doc/classes/InputEventWithModifiers.xml +++ b/doc/classes/InputEventWithModifiers.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InputEventWithModifiers" inherits="InputEvent" category="Core" version="3.1-dev"> +<class name="InputEventWithModifiers" inherits="InputEvent" category="Core" version="3.1"> <brief_description> Base class for keys events with modifiers. </brief_description> @@ -7,7 +7,7 @@ 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/3.0/tutorials/inputs/inputevent.html + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index c5326c6211..7fd1d7e8ac 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.1-dev"> +<class name="InputMap" inherits="Object" category="Core" version="3.1"> <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/3.0/tutorials/inputs/inputevent.html#inputmap + <link>http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html#inputmap</link> </tutorials> <demos> </demos> @@ -34,6 +34,15 @@ Removes an [InputEvent] from an action. </description> </method> + <method name="action_erase_events"> + <return type="void"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + Removes all events from an action. + </description> + </method> <method name="action_has_event"> <return type="bool"> </return> @@ -42,7 +51,17 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Returns [true] if an action has an [InputEvent] associated with it. + Returns [code]true[/code] if the action has the given [InputEvent] associated with it. + </description> + </method> + <method name="action_set_deadzone"> + <return type="void"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <argument index="1" name="deadzone" type="float"> + </argument> + <description> </description> </method> <method name="add_action"> @@ -50,8 +69,11 @@ </return> <argument index="0" name="action" type="String"> </argument> + <argument index="1" name="deadzone" type="float" default="0.5"> + </argument> <description> - Adds an (empty) action to the [code]InputMap[/code]. An [InputEvent] can then be added to this action with [method action_add_event]. + Adds an empty action to the [code]InputMap[/code] with a configurable [code]deadzone[/code]. + An [InputEvent] can then be added to this action with [method action_add_event]. </description> </method> <method name="erase_action"> diff --git a/doc/classes/InstancePlaceholder.xml b/doc/classes/InstancePlaceholder.xml index 834ad7bb11..71c859fd9e 100644 --- a/doc/classes/InstancePlaceholder.xml +++ b/doc/classes/InstancePlaceholder.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InstancePlaceholder" inherits="Node" category="Core" version="3.1-dev"> +<class name="InstancePlaceholder" inherits="Node" category="Core" version="3.1"> <brief_description> Placeholder for the root [Node] of a [PackedScene]. </brief_description> <description> - Turning on the option [b]Load As Placeholder[/b] for an instanced scene in the editor causes it to be replaced by an InstacePlaceholder when running the game. This makes it possible to delay actually loading the scene until calling [method replace_by_instance]. This is useful to avoid loading large scenes all at once by loading parts of it selectively. + Turning on the option [b]Load As Placeholder[/b] for an instanced scene in the editor causes it to be replaced by an InstancePlaceholder when running the game. This makes it possible to delay actually loading the scene until calling [method replace_by_instance]. This is useful to avoid loading large scenes all at once by loading parts of it selectively. The InstancePlaceholder does not have a transform. This causes any child nodes to be positioned relatively to the Viewport from point (0,0), rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again. </description> <tutorials> @@ -12,6 +12,16 @@ <demos> </demos> <methods> + <method name="create_instance"> + <return type="Node"> + </return> + <argument index="0" name="replace" type="bool" default="false"> + </argument> + <argument index="1" name="custom_scene" type="PackedScene" default="null"> + </argument> + <description> + </description> + </method> <method name="get_instance_path" qualifiers="const"> <return type="String"> </return> diff --git a/doc/classes/InterpolatedCamera.xml b/doc/classes/InterpolatedCamera.xml index 19252ca5a8..1ac7b5107e 100644 --- a/doc/classes/InterpolatedCamera.xml +++ b/doc/classes/InterpolatedCamera.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="InterpolatedCamera" inherits="Camera" category="Core" version="3.1-dev"> +<class name="InterpolatedCamera" inherits="Camera" category="Core" version="3.1"> <brief_description> + Camera which moves toward another node. </brief_description> <description> + InterpolatedCamera is a [Camera] which smoothly moves to match a target node's position and rotation. + If it is not [member enabled] or does not have a valid target set, InterpolatedCamera acts like a normal Camera. </description> <tutorials> </tutorials> @@ -15,15 +18,19 @@ <argument index="0" name="target" type="Object"> </argument> <description> + Sets the node to move toward and orient with. </description> </method> </methods> <members> <member name="enabled" type="bool" setter="set_interpolation_enabled" getter="is_interpolation_enabled"> + If [code]true[/code] and a target is set, the camera will move automatically. </member> <member name="speed" type="float" setter="set_speed" getter="get_speed"> + How quickly the camera moves toward its target. Higher values will result in tighter camera motion. </member> <member name="target" type="NodePath" setter="set_target_path" getter="get_target_path"> + The target's [NodePath]. </member> </members> <constants> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index 95812ab299..4723cf8ee4 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -1,13 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ItemList" inherits="Control" category="Core" version="3.1-dev"> +<class name="ItemList" inherits="Control" category="Core" version="3.1"> <brief_description> Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns. </brief_description> <description> - This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, - or both text and icon. Tooltips are supported and may be different for every item in the list. Selectable items in the list - may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled - to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key). + This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, or both text and icon. Tooltips are supported and may be different for every item in the list. + Selectable items in the list may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key). </description> <tutorials> </tutorials> @@ -79,6 +77,14 @@ <description> </description> </method> + <method name="get_item_custom_fg_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> <method name="get_item_icon" qualifiers="const"> <return type="Texture"> </return> @@ -87,6 +93,15 @@ <description> </description> </method> + <method name="get_item_icon_modulate" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Returns a [Color] modulating item's icon at the specified index. + </description> + </method> <method name="get_item_icon_region" qualifiers="const"> <return type="Rect2"> </return> @@ -135,6 +150,13 @@ Returns the current vertical scroll bar for the List. </description> </method> + <method name="is_anything_selected"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if one or more items are selected. + </description> + </method> <method name="is_item_disabled" qualifiers="const"> <return type="bool"> </return> @@ -171,6 +193,17 @@ Returns whether or not item at the specified index is currently selected. </description> </method> + <method name="move_item"> + <return type="void"> + </return> + <argument index="0" name="from_idx" type="int"> + </argument> + <argument index="1" name="to_idx" type="int"> + </argument> + <description> + Moves item at index [code]from_idx[/code] to [code]to_idx[/code]. + </description> + </method> <method name="remove_item"> <return type="void"> </return> @@ -202,6 +235,16 @@ <description> </description> </method> + <method name="set_item_custom_fg_color"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="custom_fg_color" type="Color"> + </argument> + <description> + </description> + </method> <method name="set_item_disabled"> <return type="void"> </return> @@ -225,6 +268,17 @@ Set (or replace) icon of the item at the specified index. </description> </method> + <method name="set_item_icon_modulate"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="modulate" type="Color"> + </argument> + <description> + Sets a modulating [Color] for item's icon at the specified index. + </description> + </method> <method name="set_item_icon_region"> <return type="void"> </return> @@ -306,6 +360,13 @@ Ensure item at specified index is not selected. </description> </method> + <method name="unselect_all"> + <return type="void"> + </return> + <description> + Ensure there are no items selected. + </description> + </method> </methods> <members> <member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect"> diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index d3c2e7bb2f..fbf9aea7f9 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="JSON" inherits="Object" category="Core" version="3.1-dev"> +<class name="JSON" inherits="Object" category="Core" version="3.1"> <brief_description> Helper class for parsing JSON data. </brief_description> diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index 4f9cdc976d..a9162e2d95 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="JSONParseResult" inherits="Reference" category="Core" version="3.1-dev"> +<class name="JSONParseResult" inherits="Reference" category="Core" version="3.1"> <brief_description> Data class wrapper for decoded JSON. </brief_description> diff --git a/doc/classes/JavaScript.xml b/doc/classes/JavaScript.xml index 4f37d75038..17588717c2 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.1-dev"> +<class name="JavaScript" inherits="Object" category="Core" version="3.1"> <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/3.0/getting_started/workflow/export/exporting_for_web.html#calling-javascript-from-script + <link>http://docs.godotengine.org/en/3.0/getting_started/workflow/export/exporting_for_web.html#calling-javascript-from-script</link> </tutorials> <demos> </demos> diff --git a/doc/classes/Joint.xml b/doc/classes/Joint.xml index bb7ac74556..8cafdbdbf3 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.1-dev"> +<class name="Joint" inherits="Spatial" category="Core" version="3.1"> <brief_description> Base class for all 3D joints </brief_description> diff --git a/doc/classes/Joint2D.xml b/doc/classes/Joint2D.xml index a005e7994a..8247997927 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.1-dev"> +<class name="Joint2D" inherits="Node2D" category="Core" version="3.1"> <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 7ebea43cb9..0c66319ae7 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.1-dev"> +<class name="KinematicBody" inherits="PhysicsBody" category="Core" version="3.1"> <brief_description> Kinematic body 3D node. </brief_description> @@ -9,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/kinematic_character_2d.html</link> </tutorials> <demos> </demos> @@ -63,8 +63,13 @@ </return> <argument index="0" name="rel_vec" type="Vector3"> </argument> + <argument index="1" name="infinite_inertia" type="bool" default="true"> + </argument> + <argument index="2" name="test_only" type="bool" default="false"> + </argument> <description> Moves the body along the vector [code]rel_vec[/code]. The body will stop if it collides. Returns a [KinematicCollision], which contains information about the collision. + If [code]test_only[/code] is [code]true[/true], the body does not move but the would-be collision information is given. </description> </method> <method name="move_and_slide"> @@ -74,22 +79,44 @@ </argument> <argument index="1" name="floor_normal" type="Vector3" default="Vector3( 0, 0, 0 )"> </argument> - <argument index="2" name="slope_stop_min_velocity" type="float" default="0.05"> + <argument index="2" name="stop_on_slope" type="bool" default="false"> </argument> <argument index="3" name="max_slides" type="int" default="4"> </argument> <argument index="4" name="floor_max_angle" type="float" default="0.785398"> </argument> + <argument index="5" name="infinite_inertia" type="bool" default="true"> + </argument> <description> Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [code]KinematicBody[/code] or [RigidBody], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. [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. + [i]TODO: Update for new stop_on_slode argument.[/i] 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_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 occurred, use [method get_slide_collision]. </description> </method> + <method name="move_and_slide_with_snap"> + <return type="Vector3"> + </return> + <argument index="0" name="linear_velocity" type="Vector3"> + </argument> + <argument index="1" name="snap" type="Vector3"> + </argument> + <argument index="2" name="floor_normal" type="Vector3" default="Vector3( 0, 0, 0 )"> + </argument> + <argument index="3" name="infinite_inertia" type="bool" default="true"> + </argument> + <argument index="4" name="stop_on_slope" type="bool" default="false"> + </argument> + <argument index="5" name="max_bounces" type="int" default="4"> + </argument> + <argument index="6" name="floor_max_angle" type="float" default="0.785398"> + </argument> + <description> + </description> + </method> <method name="test_move"> <return type="bool"> </return> @@ -97,26 +124,22 @@ </argument> <argument index="1" name="rel_vec" type="Vector3"> </argument> + <argument index="2" name="infinite_inertia" type="bool"> + </argument> <description> Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given [Transform], then tries to move the body along the vector [code]rel_vec[/code]. Returns [code]true[/code] if a collision would occur. </description> </method> </methods> <members> - <member name="axis_lock_angular_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - </member> - <member name="axis_lock_angular_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - </member> - <member name="axis_lock_angular_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - </member> - <member name="axis_lock_linear_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + <member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin"> + If the body is at least this close to another body, this body will consider them to be colliding. </member> - <member name="axis_lock_linear_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + <member name="move_lock_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> </member> - <member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + <member name="move_lock_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> </member> - <member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin"> - If the body is at least this close to another body, this body will consider them to be colliding. + <member name="move_lock_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> </member> </members> <constants> diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index da7b34440e..e48660a889 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.1-dev"> +<class name="KinematicBody2D" inherits="PhysicsBody2D" category="Core" version="3.1"> <brief_description> Kinematic body 2D node. </brief_description> @@ -62,6 +62,12 @@ </return> <argument index="0" name="rel_vec" type="Vector2"> </argument> + <argument index="1" name="infinite_inertia" type="bool" default="true"> + </argument> + <argument index="2" name="exclude_raycast_shapes" type="bool" default="true"> + </argument> + <argument index="3" name="test_only" type="bool" default="false"> + </argument> <description> Moves the body along the vector [code]rel_vec[/code]. The body will stop if it collides. Returns a [KinematicCollision2D], which contains information about the collision. </description> @@ -73,22 +79,46 @@ </argument> <argument index="1" name="floor_normal" type="Vector2" default="Vector2( 0, 0 )"> </argument> - <argument index="2" name="slope_stop_min_velocity" type="float" default="5"> + <argument index="2" name="infinite_inertia" type="bool" default="true"> </argument> - <argument index="3" name="max_bounces" type="int" default="4"> + <argument index="3" name="stop_on_slope" type="bool" default="false"> </argument> - <argument index="4" name="floor_max_angle" type="float" default="0.785398"> + <argument index="4" name="max_bounces" type="int" default="4"> + </argument> + <argument index="5" name="floor_max_angle" type="float" default="0.785398"> </argument> <description> Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [code]KinematicBody2D[/code] or [RigidBody2D], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. [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]Vector2(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. + [i]TODO: Update for stop_on_slope argument.[/i] 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 occurred, use [method get_slide_collision]. </description> </method> + <method name="move_and_slide_with_snap"> + <return type="Vector2"> + </return> + <argument index="0" name="linear_velocity" type="Vector2"> + </argument> + <argument index="1" name="snap" type="Vector2"> + </argument> + <argument index="2" name="floor_normal" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <argument index="3" name="infinite_inertia" type="bool" default="true"> + </argument> + <argument index="4" name="stop_on_slope" type="bool" default="false"> + </argument> + <argument index="5" name="max_bounces" type="int" default="4"> + </argument> + <argument index="6" name="floor_max_angle" type="float" default="0.785398"> + </argument> + <description> + Moves the body while keeping it attached to slopes. Similar to [method move_and_slide]. + As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting[code]snap[/code] to[code](0, 0)[/code] or by using [method move_and_slide] instead. + </description> + </method> <method name="test_move"> <return type="bool"> </return> @@ -96,6 +126,8 @@ </argument> <argument index="1" name="rel_vec" type="Vector2"> </argument> + <argument index="2" name="infinite_inertia" type="bool"> + </argument> <description> Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given [Transform2D], then tries to move the body along the vector [code]rel_vec[/code]. Returns [code]true[/code] if a collision would occur. </description> @@ -105,6 +137,9 @@ <member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin"> If the body is at least this close to another body, this body will consider them to be colliding. </member> + <member name="motion/sync_to_physics" type="bool" setter="set_sync_to_physics" getter="is_sync_to_physics_enabled"> + If [code]true[/code] the body's movement will be synchronized to the physics frame. This is useful when animating movement via [AnimationPlayer], for example on moving platforms. + </member> </members> <constants> </constants> diff --git a/doc/classes/KinematicCollision.xml b/doc/classes/KinematicCollision.xml index 29025910f8..87eb9e77b5 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.1-dev"> +<class name="KinematicCollision" inherits="Reference" category="Core" version="3.1"> <brief_description> Collision data for KinematicBody collisions. </brief_description> diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index b133703c65..e403ada0b9 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.1-dev"> +<class name="KinematicCollision2D" inherits="Reference" category="Core" version="3.1"> <brief_description> Collision data for KinematicBody2D collisions. </brief_description> diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 7dd07c0c8e..1e78a196b1 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Label" inherits="Control" category="Core" version="3.1-dev"> +<class name="Label" inherits="Control" category="Core" version="3.1"> <brief_description> Displays plain text in a line or wrapped inside a rectangle. For formatted text, use [RichTextLabel]. </brief_description> @@ -106,6 +106,8 @@ </theme_item> <theme_item name="font_color_shadow" type="Color"> </theme_item> + <theme_item name="font_outline_modulate" type="Color"> + </theme_item> <theme_item name="line_spacing" type="int"> </theme_item> <theme_item name="normal" type="StyleBox"> diff --git a/doc/classes/LargeTexture.xml b/doc/classes/LargeTexture.xml index f09f2aa82c..763b38f49e 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.1-dev"> +<class name="LargeTexture" inherits="Texture" category="Core" version="3.1"> <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 b99908256c..04191136a8 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.1-dev"> +<class name="Light" inherits="VisualInstance" category="Core" version="3.1"> <brief_description> Provides a base class for different kinds of light nodes. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html</link> </tutorials> <demos> </demos> @@ -15,28 +15,40 @@ </methods> <members> <member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only"> + If [code]true[/code] the light only appears in the editor and will not be visible at runtime. Default value:[code]false[/code]. </member> <member name="light_bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="Light.BakeMode"> + The light's bake mode. See [enum BakeMode]. </member> <member name="light_color" type="Color" setter="set_color" getter="get_color"> + The light's color. </member> <member name="light_cull_mask" type="int" setter="set_cull_mask" getter="get_cull_mask"> + The light will affect objects in the selected layers. </member> <member name="light_energy" type="float" setter="set_param" getter="get_param"> + The light's strength multiplier. </member> <member name="light_indirect_energy" type="float" setter="set_param" getter="get_param"> + Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. </member> <member name="light_negative" type="bool" setter="set_negative" getter="is_negative"> + If [code]true[/code] the light's effect is reversed, darkening areas and casting bright shadows. Default value: [code]false[/code]. </member> <member name="light_specular" type="float" setter="set_param" getter="get_param"> + The intensity of the specular blob in objects affected by the light. At [code]0[/code] the light becomes a pure diffuse light. </member> <member name="shadow_bias" type="float" setter="set_param" getter="get_param"> + Used to adjust shadow appearance. Too small a value results in self shadowing, while too large a value causes shadows to separate from casters. Adjust as needed. </member> <member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color"> + The color of shadows cast by this light. </member> <member name="shadow_contact" type="float" setter="set_param" getter="get_param"> + Attempts to reduce [member shadow_bias] gap. </member> <member name="shadow_enabled" type="bool" setter="set_shadow" getter="has_shadow"> + If [code]true[/code] the light will cast shadows. Default value: [code]false[/code]. </member> <member name="shadow_reverse_cull_face" type="bool" setter="set_shadow_reverse_cull_face" getter="get_shadow_reverse_cull_face"> </member> @@ -75,10 +87,13 @@ <constant name="PARAM_MAX" value="15" enum="Param"> </constant> <constant name="BAKE_DISABLED" value="0" enum="BakeMode"> + Light is ignored when baking. Note: hiding a light does [i]not[/i] affect baking. </constant> <constant name="BAKE_INDIRECT" value="1" enum="BakeMode"> + Only indirect lighting will be baked. Default value. </constant> <constant name="BAKE_ALL" value="2" enum="BakeMode"> + Both direct and indirect light will be baked. Note: you should hide the light if you don't want it to appear twice (dynamic and baked). </constant> </constants> </class> diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index b12cecacfc..f3903ffeae 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.1-dev"> +<class name="Light2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> Casts light in a 2D environment. </brief_description> diff --git a/doc/classes/LightOccluder2D.xml b/doc/classes/LightOccluder2D.xml index becfdd2ff2..38b9054411 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.1-dev"> +<class name="LightOccluder2D" inherits="Node2D" category="Core" version="3.1"> <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 89f43fc95d..c1682e71e5 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.1-dev"> +<class name="Line2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> A 2D line. </brief_description> @@ -117,5 +117,8 @@ <constant name="LINE_TEXTURE_TILE" value="1" enum="LineTextureMode"> Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly. </constant> + <constant name="LINE_TEXTURE_STRETCH" value="2" enum="LineTextureMode"> + Stretches the texture across the line. Import the texture with Repeat Disabled for best results. + </constant> </constants> </class> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index fa65180d89..c244b8b7a7 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.1-dev"> +<class name="LineEdit" inherits="Control" category="Core" version="3.1"> <brief_description> Control that provides single line string editing. </brief_description> @@ -88,6 +88,8 @@ <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="clear_button_enabled" type="bool" setter="set_clear_button_enabled" getter="is_clear_button_enabled"> + </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> @@ -110,7 +112,10 @@ Text shown when the [LineEdit] is empty. It is [b]not[/b] the [LineEdit]'s default value (see [member text]). </member> <member name="secret" type="bool" setter="set_secret" getter="is_secret"> - If [code]true[/code] every character is shown as "*". + If [code]true[/code], every character is replaced with the secret character (see [member secret_character]). + </member> + <member name="secret_character" type="String" setter="set_secret_character" getter="get_secret_character"> + The character to use to mask secret input (defaults to "*"). Only a single character can be used as the secret character. </member> <member name="text" type="String" setter="set_text" getter="get_text"> String value of the [LineEdit]. @@ -169,6 +174,12 @@ </constant> </constants> <theme_items> + <theme_item name="clear" type="Texture"> + </theme_item> + <theme_item name="clear_button_color" type="Color"> + </theme_item> + <theme_item name="clear_button_color_pressed" type="Color"> + </theme_item> <theme_item name="cursor_color" type="Color"> </theme_item> <theme_item name="focus" type="StyleBox"> diff --git a/doc/classes/LineShape2D.xml b/doc/classes/LineShape2D.xml index 8ff3c71a9c..4a5486583a 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.1-dev"> +<class name="LineShape2D" inherits="Shape2D" category="Core" version="3.1"> <brief_description> Line shape for 2D collisions. </brief_description> diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index b3a5f3fd7c..a09edfad89 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="LinkButton" inherits="BaseButton" category="Core" version="3.1-dev"> +<class name="LinkButton" inherits="BaseButton" category="Core" version="3.1"> <brief_description> - Simple button used to represent a link to some resource + Simple button used to represent a link to some resource. </brief_description> <description> This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page). diff --git a/doc/classes/Listener.xml b/doc/classes/Listener.xml index 0783c3ddba..720a7eafc5 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.1-dev"> +<class name="Listener" inherits="Spatial" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index 214c2569e9..9454a16988 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.1-dev"> +<class name="MainLoop" inherits="Object" category="Core" version="3.1"> <brief_description> Main loop is the abstract main loop base class. </brief_description> @@ -134,5 +134,7 @@ </constant> <constant name="NOTIFICATION_WM_ABOUT" value="91"> </constant> + <constant name="NOTIFICATION_CRASH" value="92"> + </constant> </constants> </class> diff --git a/doc/classes/MarginContainer.xml b/doc/classes/MarginContainer.xml index 80554192a0..15613e4bec 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.1-dev"> +<class name="MarginContainer" inherits="Container" category="Core" version="3.1"> <brief_description> Simple margin container. </brief_description> diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index 44ff094971..687f81eec7 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.1-dev"> +<class name="Marshalls" inherits="Reference" category="Core" version="3.1"> <brief_description> Data transformation (marshalling) and encoding helpers. </brief_description> diff --git a/doc/classes/Material.xml b/doc/classes/Material.xml index fa53ce11da..7420a5deb0 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.1-dev"> +<class name="Material" inherits="Resource" category="Core" version="3.1"> <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 333326b730..c9a8d3ce7a 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.1-dev"> +<class name="MenuButton" inherits="Button" category="Core" version="3.1"> <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 6e60809999..afb5d7db93 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.1-dev"> +<class name="Mesh" inherits="Resource" category="Core" version="3.1"> <brief_description> A [Resource] that contains vertex-array based geometry. </brief_description> @@ -121,7 +121,7 @@ </constant> <constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288" enum="ArrayFormat"> </constant> - <constant name="ARRAY_COMPRESS_DEFAULT" value="97792" enum="ArrayFormat"> + <constant name="ARRAY_COMPRESS_DEFAULT" value="97280" enum="ArrayFormat"> </constant> <constant name="ARRAY_VERTEX" value="0" enum="ArrayType"> </constant> diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml index eff6bd2c61..43d94004a8 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.1-dev"> +<class name="MeshDataTool" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/MeshInstance.xml b/doc/classes/MeshInstance.xml index d70123239a..ef42726ca9 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.1-dev"> +<class name="MeshInstance" inherits="GeometryInstance" category="Core" version="3.1"> <brief_description> Node that instances meshes into a scenario. </brief_description> diff --git a/doc/classes/MeshInstance2D.xml b/doc/classes/MeshInstance2D.xml new file mode 100644 index 0000000000..7f0136bf77 --- /dev/null +++ b/doc/classes/MeshInstance2D.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MeshInstance2D" inherits="Node2D" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> + </member> + <member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map"> + </member> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index 40776d095a..3726524638 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.1-dev"> +<class name="MeshLibrary" inherits="Resource" category="Core" version="3.1"> <brief_description> Library of meshes. </brief_description> diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index f5bd0885d3..b78d82199c 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.1-dev"> +<class name="MultiMesh" inherits="Resource" category="Core" version="3.1"> <brief_description> Provides high performance mesh instancing. </brief_description> diff --git a/doc/classes/MultiMeshInstance.xml b/doc/classes/MultiMeshInstance.xml index 0ffdb3c928..5e021dfe9b 100644 --- a/doc/classes/MultiMeshInstance.xml +++ b/doc/classes/MultiMeshInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MultiMeshInstance" inherits="GeometryInstance" category="Core" version="3.1-dev"> +<class name="MultiMeshInstance" inherits="GeometryInstance" category="Core" version="3.1"> <brief_description> Node that instances a [MultiMesh]. </brief_description> diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml new file mode 100644 index 0000000000..10e7f1b172 --- /dev/null +++ b/doc/classes/MultiplayerAPI.xml @@ -0,0 +1,165 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MultiplayerAPI" inherits="Reference" category="Core" version="3.1"> + <brief_description> + High Level Multiplayer API. + </brief_description> + <description> + This class implements most of the logic behind the high level multiplayer API. + By default, [SceneTree] has a reference to this class that is used to provide multiplayer capabilities (i.e. RPC/RSET) across the whole scene. + It is possible to override the MultiplayerAPI instance used by specific Nodes by setting the [member Node.custom_multiplayer] property, effectively allowing to run both client and server in the same scene. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear"> + <return type="void"> + </return> + <description> + Clears the current MultiplayerAPI network state (you shouldn't call this unless you know what you are doing). + </description> + </method> + <method name="get_network_connected_peers" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <description> + Returns the peer IDs of all connected peers of this MultiplayerAPI's [member network_peer]. + </description> + </method> + <method name="get_network_unique_id" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the unique peer ID of this MultiplayerAPI's [member network_peer]. + </description> + </method> + <method name="get_rpc_sender_id" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the sender's peer ID for the RPC currently being executed. + NOTE: If not inside an RPC this method will return 0. + </description> + </method> + <method name="has_network_peer" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if there is a [member network_peer] set. + </description> + </method> + <method name="is_network_server" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if this MultiplayerAPI's [member network_peer] is in server mode (listening for connections). + </description> + </method> + <method name="poll"> + <return type="void"> + </return> + <description> + Method used for polling the MultiplayerAPI. You only need to worry about this if you are using [member Node.custom_multiplayer] override or you set [member SceneTree.multiplayer_poll] to [code]false[/code]. By default [SceneTree] will poll its MultiplayerAPI for you. + NOTE: This method results in RPCs and RSETs being called, so they will be executed in the same context of this function (e.g. [code]_process[/code], [code]physics[/code], [Thread]). + </description> + </method> + <method name="send_bytes"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="bytes" type="PoolByteArray"> + </argument> + <argument index="1" name="id" type="int" default="0"> + </argument> + <argument index="2" name="mode" type="int" enum="NetworkedMultiplayerPeer.TransferMode" default="2"> + </argument> + <description> + Sends the given raw [code]bytes[/code] to a specific peer identified by [code]id[/code] (see [method NetworkedMultiplayerPeer.set_target_peer]). Default ID is [code]0[/code], i.e. broadcast to all peers. + </description> + </method> + <method name="set_root_node"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + Sets the base root node to use for RPCs. Instead of an absolute path, a relative path will be used to find the node upon which the RPC should be executed. + This effectively allows to have different branches of the scene tree to be managed by different MultiplayerAPI, allowing for example to run both client and server in the same scene. + </description> + </method> + </methods> + <members> + <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 MultiplayerAPI 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 MultiplayerAPI's signals. + </member> + <member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections"> + If [code]true[/code] the MultiplayerAPI's [member network_peer] refuses new incoming connections. + </member> + </members> + <signals> + <signal name="connected_to_server"> + <description> + Emitted whenever this MultiplayerAPI's [member network_peer] successfully connected to a server. Only emitted on clients. + </description> + </signal> + <signal name="connection_failed"> + <description> + Emitted whenever this MultiplayerAPI's [member network_peer] fails to establish a connection to a server. Only emitted on clients. + </description> + </signal> + <signal name="network_peer_connected"> + <argument index="0" name="id" type="int"> + </argument> + <description> + Emitted whenever this MultiplayerAPI's [member network_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). + </description> + </signal> + <signal name="network_peer_disconnected"> + <argument index="0" name="id" type="int"> + </argument> + <description> + Emitted whenever this MultiplayerAPI's [member network_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server. + </description> + </signal> + <signal name="network_peer_packet"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="packet" type="PoolByteArray"> + </argument> + <description> + Emitted whenever this MultiplayerAPI's [member network_peer] receive a [code]packet[/code] with custom data (see [method send_bytes]). ID is the peer ID of the peer that sent the packet. + </description> + </signal> + <signal name="server_disconnected"> + <description> + Emitted whenever this MultiplayerAPI's [member network_peer] disconnects from server. Only emitted on clients. + </description> + </signal> + </signals> + <constants> + <constant name="RPC_MODE_DISABLED" value="0" enum="RPCMode"> + Used with [method Node.rpc_config] or [method Node.rset_config] to disable a method or property for all RPC calls, making it unavailable. Default for all methods. + </constant> + <constant name="RPC_MODE_REMOTE" value="1" enum="RPCMode"> + Used with [method Node.rpc_config] or [method Node.rset_config] to set a method to be called or a property to be changed only on the remote end, not locally. Analogous to the [code]remote[/code] keyword. Calls and property changes are accepted from all remote peers, no matter if they are node's master or slaves. + </constant> + <constant name="RPC_MODE_SYNC" value="2" enum="RPCMode"> + Behave like [code]RPC_MODE_REMOTE[/code] but also make the call or property change locally. Analogous to the [code]sync[/code] keyword. + </constant> + <constant name="RPC_MODE_MASTER" value="3" enum="RPCMode"> + Used with [method Node.rpc_config] or [method Node.rset_config] to set a method to be called or a property to be changed only on the network master for this node. Analogous to the [code]master[/code] keyword. Only accepts calls or property changes from the node's network slaves, see [method Node.set_network_master]. + </constant> + <constant name="RPC_MODE_SLAVE" value="4" enum="RPCMode"> + Used with [method Node.rpc_config] or [method Node.rset_config] to set a method to be called or a property to be changed only on slaves for this node. Analogous to the [code]slave[/code] keyword. Only accepts calls or property changes from the node's network master, see [method Node.set_network_master]. + </constant> + <constant name="RPC_MODE_REMOTESYNC" value="5" enum="RPCMode"> + Behave like [code]RPC_MODE_REMOTE[/code] but also make the call or property change locally. Same as [code]RPC_MODE_SYNC[/code] which is only kept for compatibility. Analogous to the [code]remotesync[/code] keyword. + </constant> + <constant name="RPC_MODE_MASTERSYNC" value="6" enum="RPCMode"> + Behave like [code]RPC_MODE_MASTER[/code] but also make the call or property change locally. Analogous to the [code]mastersync[/code] keyword. + </constant> + <constant name="RPC_MODE_SLAVESYNC" value="7" enum="RPCMode"> + Behave like [code]RPC_MODE_SLAVE[/code] but also make the call or property change locally. Analogous to the [code]slavesync[/code] keyword. + </constant> + </constants> +</class> diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index ce3a4cc45a..8f2751af98 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.1-dev"> +<class name="Mutex" inherits="Reference" category="Core" version="3.1"> <brief_description> A synchronization Mutex. </brief_description> diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index e2be70979d..08f22d49d3 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Navigation" inherits="Spatial" category="Core" version="3.1-dev"> +<class name="Navigation" inherits="Spatial" category="Core" version="3.1"> <brief_description> - A collection of [code]NavigationMesh[/code] resources and methods used for pathfinding. + Mesh-based navigation and pathfinding node. </brief_description> <description> - The Navigation node is used for basic or advanced navigation. By default it will automatically collect all child [code]NavigationMesh[/code] resources, but they can also be added on the fly through scripting. It can be used for generating a simple path between two points or it can be used to ensure that a navigation agent is angled perfectly to the terrain it is navigating. + Provides navigation and pathfinding within a collection of [NavigationMesh]es. By default these will be automatically collected from child [NavigationMeshInstance] nodes, but they can also be added on the fly with [method navmesh_add]. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. </description> <tutorials> </tutorials> @@ -17,7 +17,7 @@ <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Returns the closest navigation point to the point passed. + Returns the navigation point closest to the point given. Points are in local coordinate space. </description> </method> <method name="get_closest_point_normal"> @@ -26,7 +26,7 @@ <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Returns the surface normal of the navigation mesh at the point passed. For instance, if the point passed was at a 45 degree slope it would return something like (0.5,0.5,0). This is useful for rotating a navigation agent in accordance with the [code]NavigationMesh[/code]. + Returns the surface normal at the navigation point closest to the point given. Useful for rotating a navigation agent according to the navigation mesh it moves on. </description> </method> <method name="get_closest_point_owner"> @@ -35,7 +35,7 @@ <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Returns the nearest [code]NavigationMeshInstance[/code] to the point passed. + Returns the owner of the [NavigationMesh] which contains the navigation point closest to the point given. This is usually a [NavigtionMeshInstance]. For meshes added via [method navmesh_add], returns the owner that was given (or [code]null[/code] if the [code]owner[/code] parameter was omitted). </description> </method> <method name="get_closest_point_to_segment"> @@ -48,7 +48,7 @@ <argument index="2" name="use_collision" type="bool" default="false"> </argument> <description> - Returns the nearest point to the line segment passed. The third optional parameter takes collisions into account. + Returns the navigation point closest to the given line segment. When enabling [code]use_collision[/code], only considers intersection points between segment and navigation meshes. If multiple intersection points are found, the one closest to the segment start point is returned. </description> </method> <method name="get_simple_path"> @@ -61,7 +61,7 @@ <argument index="2" name="optimize" type="bool" default="true"> </argument> <description> - Returns a path of points as a [code]PoolVector3Array[/code]. If [code]optimize[/code] is false the [code]NavigationMesh[/code] agent properties will be taken into account, otherwise it will return the nearest path and ignore agent radius, height, etc. + Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the agent properties associated with each [NavigationMesh] (raidus, height, etc.) are considered in the path calculation, otherwise they are ignored. </description> </method> <method name="navmesh_add"> @@ -74,7 +74,7 @@ <argument index="2" name="owner" type="Object" default="null"> </argument> <description> - Adds a [code]NavigationMesh[/code] to the list of NavigationMesh's in this node. Returns an id. Its position, rotation and scale are associated with the [code]Transform[/code] passed. The [code]Node[/code] (or [code]Object[/code]) that owns this node is an optional parameter. + Adds a [NavigationMesh]. Returns an ID for use with [method navmesh_remove] or [method navmesh_set_transform]. If given, a [Transform2D] is applied to the polygon. The optional [code]owner[/code] is used as return value for [method get_closest_point_owner]. </description> </method> <method name="navmesh_remove"> @@ -83,7 +83,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Removes a [code]NavigationMesh[/code] from the list of NavigationMesh's in this node. + Removes the [NavigationMesh] with the given ID. </description> </method> <method name="navmesh_set_transform"> @@ -94,13 +94,13 @@ <argument index="1" name="xform" type="Transform"> </argument> <description> - Associates a [code]NavigationMesh[/code]'s id with a [code]Transform[/code]. Its position, rotation and scale are based on the [code]Transform[/code] passed. + Sets the transform applied to the [NavigationMesh] with the given ID. </description> </method> </methods> <members> <member name="up_vector" type="Vector3" setter="set_up_vector" getter="get_up_vector"> - Defines which direction is up. The default defines 0,1,0 as up which is the world up direction. To make this a ceiling use 0,-1,0 to define down as up. + Defines which direction is up. By default this is [code](0, 1, 0)[/code], which is the world up direction. </member> </members> <constants> diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml index 4709dab3e8..364da55f99 100644 --- a/doc/classes/Navigation2D.xml +++ b/doc/classes/Navigation2D.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Navigation2D" inherits="Node2D" category="Core" version="3.1-dev"> +<class name="Navigation2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> + 2D navigation and pathfinding node. </brief_description> <description> + Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of [NavigationPolygon] resources. By default these are automatically collected from child [NavigationPolygonInstance] nodes, but they can also be added on the fly with [method navpoly_add]. </description> <tutorials> </tutorials> @@ -15,6 +17,7 @@ <argument index="0" name="to_point" type="Vector2"> </argument> <description> + Returns the navigation point closest to the point given. Points are in local coordinate space. </description> </method> <method name="get_closest_point_owner"> @@ -23,6 +26,7 @@ <argument index="0" name="to_point" type="Vector2"> </argument> <description> + Returns the owner of the [NavigationPolygon] which contains the navigation point closest to the point given. This is usually a [NavigtionPolygonInstance]. For polygons added via [method navpoly_add], returns the owner that was given (or [code]null[/code] if the [code]owner[/code] parameter was omitted). </description> </method> <method name="get_simple_path"> @@ -35,6 +39,7 @@ <argument index="2" name="optimize" type="bool" default="true"> </argument> <description> + Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the path is smoothed by merging path segments where possible. </description> </method> <method name="navpoly_add"> @@ -47,6 +52,7 @@ <argument index="2" name="owner" type="Object" default="null"> </argument> <description> + Adds a [NavigationPolygon]. Returns an ID for use with [method navpoly_remove] or [method navpoly_set_transform]. If given, a [Transform2D] is applied to the polygon. The optional [code]owner[/code] is used as return value for [method get_closest_point_owner]. </description> </method> <method name="navpoly_remove"> @@ -55,6 +61,7 @@ <argument index="0" name="id" type="int"> </argument> <description> + Removes the [NavigationPolygon] with the given ID. </description> </method> <method name="navpoly_set_transform"> @@ -65,6 +72,7 @@ <argument index="1" name="xform" type="Transform2D"> </argument> <description> + Sets the transform applied to the [NavigationPolygon] with the given ID. </description> </method> </methods> diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 34ca1f852e..f0654e5b12 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.1-dev"> +<class name="NavigationMesh" inherits="Resource" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/NavigationMeshInstance.xml b/doc/classes/NavigationMeshInstance.xml index 48b7e3a8ef..643bfc726f 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.1-dev"> +<class name="NavigationMeshInstance" inherits="Spatial" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index b8865a24b3..b29e19e5d8 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.1-dev"> +<class name="NavigationPolygon" inherits="Resource" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/NavigationPolygonInstance.xml b/doc/classes/NavigationPolygonInstance.xml index db9b691ef1..ff95f652f1 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.1-dev"> +<class name="NavigationPolygonInstance" inherits="Node2D" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index 794886dd64..e878b3a746 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.1-dev"> +<class name="NetworkedMultiplayerPeer" inherits="PacketPeer" category="Core" version="3.1"> <brief_description> A high-level network interface to simplify multiplayer interactions. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/networking/high_level_multiplayer.html</link> </tutorials> <demos> </demos> @@ -46,7 +46,8 @@ <argument index="0" name="id" type="int"> </argument> <description> - The peer to which packets will be sent. Default value: [code]0[/code]. + Sets the peer to which packets will be sent. + The [code]id[/code] can be one of: [code]TARGET_PEER_BROADCAST[/code] to send to all connected peers, [code]TARGET_PEER_SERVER[/code] to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. Default: [code]TARGET_PEER_BROADCAST[/code] </description> </method> </methods> diff --git a/doc/classes/Nil.xml b/doc/classes/Nil.xml index 46c972d4d5..e09dba6511 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.1-dev"> +<class name="Nil" category="Built-In Types" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index ce6fe26e07..f40b32951f 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.1-dev"> +<class name="NinePatchRect" inherits="Control" category="Core" version="3.1"> <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 e272e14d08..d02e3dfdfa 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Node" inherits="Object" category="Core" version="3.1-dev"> +<class name="Node" inherits="Object" category="Core" version="3.1"> <brief_description> Base class for all [i]scene[/i] objects. </brief_description> <description> Nodes are Godot's building blocks. They can be assigned as the child of another node, resulting in a tree arrangement. A given node can contain any number of nodes as children with the requirement that all siblings (direct children of a node) should have unique names. - A tree of nodes is called a [i]scene[/i]. Scenes can be saved to the disk and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of Godot projects. Nodes can also optionally be added to groups. This makes it possible to access a number of nodes from code (an "enemies" group, for example) to perform grouped actions. + A tree of nodes is called a [i]scene[/i]. Scenes can be saved to the disk and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of Godot projects. [b]Scene tree:[/b] The [SceneTree] contains the active tree of nodes. When a node is added to the scene tree, it receives the NOTIFICATION_ENTER_TREE notification and its [method _enter_tree] callback is triggered. Child nodes are always added [i]after[/i] their parent node, i.e. the [method _enter_tree] callback of a parent node will be triggered before its child's. Once all nodes have been added in the scene tree, they receive the NOTIFICATION_READY notification and their respective [method _ready] callbacks are triggered. For groups of nodes, the [method _ready] callback is called in reverse order, starting with the children and moving up to the parent nodes. This means that when adding a node to the scene tree, the following order will be used for the callbacks: [method _enter_tree] of the parent, [method _enter_tree] of the children, [method _ready] of the children and finally [method _ready] of the parent (recursively for the entire scene tree). @@ -13,10 +13,11 @@ Nodes can also process input events. When present, the [method _input] function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the [method _unhandled_input] function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI [Control] nodes), ensuring that the node only receives the events that were meant for it. To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with [method set_owner]. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed with [method free] or [method queue_free], it will also free all its children. - [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). + [b]Groups:[/b] Nodes can be added to as many groups as you want to be easy to manage, you could create groups like "enemies" or "collectables" for example, depending on your game. See [method add_to_group], [method is_in_group] and [method remove_from_group]. You can then retrieve all nodes in these groups, iterate them and even call methods on groups via the methods on [SceneTree]. + [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). To identify which node receives the RPC call Godot will use its [NodePath] (make sure node names are the same on all peers). Also take a look at the high-level networking tutorial and corresponding demos. </description> <tutorials> - http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scenes_and_nodes.html + <link>http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scenes_and_nodes.html</link> </tutorials> <demos> </demos> @@ -37,6 +38,12 @@ 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="_get_configuration_warning" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> <method name="_input" qualifiers="virtual"> <return type="void"> </return> @@ -45,6 +52,8 @@ <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 overridden, and can be toggled with [method set_process_input]. + To consume the input event and stop it propagating further to other nodes, [method SceneTree.set_input_as_handled] can be called. + For gameplay input, [method _unhandled_input] and [method _unhandled_key_input] are usually a better fit as they allow the GUI to intercept the events first. </description> </method> <method name="_physics_process" qualifiers="virtual"> @@ -74,7 +83,8 @@ </return> <description> Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their [method _ready] callbacks get triggered first, and the parent node will receive the ready notification afterwards. - Corresponds to the NOTIFICATION_READY notification in [method Object._notification]. + Corresponds to the NOTIFICATION_READY notification in [method Object._notification]. See also the [code]onready[/code] keyword for variables. + Usually used for initialization. For even earlier initialization, [method Object._init] may be used. Also see [method _enter_tree]. </description> </method> <method name="_unhandled_input" qualifiers="virtual"> @@ -83,8 +93,10 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> - Propagated to all nodes when the previous InputEvent is not consumed by any nodes. + 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 overridden, and can be toggled with [method set_process_unhandled_input]. + To consume the input event and stop it propagating further to other nodes, [method SceneTree.set_input_as_handled] can be called. + For gameplay input, this and [method _unhandled_key_input] are usually a better fit than [method _input] as they allow the GUI to intercept the events first. </description> </method> <method name="_unhandled_key_input" qualifiers="virtual"> @@ -93,6 +105,10 @@ <argument index="0" name="event" type="InputEventKey"> </argument> <description> + Propagated to all nodes when the previous [InputEventKey] is not consumed by any nodes. + It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_key_input]. + To consume the input event and stop it propagating further to other nodes, [method SceneTree.set_input_as_handled] can be called. + For gameplay input, this and [method _unhandled_input] are usually a better fit than [method _input] as they allow the GUI to intercept the events first. </description> </method> <method name="add_child"> @@ -129,7 +145,7 @@ <argument index="1" name="persistent" type="bool" default="false"> </argument> <description> - Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see [method is_inside_tree]). + Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see [method is_inside_tree]). See notes in the description, and the group methods in [SceneTree]. </description> </method> <method name="can_process" qualifiers="const"> @@ -203,7 +219,7 @@ <return type="int"> </return> <description> - Returns the peer ID of the network master for this node. + Returns the peer ID of the network master for this node. See [method set_network_master]. </description> </method> <method name="get_node" qualifiers="const"> @@ -213,8 +229,8 @@ </argument> <description> Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a [code]null instance[/code] is returned and attempts to access it will result in an "Attempt to call <method> on a null instance." error. - Note: fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). - [i]Example:[/i] Assume your current node is Character and the following tree: + [b]Note:[/b] Fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). + [b]Example:[/b] Assume your current node is Character and the following tree: [codeblock] /root /root/Character @@ -262,7 +278,7 @@ <argument index="0" name="node" type="Node"> </argument> <description> - Returns the relative path from the current node to the specified node in "node" argument. Both nodes must be in the same scene, or the function will fail. + Returns the relative [NodePath] from this node to the specified [code]node[/code]. Both nodes must be in the same scene or the function will fail. </description> </method> <method name="get_physics_process_delta_time" qualifiers="const"> @@ -290,6 +306,7 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if this is an instance load placeholder. See [InstancePlaceholder]. </description> </method> <method name="get_tree" qualifiers="const"> @@ -354,7 +371,7 @@ <argument index="0" name="group" type="String"> </argument> <description> - Returns [code]true[/code] if this node is in the specified group. + Returns [code]true[/code] if this node is in the specified group. See notes in the description, and the group methods in [SceneTree]. </description> </method> <method name="is_inside_tree" qualifiers="const"> @@ -368,6 +385,7 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if the local system is the master of this node. </description> </method> <method name="is_physics_processing" qualifiers="const"> @@ -381,6 +399,7 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if internal physics processing is enabled (see [method set_physics_process_internal]). </description> </method> <method name="is_processing" qualifiers="const"> @@ -401,6 +420,7 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if internal processing is enabled (see [method set_process_internal]). </description> </method> <method name="is_processing_unhandled_input" qualifiers="const"> @@ -432,13 +452,37 @@ <return type="void"> </return> <description> + Prints all stray nodes (nodes outside the [SceneTree]). Used for debugging. Works only in debug builds. </description> </method> <method name="print_tree"> <return type="void"> </return> <description> - Prints the scene to stdout. Used mainly for debugging purposes. + Prints the tree to stdout. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the [method get_node] function. Example output: + [codeblock] + TheGame + TheGame/Menu + TheGame/Menu/Label + TheGame/Menu/Camera2D + TheGame/SplashScreen + TheGame/SplashScreen/Camera2D + [/codeblock] + </description> + </method> + <method name="print_tree_pretty"> + <return type="void"> + </return> + <description> + Similar to [method print_tree], this prints the tree to stdout. This version displays a more graphical representation similar to what is displayed in the scene inspector. It is useful for inspecting larger trees. Example output: + [codeblock] + ┖╴TheGame + ┠╴Menu + ┃ ┠╴Label + ┃ ┖╴Camera2D + ┖-SplashScreen + ┖╴Camera2D + [/codeblock] </description> </method> <method name="propagate_call"> @@ -499,7 +543,7 @@ <argument index="0" name="group" type="String"> </argument> <description> - Removes a node from a group. + Removes a node from a group. See notes in the description, and the group methods in [SceneTree]. </description> </method> <method name="replace_by"> @@ -526,7 +570,7 @@ <argument index="0" name="method" type="String"> </argument> <description> - Sends a remote procedure call request to all peers on the network (and locally), optionally sending additional data as arguments. Call request will be received by nodes with the same [NodePath]. + Sends a remote procedure call request for the given [code]method[/code] to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same [NodePath], including the exact same node name. Behaviour depends on the RPC configuration for the given method, see [method rpc_config]. Methods are not exposed to RPCs by default. Also see [method rset] and [method rset_config] for properties. Returns an empty [Variant]. Note that you can only safely use RPCs on clients after you received the [code]connected_to_server[/code] signal from the [SceneTree]. You also need to keep track of the connection state, either by the [SceneTree] signals like [code]server_disconnected[/code] or by checking [code]SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED[/code]. </description> </method> <method name="rpc_config"> @@ -534,10 +578,10 @@ </return> <argument index="0" name="method" type="String"> </argument> - <argument index="1" name="mode" type="int" enum="Node.RPCMode"> + <argument index="1" name="mode" type="int" enum="MultiplayerAPI.RPCMode"> </argument> <description> - Changes the method's RPC mode (one of RPC_MODE_* constants). + Changes the RPC mode for the given [code]method[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]sync[/code], [code]master[/code], [code]slave[/code]). By default, methods are not exposed to networking (and RPCs). Also see [method rset] and [method rset_config] for properties. </description> </method> <method name="rpc_id" qualifiers="vararg"> @@ -548,7 +592,7 @@ <argument index="1" name="method" type="String"> </argument> <description> - Sends a [method rpc] to a specific peer identified by [i]peer_id[/i]. + Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] (see [method NetworkedMultiplayerPeer.set_target_peer]). Returns an empty [Variant]. </description> </method> <method name="rpc_unreliable" qualifiers="vararg"> @@ -557,7 +601,7 @@ <argument index="0" name="method" type="String"> </argument> <description> - Sends a [method rpc] using an unreliable protocol. + Sends a [method rpc] using an unreliable protocol. Returns an empty [Variant]. </description> </method> <method name="rpc_unreliable_id" qualifiers="vararg"> @@ -568,7 +612,7 @@ <argument index="1" name="method" type="String"> </argument> <description> - Sends a [method rpc] to a specific peer identified by [i]peer_id[/i] using an unreliable protocol. + Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] using an unreliable protocol (see [method NetworkedMultiplayerPeer.set_target_peer]). Returns an empty [Variant]. </description> </method> <method name="rset"> @@ -579,7 +623,7 @@ <argument index="1" name="value" type="Variant"> </argument> <description> - Remotely changes property's value on other peers (and locally). + Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see [method rset_config]. Also see [method rpc] for RPCs for methods, most information applies to this method as well. </description> </method> <method name="rset_config"> @@ -587,10 +631,10 @@ </return> <argument index="0" name="property" type="String"> </argument> - <argument index="1" name="mode" type="int" enum="Node.RPCMode"> + <argument index="1" name="mode" type="int" enum="MultiplayerAPI.RPCMode"> </argument> <description> - Changes the property's RPC mode (one of RPC_MODE_* constants). + Changes the RPC mode for the given [code]property[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]sync[/code], [code]master[/code], [code]slave[/code]). By default, properties are not exposed to networking (and RPCs). Also see [method rpc] and [method rpc_config] for methods. </description> </method> <method name="rset_id"> @@ -603,7 +647,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Remotely changes property's value on a specific peer identified by [i]peer_id[/i]. + Remotely changes the property's value on a specific peer identified by [code]peer_id[/code] (see [method NetworkedMultiplayerPeer.set_target_peer]). </description> </method> <method name="rset_unreliable"> @@ -614,7 +658,7 @@ <argument index="1" name="value" type="Variant"> </argument> <description> - Remotely changes property's value on other peers (and locally) using an unreliable protocol. + Remotely changes the property's value on other peers (and locally) using an unreliable protocol. </description> </method> <method name="rset_unreliable_id"> @@ -627,7 +671,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Remotely changes property's value on a specific peer identified by [i]peer_id[/i] using an unreliable protocol. + Remotely changes property's value on a specific peer identified by [code]peer_id[/code] using an unreliable protocol (see [method NetworkedMultiplayerPeer.set_target_peer]). </description> </method> <method name="set_display_folded"> @@ -647,7 +691,7 @@ <argument index="1" name="recursive" type="bool" default="true"> </argument> <description> - Sets the node network master to the peer with the given peer ID. The network master is the peer that has authority over it on the network. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server). + Sets the node's network master to the peer with the given peer ID. The network master is the peer that has authority over the node on the network. Useful in conjunction with the [code]master[/code] and [code]slave[/code] keywords. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server). If [code]recursive[/code], the given peer is recursively set as the master for all children of this node. </description> </method> <method name="set_physics_process"> @@ -665,6 +709,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal [method _physics_process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting ([method set_physics_process]). Only useful for advanced uses to manipulate built-in nodes behaviour. </description> </method> <method name="set_process"> @@ -691,6 +736,15 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal [method _process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting ([method set_process]). Only useful for advanced uses to manipulate built-in nodes behaviour. + </description> + </method> + <method name="set_process_priority"> + <return type="void"> + </return> + <argument index="0" name="priority" type="int"> + </argument> + <description> </description> </method> <method name="set_process_unhandled_input"> @@ -717,24 +771,36 @@ <argument index="0" name="load_placeholder" type="bool"> </argument> <description> + Sets whether this is an instance load placeholder. See [InstancePlaceholder]. </description> </method> </methods> <members> + <member name="custom_multiplayer" type="MultiplayerAPI" setter="set_custom_multiplayer" getter="get_custom_multiplayer"> + The override to the default [MultiplayerAPI]. Set to null to use the default SceneTree one. + </member> <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="multiplayer" type="MultiplayerAPI" setter="" getter="get_multiplayer"> + The [MultiplayerAPI] instance associated with this node. Either the [member custom_multiplayer], or the default SceneTree one (if inside tree). + </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 + 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. + The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using [PackedScene]) all the nodes it owns will be saved with it. This allows for the creation of complex [SceneTree]s, with instancing and subinstancing. </member> <member name="pause_mode" type="int" setter="set_pause_mode" getter="get_pause_mode" enum="Node.PauseMode"> + Pause mode. How the node will behave if the [SceneTree] is paused. </member> </members> <signals> + <signal name="ready"> + <description> + Emitted when the node is ready. + </description> + </signal> <signal name="renamed"> <description> Emitted when the node is renamed. @@ -752,7 +818,7 @@ </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. + Emitted when the node is still active but about to exit the tree. This is the right place for de-initialization (or a "destructor", if you will). </description> </signal> </signals> @@ -800,33 +866,22 @@ Notification received when the node's [NodePath] changed. </constant> <constant name="NOTIFICATION_TRANSLATION_CHANGED" value="24"> + Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like [method Object.tr]. </constant> <constant name="NOTIFICATION_INTERNAL_PROCESS" value="25"> + Notification received every frame when the internal process flag is set (see [method set_process_internal]). </constant> <constant name="NOTIFICATION_INTERNAL_PHYSICS_PROCESS" value="26"> - </constant> - <constant name="RPC_MODE_DISABLED" value="0" enum="RPCMode"> - </constant> - <constant name="RPC_MODE_REMOTE" value="1" enum="RPCMode"> - Call a method remotely. - </constant> - <constant name="RPC_MODE_SYNC" value="2" enum="RPCMode"> - Call a method both remotely and locally. - </constant> - <constant name="RPC_MODE_MASTER" value="3" enum="RPCMode"> - Call a method if the Node is Master. - </constant> - <constant name="RPC_MODE_SLAVE" value="4" enum="RPCMode"> - Call a method if the Node is Slave. + Notification received every frame when the internal physics process flag is set (see [method set_physics_process_internal]). </constant> <constant name="PAUSE_MODE_INHERIT" value="0" enum="PauseMode"> - Inherits pause mode from parent. For root node, it is equivalent to PAUSE_MODE_STOP. + Inherits pause mode from the node's parent. For the root node, it is equivalent to PAUSE_MODE_STOP. Default. </constant> <constant name="PAUSE_MODE_STOP" value="1" enum="PauseMode"> - Stop processing when SceneTree is paused. + Stop processing when the [SceneTree] is paused. </constant> <constant name="PAUSE_MODE_PROCESS" value="2" enum="PauseMode"> - Continue to process regardless of SceneTree pause state. + Continue to process regardless of the [SceneTree] pause state. </constant> <constant name="DUPLICATE_SIGNALS" value="1" enum="DuplicateFlags"> Duplicate the node's signals. diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 0b462967a1..13eabeca17 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.1-dev"> +<class name="Node2D" inherits="CanvasItem" category="Core" version="3.1"> <brief_description> A 2D game object, parent of all 2D related nodes. Has a position, rotation, scale and Z-index. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/2d/custom_drawing_in_2d.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index 48effa5918..f589fa12b7 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.1-dev"> +<class name="NodePath" category="Built-In Types" version="3.1"> <brief_description> Pre-parsed scene tree path. </brief_description> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index f37c80efc9..cf86176086 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.1-dev"> +<class name="OS" inherits="Object" category="Core" version="3.1"> <brief_description> Operating System functions. </brief_description> @@ -40,6 +40,7 @@ <return type="void"> </return> <description> + Centers the window on the screen if in windowed mode. </description> </method> <method name="delay_msec" qualifiers="const"> @@ -48,7 +49,7 @@ <argument index="0" name="msec" type="int"> </argument> <description> - Delay executing of the current thread by given milliseconds. + Delay execution of the current thread by given milliseconds. </description> </method> <method name="delay_usec" qualifiers="const"> @@ -57,7 +58,7 @@ <argument index="0" name="usec" type="int"> </argument> <description> - Delay executing of the current thread by given microseconds. + Delay execution of the current thread by given microseconds. </description> </method> <method name="dump_memory_to_file"> @@ -67,7 +68,7 @@ </argument> <description> Dumps the memory allocation ringlist to a file (only works in debug). - Entry format per line: "Address - Size - Description" + Entry format per line: "Address - Size - Description". </description> </method> <method name="dump_resources_to_file"> @@ -77,7 +78,7 @@ </argument> <description> Dumps all used resources to file (only works in debug). - Entry format per line: "Resource Type : Resource Location" + Entry format per line: "Resource Type : Resource Location". At the end of the file is a statistic of all used Resource Types. </description> </method> @@ -93,17 +94,24 @@ <argument index="3" name="output" type="Array" default="[ ]"> </argument> <description> - 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: + Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable. + The arguments are used in the given order and separated by a space, so [code]OS.execute('ping', ['-c', '3', 'godotengine.org'])[/code] will resolve to [code]ping -c 3 godotengine.org[/code] in the system's shell. + This method has slightly different behaviour based on whether the [code]blocking[/code] mode is enabled. + When [code]blocking[/code] is enabled, the Godot thread will pause its execution while waiting for the process to terminate. The shell output of the process will be written to the [code]output[/code] array as a single string. When the process terminates, the Godot thread will resume execution. + When [code]blocking[/code] is disabled, the Godot thread will continue while the new process runs. It is not possible to retrieve the shell output in non-blocking mode, so [code]output[/code] will be empty. + The return value also depends on the blocking mode. When blocking, the method will return -2 (no process ID information is available in blocking mode). When non-blocking, the method returns a process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process forking (non-blocking) or opening (blocking) fails, the method will return -1. + Example of blocking mode and retrieving the shell output: [codeblock] var output = [] - var pid = OS.execute('ls', [], true, output) + OS.execute('ls', ['-l', '/tmp'], 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: + Example of non-blocking mode, running another instance of the project and storing its process ID: [codeblock] - var pid = OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output) + var pid = OS.execute(OS.get_executable_path(), [], false) + [/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] + OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output) [/codeblock] </description> </method> @@ -116,6 +124,22 @@ Returns the scancode of the given string (e.g. "Escape") </description> </method> + <method name="get_audio_driver_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the total number of available audio drivers. + </description> + </method> + <method name="get_audio_driver_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="driver" type="int"> + </argument> + <description> + Returns the audio driver name for the given index. + </description> + </method> <method name="get_cmdline_args"> <return type="PoolStringArray"> </return> @@ -123,6 +147,12 @@ Returns the command line arguments passed to the engine. </description> </method> + <method name="get_connected_midi_inputs"> + <return type="PoolStringArray"> + </return> + <description> + </description> + </method> <method name="get_date" qualifiers="const"> <return type="Dictionary"> </return> @@ -242,6 +272,7 @@ <return type="Vector2"> </return> <description> + Returns the window size including decorations like window borders. </description> </method> <method name="get_scancode_string" qualifiers="const"> @@ -267,7 +298,6 @@ </argument> <description> Returns the dots per inch density of the specified screen. - On Android Devices, the actual screen densities are grouped into six generalized densities: ldpi - 120 dpi mdpi - 160 dpi @@ -338,6 +368,13 @@ Returns the amount of time passed in milliseconds since the engine started. </description> </method> + <method name="get_ticks_usec" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the amount of time passed in microseconds since the engine started. + </description> + </method> <method name="get_time" qualifiers="const"> <return type="Dictionary"> </return> @@ -366,7 +403,7 @@ <return type="int"> </return> <description> - Return the current unix timestamp. + Returns the current unix epoch timestamp. </description> </method> <method name="get_unix_time_from_datetime" qualifiers="const"> @@ -385,12 +422,37 @@ </return> <description> Returns the absolute directory path where user data is written ([code]user://[/code]). + On Linux, this is [code]~/.local/share/godot/app_userdata/[project_name][/code], or [code]~/.local/share/[custom_name][/code] if [code]use_custom_user_dir[/code] is set. + On macOS, this is [code]~/Library/Application Support/Godot/app_userdata/[project_name][/code], or [code]~/Library/Application Support/[custom_name][/code] if [code]use_custom_user_dir[/code] is set. + On Windows, this is [code]%APPDATA%/Godot/app_userdata/[project_name][/code], or [code]%APPDATA%/[custom_name][/code] if [code]use_custom_user_dir[/code] is set. + If the project name is empty, [code]user://[/code] falls back to [code]res://[/code]. + </description> + </method> + <method name="get_video_driver_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_video_driver_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="driver" type="int"> + </argument> + <description> </description> </method> <method name="get_virtual_keyboard_height"> <return type="int"> </return> <description> + Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or it is currently hidden. + </description> + </method> + <method name="get_window_safe_area" qualifiers="const"> + <return type="Rect2"> + </return> + <description> </description> </method> <method name="has_environment" qualifiers="const"> @@ -408,6 +470,7 @@ <argument index="0" name="tag_name" type="String"> </argument> <description> + Returns [code]true[/code] if the feature for the given feature tag is supported in the currently running instance, depending on platform, build etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. See feature tags documentation. </description> </method> <method name="has_touchscreen_ui_hint" qualifiers="const"> @@ -474,6 +537,7 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if the window should always be on top of other windows. </description> </method> <method name="kill"> @@ -482,7 +546,8 @@ <argument index="0" name="pid" type="int"> </argument> <description> - Kill a process ID (this method can be used to kill processes that were not spawned by the game). + Kill (terminate) the process identified by the given process ID ([code]pid[/code]), e.g. the one returned by [method execute] in non-blocking mode. + Note that this method can also be used to kill processes that were not spawned by the game. </description> </method> <method name="native_video_is_playing"> @@ -610,6 +675,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> + Sets whether the window should always be on top. </description> </method> <method name="set_window_title"> @@ -650,27 +716,33 @@ The current screen index (starting from 0). </member> <member name="exit_code" type="int" setter="set_exit_code" getter="get_exit_code"> + The exit code passed to the OS when the main loop exits. </member> <member name="keep_screen_on" type="bool" setter="set_keep_screen_on" getter="is_keep_screen_on"> + If [code]true[/code] the engine tries to keep the screen on while the game is running. Useful on mobile. </member> <member name="low_processor_usage_mode" type="bool" setter="set_low_processor_usage_mode" getter="is_in_low_processor_usage_mode"> + If [code]true[/code] the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. </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"> + If [code]true[/code] vertical synchronization (Vsync) is enabled. </member> <member name="window_borderless" type="bool" setter="set_borderless_window" getter="get_borderless_window"> - If [code]true[/code], removes the window frame. + 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. + 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. + 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. + If [code]true[/code] the window is minimized. + </member> + <member name="window_per_pixel_transparency_enabled" type="bool" setter="set_window_per_pixel_transparency_enabled" getter="get_window_per_pixel_transparency_enabled"> </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. @@ -684,82 +756,121 @@ </members> <constants> <constant name="DAY_SUNDAY" value="0" enum="Weekday"> + Sunday. </constant> <constant name="DAY_MONDAY" value="1" enum="Weekday"> + Monday. </constant> <constant name="DAY_TUESDAY" value="2" enum="Weekday"> + Tuesday. </constant> <constant name="DAY_WEDNESDAY" value="3" enum="Weekday"> + Wednesday. </constant> <constant name="DAY_THURSDAY" value="4" enum="Weekday"> + Thursday. </constant> <constant name="DAY_FRIDAY" value="5" enum="Weekday"> + Friday. </constant> <constant name="DAY_SATURDAY" value="6" enum="Weekday"> + Saturday. </constant> <constant name="MONTH_JANUARY" value="1" enum="Month"> + January. </constant> <constant name="MONTH_FEBRUARY" value="2" enum="Month"> + February. </constant> <constant name="MONTH_MARCH" value="3" enum="Month"> + March. </constant> <constant name="MONTH_APRIL" value="4" enum="Month"> + April. </constant> <constant name="MONTH_MAY" value="5" enum="Month"> + May. </constant> <constant name="MONTH_JUNE" value="6" enum="Month"> + June. </constant> <constant name="MONTH_JULY" value="7" enum="Month"> + July. </constant> <constant name="MONTH_AUGUST" value="8" enum="Month"> + August. </constant> <constant name="MONTH_SEPTEMBER" value="9" enum="Month"> + September. </constant> <constant name="MONTH_OCTOBER" value="10" enum="Month"> + October. </constant> <constant name="MONTH_NOVEMBER" value="11" enum="Month"> + November. </constant> <constant name="MONTH_DECEMBER" value="12" enum="Month"> + December. </constant> <constant name="SCREEN_ORIENTATION_LANDSCAPE" value="0" enum="ScreenOrientation"> + Landscape screen orientation. </constant> <constant name="SCREEN_ORIENTATION_PORTRAIT" value="1" enum="ScreenOrientation"> + Portrait screen orientation. </constant> <constant name="SCREEN_ORIENTATION_REVERSE_LANDSCAPE" value="2" enum="ScreenOrientation"> + Reverse landscape screen orientation. </constant> <constant name="SCREEN_ORIENTATION_REVERSE_PORTRAIT" value="3" enum="ScreenOrientation"> + Reverse portrait screen orientation. </constant> <constant name="SCREEN_ORIENTATION_SENSOR_LANDSCAPE" value="4" enum="ScreenOrientation"> + Uses landscape or reverse landscape based on the hardware sensor. </constant> <constant name="SCREEN_ORIENTATION_SENSOR_PORTRAIT" value="5" enum="ScreenOrientation"> + Uses portrait or reverse portrait based on the hardware sensor. </constant> <constant name="SCREEN_ORIENTATION_SENSOR" value="6" enum="ScreenOrientation"> + Uses most suitable orientation based on the hardware sensor. </constant> <constant name="SYSTEM_DIR_DESKTOP" value="0" enum="SystemDir"> + Desktop directory path. </constant> <constant name="SYSTEM_DIR_DCIM" value="1" enum="SystemDir"> + DCIM (Digital Camera Images) directory path. </constant> <constant name="SYSTEM_DIR_DOCUMENTS" value="2" enum="SystemDir"> + Documents directory path. </constant> <constant name="SYSTEM_DIR_DOWNLOADS" value="3" enum="SystemDir"> + Downloads directory path. </constant> <constant name="SYSTEM_DIR_MOVIES" value="4" enum="SystemDir"> + Movies directory path. </constant> <constant name="SYSTEM_DIR_MUSIC" value="5" enum="SystemDir"> + Music directory path. </constant> <constant name="SYSTEM_DIR_PICTURES" value="6" enum="SystemDir"> + Pictures directory path. </constant> <constant name="SYSTEM_DIR_RINGTONES" value="7" enum="SystemDir"> + Ringtones directory path. </constant> <constant name="POWERSTATE_UNKNOWN" value="0" enum="PowerState"> + Unknown powerstate. </constant> <constant name="POWERSTATE_ON_BATTERY" value="1" enum="PowerState"> + Unplugged, running on battery. </constant> <constant name="POWERSTATE_NO_BATTERY" value="2" enum="PowerState"> + Plugged in, no battery available. </constant> <constant name="POWERSTATE_CHARGING" value="3" enum="PowerState"> + Plugged in, battery charging. </constant> <constant name="POWERSTATE_CHARGED" value="4" enum="PowerState"> + Plugged in, battery fully charged. </constant> </constants> </class> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 663eb2be56..f4ad196ad2 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.1-dev"> +<class name="Object" category="Core" version="3.1"> <brief_description> Base class for all non built-in types. </brief_description> @@ -16,7 +16,7 @@ </demos> <methods> <method name="_get" qualifiers="virtual"> - <return type="void"> + <return type="Variant"> </return> <argument index="0" name="property" type="String"> </argument> @@ -184,6 +184,8 @@ <argument index="0" name="property" type="NodePath"> </argument> <description> + Get indexed object property by String. + Property indices get accessed with colon seperation, for example: [code]position:x[/code] </description> </method> <method name="get_instance_id" qualifiers="const"> @@ -398,6 +400,7 @@ <signals> <signal name="script_changed"> <description> + Emitted whenever the script of the Object is changed. </description> </signal> </signals> @@ -417,5 +420,7 @@ <constant name="CONNECT_ONESHOT" value="4" enum="ConnectFlags"> One shot connections disconnect themselves after emission. </constant> + <constant name="CONNECT_REFERENCE_COUNTED" value="8" enum="ConnectFlags"> + </constant> </constants> </class> diff --git a/doc/classes/OccluderPolygon2D.xml b/doc/classes/OccluderPolygon2D.xml index 9824c7868d..e8d6b54f27 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.1-dev"> +<class name="OccluderPolygon2D" inherits="Resource" category="Core" version="3.1"> <brief_description> Defines a 2D polygon for LightOccluder2D. </brief_description> diff --git a/doc/classes/OmniLight.xml b/doc/classes/OmniLight.xml index 2fdcc86d55..5ed058bb06 100644 --- a/doc/classes/OmniLight.xml +++ b/doc/classes/OmniLight.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="OmniLight" inherits="Light" category="Core" version="3.1-dev"> +<class name="OmniLight" inherits="Light" category="Core" version="3.1"> <brief_description> - OmniDirectional Light, such as a light bulb or a candle. + Omnidirectional light, such as a light bulb or a candle. </brief_description> <description> - 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]. + An Omnidirectional light is a type of [Light] that emits light in all directions. The light is attenuated by distance and this attenuation can be configured by changing its energy, radius, and attenuation parameters. </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html</link> </tutorials> <demos> </demos> @@ -15,12 +15,16 @@ </methods> <members> <member name="omni_attenuation" type="float" setter="set_param" getter="get_param"> + The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. </member> <member name="omni_range" type="float" setter="set_param" getter="get_param"> + Maximum distance the light affects. </member> <member name="omni_shadow_detail" type="int" setter="set_shadow_detail" getter="get_shadow_detail" enum="OmniLight.ShadowDetail"> + See [enum ShadowDetail]. </member> <member name="omni_shadow_mode" type="int" setter="set_shadow_mode" getter="get_shadow_mode" enum="OmniLight.ShadowMode"> + See [enum ShadowMode]. </member> </members> <constants> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index cefb02d724..c58c932b61 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.1-dev"> +<class name="OptionButton" inherits="Button" category="Core" version="3.1"> <brief_description> Button control that provides selectable options when pressed. </brief_description> @@ -18,7 +18,7 @@ </argument> <argument index="1" name="label" type="String"> </argument> - <argument index="2" name="id" type="int"> + <argument index="2" name="id" type="int" default="-1"> </argument> <description> Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. @@ -194,6 +194,13 @@ </member> </members> <signals> + <signal name="item_focused"> + <argument index="0" name="ID" type="int"> + </argument> + <description> + This signal is emitted when user navigated to an item using [code]ui_up[/code] or [code]ui_down[/code] action. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). + </description> + </signal> <signal name="item_selected"> <argument index="0" name="ID" type="int"> </argument> diff --git a/doc/classes/OrientedPathFollow.xml b/doc/classes/OrientedPathFollow.xml new file mode 100644 index 0000000000..85d60936ad --- /dev/null +++ b/doc/classes/OrientedPathFollow.xml @@ -0,0 +1,40 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="OrientedPathFollow" inherits="Spatial" category="Core" version="3.1"> + <brief_description> + Oriented point sampler for a [Path]. + </brief_description> + <description> + This node behaves like [PathFollow], except it uses its parent [Path] up vector information to enforce orientation. + Make sure to check if the curve of this node's parent [Path] has up vectors enabled. See [PathFollow] and [Curve3D] for further information. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </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="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> + </constants> +</class> diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml index ed7a343f03..01985a9bb3 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.1-dev"> +<class name="PCKPacker" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PHashTranslation.xml b/doc/classes/PHashTranslation.xml index 52eb2748da..18c72a0576 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.1-dev"> +<class name="PHashTranslation" inherits="Translation" category="Core" version="3.1"> <brief_description> Optimized translation. </brief_description> diff --git a/doc/classes/PackedDataContainer.xml b/doc/classes/PackedDataContainer.xml index edabaace8f..e6dbe57925 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.1-dev"> +<class name="PackedDataContainer" inherits="Resource" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PackedDataContainerRef.xml b/doc/classes/PackedDataContainerRef.xml index 2f418991de..371fe5a5ac 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.1-dev"> +<class name="PackedDataContainerRef" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index b6ef9db068..8d810bc9c4 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -1,11 +1,18 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PackedScene" inherits="Resource" category="Core" version="3.1-dev"> +<class name="PackedScene" inherits="Resource" category="Core" version="3.1"> <brief_description> An abstraction of a serialized scene. </brief_description> <description> A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself. - TODO: explain ownership, and that node does not need to own itself + Can be used to save a node to a file. When saving, the node as well as all the node it owns get saved (see [code]owner[/code] property on [Node]). Note that the node doesn't need to own itself. + Example of saving a node: + [codeblock] + var scene = PackedScene.new() + var result = scene.pack(child) + if result == OK: + ResourceSaver.save("res://path/name.scn", scene) // or user://... + [/codeblock] </description> <tutorials> </tutorials> diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index 6fdbaf27e6..a4cf0c8029 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.1-dev"> +<class name="PacketPeer" inherits="Reference" category="Core" version="3.1"> <brief_description> Abstraction and base class for packet-based protocols. </brief_description> diff --git a/doc/classes/PacketPeerStream.xml b/doc/classes/PacketPeerStream.xml index 0ad473f644..9e3195bb44 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.1-dev"> +<class name="PacketPeerStream" inherits="PacketPeer" category="Core" version="3.1"> <brief_description> Wrapper to use a PacketPeer over a StreamPeer. </brief_description> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 29abcda9d9..d4e3d17de6 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.1-dev"> +<class name="PacketPeerUDP" inherits="PacketPeer" category="Core" version="3.1"> <brief_description> UDP packet peer. </brief_description> @@ -22,14 +22,14 @@ <return type="String"> </return> <description> - Return the IP of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]). + Return the IP of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). </description> </method> <method name="get_packet_port" qualifiers="const"> <return type="int"> </return> <description> - Return the port of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]). + Return the port of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). </description> </method> <method name="is_listening" qualifiers="const"> diff --git a/doc/classes/Panel.xml b/doc/classes/Panel.xml index 3afda37355..758925e969 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.1-dev"> +<class name="Panel" inherits="Control" category="Core" version="3.1"> <brief_description> Provides an opaque background for [Control] children. </brief_description> diff --git a/doc/classes/PanelContainer.xml b/doc/classes/PanelContainer.xml index 5b76f49687..f5c351fa21 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.1-dev"> +<class name="PanelContainer" inherits="Container" category="Core" version="3.1"> <brief_description> Panel container type. </brief_description> diff --git a/doc/classes/PanoramaSky.xml b/doc/classes/PanoramaSky.xml index 0196f7a73e..402e65c573 100644 --- a/doc/classes/PanoramaSky.xml +++ b/doc/classes/PanoramaSky.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PanoramaSky" inherits="Sky" category="Core" version="3.1-dev"> +<class name="PanoramaSky" inherits="Sky" category="Core" version="3.1"> <brief_description> + A type of [Sky] used to draw a background texture. </brief_description> <description> + A resource referenced in an [Environment] that is used to draw a background. The Panorama sky functions similar to skyboxes in other engines except it uses a equirectangular sky map instead of a cube map. </description> <tutorials> </tutorials> @@ -12,6 +14,7 @@ </methods> <members> <member name="panorama" type="Texture" setter="set_panorama" getter="get_panorama"> + [Texture] to be applied to the PanoramaSky. </member> </members> <constants> diff --git a/doc/classes/ParallaxBackground.xml b/doc/classes/ParallaxBackground.xml index c8b15b3c7d..2409b7a1c1 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.1-dev"> +<class name="ParallaxBackground" inherits="CanvasLayer" category="Core" version="3.1"> <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 b5d4e10d7e..662a15e043 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.1-dev"> +<class name="ParallaxLayer" inherits="Node2D" category="Core" version="3.1"> <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 b56c15f246..2e30750bf9 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.1-dev"> +<class name="Particles" inherits="GeometryInstance" category="Core" version="3.1"> <brief_description> 3D particle emitter. </brief_description> @@ -22,6 +22,7 @@ <return type="void"> </return> <description> + Restarts the particle emmission, clearing existing particles. </description> </method> </methods> @@ -33,14 +34,19 @@ Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Default value: [code]DRAW_ORDER_INDEX[/code]. </member> <member name="draw_pass_1" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> + [Mesh] that is drawn for the first draw pass. </member> <member name="draw_pass_2" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> + [Mesh] that is drawn for the second draw pass. </member> <member name="draw_pass_3" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> + [Mesh] that is drawn for the third draw pass. </member> <member name="draw_pass_4" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> + [Mesh] that is drawn for the fourth draw pass. </member> <member name="draw_passes" type="int" setter="set_draw_passes" getter="get_draw_passes"> + The number of draw passes when rendering particles. </member> <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting"> If [code]true[/code] particles are being emitted. Default value: [code]true[/code]. @@ -62,6 +68,7 @@ If [code]true[/code] only [code]amount[/code] particles will be emitted. Default value: [code]false[/code]. </member> <member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time"> + Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting. </member> <member name="process_material" type="Material" setter="set_process_material" getter="get_process_material"> [Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial]. @@ -70,9 +77,10 @@ Emission randomness ratio. Default value: [code]0[/code]. </member> <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> - Speed scaling ratio. Default value: [code]1[/code]. + Speed scaling ratio. Default value: [code]1[/code]. A value of [code]0[/code] can be used to pause the particles. </member> <member name="visibility_aabb" type="AABB" setter="set_visibility_aabb" getter="get_visibility_aabb"> + The [AABB] that determines the area of the world part of which needs to be visible on screen for the particle system to be active. </member> </members> <constants> @@ -86,6 +94,7 @@ Particles are drawn in order of depth. </constant> <constant name="MAX_DRAW_PASSES" value="4"> + Maximum number of draw passes supported. </constant> </constants> </class> diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml index 88a373b7a9..f872552a49 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.1-dev"> +<class name="Particles2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> 2D particle emitter. </brief_description> @@ -66,7 +66,7 @@ Emission lifetime randomness ratio. Default value: [code]0[/code]. </member> <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> - Particle system's running speed scaling ratio. Default value: [code]1[/code]. + Particle system's running speed scaling ratio. Default value: [code]1[/code]. A value of [code]0[/code] can be used to pause the particles. </member> <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> Particle texture. If [code]null[/code] particles will be squares. diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index a6c463d307..354b98485e 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.1-dev"> +<class name="ParticlesMaterial" inherits="Material" category="Core" version="3.1"> <brief_description> Particle properties for [Particles] and [Particles2D] nodes. </brief_description> @@ -132,7 +132,7 @@ Orbital velocity randomness ratio. Default value: [code]0[/code]. </member> <member name="radial_accel" type="float" setter="set_param" getter="get_param"> - Linear acceleration applied to each particle. + Radial acceleration applied to each particle. </member> <member name="radial_accel_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> Each particle's radial acceleration will vary along this [CurveTexture]. diff --git a/doc/classes/Path.xml b/doc/classes/Path.xml index 48d41c89c1..5ece747aaf 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.1-dev"> +<class name="Path" inherits="Spatial" category="Core" version="3.1"> <brief_description> Container for a [Curve3D]. </brief_description> @@ -16,6 +16,12 @@ <member name="curve" type="Curve3D" setter="set_curve" getter="get_curve"> </member> </members> + <signals> + <signal name="curve_changed"> + <description> + </description> + </signal> + </signals> <constants> </constants> </class> diff --git a/doc/classes/Path2D.xml b/doc/classes/Path2D.xml index dcef22c241..5e40fb6956 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.1-dev"> +<class name="Path2D" inherits="Node2D" category="Core" version="3.1"> <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 c248e6f868..650fed7ec6 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.1-dev"> +<class name="PathFollow" inherits="Spatial" category="Core" version="3.1"> <brief_description> Point sampler for a [Path]. </brief_description> diff --git a/doc/classes/PathFollow2D.xml b/doc/classes/PathFollow2D.xml index 995c65d4fa..f9940dab2f 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.1-dev"> +<class name="PathFollow2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> Point sampler for a [Path2D]. </brief_description> diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index c67b9e2f07..3b11d9e47f 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.1-dev"> +<class name="Performance" inherits="Object" category="Core" version="3.1"> <brief_description> Exposes performance related data. </brief_description> @@ -106,7 +106,9 @@ <constant name="PHYSICS_3D_ISLAND_COUNT" value="26" enum="Monitor"> Number of islands in the 3D physics engine. </constant> - <constant name="MONITOR_MAX" value="27" enum="Monitor"> + <constant name="AUDIO_OUTPUT_LATENCY" value="27" enum="Monitor"> + </constant> + <constant name="MONITOR_MAX" value="28" enum="Monitor"> </constant> </constants> </class> diff --git a/doc/classes/PhysicalBone.xml b/doc/classes/PhysicalBone.xml new file mode 100644 index 0000000000..5eb4550e93 --- /dev/null +++ b/doc/classes/PhysicalBone.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicalBone" inherits="PhysicsBody" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_bone_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_simulate_physics"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_simulating_physics"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_static_body"> + <return type="bool"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="body_offset" type="Transform" setter="set_body_offset" getter="get_body_offset"> + </member> + <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> + </member> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> + </member> + <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale"> + </member> + <member name="joint_offset" type="Transform" setter="set_joint_offset" getter="get_joint_offset"> + </member> + <member name="joint_type" type="int" setter="set_joint_type" getter="get_joint_type" enum="PhysicalBone.JointType"> + </member> + <member name="mass" type="float" setter="set_mass" getter="get_mass"> + </member> + <member name="weight" type="float" setter="set_weight" getter="get_weight"> + </member> + </members> + <constants> + <constant name="JOINT_TYPE_NONE" value="0" enum="JointType"> + </constant> + <constant name="JOINT_TYPE_PIN" value="1" enum="JointType"> + </constant> + <constant name="JOINT_TYPE_CONE" value="2" enum="JointType"> + </constant> + <constant name="JOINT_TYPE_HINGE" value="3" enum="JointType"> + </constant> + <constant name="JOINT_TYPE_SLIDER" value="4" enum="JointType"> + </constant> + <constant name="JOINT_TYPE_6DOF" value="5" enum="JointType"> + </constant> + </constants> +</class> diff --git a/doc/classes/Physics2DDirectBodyState.xml b/doc/classes/Physics2DDirectBodyState.xml index d1634974f4..52c89248ff 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.1-dev"> +<class name="Physics2DDirectBodyState" inherits="Object" category="Core" version="3.1"> <brief_description> Direct access object to a physics body in the [Physics2DServer]. </brief_description> @@ -11,6 +11,58 @@ <demos> </demos> <methods> + <method name="add_central_force"> + <return type="void"> + </return> + <argument index="0" name="force" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="add_force"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <argument index="1" name="force" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="add_torque"> + <return type="void"> + </return> + <argument index="0" name="torque" type="float"> + </argument> + <description> + </description> + </method> + <method name="apply_central_impulse"> + <return type="void"> + </return> + <argument index="0" name="impulse" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="apply_impulse"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <argument index="1" name="impulse" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="apply_torque_impulse"> + <return type="void"> + </return> + <argument index="0" name="impulse" type="float"> + </argument> + <description> + </description> + </method> <method name="get_contact_collider" qualifiers="const"> <return type="RID"> </return> diff --git a/doc/classes/Physics2DDirectBodyStateSW.xml b/doc/classes/Physics2DDirectBodyStateSW.xml index 7d04e483ff..cb1e9239b3 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.1-dev"> +<class name="Physics2DDirectBodyStateSW" inherits="Physics2DDirectBodyState" category="Core" version="3.1"> <brief_description> Software implementation of [Physics2DDirectBodyState]. </brief_description> diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml index b3a33e9216..f0fee77a5a 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.1-dev"> +<class name="Physics2DDirectSpaceState" inherits="Object" category="Core" version="3.1"> <brief_description> Direct access object to a space in the [Physics2DServer]. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/ray-casting.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index 644731516f..a473de4ce8 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.1-dev"> +<class name="Physics2DServer" inherits="Object" category="Core" version="3.1"> <brief_description> Physics 2D Server. </brief_description> @@ -140,6 +140,18 @@ Removes a shape from an area. It does not delete the shape, so it can be reassigned later. </description> </method> + <method name="area_set_area_monitor_callback"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <description> + </description> + </method> <method name="area_set_collision_layer"> <return type="void"> </return> @@ -180,6 +192,16 @@ 5: The shape index of the area where the object entered/exited. </description> </method> + <method name="area_set_monitorable"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="monitorable" type="bool"> + </argument> + <description> + </description> + </method> <method name="area_set_param"> <return type="void"> </return> @@ -265,6 +287,16 @@ Sets the transform matrix for an area. </description> </method> + <method name="body_add_central_force"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="force" type="Vector2"> + </argument> + <description> + </description> + </method> <method name="body_add_collision_exception"> <return type="void"> </return> @@ -302,6 +334,26 @@ Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> + <method name="body_add_torque"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="torque" type="float"> + </argument> + <description> + </description> + </method> + <method name="body_apply_central_impulse"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="impulse" type="Vector2"> + </argument> + <description> + </description> + </method> <method name="body_apply_impulse"> <return type="void"> </return> @@ -315,6 +367,16 @@ Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. </description> </method> + <method name="body_apply_torque_impulse"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="impulse" type="float"> + </argument> + <description> + </description> + </method> <method name="body_attach_object_instance_id"> <return type="void"> </return> @@ -566,7 +628,7 @@ <argument index="3" name="userdata" type="Variant" default="null"> </argument> <description> - Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). + Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]). </description> </method> <method name="body_set_max_contacts_reported"> @@ -688,7 +750,7 @@ <argument index="1" name="space" type="RID"> </argument> <description> - Assigns a space to the body (see [method create_space]). + Assigns a space to the body (see [method space_create]). </description> </method> <method name="body_set_state"> @@ -713,9 +775,11 @@ </argument> <argument index="2" name="motion" type="Vector2"> </argument> - <argument index="3" name="margin" type="float" default="0.08"> + <argument index="3" name="infinite_inertia" type="bool"> + </argument> + <argument index="4" name="margin" type="float" default="0.08"> </argument> - <argument index="4" name="result" type="Physics2DTestMotionResult" default="null"> + <argument index="5" name="result" type="Physics2DTestMotionResult" default="null"> </argument> <description> Returns whether a body can move from a given point in a given direction. Apart from the boolean return value, a [Physics2DTestMotionResult] can be passed to return additional information in. diff --git a/doc/classes/Physics2DServerSW.xml b/doc/classes/Physics2DServerSW.xml index 25ca5dd4d2..49157bd94b 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.1-dev"> +<class name="Physics2DServerSW" inherits="Physics2DServer" category="Core" version="3.1"> <brief_description> Software implementation of [Physics2DServer]. </brief_description> diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 209623c62a..391ad6276f 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.1-dev"> +<class name="Physics2DShapeQueryParameters" inherits="Reference" category="Core" version="3.1"> <brief_description> Parameters to be sent to a 2D shape physics query. </brief_description> diff --git a/doc/classes/Physics2DShapeQueryResult.xml b/doc/classes/Physics2DShapeQueryResult.xml index 2e2180ee0f..52e7294e24 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.1-dev"> +<class name="Physics2DShapeQueryResult" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Physics2DTestMotionResult.xml b/doc/classes/Physics2DTestMotionResult.xml index 943ef72ffb..3b864433f0 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.1-dev"> +<class name="Physics2DTestMotionResult" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PhysicsBody.xml b/doc/classes/PhysicsBody.xml index b765bb1f1f..14053c6a35 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.1-dev"> +<class name="PhysicsBody" inherits="CollisionObject" category="Core" version="3.1"> <brief_description> Base class for all objects affected by physics in 3D space. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index 80d72512fe..ccc704c7ec 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.1-dev"> +<class name="PhysicsBody2D" inherits="CollisionObject2D" category="Core" version="3.1"> <brief_description> Base class for all objects affected by physics in 2D space. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/PhysicsDirectBodyState.xml b/doc/classes/PhysicsDirectBodyState.xml index fa0e529a73..91fc4df4ff 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.1-dev"> +<class name="PhysicsDirectBodyState" inherits="Object" category="Core" version="3.1"> <brief_description> </brief_description> <description> @@ -9,6 +9,14 @@ <demos> </demos> <methods> + <method name="add_central_force"> + <return type="void"> + </return> + <argument index="0" name="force" type="Vector3"> + </argument> + <description> + </description> + </method> <method name="add_force"> <return type="void"> </return> @@ -19,6 +27,22 @@ <description> </description> </method> + <method name="add_torque"> + <return type="void"> + </return> + <argument index="0" name="torque" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="apply_central_impulse"> + <return type="void"> + </return> + <argument index="0" name="j" type="Vector3"> + </argument> + <description> + </description> + </method> <method name="apply_impulse"> <return type="void"> </return> @@ -29,7 +53,7 @@ <description> </description> </method> - <method name="apply_torqe_impulse"> + <method name="apply_torque_impulse"> <return type="void"> </return> <argument index="0" name="j" type="Vector3"> @@ -91,6 +115,15 @@ <description> </description> </method> + <method name="get_contact_impulse" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + Impulse created by the contact. Only implemented for Bullet physics. + </description> + </method> <method name="get_contact_local_normal" qualifiers="const"> <return type="Vector3"> </return> diff --git a/doc/classes/PhysicsDirectSpaceState.xml b/doc/classes/PhysicsDirectSpaceState.xml index e33718edf0..3f0e1a4f70 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.1-dev"> +<class name="PhysicsDirectSpaceState" inherits="Object" category="Core" version="3.1"> <brief_description> Direct access object to a space in the [PhysicsServer]. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/ray-casting.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/PhysicsMaterial.xml b/doc/classes/PhysicsMaterial.xml new file mode 100644 index 0000000000..bfebb472a5 --- /dev/null +++ b/doc/classes/PhysicsMaterial.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsMaterial" inherits="Resource" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="absorbent" type="bool" setter="set_absorbent" getter="is_absorbent"> + </member> + <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> + </member> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> + </member> + <member name="rough" type="bool" setter="set_rough" getter="is_rough"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 02172a310d..88a104cb11 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.1-dev"> +<class name="PhysicsServer" inherits="Object" category="Core" version="3.1"> <brief_description> Server interface for low level physics access. </brief_description> @@ -149,6 +149,18 @@ Removes a shape from an area. It does not delete the shape, so it can be reassigned later. </description> </method> + <method name="area_set_area_monitor_callback"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <description> + </description> + </method> <method name="area_set_collision_layer"> <return type="void"> </return> @@ -189,6 +201,16 @@ 5: The shape index of the area where the object entered/exited. </description> </method> + <method name="area_set_monitorable"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="monitorable" type="bool"> + </argument> + <description> + </description> + </method> <method name="area_set_param"> <return type="void"> </return> @@ -272,6 +294,16 @@ Sets the transform matrix for an area. </description> </method> + <method name="body_add_central_force"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="force" type="Vector3"> + </argument> + <description> + </description> + </method> <method name="body_add_collision_exception"> <return type="void"> </return> @@ -283,6 +315,18 @@ Adds a body to the list of bodies exempt from collisions. </description> </method> + <method name="body_add_force"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="force" type="Vector3"> + </argument> + <argument index="2" name="position" type="Vector3"> + </argument> + <description> + </description> + </method> <method name="body_add_shape"> <return type="void"> </return> @@ -296,6 +340,26 @@ Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> + <method name="body_add_torque"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="torque" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="body_apply_central_impulse"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="impulse" type="Vector3"> + </argument> + <description> + </description> + </method> <method name="body_apply_impulse"> <return type="void"> </return> @@ -605,7 +669,7 @@ <argument index="3" name="userdata" type="Variant" default="null"> </argument> <description> - Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). + Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]). </description> </method> <method name="body_set_kinematic_safe_margin"> @@ -1331,31 +1395,37 @@ <constant name="G6DOF_JOINT_LINEAR_DAMPING" value="4" enum="G6DOFJointAxisParam"> 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"> + <constant name="G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY" value="5" enum="G6DOFJointAxisParam"> + The velocity that the joint's linear motor will attempt to reach. + </constant> + <constant name="G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT" value="6" enum="G6DOFJointAxisParam"> + The maximum force that the linear motor can apply while trying to reach the target velocity. + </constant> + <constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="7" enum="G6DOFJointAxisParam"> 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"> + <constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="8" enum="G6DOFJointAxisParam"> 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"> + <constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="9" enum="G6DOFJointAxisParam"> A factor that gets multiplied onto all rotations across the axes. </constant> - <constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="8" enum="G6DOFJointAxisParam"> + <constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="10" enum="G6DOFJointAxisParam"> 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"> + <constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="11" enum="G6DOFJointAxisParam"> 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"> + <constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="12" enum="G6DOFJointAxisParam"> The maximum amount of force that can occur, when rotating around the axes. </constant> - <constant name="G6DOF_JOINT_ANGULAR_ERP" value="11" enum="G6DOFJointAxisParam"> + <constant name="G6DOF_JOINT_ANGULAR_ERP" value="13" enum="G6DOFJointAxisParam"> 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"> + <constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="14" enum="G6DOFJointAxisParam"> Target speed for the motor at the axes. </constant> - <constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="13" enum="G6DOFJointAxisParam"> + <constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="15" enum="G6DOFJointAxisParam"> Maximum acceleration for the motor at the axes. </constant> <constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="G6DOFJointAxisFlag"> @@ -1367,6 +1437,9 @@ <constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="2" enum="G6DOFJointAxisFlag"> If [code]set[/code] there is a rotational motor across these axes. </constant> + <constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR" value="3" enum="G6DOFJointAxisFlag"> + If [code]set[/code] there is a linear motor on this axis that targets a specific velocity. + </constant> <constant name="SHAPE_PLANE" value="0" enum="ShapeType"> The [Shape] is a [PlaneShape]. </constant> @@ -1382,16 +1455,19 @@ <constant name="SHAPE_CAPSULE" value="4" enum="ShapeType"> The [Shape] is a [CapsuleShape]. </constant> - <constant name="SHAPE_CONVEX_POLYGON" value="5" enum="ShapeType"> + <constant name="SHAPE_CYLINDER" value="5" enum="ShapeType"> + The [Shape] is a [CylinderShape]. + </constant> + <constant name="SHAPE_CONVEX_POLYGON" value="6" enum="ShapeType"> The [Shape] is a [ConvexPolygonShape]. </constant> - <constant name="SHAPE_CONCAVE_POLYGON" value="6" enum="ShapeType"> + <constant name="SHAPE_CONCAVE_POLYGON" value="7" enum="ShapeType"> The [Shape] is a [ConcavePolygonShape]. </constant> - <constant name="SHAPE_HEIGHTMAP" value="7" enum="ShapeType"> + <constant name="SHAPE_HEIGHTMAP" value="8" enum="ShapeType"> The [Shape] is a [HeightMapShape]. </constant> - <constant name="SHAPE_CUSTOM" value="8" enum="ShapeType"> + <constant name="SHAPE_CUSTOM" value="9" enum="ShapeType"> This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. </constant> <constant name="AREA_PARAM_GRAVITY" value="0" enum="AreaParameter"> diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml index 6bd37dda32..2f36e81e27 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.1-dev"> +<class name="PhysicsShapeQueryParameters" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PhysicsShapeQueryResult.xml b/doc/classes/PhysicsShapeQueryResult.xml index bb78071e85..080d7389b7 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.1-dev"> +<class name="PhysicsShapeQueryResult" inherits="Reference" category="Core" version="3.1"> <brief_description> Result of a shape query in Physics2DServer. </brief_description> diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index 7c94347008..470c22cd4c 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.1-dev"> +<class name="PinJoint" inherits="Joint" category="Core" version="3.1"> <brief_description> Pin Joint for 3D Shapes. </brief_description> diff --git a/doc/classes/PinJoint2D.xml b/doc/classes/PinJoint2D.xml index 0982ffacae..42708151ec 100644 --- a/doc/classes/PinJoint2D.xml +++ b/doc/classes/PinJoint2D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PinJoint2D" inherits="Joint2D" category="Core" version="3.1-dev"> +<class name="PinJoint2D" inherits="Joint2D" category="Core" version="3.1"> <brief_description> Pin Joint for 2D Shapes. </brief_description> <description> - Pin Joint for 2D Rigid Bodies. It pins 2 bodies (rigid or static) together, or a single body to a fixed position in space. + Pin Joint for 2D Rigid Bodies. It pins two bodies (rigid or static) together. </description> <tutorials> </tutorials> diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index f478b2d384..62e4fc5d9d 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.1-dev"> +<class name="Plane" category="Built-In Types" version="3.1"> <brief_description> Plane in hessian form. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/math/index.html</link> </tutorials> <demos> </demos> @@ -24,7 +24,7 @@ <argument index="3" name="d" type="float"> </argument> <description> - Creates a plane from the three parameters "a", "b", "c" and "d". + Creates a plane from the four parameters "a", "b", "c" and "d". </description> </method> <method name="Plane"> @@ -157,5 +157,11 @@ </member> </members> <constants> + <constant name="X" value="Plane( 1, 0, 0, 0 )"> + </constant> + <constant name="Y" value="Plane( 0, 1, 0, 0 )"> + </constant> + <constant name="Z" value="Plane( 0, 0, 1, 0 )"> + </constant> </constants> </class> diff --git a/doc/classes/PlaneMesh.xml b/doc/classes/PlaneMesh.xml index 60bc1f6613..fc293ab4df 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.1-dev"> +<class name="PlaneMesh" inherits="PrimitiveMesh" category="Core" version="3.1"> <brief_description> Class representing a planar [PrimitiveMesh]. </brief_description> diff --git a/doc/classes/PlaneShape.xml b/doc/classes/PlaneShape.xml index e0c1fdf25b..bc3faf7c01 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.1-dev"> +<class name="PlaneShape" inherits="Shape" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index a538cd2f05..bf4519fd0a 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.1-dev"> +<class name="Polygon2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> A 2D polygon. </brief_description> @@ -11,11 +11,79 @@ <demos> </demos> <methods> + <method name="add_bone"> + <return type="void"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <argument index="1" name="weights" type="PoolRealArray"> + </argument> + <description> + </description> + </method> + <method name="clear_bones"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="erase_bone"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bone_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_bone_path" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bone_weights" qualifiers="const"> + <return type="PoolRealArray"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_bone_path"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_bone_weights"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="weights" type="PoolRealArray"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="antialiased" type="bool" setter="set_antialiased" getter="get_antialiased"> If [code]true[/code] polygon edges will be anti-aliased. Default value: [code]false[/code]. </member> + <member name="bones" type="Array" setter="_set_bones" getter="_get_bones"> + </member> <member name="color" type="Color" setter="set_color" getter="get_color"> The polygon's fill color. If [code]texture[/code] is defined, it will be multiplied by this color. It will also be the default color for vertices not set in [code]vertex_colors[/code]. </member> @@ -31,6 +99,10 @@ <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon"> The polygon's list of vertices. The final point will be connected to the first. </member> + <member name="skeleton" type="NodePath" setter="set_skeleton" getter="get_skeleton"> + </member> + <member name="splits" type="PoolIntArray" setter="set_splits" getter="get_splits"> + </member> <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> The polygon's fill texture. Use [code]uv[/code] to set texture coordinates. </member> diff --git a/doc/classes/PolygonPathFinder.xml b/doc/classes/PolygonPathFinder.xml index 3c57b4ca18..e4a4d9b976 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.1-dev"> +<class name="PolygonPathFinder" inherits="Resource" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml index 7982c91ea9..120d80ba39 100644 --- a/doc/classes/PoolByteArray.xml +++ b/doc/classes/PoolByteArray.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolByteArray" category="Built-In Types" version="3.1-dev"> +<class name="PoolByteArray" category="Built-In Types" version="3.1"> <brief_description> Raw byte array. </brief_description> <description> - Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. + Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference. </description> <tutorials> </tutorials> diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml index c61f39b238..0c93a565f5 100644 --- a/doc/classes/PoolColorArray.xml +++ b/doc/classes/PoolColorArray.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolColorArray" category="Built-In Types" version="3.1-dev"> +<class name="PoolColorArray" category="Built-In Types" version="3.1"> <brief_description> Array of Colors </brief_description> <description> - Array of Color, Contains colors. Optimized for memory usage, can't fragment the memory. + Array of Color, Contains colors. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference. </description> <tutorials> </tutorials> diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml index 7b9bb96730..43cb5d77de 100644 --- a/doc/classes/PoolIntArray.xml +++ b/doc/classes/PoolIntArray.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolIntArray" category="Built-In Types" version="3.1-dev"> +<class name="PoolIntArray" category="Built-In Types" version="3.1"> <brief_description> Integer Array. </brief_description> <description> - Integer Array. Contains integers. Optimized for memory usage, can't fragment the memory. + Integer Array. Contains integers. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference. </description> <tutorials> </tutorials> diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml index b0f971ae3e..0808b44104 100644 --- a/doc/classes/PoolRealArray.xml +++ b/doc/classes/PoolRealArray.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolRealArray" category="Built-In Types" version="3.1-dev"> +<class name="PoolRealArray" category="Built-In Types" version="3.1"> <brief_description> Real Array. </brief_description> <description> - Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. + Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference. </description> <tutorials> </tutorials> diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml index 9db0af34be..9f6c4306cb 100644 --- a/doc/classes/PoolStringArray.xml +++ b/doc/classes/PoolStringArray.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolStringArray" category="Built-In Types" version="3.1-dev"> +<class name="PoolStringArray" category="Built-In Types" version="3.1"> <brief_description> String Array. </brief_description> <description> - String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. + String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference. </description> <tutorials> </tutorials> diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml index 5c8599f220..072281158c 100644 --- a/doc/classes/PoolVector2Array.xml +++ b/doc/classes/PoolVector2Array.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolVector2Array" category="Built-In Types" version="3.1-dev"> +<class name="PoolVector2Array" category="Built-In Types" version="3.1"> <brief_description> An Array of Vector2. </brief_description> <description> - An Array specifically designed to hold Vector2. + An Array specifically designed to hold Vector2. Note that this type is passed by value and not by reference. </description> <tutorials> </tutorials> diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml index 944bb767e0..7aa5dfc090 100644 --- a/doc/classes/PoolVector3Array.xml +++ b/doc/classes/PoolVector3Array.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PoolVector3Array" category="Built-In Types" version="3.1-dev"> +<class name="PoolVector3Array" category="Built-In Types" version="3.1"> <brief_description> An Array of Vector3. </brief_description> <description> - An Array specifically designed to hold Vector3. + An Array specifically designed to hold Vector3. Note that this type is passed by value and not by reference. </description> <tutorials> </tutorials> diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml index b6ee43254e..ae5bce5d7d 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.1-dev"> +<class name="Popup" inherits="Control" category="Core" version="3.1"> <brief_description> Base container control for popups and dialogs. </brief_description> @@ -50,6 +50,7 @@ </methods> <members> <member name="popup_exclusive" type="bool" setter="set_exclusive" getter="is_exclusive"> + If [code]true[/code] the popup will not be hidden when a click event occurs outside of it, or when it receives the [code]ui_cancel[/code] action event. </member> </members> <signals> diff --git a/doc/classes/PopupDialog.xml b/doc/classes/PopupDialog.xml index eac361f404..4f15fb4b05 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.1-dev"> +<class name="PopupDialog" inherits="Popup" category="Core" version="3.1"> <brief_description> Base class for Popup Dialogs. </brief_description> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 62911c1cf7..fe7dbe52b0 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.1-dev"> +<class name="PopupMenu" inherits="Popup" category="Core" version="3.1"> <brief_description> PopupMenu displays a list of options. </brief_description> @@ -108,9 +108,36 @@ Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. </description> </method> + <method name="add_radio_check_item"> + <return type="void"> + </return> + <argument index="0" name="label" type="String"> + </argument> + <argument index="1" name="id" type="int" default="-1"> + </argument> + <argument index="2" name="accel" type="int" default="0"> + </argument> + <description> + The same as [method add_check_item] but the inserted item will look as a radio button. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. + </description> + </method> + <method name="add_radio_check_shortcut"> + <return type="void"> + </return> + <argument index="0" name="shortcut" type="ShortCut"> + </argument> + <argument index="1" name="id" type="int" default="-1"> + </argument> + <argument index="2" name="global" type="bool" default="false"> + </argument> + <description> + </description> + </method> <method name="add_separator"> <return type="void"> </return> + <argument index="0" name="label" type="String" default=""""> + </argument> <description> Add a separator between items. Separators also occupy an index. </description> @@ -233,13 +260,19 @@ <description> </description> </method> + <method name="is_hide_on_window_lose_focus" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_item_checkable" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Return whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="is_item_checked" qualifiers="const"> @@ -248,7 +281,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the checkstate status of the item at index "idx". + Return whether the item at index "idx" is checked. </description> </method> <method name="is_item_disabled" qualifiers="const"> @@ -260,6 +293,15 @@ Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. </description> </method> + <method name="is_item_radio_checkable" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return whether the item at index "idx" has radio-button-style checkability. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. + </description> + </method> <method name="is_item_separator" qualifiers="const"> <return type="bool"> </return> @@ -269,6 +311,14 @@ Return whether the item is a separator. If it is, it would be displayed as a line. </description> </method> + <method name="is_item_shortcut_disabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> <method name="remove_item"> <return type="void"> </return> @@ -278,6 +328,14 @@ 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_window_lose_focus"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_item_accelerator"> <return type="void"> </return> @@ -300,6 +358,18 @@ Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> + <method name="set_item_as_radio_checkable"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + The same as [method set_item_as_checkable] but placing a radio button in case of enabling. If used for disabling, it's the same. + Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. + </description> + </method> <method name="set_item_as_separator"> <return type="void"> </return> @@ -387,6 +457,16 @@ <description> </description> </method> + <method name="set_item_shortcut_disabled"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_item_submenu"> <return type="void"> </return> @@ -443,8 +523,18 @@ </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> + <member name="submenu_popup_delay" type="float" setter="set_submenu_popup_delay" getter="get_submenu_popup_delay"> + Sets the delay time for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. Default value: [code]0.3[/code] seconds. + </member> </members> <signals> + <signal name="id_focused"> + <argument index="0" name="ID" type="int"> + </argument> + <description> + This event is emitted when user navigated to an item of some id using [code]ui_up[/code] or [code]ui_down[/code] action. + </description> + </signal> <signal name="id_pressed"> <argument index="0" name="ID" type="int"> </argument> @@ -479,10 +569,18 @@ </theme_item> <theme_item name="hseparation" type="int"> </theme_item> + <theme_item name="labeled_separator_left" type="StyleBox"> + </theme_item> + <theme_item name="labeled_separator_right" type="StyleBox"> + </theme_item> <theme_item name="panel" type="StyleBox"> </theme_item> <theme_item name="panel_disabled" type="StyleBox"> </theme_item> + <theme_item name="radio_checked" type="Texture"> + </theme_item> + <theme_item name="radio_unchecked" type="Texture"> + </theme_item> <theme_item name="separator" type="StyleBox"> </theme_item> <theme_item name="submenu" type="Texture"> diff --git a/doc/classes/PopupPanel.xml b/doc/classes/PopupPanel.xml index 5e8e24d36f..694c29efda 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.1-dev"> +<class name="PopupPanel" inherits="Popup" category="Core" version="3.1"> <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 3e29000c5b..6c26bf412c 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.1-dev"> +<class name="Position2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> Generic 2D Position hint for editing. </brief_description> diff --git a/doc/classes/Position3D.xml b/doc/classes/Position3D.xml index 2719cdb7f3..7c0875cc0c 100644 --- a/doc/classes/Position3D.xml +++ b/doc/classes/Position3D.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Position3D" inherits="Spatial" category="Core" version="3.1-dev"> +<class name="Position3D" inherits="Spatial" category="Core" version="3.1"> <brief_description> - Generic 3D Position hint for editing + Generic 3D Position hint for editing. </brief_description> <description> Generic 3D Position hint for editing. It's just like a plain [Spatial] but displays as a cross in the 3D-Editor at all times. diff --git a/doc/classes/PrimitiveMesh.xml b/doc/classes/PrimitiveMesh.xml index 8fd8e5da1e..0f0511258b 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.1-dev"> +<class name="PrimitiveMesh" inherits="Mesh" category="Core" version="3.1"> <brief_description> Base class for all primitive meshes. Handles applying a [Material] to a primitive mesh. </brief_description> @@ -19,6 +19,10 @@ </method> </methods> <members> + <member name="custom_aabb" type="AABB" setter="set_custom_aabb" getter="get_custom_aabb"> + </member> + <member name="flip_faces" type="bool" setter="set_flip_faces" getter="get_flip_faces"> + </member> <member name="material" type="Material" setter="set_material" getter="get_material"> The current [Material] of the primitive mesh. </member> diff --git a/doc/classes/PrismMesh.xml b/doc/classes/PrismMesh.xml index 58f7a0dd09..11815d299b 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.1-dev"> +<class name="PrismMesh" inherits="PrimitiveMesh" category="Core" version="3.1"> <brief_description> Class representing a prism-shaped [PrimitiveMesh]. </brief_description> @@ -14,7 +14,7 @@ </methods> <members> <member name="left_to_right" type="float" setter="set_left_to_right" getter="get_left_to_right"> - Displacement of of the upper edge along the x-axis. 0.0 positions edge straight above the bottome left edge. Defaults to 0.5 (positioned on the midpoint). + Displacement of the upper edge along the x-axis. 0.0 positions edge straight above the bottome left edge. Defaults to 0.5 (positioned on the midpoint). </member> <member name="size" type="Vector3" setter="set_size" getter="get_size"> Size of the prism. Defaults to (2.0, 2.0, 2.0). diff --git a/doc/classes/ProceduralSky.xml b/doc/classes/ProceduralSky.xml index 75831465ed..df0519b2ad 100644 --- a/doc/classes/ProceduralSky.xml +++ b/doc/classes/ProceduralSky.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ProceduralSky" inherits="Sky" category="Core" version="3.1-dev"> +<class name="ProceduralSky" inherits="Sky" category="Core" version="3.1"> <brief_description> + Type of [Sky] that is generated procedurally based on user input parameters. </brief_description> <description> + ProceduralSky provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are very similar, they are defined by a color at the horizon, another color, and finally an easing curve to interpolate between these two colors. Similarly the sun is described by a position in the sky, a color, and an easing curve. However, the sun also defines a minimum and maximum angle, these two values define at what distance the easing curve begins and ends from the sun, and thus end up defining the size of the sun in the sky. + The ProceduralSky is updated on the CPU after the parameters change and stored in a texture and then displayed as a background in the scene. This makes it relatively unsuitable for realtime updates during gameplay. But with a small texture size it is still feasible to update relatively frequently becuase it is updated on a background thread when multi-threading is available. </description> <tutorials> </tutorials> @@ -12,36 +15,52 @@ </methods> <members> <member name="ground_bottom_color" type="Color" setter="set_ground_bottom_color" getter="get_ground_bottom_color"> + Color of the ground at the bottom. </member> <member name="ground_curve" type="float" setter="set_ground_curve" getter="get_ground_curve"> + How quickly the [member ground_horizon_color] fades into the [member ground_bottom_color]. </member> <member name="ground_energy" type="float" setter="set_ground_energy" getter="get_ground_energy"> + Amount of energy contribution from the ground. </member> <member name="ground_horizon_color" type="Color" setter="set_ground_horizon_color" getter="get_ground_horizon_color"> + Color of the ground at the horizon. </member> <member name="sky_curve" type="float" setter="set_sky_curve" getter="get_sky_curve"> + How quickly the [member sky_horizon_color] fades into the [member sky_top_color]. </member> <member name="sky_energy" type="float" setter="set_sky_energy" getter="get_sky_energy"> + Amount of energy contribution from the sky. </member> <member name="sky_horizon_color" type="Color" setter="set_sky_horizon_color" getter="get_sky_horizon_color"> + Color of the sky at the horizon. </member> <member name="sky_top_color" type="Color" setter="set_sky_top_color" getter="get_sky_top_color"> + Color of the sky at the top. </member> <member name="sun_angle_max" type="float" setter="set_sun_angle_max" getter="get_sun_angle_max"> + Distance from center of sun where it fades out completely. </member> <member name="sun_angle_min" type="float" setter="set_sun_angle_min" getter="get_sun_angle_min"> + Distance from sun where it goes from solid to starting to fade. </member> <member name="sun_color" type="Color" setter="set_sun_color" getter="get_sun_color"> + Color of the sun. </member> <member name="sun_curve" type="float" setter="set_sun_curve" getter="get_sun_curve"> + How quickly the sun fades away between [member sun_angle_min] and [member sun_angle_max] </member> <member name="sun_energy" type="float" setter="set_sun_energy" getter="get_sun_energy"> + Amount of energy contribution from the sun. </member> <member name="sun_latitude" type="float" setter="set_sun_latitude" getter="get_sun_latitude"> + The suns height using polar coordinates. </member> <member name="sun_longitude" type="float" setter="set_sun_longitude" getter="get_sun_longitude"> + The direction of the sun using polar coordinates. </member> <member name="texture_size" type="int" setter="set_texture_size" getter="get_texture_size" enum="ProceduralSky.TextureSize"> + Size of [Texture] that the ProceduralSky will generate. </member> </members> <constants> diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml index 44eb82f2a4..0f03b7b80a 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.1-dev"> +<class name="ProgressBar" inherits="Range" category="Core" version="3.1"> <brief_description> General purpose progress bar. </brief_description> @@ -14,6 +14,7 @@ </methods> <members> <member name="percent_visible" type="bool" setter="set_percent_visible" getter="is_percent_visible"> + If [code]true[/code] the fill percentage is displayed on the bar. Default value: [code]true[/code]. </member> </members> <constants> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 83dea5d097..358b7292a5 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ProjectSettings" inherits="Object" category="Core" version="3.1-dev"> +<class name="ProjectSettings" inherits="Object" category="Core" version="3.1"> <brief_description> Contains global variables accessible from everywhere. </brief_description> @@ -156,6 +156,588 @@ </description> </method> </methods> + <members> + <member name="application/boot_splash/fullsize" type="bool" setter="" getter=""> + Scale the boot splash image to the full window length when engine starts (will leave it as default pixel size otherwise). + </member> + <member name="application/boot_splash/image" type="String" setter="" getter=""> + Path to an image used for boot splash. + </member> + <member name="application/config/custom_user_dir_name" type="String" setter="" getter=""> + This directory is used for storing persistent data (user:// filesystem). If a custom name is set, then system paths will be used to store this on Desktop (AppData on Windows, user ~/.config on Unixes, etc), else the Godot config folder is used. This name needs to be unique, and it's recommended to set it to something before publishing. + the "use_custom_user_dir" setting must be enabled for this to take effect. + </member> + <member name="application/config/icon" type="String" setter="" getter=""> + Icon used for the project, set when project loads. Exporters will use this icon when possible to. + </member> + <member name="application/config/name" type="String" setter="" getter=""> + Name of the project. It is used from both project manager and by the exporters. Overriding this as name.locale allows setting it in multiple languages. + </member> + <member name="application/config/use_custom_user_dir" type="bool" setter="" getter=""> + Allow the project to save to it's own custom user dir (in AppData on windows or ~/.config on unixes). This setting only works for desktop exporters. A name must be set in the "custom_user_dir_name" setting for this to take effect. + </member> + <member name="application/run/disable_stderr" type="bool" setter="" getter=""> + Disable printing to stderr on exported build. + </member> + <member name="application/run/disable_stdout" type="bool" setter="" getter=""> + Disable printing to stdout on exported build. + </member> + <member name="application/run/frame_delay_msec" type="int" setter="" getter=""> + Force a delay between frames in the main loop. This may be useful if you plan to disable vsync. + </member> + <member name="application/run/low_processor_mode" type="bool" setter="" getter=""> + Turn on low processor mode. This setting only works on desktops. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) on games. + </member> + <member name="application/run/low_processor_mode_sleep_usec" type="int" setter="" getter=""> + Amount of sleeping between frames when the low_processor_mode is enabled. This effectively reduces CPU usage when this mode is enabled. + </member> + <member name="application/run/main_scene" type="String" setter="" getter=""> + Path to the main scene file that will be loaded when the project runs. + </member> + <member name="audio/channel_disable_threshold_db" type="float" setter="" getter=""> + Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. + </member> + <member name="audio/channel_disable_time" type="float" setter="" getter=""> + Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. + </member> + <member name="audio/driver" type="String" setter="" getter=""> + </member> + <member name="audio/mix_rate" type="int" setter="" getter=""> + Mix rate used for audio. In general, it's better to not touch this and leave it to the host operating system. + </member> + <member name="audio/output_latency" type="int" setter="" getter=""> + </member> + <member name="audio/video_delay_compensation_ms" type="int" setter="" getter=""> + Setting to harcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. + </member> + <member name="compression/formats/gzip/compression_level" type="int" setter="" getter=""> + Default compression level for gzip. Affects compressed scenes and resources. + </member> + <member name="compression/formats/zlib/compression_level" type="int" setter="" getter=""> + Default compression level for zlib. Affects compressed scenes and resources. + </member> + <member name="compression/formats/zstd/compression_level" type="int" setter="" getter=""> + Default compression level for zstd. Affects compressed scenes and resources. + </member> + <member name="compression/formats/zstd/long_distance_matching" type="bool" setter="" getter=""> + Enable long distance matching in zstd. + </member> + <member name="compression/formats/zstd/window_log_size" type="int" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/constant_used_as_function" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/enable" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/function_conflicts_constant" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/function_conflicts_variable" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/function_may_yield" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/function_used_as_property" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/incompatible_ternary" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/integer_division" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/narrowing_conversion" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/property_used_as_function" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/treat_warnings_as_errors" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unassigned_variable" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unassigned_variable_op_assign" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unreachable_code" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unsafe_call_argument" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unsafe_cast" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unsafe_method_access" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unsafe_property_access" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unused_argument" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unused_class_variable" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unused_signal" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unused_variable" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/variable_conflicts_function" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/void_assignment" type="bool" setter="" getter=""> + </member> + <member name="debug/settings/crash_handler/message" type="String" setter="" getter=""> + </member> + <member name="debug/settings/fps/force_fps" type="int" setter="" getter=""> + </member> + <member name="debug/settings/gdscript/max_call_stack" type="int" setter="" getter=""> + Maximum call stack allowed for debugging GDScript. + </member> + <member name="debug/settings/profiler/max_functions" type="int" setter="" getter=""> + Maximum amount of functions per frame allowed when profiling. + </member> + <member name="debug/settings/stdout/print_fps" type="bool" setter="" getter=""> + Print frames per second to stdout. Not very useful in general. + </member> + <member name="debug/settings/stdout/verbose_stdout" type="bool" setter="" getter=""> + Print more information to stdout when running. It shows info such as memory leaks, which scenes and resources are being loaded, etc. + </member> + <member name="debug/settings/visual_script/max_call_stack" type="int" setter="" getter=""> + Maximum call stack in visual scripting, to avoid infinite recursion. + </member> + <member name="display/mouse_cursor/custom_image" type="String" setter="" getter=""> + Custom image for the mouse cursor. + </member> + <member name="display/mouse_cursor/custom_image_hotspot" type="Vector2" setter="" getter=""> + Hotspot for the custom mouse cursor image. + </member> + <member name="display/window/allow_per_pixel_transparency" type="bool" setter="" getter=""> + Allow per pixel transparency in a Desktop window. This affects performance if not needed, so leave it off. + </member> + <member name="display/window/dpi/allow_hidpi" type="bool" setter="" getter=""> + Allow HiDPI display on Windows and OSX. On Desktop Linux, this can't be enabled or disabled. + </member> + <member name="display/window/energy_saving/keep_screen_on" type="bool" setter="" getter=""> + Force keep the screen on, so the screensaver does not take over. Works on Desktop and Mobile. + </member> + <member name="display/window/handheld/orientation" type="String" setter="" getter=""> + Default orientation for cell phone or tablet. + </member> + <member name="display/window/per_pixel_transparency" type="bool" setter="" getter=""> + </member> + <member name="display/window/per_pixel_transparency_splash" type="bool" setter="" getter=""> + </member> + <member name="display/window/size/always_on_top" type="bool" setter="" getter=""> + Force the window to be always on top. + </member> + <member name="display/window/size/borderless" type="bool" setter="" getter=""> + Force the window to be borderless. + </member> + <member name="display/window/size/fullscreen" type="bool" setter="" getter=""> + Set the window to full screen when it starts. + </member> + <member name="display/window/size/height" type="int" setter="" getter=""> + Set the main window height. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. + </member> + <member name="display/window/size/resizable" type="bool" setter="" getter=""> + Allow the window to be resizable by default. + </member> + <member name="display/window/size/test_height" type="int" setter="" getter=""> + Test a different height for the window. The main use for this is to test with stretch modes. + </member> + <member name="display/window/size/test_width" type="int" setter="" getter=""> + Test a different width for the window. The main use for this is to test with stretch modes. + </member> + <member name="display/window/size/width" type="int" setter="" getter=""> + Set the main window width. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. + </member> + <member name="display/window/vsync/use_vsync" type="bool" setter="" getter=""> + Use VSync. Don't be stupid, don't turn this off. + </member> + <member name="editor/active" type="bool" setter="" getter=""> + Internal editor setting, don't touch. + </member> + <member name="gui/common/default_scroll_deadzone" type="int" setter="" getter=""> + </member> + <member name="gui/common/swap_ok_cancel" type="bool" setter="" getter=""> + Enable swap OK and Cancel buttons on dialogs. This is because Windows/MacOS/Desktop Linux may use them in different order, so the GUI swaps them depending on the host OS. Disable this behavior by turning this setting off. + </member> + <member name="gui/theme/custom" type="String" setter="" getter=""> + Use a custom theme resource, set a path to it here. + </member> + <member name="gui/theme/custom_font" type="String" setter="" getter=""> + USe a custom default font resource, set a path to it here. + </member> + <member name="gui/theme/use_hidpi" type="bool" setter="" getter=""> + Make sure the theme used works with hidpi. + </member> + <member name="gui/timers/incremental_search_max_interval_msec" type="int" setter="" getter=""> + Timer setting for incremental search in Tree, IntemList, etc. controls. + </member> + <member name="gui/timers/text_edit_idle_detect_sec" type="int" setter="" getter=""> + Timer for detecting idle in the editor. + </member> + <member name="input/ui_accept" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_cancel" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_down" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_end" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_focus_next" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_focus_prev" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_home" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_left" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_page_down" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_page_up" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_right" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_select" type="Dictionary" setter="" getter=""> + </member> + <member name="input/ui_up" type="Dictionary" setter="" getter=""> + </member> + <member name="input_devices/pointing/emulate_mouse_from_touch" type="bool" setter="" getter=""> + </member> + <member name="input_devices/pointing/emulate_touch_from_mouse" type="bool" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_1" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_10" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_11" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_12" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_13" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_14" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_15" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_16" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_17" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_18" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_19" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_2" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_20" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_3" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_4" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_5" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_6" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_7" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_8" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_physics/layer_9" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_1" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_10" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_11" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_12" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_13" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_14" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_15" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_16" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_17" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_18" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_19" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_2" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_20" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_3" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_4" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_5" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_6" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_7" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_8" type="String" setter="" getter=""> + </member> + <member name="layer_names/2d_render/layer_9" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_1" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_10" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_11" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_12" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_13" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_14" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_15" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_16" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_17" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_18" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_19" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_2" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_20" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_3" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_4" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_5" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_6" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_7" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_8" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_physics/layer_9" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_1" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_10" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_11" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_12" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_13" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_14" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_15" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_16" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_17" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_18" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_19" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_2" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_20" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_3" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_4" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_5" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_6" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_7" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_8" type="String" setter="" getter=""> + </member> + <member name="layer_names/3d_render/layer_9" type="String" setter="" getter=""> + </member> + <member name="locale/fallback" type="String" setter="" getter=""> + </member> + <member name="locale/test" type="String" setter="" getter=""> + </member> + <member name="logging/file_logging/enable_file_logging" type="bool" setter="" getter=""> + Log all output to a file. + </member> + <member name="logging/file_logging/log_path" type="String" setter="" getter=""> + Path to logs withint he project. Using an user:// based path is recommended. + </member> + <member name="logging/file_logging/max_log_files" type="int" setter="" getter=""> + Amount of log files (used for rotation)/ + </member> + <member name="memory/limits/message_queue/max_size_kb" type="int" setter="" getter=""> + Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here. + </member> + <member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter=""> + This is used by servers when used in multi threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number. + </member> + <member name="network/limits/debugger_stdout/max_chars_per_second" type="int" setter="" getter=""> + Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. + </member> + <member name="network/limits/debugger_stdout/max_errors_per_frame" type="int" setter="" getter=""> + Maximum amount of errors allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. + </member> + <member name="network/limits/debugger_stdout/max_messages_per_frame" type="int" setter="" getter=""> + Maximum amount of messages allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. + </member> + <member name="network/limits/packet_peer_stream/max_buffer_po2" type="int" setter="" getter=""> + Default size of packet peer stream for deserializing godot data. Over this size, data is dropped. + </member> + <member name="network/remote_fs/max_pages" type="int" setter="" getter=""> + Maximum amount of pages used for remote filesystem (used by debugging). + </member> + <member name="network/remote_fs/page_read_ahead" type="int" setter="" getter=""> + Amount of read ahead used by remote filesystem. Improves latency. + </member> + <member name="network/remote_fs/page_size" type="int" setter="" getter=""> + Page size used by remote filesystem. + </member> + <member name="network/ssl/certificates" type="String" setter="" getter=""> + If your game or application uses HTTPS, a certificates file is needed. It must be set here. + </member> + <member name="node/name_casing" type="int" setter="" getter=""> + When creating nodes names automatically, set the type of casing in this project. This is mostly an editor setting. + </member> + <member name="node/name_num_separator" type="int" setter="" getter=""> + What to use to separate node name from number. This is mostly an editor setting. + </member> + <member name="physics/2d/physics_engine" type="String" setter="" getter=""> + </member> + <member name="physics/2d/thread_model" type="int" setter="" getter=""> + Set whether physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API Access to only physics process. + </member> + <member name="physics/3d/active_soft_world" type="bool" setter="" getter=""> + </member> + <member name="physics/3d/physics_engine" type="String" setter="" getter=""> + </member> + <member name="physics/common/physics_fps" type="int" setter="" getter=""> + Frames per second used in the physics. Physics always needs a fixed amount of frames per second. + </member> + <member name="physics/common/physics_jitter_fix" type="float" setter="" getter=""> + Fix to improve physics jitter, specially on monitors where refresh rate is different than physics FPS. + </member> + <member name="rendering/environment/default_clear_color" type="Color" setter="" getter=""> + Default background clear color. + </member> + <member name="rendering/limits/buffers/blend_shape_max_buffer_size_kb" type="int" setter="" getter=""> + Max buffer size for blend shapes. Any blend shape bigger than this will not work. + </member> + <member name="rendering/limits/buffers/canvas_polygon_buffer_size_kb" type="int" setter="" getter=""> + Max buffer size for drawing polygons. Any polygon bigger than this will not work. + </member> + <member name="rendering/limits/buffers/canvas_polygon_index_buffer_size_kb" type="int" setter="" getter=""> + Max index buffer size for drawing polygons. Any polygon bigger than this will not work. + </member> + <member name="rendering/limits/buffers/immediate_buffer_size_kb" type="int" setter="" getter=""> + Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work. + </member> + <member name="rendering/limits/rendering/max_renderable_elements" type="int" setter="" getter=""> + Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not mesh themselves. + </member> + <member name="rendering/limits/time/time_rollover_secs" type="int" setter="" getter=""> + Shaders have a time variable that constantly increases. At some point it needs to be rolled back to zero to avoid numerical errors on shader animations. This setting specifies when. + </member> + <member name="rendering/quality/2d/use_pixel_snap" type="bool" setter="" getter=""> + Force snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. + </member> + <member name="rendering/quality/depth_prepass/disable_for_vendors" type="String" setter="" getter=""> + Disable depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. + </member> + <member name="rendering/quality/depth_prepass/enable" type="bool" setter="" getter=""> + Do a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. + </member> + <member name="rendering/quality/directional_shadow/size" type="int" setter="" getter=""> + Size in pixels of the directional shadow. + </member> + <member name="rendering/quality/directional_shadow/size.mobile" type="int" setter="" getter=""> + </member> + <member name="rendering/quality/driver/driver_name" type="String" setter="" getter=""> + </member> + <member name="rendering/quality/filters/anisotropic_filter_level" type="int" setter="" getter=""> + Maximum Anisotropic filter level used for textures when anisotropy enabled. + </member> + <member name="rendering/quality/filters/use_nearest_mipmap_filter" type="bool" setter="" getter=""> + Force to use nearest mipmap filtering when using mipmaps. This may increase performance in mobile as less memory bandwidth is used. + </member> + <member name="rendering/quality/intended_usage/framebuffer_allocation" type="int" setter="" getter=""> + Strategy used for framebuffer allocation. The simpler it is, the less memory it uses (but the least features it supports). + </member> + <member name="rendering/quality/intended_usage/framebuffer_allocation.mobile" type="int" setter="" getter=""> + </member> + <member name="rendering/quality/reflections/high_quality_ggx" type="bool" setter="" getter=""> + For reflection probes and panorama backgrounds (sky), use a high amount of samples to create ggx blurred versions (used for roughness). + </member> + <member name="rendering/quality/reflections/high_quality_ggx.mobile" type="bool" setter="" getter=""> + </member> + <member name="rendering/quality/reflections/texture_array_reflections" type="bool" setter="" getter=""> + For reflection probes and panorama backgrounds (sky), use a texure array instead of mipmaps. This reduces jitter noise on reflections, but costs more performance and memory. + </member> + <member name="rendering/quality/reflections/texture_array_reflections.mobile" type="bool" setter="" getter=""> + </member> + <member name="rendering/quality/shading/force_vertex_shading" type="bool" setter="" getter=""> + Force vertex shading for all rendering. This can increase performance a lot, but also reduces quality inmensely. Can work to optimize on very low end mobile. + </member> + <member name="rendering/quality/shading/force_vertex_shading.mobile" type="bool" setter="" getter=""> + </member> + <member name="rendering/quality/shadow_atlas/quadrant_0_subdiv" type="int" setter="" getter=""> + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + </member> + <member name="rendering/quality/shadow_atlas/quadrant_1_subdiv" type="int" setter="" getter=""> + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + </member> + <member name="rendering/quality/shadow_atlas/quadrant_2_subdiv" type="int" setter="" getter=""> + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + </member> + <member name="rendering/quality/shadow_atlas/quadrant_3_subdiv" type="int" setter="" getter=""> + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + </member> + <member name="rendering/quality/shadow_atlas/size" type="int" setter="" getter=""> + Size for shadow atlas (used for point and omni lights). See documentation. + </member> + <member name="rendering/quality/shadow_atlas/size.mobile" type="int" setter="" getter=""> + </member> + <member name="rendering/quality/shadows/filter_mode" type="int" setter="" getter=""> + Shadow filter mode. The more complex the filter, the more memory bandwidth required. + </member> + <member name="rendering/quality/shadows/filter_mode.mobile" type="int" setter="" getter=""> + </member> + <member name="rendering/quality/subsurface_scattering/follow_surface" type="bool" setter="" getter=""> + Improves quality of subsurface scattering, but cost significantly increases. + </member> + <member name="rendering/quality/subsurface_scattering/quality" type="int" setter="" getter=""> + Quality setting for subsurface scaterring (samples taken). + </member> + <member name="rendering/quality/subsurface_scattering/scale" type="int" setter="" getter=""> + </member> + <member name="rendering/quality/subsurface_scattering/weight_samples" type="bool" setter="" getter=""> + Weight subsurface scattering samples. Helps to avoid reading samples from unrelated parts of the screen. + </member> + <member name="rendering/quality/voxel_cone_tracing/high_quality" type="bool" setter="" getter=""> + Use high quality voxel cone tracing (looks better, but requires a higher end GPU). + </member> + <member name="rendering/threads/thread_model" type="int" setter="" getter=""> + Thread model for rendering. Rendering on a thread can vastly improve performance, but syncinc to the main thread can cause a bit more jitter. + </member> + <member name="rendering/vram_compression/import_etc" type="bool" setter="" getter=""> + If the project uses this compression (usually low end mobile), texture importer will import these. + </member> + <member name="rendering/vram_compression/import_etc2" type="bool" setter="" getter=""> + If the project uses this compression (usually high end mobile), texture importer will import these. + </member> + <member name="rendering/vram_compression/import_pvrtc" type="bool" setter="" getter=""> + If the project uses this compression (usually iOS), texture importer will import these. + </member> + <member name="rendering/vram_compression/import_s3tc" type="bool" setter="" getter=""> + If the project uses this compression (usually Desktop and Consoles), texture importer will import these. + </member> + <member name="script" type="Script" setter="" getter=""> + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/ProximityGroup.xml b/doc/classes/ProximityGroup.xml index 697bb8ff7e..1f1c45fbf9 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.1-dev"> +<class name="ProximityGroup" inherits="Spatial" category="Core" version="3.1"> <brief_description> General purpose proximity-detection node. </brief_description> diff --git a/doc/classes/ProxyTexture.xml b/doc/classes/ProxyTexture.xml index 2f50229643..69702ee22e 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.1-dev"> +<class name="ProxyTexture" inherits="Texture" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/QuadMesh.xml b/doc/classes/QuadMesh.xml index a295ffc929..a45b2ddf4b 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.1-dev"> +<class name="QuadMesh" inherits="PrimitiveMesh" category="Core" version="3.1"> <brief_description> Class representing a square mesh. </brief_description> diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index 90301db01f..67631bbc92 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -1,15 +1,16 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Quat" category="Built-In Types" version="3.1-dev"> +<class name="Quat" category="Built-In Types" version="3.1"> <brief_description> Quaternion. </brief_description> <description> - A 4-dimensional vector representing a rotation. - The vector represents a 4 dimensional complex number where multiplication of the basis elements is not commutative (multiplying i with j gives a different result than multiplying j with i). - Multiplying quaternions reproduces rotation sequences. However quaternions need to be often renormalized, or else they suffer from precision issues. - It can be used to perform SLERP (spherical-linear interpolation) between two rotations. + A unit quaternion used for representing 3D rotations. + It is similar to [Basis], which implements matrix representation of rotations, and can be parametrized using both an axis-angle pair or Euler angles. But due to its compactness and the way it is stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating point errors. + Quaternions need to be (re)normalized. </description> <tutorials> + <link>http://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html#interpolating-with-quaternions</link> + <link>http://docs.godotengine.org/en/latest/tutorials/math/rotations.html</link> </tutorials> <demos> </demos> @@ -17,16 +18,19 @@ <method name="Quat"> <return type="Quat"> </return> - <argument index="0" name="x" type="float"> - </argument> - <argument index="1" name="y" type="float"> - </argument> - <argument index="2" name="z" type="float"> + <argument index="0" name="from" type="Basis"> </argument> - <argument index="3" name="w" type="float"> + <description> + Returns the rotation matrix corresponding to the given quaternion. + </description> + </method> + <method name="Quat"> + <return type="Quat"> + </return> + <argument index="0" name="euler" type="Vector3"> </argument> <description> - Returns a quaternion defined by these values. + Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). </description> </method> <method name="Quat"> @@ -43,10 +47,16 @@ <method name="Quat"> <return type="Quat"> </return> - <argument index="0" name="from" type="Basis"> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <argument index="2" name="z" type="float"> + </argument> + <argument index="3" name="w" type="float"> </argument> <description> - Returns the rotation matrix corresponding to the given quaternion. + Returns a quaternion defined by these values. </description> </method> <method name="cubic_slerp"> @@ -73,6 +83,13 @@ Returns the dot product of two quaternions. </description> </method> + <method name="get_euler"> + <return type="Vector3"> + </return> + <description> + Return Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). + </description> + </method> <method name="inverse"> <return type="Quat"> </return> @@ -108,6 +125,22 @@ Returns a copy of the quaternion, normalized to unit length. </description> </method> + <method name="set_axis_angle"> + <argument index="0" name="axis" type="Vector3"> + </argument> + <argument index="1" name="angle" type="float"> + </argument> + <description> + Set the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector. + </description> + </method> + <method name="set_euler"> + <argument index="0" name="euler" type="Vector3"> + </argument> + <description> + Set the quaternion to a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). + </description> + </method> <method name="slerp"> <return type="Quat"> </return> @@ -155,5 +188,7 @@ </member> </members> <constants> + <constant name="IDENTITY" value="Quat( 0, 0, 0, 1 )"> + </constant> </constants> </class> diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index 85702727ce..ee34560afd 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.1-dev"> +<class name="RID" category="Built-In Types" version="3.1"> <brief_description> Handle for a [Resource]'s unique ID. </brief_description> diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index 7828445dc4..46a6132b94 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.1-dev"> +<class name="Range" inherits="Control" category="Core" version="3.1"> <brief_description> Abstract base class for range-based controls. </brief_description> @@ -17,26 +17,32 @@ <argument index="0" name="with" type="Node"> </argument> <description> - Binds two Ranges together along with any Ranges previously grouped with either of them. When any of Range's member variables change, it will share the new value with all other Ranges in its group. + Binds two ranges together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. </description> </method> <method name="unshare"> <return type="void"> </return> <description> - Stop Range from sharing its member variables with any other Range. + Stop range from sharing its member variables with any other. </description> </method> </methods> <members> + <member name="allow_greater" type="bool" setter="set_allow_greater" getter="is_greater_allowed"> + If [code]true[/code] [member value] may be greater than [member max_value]. Default value: [code]false[/code]. + </member> + <member name="allow_lesser" type="bool" setter="set_allow_lesser" getter="is_lesser_allowed"> + If [code]true[/code] [member value] may be less than [member min_value]. Default value: [code]false[/code]. + </member> <member name="exp_edit" type="bool" setter="set_exp_ratio" getter="is_ratio_exp"> If [code]true[/code] and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly. </member> <member name="max_value" type="float" setter="set_max" getter="get_max"> - Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code]. Default value: 100. + Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code]. Default value: [code]100[/code]. </member> <member name="min_value" type="float" setter="set_min" getter="get_min"> - Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code]. Default value: 0. + Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code]. Default value: [code]0[/code]. </member> <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]. @@ -45,7 +51,7 @@ 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. + If [code]true[/code] [code]value[/code] will always be rounded to the nearest integer. Default value: [code]false[/code]. </member> <member name="step" type="float" setter="set_step" getter="get_step"> If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer. @@ -57,14 +63,14 @@ <signals> <signal name="changed"> <description> - This signal is emitted when min, max, range or step change. + Emitted when [member min_value], [member max_value], [member page], or [member step] change. </description> </signal> <signal name="value_changed"> <argument index="0" name="value" type="float"> </argument> <description> - This signal is emitted when value changes. + Emitted when [member value] changes. </description> </signal> </signals> diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index 76574b305f..dce73d9c29 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.1-dev"> +<class name="RayCast" inherits="Spatial" category="Core" version="3.1"> <brief_description> Query the closest object intersecting a ray. </brief_description> diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 7a6ec8ded8..79e733bcdc 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.1-dev"> +<class name="RayCast2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> Query the closest object intersecting a ray. </brief_description> diff --git a/doc/classes/RayShape.xml b/doc/classes/RayShape.xml index 5d488cb3f5..e03541011d 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.1-dev"> +<class name="RayShape" inherits="Shape" category="Core" version="3.1"> <brief_description> Ray shape for 3D collisions. </brief_description> @@ -16,6 +16,9 @@ <member name="length" type="float" setter="set_length" getter="get_length"> The ray's length. </member> + <member name="slips_on_slope" type="bool" setter="set_slips_on_slope" getter="get_slips_on_slope"> + If [code]true[/code] allow the shape to return the correct normal. Default value: [code]false[/code]. + </member> </members> <constants> </constants> diff --git a/doc/classes/RayShape2D.xml b/doc/classes/RayShape2D.xml index 3137bbd1ad..37cfe4f2d3 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.1-dev"> +<class name="RayShape2D" inherits="Shape2D" category="Core" version="3.1"> <brief_description> Ray shape for 2D collisions. </brief_description> @@ -16,6 +16,9 @@ <member name="length" type="float" setter="set_length" getter="get_length"> The ray's length. </member> + <member name="slips_on_slope" type="bool" setter="set_slips_on_slope" getter="get_slips_on_slope"> + If [code]true[/code] allow the shape to return the correct normal. Default value: [code]false[/code]. + </member> </members> <constants> </constants> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index bafa5a3632..1eea940da9 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.1-dev"> +<class name="Rect2" category="Built-In Types" version="3.1"> <brief_description> 2D Axis-aligned bounding box. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/math/index.html</link> </tutorials> <demos> </demos> @@ -42,6 +42,7 @@ <return type="Rect2"> </return> <description> + Returns a [code]Rect2[/code] with equivalent position and area, modified so that the top-left corner is the origin and [code]width[/code] and [code]height[/code] are positive. </description> </method> <method name="clip"> diff --git a/doc/classes/RectangleShape2D.xml b/doc/classes/RectangleShape2D.xml index 5e2bdf040a..4a312503f4 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.1-dev"> +<class name="RectangleShape2D" inherits="Shape2D" category="Core" version="3.1"> <brief_description> Rectangle shape for 2D collisions. </brief_description> diff --git a/doc/classes/Reference.xml b/doc/classes/Reference.xml index 3f4f499b3e..3238501633 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.1-dev"> +<class name="Reference" inherits="Object" category="Core" version="3.1"> <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 1946ee8b81..e1cb104e40 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.1-dev"> +<class name="ReferenceRect" inherits="Control" category="Core" version="3.1"> <brief_description> Reference frame for GUI. </brief_description> @@ -12,10 +12,10 @@ </demos> <methods> </methods> + <members> + <member name="border_color" type="Color" setter="set_border_color" getter="get_border_color"> + </member> + </members> <constants> </constants> - <theme_items> - <theme_item name="border" type="StyleBox"> - </theme_item> - </theme_items> </class> diff --git a/doc/classes/ReflectionProbe.xml b/doc/classes/ReflectionProbe.xml index c565fc6a92..a9a897ebaf 100644 --- a/doc/classes/ReflectionProbe.xml +++ b/doc/classes/ReflectionProbe.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ReflectionProbe" inherits="VisualInstance" category="Core" version="3.1-dev"> +<class name="ReflectionProbe" inherits="VisualInstance" category="Core" version="3.1"> <brief_description> </brief_description> <description> </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/3d/reflection_probes.html + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/reflection_probes.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/RemoteTransform.xml b/doc/classes/RemoteTransform.xml index 16521e27ea..a7deb273b6 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.1-dev"> +<class name="RemoteTransform" inherits="Spatial" category="Core" version="3.1"> <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 a6c61eb2f4..bc562dcdad 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.1-dev"> +<class name="RemoteTransform2D" inherits="Node2D" category="Core" version="3.1"> <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 9bba251607..fc42635ce2 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.1-dev"> +<class name="Resource" inherits="Reference" category="Core" version="3.1"> <brief_description> Base class for all resources. </brief_description> diff --git a/doc/classes/ResourceImporter.xml b/doc/classes/ResourceImporter.xml index 91e72ff595..09fe828bd3 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.1-dev"> +<class name="ResourceImporter" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ResourceInteractiveLoader.xml b/doc/classes/ResourceInteractiveLoader.xml index dba045213e..076121b42d 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.1-dev"> +<class name="ResourceInteractiveLoader" inherits="Reference" category="Core" version="3.1"> <brief_description> Interactive Resource Loader. </brief_description> diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index baeb7a6bb4..ae900e34ef 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.1-dev"> +<class name="ResourceLoader" inherits="Object" category="Core" version="3.1"> <brief_description> Resource Loader. </brief_description> @@ -11,6 +11,16 @@ <demos> </demos> <methods> + <method name="exists"> + <return type="bool"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="type_hint" type="String" default=""""> + </argument> + <description> + </description> + </method> <method name="get_dependencies"> <return type="PoolStringArray"> </return> @@ -36,6 +46,14 @@ <description> </description> </method> + <method name="has_cached"> + <return type="bool"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> <method name="load"> <return type="Resource"> </return> diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index 6c3c4cd5d0..002bcd891a 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.1-dev"> +<class name="ResourcePreloader" inherits="Node" category="Core" version="3.1"> <brief_description> Resource Preloader Node. </brief_description> diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index e44244aabb..ae0d8e909d 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.1-dev"> +<class name="ResourceSaver" inherits="Object" category="Core" version="3.1"> <brief_description> Resource Saving Interface. </brief_description> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index dab8eb1505..618f2f42b2 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.1-dev"> +<class name="RichTextLabel" inherits="Control" category="Core" version="3.1"> <brief_description> Label that displays rich text. </brief_description> @@ -8,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/gui/bbcode_in_richtextlabel.html</link> </tutorials> <demos> </demos> @@ -47,6 +47,13 @@ Clears the tag stack and sets [member bbcode_text] to an empty string. </description> </method> + <method name="get_content_height"> + <return type="int"> + </return> + <description> + Returns the height of the content. + </description> + </method> <method name="get_line_count" qualifiers="const"> <return type="int"> </return> @@ -319,6 +326,8 @@ </theme_item> <theme_item name="font_color_selected" type="Color"> </theme_item> + <theme_item name="font_color_shadow" type="Color"> + </theme_item> <theme_item name="italics_font" type="Font"> </theme_item> <theme_item name="line_separation" type="int"> @@ -331,6 +340,12 @@ </theme_item> <theme_item name="selection_color" type="Color"> </theme_item> + <theme_item name="shadow_as_outline" type="int"> + </theme_item> + <theme_item name="shadow_offset_x" type="int"> + </theme_item> + <theme_item name="shadow_offset_y" type="int"> + </theme_item> <theme_item name="table_hseparation" type="int"> </theme_item> <theme_item name="table_vseparation" type="int"> diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index a1aa479ea1..038464e127 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.1-dev"> +<class name="RigidBody" inherits="PhysicsBody" category="Core" version="3.1"> <brief_description> Physics Body whose position is determined through physics simulation in 3D space. </brief_description> @@ -10,7 +10,7 @@ If you need to override the default physics behavior, you can write a custom force integration. See [member custom_integrator]. </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html</link> </tutorials> <demos> </demos> @@ -24,6 +24,40 @@ Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body. </description> </method> + <method name="add_central_force"> + <return type="void"> + </return> + <argument index="0" name="force" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="add_force"> + <return type="void"> + </return> + <argument index="0" name="force" type="Vector3"> + </argument> + <argument index="1" name="position" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="add_torque"> + <return type="void"> + </return> + <argument index="0" name="torque" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="apply_central_impulse"> + <return type="void"> + </return> + <argument index="0" name="impulse" type="Vector3"> + </argument> + <description> + </description> + </method> <method name="apply_impulse"> <return type="void"> </return> @@ -38,7 +72,7 @@ <method name="apply_torque_impulse"> <return type="void"> </return> - <argument index="1" name="impulse" type="Vector3"> + <argument index="0" name="impulse" type="Vector3"> </argument> <description> Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the passed in vector. @@ -117,6 +151,8 @@ <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="RigidBody.Mode"> The body mode from the MODE_* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. </member> + <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override"> + </member> <member name="sleeping" type="bool" setter="set_sleeping" getter="is_sleeping"> If [code]true[/code] RigidBody is sleeping and will not calculate forces until woken up by a collision or the [code]apply_impulse[/code] method. </member> diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 719ddfffe4..2265c777c8 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.1-dev"> +<class name="RigidBody2D" inherits="PhysicsBody2D" category="Core" version="3.1"> <brief_description> A body that is controlled by the 2D physics engine. </brief_description> @@ -23,6 +23,14 @@ Allows you to read and safely modify the simulation state for the object. Use this instead of [Node._physics_process] if you need to directly change the body's [code]position[/code] or other physics properties. By default it works in addition to the usual physics behavior, but [member custom_integrator] allows you to disable the default behavior and write custom force integration for a body. </description> </method> + <method name="add_central_force"> + <return type="void"> + </return> + <argument index="0" name="force" type="Vector2"> + </argument> + <description> + </description> + </method> <method name="add_force"> <return type="void"> </return> @@ -34,6 +42,22 @@ Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates. </description> </method> + <method name="add_torque"> + <return type="void"> + </return> + <argument index="0" name="torque" type="float"> + </argument> + <description> + </description> + </method> + <method name="apply_central_impulse"> + <return type="void"> + </return> + <argument index="0" name="impulse" type="Vector2"> + </argument> + <description> + </description> + </method> <method name="apply_impulse"> <return type="void"> </return> @@ -45,6 +69,14 @@ 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="apply_torque_impulse"> + <return type="void"> + </return> + <argument index="0" name="torque" type="float"> + </argument> + <description> + </description> + </method> <method name="get_colliding_bodies" qualifiers="const"> <return type="Array"> </return> @@ -66,9 +98,11 @@ </return> <argument index="0" name="motion" type="Vector2"> </argument> - <argument index="1" name="margin" type="float" default="0.08"> + <argument index="1" name="infinite_inertia" type="bool" default="true"> + </argument> + <argument index="2" name="margin" type="float" default="0.08"> </argument> - <argument index="2" name="result" type="Physics2DTestMotionResult" default="null"> + <argument index="3" name="result" type="Physics2DTestMotionResult" default="null"> </argument> <description> Returns [code]true[/code] if a collision would result from moving in the given vector. [code]margin[/code] increases the size of the shapes involved in the collision detection, and [code]result[/code] is an object of type [Physics2DTestMotionResult], which contains additional information about the collision (should there be one). @@ -128,6 +162,8 @@ <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="RigidBody2D.Mode"> The body's mode. See [code]MODE_*[/code] constants. Default value: [code]MODE_RIGID[/code]. </member> + <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override"> + </member> <member name="sleeping" type="bool" setter="set_sleeping" getter="is_sleeping"> If [code]true[/code] the body is sleeping and will not calculate forces until woken up by a collision or by using [method apply_impulse] or [method add_force]. </member> diff --git a/doc/classes/RootMotionView.xml b/doc/classes/RootMotionView.xml new file mode 100644 index 0000000000..97008f05ff --- /dev/null +++ b/doc/classes/RootMotionView.xml @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RootMotionView" inherits="VisualInstance" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="animation_path" type="NodePath" setter="set_animation_path" getter="get_animation_path"> + </member> + <member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size"> + </member> + <member name="color" type="Color" setter="set_color" getter="get_color"> + </member> + <member name="radius" type="float" setter="set_radius" getter="get_radius"> + </member> + <member name="zero_y" type="bool" setter="set_zero_y" getter="get_zero_y"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index 3ce08c0878..36cddf08df 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.1-dev"> +<class name="SceneState" inherits="Reference" category="Core" version="3.1"> <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 bd6ffbaf80..c85bee9b84 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -1,12 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SceneTree" inherits="MainLoop" category="Core" version="3.1-dev"> +<class name="SceneTree" inherits="MainLoop" category="Core" version="3.1"> <brief_description> + SceneTree manages a hierarchy of nodes. </brief_description> <description> + As one of the most important classes, the [code]SceneTree[/code] manages the hierarchy of nodes in a scene as well as scenes themselves. Nodes can be added, retrieved and removed. The whole scene tree (and thus the current scene) can be paused. Scenes can be loaded, switched and reloaded. You can also use the SceneTree to organize your nodes into groups: every node can be assigned as many groups as you want to create, e.g. a "enemy" group. You can then iterate these groups or even call methods and set properties on all the group's members at once. </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 + <link>http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scene_tree.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/viewports/multiple_resolutions.html</link> </tutorials> <demos> </demos> @@ -19,6 +21,7 @@ <argument index="1" name="method" type="String"> </argument> <description> + Calls [code]method[/code] on each member of the given group. </description> </method> <method name="call_group_flags" qualifiers="vararg"> @@ -31,6 +34,7 @@ <argument index="2" name="method" type="String"> </argument> <description> + Calls [code]method[/code] on each member of the given group, respecting the given [enum GroupCallFlags]. </description> </method> <method name="change_scene"> @@ -39,6 +43,7 @@ <argument index="0" name="path" type="String"> </argument> <description> + Changes to the scene at the given [code]path[/code]. </description> </method> <method name="change_scene_to"> @@ -47,6 +52,7 @@ <argument index="0" name="packed_scene" type="PackedScene"> </argument> <description> + Changes to the given [PackedScene]. </description> </method> <method name="create_timer"> @@ -57,6 +63,7 @@ <argument index="1" name="pause_mode_process" type="bool" default="true"> </argument> <description> + Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this SceneTree. If [code]pause_mode_process[/code] is set to false, pausing the SceneTree will also pause the timer. </description> </method> <method name="get_frame" qualifiers="const"> @@ -69,18 +76,21 @@ <return type="PoolIntArray"> </return> <description> + Returns the peer IDs of all connected peers of this SceneTree's [member network_peer]. </description> </method> <method name="get_network_unique_id" qualifiers="const"> <return type="int"> </return> <description> + Returns the unique peer ID of this SceneTree's [member network_peer]. </description> </method> <method name="get_node_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of nodes in this SceneTree. </description> </method> <method name="get_nodes_in_group"> @@ -89,12 +99,14 @@ <argument index="0" name="group" type="String"> </argument> <description> + Returns all nodes assigned to the given group. </description> </method> <method name="get_rpc_sender_id" qualifiers="const"> <return type="int"> </return> <description> + Returns the sender's peer ID for the most recently received RPC call. </description> </method> <method name="has_group" qualifiers="const"> @@ -103,26 +115,28 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns [code]true[/code] if the given group exists. </description> </method> <method name="has_network_peer" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if there is a [NetworkedMultiplayerPeer] set (with [method SceneTree.set_network_peer]). + Returns [code]true[/code] if there is a [member network_peer] set. </description> </method> <method name="is_input_handled"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the most recent InputEvent was marked as handled with [method set_input_as_handled]. </description> </method> <method name="is_network_server" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if this SceneTree's [NetworkedMultiplayerPeer] is in server mode (listening for connections). + Returns [code]true[/code] if this SceneTree's [member network_peer] is in server mode (listening for connections). </description> </method> <method name="notify_group"> @@ -133,6 +147,7 @@ <argument index="1" name="notification" type="int"> </argument> <description> + Sends the given notification to all members of the [code]group[/code]. </description> </method> <method name="notify_group_flags"> @@ -145,6 +160,7 @@ <argument index="2" name="notification" type="int"> </argument> <description> + Sends the given notification to all members of the [code]group[/code], respecting the given [enum GroupCallFlags]. </description> </method> <method name="queue_delete"> @@ -153,18 +169,21 @@ <argument index="0" name="obj" type="Object"> </argument> <description> + Queues the given object for deletion, delaying the call to [method Object.free] to after the current frame. </description> </method> <method name="quit"> <return type="void"> </return> <description> + Quits the application. </description> </method> <method name="reload_current_scene"> <return type="int" enum="Error"> </return> <description> + Reloads the currently active scene. </description> </method> <method name="set_auto_accept_quit"> @@ -173,6 +192,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] the application automatically accepts quitting. </description> </method> <method name="set_group"> @@ -185,6 +205,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> + Sets the given [code]property[/code] to [code]value[/code] on all members of the given group. </description> </method> <method name="set_group_flags"> @@ -199,12 +220,14 @@ <argument index="3" name="value" type="Variant"> </argument> <description> + Sets the given [code]property[/code] to [code]value[/code] on all members of the given group, respecting the given [enum GroupCallFlags]. </description> </method> <method name="set_input_as_handled"> <return type="void"> </return> <description> + Marks the most recent input event as handled. </description> </method> <method name="set_quit_on_go_back"> @@ -213,6 +236,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] the application quits automatically on going back (e.g. on Android). </description> </method> <method name="set_screen_stretch"> @@ -227,37 +251,53 @@ <argument index="3" name="shrink" type="float" default="1"> </argument> <description> + Configures screen stretching to the given [enum StretchMode], [enum StretchAspect], minimum size and [code]shrink[/code]. </description> </method> </methods> <members> <member name="current_scene" type="Node" setter="set_current_scene" getter="get_current_scene"> + The 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"> + The root of the edited scene. + </member> + <member name="multiplayer" type="MultiplayerAPI" setter="set_multiplayer" getter="get_multiplayer"> + The default [MultiplayerAPI] instance for this SceneTree. + </member> + <member name="multiplayer_poll" type="bool" setter="set_multiplayer_poll_enabled" getter="is_multiplayer_poll_enabled"> + If [code]true[/code] (default) enable the automatic polling of the [MultiplayerAPI] for this SceneTree during [signal idle_frame]. + When [code]false[/code] you need to manually call [method MultiplayerAPI.poll] for processing network packets and delivering RPCs/RSETs. This allows to run RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual [Mutex] protecion when accessing the [MultiplayerAPI] from threads. </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"> + If [code]true[/code] the SceneTree is paused. </member> <member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections"> + If [code]true[/code] the SceneTree's [member network_peer] refuses new incoming connections. </member> <member name="root" type="Viewport" setter="" getter="get_root"> + The SceneTree's [Viewport]. </member> <member name="use_font_oversampling" type="bool" setter="set_use_font_oversampling" getter="is_using_font_oversampling"> + If [code]true[/code] font oversampling is used. </member> </members> <signals> <signal name="connected_to_server"> <description> + Emitted whenever this SceneTree's [member network_peer] successfully connected to a server. Only emitted on clients. </description> </signal> <signal name="connection_failed"> <description> + Emitted whenever this SceneTree's [member network_peer] fails to establish a connection to a server. Only emitted on clients. </description> </signal> <signal name="files_dropped"> @@ -266,83 +306,106 @@ <argument index="1" name="screen" type="int"> </argument> <description> + Emitted whenever files are drag-and-dropped onto the window. </description> </signal> <signal name="idle_frame"> <description> + Emitted immediately before [method Node._process] is called on every node in the SceneTree. </description> </signal> <signal name="network_peer_connected"> <argument index="0" name="id" type="int"> </argument> <description> + Emitted whenever this SceneTree's [member network_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). </description> </signal> <signal name="network_peer_disconnected"> <argument index="0" name="id" type="int"> </argument> <description> + Emitted whenever this SceneTree's [member network_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server. </description> </signal> <signal name="node_added"> <argument index="0" name="node" type="Object"> </argument> <description> + Emitted whenever a node is added to the SceneTree. </description> </signal> <signal name="node_configuration_warning_changed"> <argument index="0" name="node" type="Object"> </argument> <description> + Emitted when a node's configuration changed. Only emitted in tool mode. </description> </signal> <signal name="node_removed"> <argument index="0" name="node" type="Object"> </argument> <description> + Emitted whenever a node is removed from the SceneTree. </description> </signal> <signal name="physics_frame"> <description> + Emitted immediately before [method Node._physics_process] is called on every node in the SceneTree. </description> </signal> <signal name="screen_resized"> <description> + Emitted whenever the screen resolution (fullscreen) or window size (windowed) changes. </description> </signal> <signal name="server_disconnected"> <description> + Emitted whenever this SceneTree's [member network_peer] disconnected from server. Only emitted on clients. </description> </signal> <signal name="tree_changed"> <description> + Emitted whenever the SceneTree hierarchy changed (children being moved or renamed, etc.). </description> </signal> </signals> <constants> <constant name="GROUP_CALL_DEFAULT" value="0" enum="GroupCallFlags"> + Call a group with no flags (default). </constant> <constant name="GROUP_CALL_REVERSE" value="1" enum="GroupCallFlags"> + Call a group in reverse scene order. </constant> <constant name="GROUP_CALL_REALTIME" value="2" enum="GroupCallFlags"> + Call a group immediately (calls are normally made on idle). </constant> <constant name="GROUP_CALL_UNIQUE" value="4" enum="GroupCallFlags"> + Call a group only once even if the call is executed many times. </constant> <constant name="STRETCH_MODE_DISABLED" value="0" enum="StretchMode"> + No stretching. </constant> <constant name="STRETCH_MODE_2D" value="1" enum="StretchMode"> + Render stretching in higher resolution (interpolated). </constant> <constant name="STRETCH_MODE_VIEWPORT" value="2" enum="StretchMode"> + Keep the specified display resolution. No interpolation. Content may appear pixelated. </constant> <constant name="STRETCH_ASPECT_IGNORE" value="0" enum="StretchAspect"> + Fill the window with the content stretched to cover excessive space. Content may appear elongated. </constant> <constant name="STRETCH_ASPECT_KEEP" value="1" enum="StretchAspect"> + Retain the same aspect ratio by padding with black bars in either axes. No expansion of content. </constant> <constant name="STRETCH_ASPECT_KEEP_WIDTH" value="2" enum="StretchAspect"> + Expand vertically. Left/right black bars may appear if the window is too wide. </constant> <constant name="STRETCH_ASPECT_KEEP_HEIGHT" value="3" enum="StretchAspect"> + Expand horizontally. Top/bottom black bars may appear if the window is too tall. </constant> <constant name="STRETCH_ASPECT_EXPAND" value="4" enum="StretchAspect"> + Expand in both directions, retaining the same aspect ratio. No black bars. </constant> </constants> </class> diff --git a/doc/classes/SceneTreeTimer.xml b/doc/classes/SceneTreeTimer.xml index a5b199d9d7..e1234ce88a 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.1-dev"> +<class name="SceneTreeTimer" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index db85890b2b..09c60afc2f 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.1-dev"> +<class name="Script" inherits="Resource" category="Core" version="3.1"> <brief_description> A class stored as a resource. </brief_description> @@ -8,7 +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 + <link>http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scripting.html</link> </tutorials> <demos> </demos> @@ -24,6 +24,7 @@ <return type="Script"> </return> <description> + Returns the script directly inherited by this script. </description> </method> <method name="get_instance_base_type" qualifiers="const"> diff --git a/doc/classes/ScriptCreateDialog.xml b/doc/classes/ScriptCreateDialog.xml new file mode 100644 index 0000000000..a3ad3a778e --- /dev/null +++ b/doc/classes/ScriptCreateDialog.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ScriptCreateDialog" inherits="ConfirmationDialog" category="Core" version="3.1"> + <brief_description> + The Editor's popup dialog for creating new [Script] files. + </brief_description> + <description> + The ScriptCreateDialog creates script files according to a given template for a given scripting language. The standard use is to configure its fields prior to calling a [method popup]() method. + [codeblock] + func _ready(): + dialog.config("Node", "res://new_node.gd") # for in-engine types + dialog.config("\"res://base_node.gd\"", "res://derived_node.gd") # for script types + dialog.popup_centered() + [/codeblock] + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="config"> + <return type="void"> + </return> + <argument index="0" name="inherits" type="String"> + </argument> + <argument index="1" name="path" type="String"> + </argument> + <description> + Prefills required fields to configure the ScriptCreateDialog for use. + </description> + </method> + </methods> + <signals> + <signal name="script_created"> + <argument index="0" name="script" type="Object"> + </argument> + <description> + Emitted when the user clicks the OK button. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 0b5365f583..4bfd07fdad 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.1-dev"> +<class name="ScriptEditor" inherits="PanelContainer" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ScrollBar.xml b/doc/classes/ScrollBar.xml index 04b3ccfca0..736b780218 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.1-dev"> +<class name="ScrollBar" inherits="Range" category="Core" version="3.1"> <brief_description> Base class for scroll bars. </brief_description> @@ -19,6 +19,7 @@ <signals> <signal name="scrolling"> <description> + Emitted whenever the scrollbar is being scrolled. </description> </signal> </signals> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 3a613f8bcd..02f58a88cb 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.1-dev"> +<class name="ScrollContainer" inherits="Container" category="Core" version="3.1"> <brief_description> A helper node for displaying scrollable elements (e.g. lists). </brief_description> @@ -11,8 +11,22 @@ <demos> </demos> <methods> + <method name="get_h_scrollbar"> + <return type="HScrollBar"> + </return> + <description> + </description> + </method> + <method name="get_v_scrollbar"> + <return type="VScrollBar"> + </return> + <description> + </description> + </method> </methods> <members> + <member name="scroll_deadzone" type="int" setter="set_deadzone" getter="get_deadzone"> + </member> <member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll"> The current horizontal scroll value. </member> @@ -20,12 +34,28 @@ 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. + The current vertical 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> + <signals> + <signal name="scroll_ended"> + <description> + Emitted whenever scrolling stops. + </description> + </signal> + <signal name="scroll_started"> + <description> + Emitted whenever scrolling is started. + </description> + </signal> + </signals> <constants> </constants> + <theme_items> + <theme_item name="bg" type="StyleBox"> + </theme_item> + </theme_items> </class> diff --git a/doc/classes/SegmentShape2D.xml b/doc/classes/SegmentShape2D.xml index 69dd4f7ca2..63afb37a7b 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.1-dev"> +<class name="SegmentShape2D" inherits="Shape2D" category="Core" version="3.1"> <brief_description> Segment shape for 2D collisions. </brief_description> diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index 353c621818..f3a37b78e1 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.1-dev"> +<class name="Semaphore" inherits="Reference" category="Core" version="3.1"> <brief_description> A synchronization Semaphore. </brief_description> diff --git a/doc/classes/Separator.xml b/doc/classes/Separator.xml index 725ca8d2d0..e5efa4a100 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.1-dev"> +<class name="Separator" inherits="Control" category="Core" version="3.1"> <brief_description> Base class for separators. </brief_description> diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index f9f26593bf..76049d8947 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Shader" inherits="Resource" category="Core" version="3.1-dev"> +<class name="Shader" inherits="Resource" category="Core" version="3.1"> <brief_description> - To be changed, ignore. + A custom shader program. </brief_description> <description> - To be changed, ignore. + This class allows you to define a custom shader program that can be used for various materials to render objects. </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/shading/index.html + <link>http://docs.godotengine.org/en/3.0/tutorials/shading/index.html</link> </tutorials> <demos> </demos> @@ -24,6 +24,7 @@ <return type="int" enum="Shader.Mode"> </return> <description> + Returns the shader mode for the shader, eiter [code]MODE_CANVAS_ITEM[/code], [code]MODE_SPATIAL[/code] or [code]MODE_PARTICLES[/code] </description> </method> <method name="has_param" qualifiers="const"> diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 57fb3ed1aa..5abba9fba9 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ShaderMaterial" inherits="Material" category="Core" version="3.1-dev"> +<class name="ShaderMaterial" inherits="Material" category="Core" version="3.1"> <brief_description> + A material that uses a custom [Shader] program. </brief_description> <description> + A material that uses a custom [Shader] program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader. </description> <tutorials> </tutorials> @@ -15,6 +17,7 @@ <argument index="0" name="param" type="String"> </argument> <description> + Returns the current value set for this material of a uniform in the shader. </description> </method> <method name="set_shader_param"> @@ -25,11 +28,13 @@ <argument index="1" name="value" type="Variant"> </argument> <description> + Changes the value set for this material of a uniform in the shader. </description> </method> </methods> <members> <member name="shader" type="Shader" setter="set_shader" getter="get_shader"> + The [Shader] program used to render this material. </member> </members> <constants> diff --git a/doc/classes/Shape.xml b/doc/classes/Shape.xml index 240da1a43d..fcd01bc25a 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.1-dev"> +<class name="Shape" inherits="Resource" category="Core" version="3.1"> <brief_description> Base class for all 3D shape resources. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 0f3fc44ecb..6c13496fc4 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.1-dev"> +<class name="Shape2D" inherits="Resource" category="Core" version="3.1"> <brief_description> Base class for all 2D Shapes. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/ShortCut.xml b/doc/classes/ShortCut.xml index 2cb832c045..6da9d7c59d 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.1-dev"> +<class name="ShortCut" inherits="Resource" category="Core" version="3.1"> <brief_description> A shortcut for binding input. </brief_description> diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index 760b2e92a9..233df28255 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -1,10 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Skeleton" inherits="Spatial" category="Core" version="3.1-dev"> +<class name="Skeleton" inherits="Spatial" category="Core" version="3.1"> <brief_description> Skeleton for characters and animated objects. </brief_description> <description> Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see [Animation]). Skeleton will support rag doll dynamics in the future. + The overall transform of a bone with respect to the skeleton is determined by the following hierarchical order: rest pose, custom pose and pose. + Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it not the actual global/world transform of the bone. </description> <tutorials> </tutorials> @@ -60,6 +62,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> + Return the custom pose of the specified bone. Custom pose is applied on top of the rest pose. </description> </method> <method name="get_bone_global_pose" qualifiers="const"> @@ -68,6 +71,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> + Return the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. </description> </method> <method name="get_bone_name" qualifiers="const"> @@ -76,7 +80,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the name of the bone at index "index" + Return the name of the bone at index "index". </description> </method> <method name="get_bone_parent" qualifiers="const"> @@ -94,7 +98,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the pose transform for bone "bone_idx". + Return the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. </description> </method> <method name="get_bone_rest" qualifiers="const"> @@ -112,6 +116,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> + Return the combination of custom pose and pose. The returned transform is in skeleton's reference frame. </description> </method> <method name="get_bound_child_nodes_to_bone" qualifiers="const"> @@ -131,6 +136,36 @@ <description> </description> </method> + <method name="physical_bones_add_collision_exception"> + <return type="void"> + </return> + <argument index="0" name="exception" type="RID"> + </argument> + <description> + </description> + </method> + <method name="physical_bones_remove_collision_exception"> + <return type="void"> + </return> + <argument index="0" name="exception" type="RID"> + </argument> + <description> + </description> + </method> + <method name="physical_bones_start_simulation"> + <return type="void"> + </return> + <argument index="0" name="bones" type="Array" default="[ ]"> + </argument> + <description> + </description> + </method> + <method name="physical_bones_stop_simulation"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="set_bone_custom_pose"> <return type="void"> </return> @@ -161,6 +196,16 @@ <description> </description> </method> + <method name="set_bone_ignore_animation"> + <return type="void"> + </return> + <argument index="0" name="bone" type="int"> + </argument> + <argument index="1" name="ignore" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_bone_parent"> <return type="void"> </return> diff --git a/doc/classes/Skeleton2D.xml b/doc/classes/Skeleton2D.xml new file mode 100644 index 0000000000..712b9ca2a5 --- /dev/null +++ b/doc/classes/Skeleton2D.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Skeleton2D" inherits="Node2D" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_bone"> + <return type="Bone2D"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bone_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_skeleton" qualifiers="const"> + <return type="RID"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/SkeletonIK.xml b/doc/classes/SkeletonIK.xml new file mode 100644 index 0000000000..50246f1b18 --- /dev/null +++ b/doc/classes/SkeletonIK.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SkeletonIK" inherits="Node" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_parent_skeleton" qualifiers="const"> + <return type="Skeleton"> + </return> + <description> + </description> + </method> + <method name="is_running"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="start"> + <return type="void"> + </return> + <argument index="0" name="one_time" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="interpolation" type="float" setter="set_interpolation" getter="get_interpolation"> + </member> + <member name="magnet" type="Vector3" setter="set_magnet_position" getter="get_magnet_position"> + </member> + <member name="max_iterations" type="int" setter="set_max_iterations" getter="get_max_iterations"> + </member> + <member name="min_distance" type="float" setter="set_min_distance" getter="get_min_distance"> + </member> + <member name="root_bone" type="String" setter="set_root_bone" getter="get_root_bone"> + </member> + <member name="target" type="Transform" setter="set_target_transform" getter="get_target_transform"> + </member> + <member name="target_node" type="NodePath" setter="set_target_node" getter="get_target_node"> + </member> + <member name="tip_bone" type="String" setter="set_tip_bone" getter="get_tip_bone"> + </member> + <member name="use_magnet" type="bool" setter="set_use_magnet" getter="is_using_magnet"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Sky.xml b/doc/classes/Sky.xml index 4f3593dfcb..245da99084 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.1-dev"> +<class name="Sky" inherits="Resource" category="Core" version="3.1"> <brief_description> The base class for [PanoramaSky] and [ProceduralSky]. </brief_description> diff --git a/doc/classes/Slider.xml b/doc/classes/Slider.xml index aa19a27735..1e6ed65b48 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.1-dev"> +<class name="Slider" inherits="Range" category="Core" version="3.1"> <brief_description> Base class for GUI Sliders. </brief_description> @@ -17,6 +17,8 @@ </member> <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" enum="Control.FocusMode"> </member> + <member name="scrollable" type="bool" setter="set_scrollable" getter="is_scrollable"> + </member> <member name="tick_count" type="int" setter="set_ticks" getter="get_ticks"> </member> <member name="ticks_on_borders" type="bool" setter="set_ticks_on_borders" getter="get_ticks_on_borders"> diff --git a/doc/classes/SliderJoint.xml b/doc/classes/SliderJoint.xml index d8e4970363..edb8e6d562 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.1-dev"> +<class name="SliderJoint" inherits="Joint" category="Core" version="3.1"> <brief_description> Piston kind of slider between two bodies in 3D. </brief_description> diff --git a/doc/classes/SoftBody.xml b/doc/classes/SoftBody.xml new file mode 100644 index 0000000000..c3c789a6de --- /dev/null +++ b/doc/classes/SoftBody.xml @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SoftBody" inherits="MeshInstance" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_collision_exception_with"> + <return type="void"> + </return> + <argument index="0" name="body" type="Node"> + </argument> + <description> + </description> + </method> + <method name="get_collision_layer_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_ray_pickable" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="remove_collision_exception_with"> + <return type="void"> + </return> + <argument index="0" name="body" type="Node"> + </argument> + <description> + </description> + </method> + <method name="set_collision_layer_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_collision_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_ray_pickable"> + <return type="void"> + </return> + <argument index="0" name="ray_pickable" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="areaAngular_stiffness" type="float" setter="set_areaAngular_stiffness" getter="get_areaAngular_stiffness"> + </member> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + </member> + <member name="damping_coefficient" type="float" setter="set_damping_coefficient" getter="get_damping_coefficient"> + </member> + <member name="drag_coefficient" type="float" setter="set_drag_coefficient" getter="get_drag_coefficient"> + </member> + <member name="linear_stiffness" type="float" setter="set_linear_stiffness" getter="get_linear_stiffness"> + </member> + <member name="parent_collision_ignore" type="NodePath" setter="set_parent_collision_ignore" getter="get_parent_collision_ignore"> + </member> + <member name="pose_matching_coefficient" type="float" setter="set_pose_matching_coefficient" getter="get_pose_matching_coefficient"> + </member> + <member name="pressure_coefficient" type="float" setter="set_pressure_coefficient" getter="get_pressure_coefficient"> + </member> + <member name="simulation_precision" type="int" setter="set_simulation_precision" getter="get_simulation_precision"> + </member> + <member name="total_mass" type="float" setter="set_total_mass" getter="get_total_mass"> + </member> + <member name="volume_stiffness" type="float" setter="set_volume_stiffness" getter="get_volume_stiffness"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index b142e5c96c..ef1bcc30b3 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -1,15 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Spatial" inherits="Node" category="Core" version="3.1-dev"> +<class name="Spatial" inherits="Node" category="Core" version="3.1"> <brief_description> Most basic 3D game object, parent of all 3D related nodes. </brief_description> <description> Most basic 3D game object, with a 3D [Transform] and visibility settings. All other 3D game objects inherit from Spatial. Use Spatial as a parent node to move, scale, rotate and show/hide children in a 3D project. - 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/introduction_to_3d.html</link> </tutorials> <demos> </demos> @@ -70,6 +69,12 @@ Returns whether node notifies about its local transformation changes. Spatial will not propagate this by default. </description> </method> + <method name="is_scale_disabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_set_as_toplevel" qualifiers="const"> <return type="bool"> </return> @@ -99,7 +104,9 @@ <argument index="1" name="up" type="Vector3"> </argument> <description> - Rotates itself to point into direction of target position. Operations take place in global space. + Rotates itself so that the local -Z axis points towards the [code]target[/code] position. + The transform will first be rotated around the given [code]up[/code] vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the [code]target[/code] and [code]up[/code] vectors. + Operations take place in global space. </description> </method> <method name="look_at_from_position"> @@ -112,7 +119,7 @@ <argument index="2" name="up" type="Vector3"> </argument> <description> - Moves the node to specified position and then rotates itself to point into direction of target position. Operations take place in global space. + Moves the node to the specified [code]position[/code], and then rotates itself to point toward the [code]target[/code] as per [method look_at]. Operations take place in global space. </description> </method> <method name="orthonormalize"> @@ -189,6 +196,14 @@ Makes the node ignore its parents transformations. Node transformations are only in global space. </description> </method> + <method name="set_disable_scale"> + <return type="void"> + </return> + <argument index="0" name="disable" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_identity"> <return type="void"> </return> @@ -282,7 +297,6 @@ </member> <member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation"> Rotation part of the local transformation, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle), in radians. - Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three indepdent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. </member> <member name="rotation_degrees" type="Vector3" setter="set_rotation_degrees" getter="get_rotation_degrees"> diff --git a/doc/classes/SpatialGizmo.xml b/doc/classes/SpatialGizmo.xml index fde79e19dd..68d1d03296 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.1-dev"> +<class name="SpatialGizmo" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index ce67ddc220..4f48889531 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SpatialMaterial" inherits="Material" category="Core" version="3.1-dev"> +<class name="SpatialMaterial" inherits="Material" category="Core" version="3.1"> <brief_description> </brief_description> <description> </description> <tutorials> - http://docs.godotengine.org/en/3.0/tutorials/3d/spatial_material.html + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/spatial_material.html</link> </tutorials> <demos> </demos> @@ -84,6 +84,12 @@ </member> <member name="flags_albedo_tex_force_srgb" type="bool" setter="set_flag" getter="get_flag"> </member> + <member name="flags_disable_ambient_light" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="flags_do_not_receive_shadows" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="flags_ensure_correct_normals" type="bool" setter="set_flag" getter="get_flag"> + </member> <member name="flags_fixed_size" type="bool" setter="set_flag" getter="get_flag"> </member> <member name="flags_no_depth_test" type="bool" setter="set_flag" getter="get_flag"> @@ -114,6 +120,8 @@ </member> <member name="params_alpha_scissor_threshold" type="float" setter="set_alpha_scissor_threshold" getter="get_alpha_scissor_threshold"> </member> + <member name="params_billboard_keep_scale" type="bool" setter="set_flag" getter="get_flag"> + </member> <member name="params_billboard_mode" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="SpatialMaterial.BillboardMode"> </member> <member name="params_blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="SpatialMaterial.BlendMode"> @@ -302,21 +310,29 @@ </constant> <constant name="FLAG_FIXED_SIZE" value="6" enum="Flags"> </constant> - <constant name="FLAG_UV1_USE_TRIPLANAR" value="7" enum="Flags"> + <constant name="FLAG_BILLBOARD_KEEP_SCALE" value="7" enum="Flags"> + </constant> + <constant name="FLAG_UV1_USE_TRIPLANAR" value="8" enum="Flags"> + </constant> + <constant name="FLAG_UV2_USE_TRIPLANAR" value="9" enum="Flags"> + </constant> + <constant name="FLAG_AO_ON_UV2" value="11" enum="Flags"> + </constant> + <constant name="FLAG_EMISSION_ON_UV2" value="12" enum="Flags"> </constant> - <constant name="FLAG_UV2_USE_TRIPLANAR" value="8" enum="Flags"> + <constant name="FLAG_USE_ALPHA_SCISSOR" value="13" enum="Flags"> </constant> - <constant name="FLAG_AO_ON_UV2" value="10" enum="Flags"> + <constant name="FLAG_TRIPLANAR_USE_WORLD" value="10" enum="Flags"> </constant> - <constant name="FLAG_EMISSION_ON_UV2" value="11" enum="Flags"> + <constant name="FLAG_ALBEDO_TEXTURE_FORCE_SRGB" value="14" enum="Flags"> </constant> - <constant name="FLAG_USE_ALPHA_SCISSOR" value="12" enum="Flags"> + <constant name="FLAG_DONT_RECEIVE_SHADOWS" value="15" enum="Flags"> </constant> - <constant name="FLAG_TRIPLANAR_USE_WORLD" value="9" enum="Flags"> + <constant name="FLAG_DISABLE_AMBIENT_LIGHT" value="17" enum="Flags"> </constant> - <constant name="FLAG_ALBEDO_TEXTURE_FORCE_SRGB" value="13" enum="Flags"> + <constant name="FLAG_ENSURE_CORRECT_NORMALS" value="16" enum="Flags"> </constant> - <constant name="FLAG_MAX" value="14" enum="Flags"> + <constant name="FLAG_MAX" value="18" enum="Flags"> </constant> <constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode"> </constant> diff --git a/doc/classes/SpatialVelocityTracker.xml b/doc/classes/SpatialVelocityTracker.xml index 8d666c9f84..45cc4232dc 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.1-dev"> +<class name="SpatialVelocityTracker" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/SphereMesh.xml b/doc/classes/SphereMesh.xml index 72af6137d0..e0e2d10408 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.1-dev"> +<class name="SphereMesh" inherits="PrimitiveMesh" category="Core" version="3.1"> <brief_description> Class representing a spherical [PrimitiveMesh]. </brief_description> diff --git a/doc/classes/SphereShape.xml b/doc/classes/SphereShape.xml index cb2461942d..bc0cd79ddd 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.1-dev"> +<class name="SphereShape" inherits="Shape" category="Core" version="3.1"> <brief_description> Sphere shape for 3D collisions. </brief_description> diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 76dcfa97f6..0fcd5bbaf5 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.1-dev"> +<class name="SpinBox" inherits="Range" category="Core" version="3.1"> <brief_description> Numerical input text field. </brief_description> diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index 54cfaaff63..d56da68448 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.1-dev"> +<class name="SplitContainer" inherits="Container" category="Core" version="3.1"> <brief_description> Container for splitting and adjusting. </brief_description> @@ -16,6 +16,7 @@ <member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed"> </member> <member name="dragger_visibility" type="int" setter="set_dragger_visibility" getter="get_dragger_visibility" enum="SplitContainer.DraggerVisibility"> + Determines whether the dragger is visible. </member> <member name="split_offset" type="int" setter="set_split_offset" getter="get_split_offset"> </member> diff --git a/doc/classes/SpotLight.xml b/doc/classes/SpotLight.xml index 88e3240188..1f81e9e5c2 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.1-dev"> +<class name="SpotLight" inherits="Light" category="Core" version="3.1"> <brief_description> Spotlight [Light], such as a reflector spotlight or a lantern. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/SpringArm.xml b/doc/classes/SpringArm.xml new file mode 100644 index 0000000000..198ff4a81d --- /dev/null +++ b/doc/classes/SpringArm.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SpringArm" inherits="Spatial" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_excluded_object"> + <return type="void"> + </return> + <argument index="0" name="RID" type="RID"> + </argument> + <description> + </description> + </method> + <method name="clear_excluded_objects"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_hit_length"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="remove_excluded_object"> + <return type="bool"> + </return> + <argument index="0" name="RID" type="RID"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + </member> + <member name="margin" type="float" setter="set_margin" getter="get_margin"> + </member> + <member name="shape" type="Shape" setter="set_shape" getter="get_shape"> + </member> + <member name="spring_length" type="float" setter="set_length" getter="get_length"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml index a3423a0739..dd7fe010ba 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.1-dev"> +<class name="Sprite" inherits="Node2D" category="Core" version="3.1"> <brief_description> General purpose Sprite node. </brief_description> @@ -11,6 +11,13 @@ <demos> </demos> <methods> + <method name="get_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Returns a Rect2 representing the Sprite's boundary relative to its local coordinates. + </description> + </method> </methods> <members> <member name="centered" type="bool" setter="set_centered" getter="is_centered"> diff --git a/doc/classes/Sprite3D.xml b/doc/classes/Sprite3D.xml index 122f0b85f7..2a65246dde 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.1-dev"> +<class name="Sprite3D" inherits="SpriteBase3D" category="Core" version="3.1"> <brief_description> 2D Sprite node in 3D world. </brief_description> diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 6dba815255..fd4b583928 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.1-dev"> +<class name="SpriteBase3D" inherits="GeometryInstance" category="Core" version="3.1"> <brief_description> 2D Sprite node in 3D environment. </brief_description> @@ -11,6 +11,12 @@ <demos> </demos> <methods> + <method name="generate_triangle_mesh" qualifiers="const"> + <return type="TriangleMesh"> + </return> + <description> + </description> + </method> <method name="get_item_rect" qualifiers="const"> <return type="Rect2"> </return> diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index e7199d7163..0e11d797e4 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.1-dev"> +<class name="SpriteFrames" inherits="Resource" category="Core" version="3.1"> <brief_description> Sprite frame library for AnimatedSprite. </brief_description> @@ -17,7 +17,7 @@ <argument index="0" name="anim" type="String"> </argument> <description> - Adds a new animation to the the library. + Adds a new animation to the library. </description> </method> <method name="add_frame"> @@ -58,6 +58,13 @@ If [code]true[/code] the given animation will loop. </description> </method> + <method name="get_animation_names" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + Returns an array containing the names associated to each animation. Values are placed in alphabetical order. + </description> + </method> <method name="get_animation_speed" qualifiers="const"> <return type="float"> </return> diff --git a/doc/classes/StaticBody.xml b/doc/classes/StaticBody.xml index df56330c08..442a520e30 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.1-dev"> +<class name="StaticBody" inherits="PhysicsBody" category="Core" version="3.1"> <brief_description> Static body for 3D Physics. </brief_description> @@ -27,6 +27,8 @@ <member name="friction" type="float" setter="set_friction" getter="get_friction"> The body friction, from 0 (frictionless) to 1 (full friction). </member> + <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override"> + </member> </members> <constants> </constants> diff --git a/doc/classes/StaticBody2D.xml b/doc/classes/StaticBody2D.xml index ca12699061..917773d502 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.1-dev"> +<class name="StaticBody2D" inherits="PhysicsBody2D" category="Core" version="3.1"> <brief_description> Static body for 2D Physics. </brief_description> @@ -26,6 +26,8 @@ <member name="friction" type="float" setter="set_friction" getter="get_friction"> The body's friction. Values range from [code]0[/code] (no friction) to [code]1[/code] (full friction). </member> + <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override"> + </member> </members> <constants> </constants> diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index 4ab83f8d8a..ebe29c7e24 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.1-dev"> +<class name="StreamPeer" inherits="Reference" category="Core" version="3.1"> <brief_description> Abstraction and base class for stream-based protocols. </brief_description> diff --git a/doc/classes/StreamPeerBuffer.xml b/doc/classes/StreamPeerBuffer.xml index a3c118ec60..3d9bdce762 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.1-dev"> +<class name="StreamPeerBuffer" inherits="StreamPeer" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 32459efd47..cf8769d22b 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.1-dev"> +<class name="StreamPeerSSL" inherits="StreamPeer" category="Core" version="3.1"> <brief_description> SSL Stream peer. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/networking/ssl_certificates.html</link> </tutorials> <demos> </demos> @@ -15,7 +15,7 @@ <method name="accept_stream"> <return type="int" enum="Error"> </return> - <argument index="0" name="stream" type="StreamPeer"> + <argument index="0" name="base" type="StreamPeer"> </argument> <description> </description> @@ -55,17 +55,20 @@ </description> </method> </methods> + <members> + <member name="blocking_handshake" type="bool" setter="set_blocking_handshake_enabled" getter="is_blocking_handshake_enabled"> + </member> + </members> <constants> <constant name="STATUS_DISCONNECTED" value="0" enum="Status"> A status representing a [code]StreamPeerSSL[/code] that is disconnected. </constant> - <constant name="STATUS_CONNECTED" value="1" enum="Status"> + <constant name="STATUS_CONNECTED" value="2" enum="Status"> A status representing a [code]StreamPeerSSL[/code] that is connected to a host. </constant> - <constant name="STATUS_ERROR_NO_CERTIFICATE" value="2" enum="Status"> - An errot status that shows the peer did not present a SSL certificate and validation was requested. + <constant name="STATUS_ERROR" value="3" enum="Status"> </constant> - <constant name="STATUS_ERROR_HOSTNAME_MISMATCH" value="3" enum="Status"> + <constant name="STATUS_ERROR_HOSTNAME_MISMATCH" value="4" enum="Status"> An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation. </constant> </constants> diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index ef856551bb..5fc8e99ced 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.1-dev"> +<class name="StreamPeerTCP" inherits="StreamPeer" category="Core" version="3.1"> <brief_description> TCP Stream peer. </brief_description> diff --git a/doc/classes/StreamTexture.xml b/doc/classes/StreamTexture.xml index 7ed95ef01c..3b44d0f00f 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.1-dev"> +<class name="StreamTexture" inherits="Texture" category="Core" version="3.1"> <brief_description> A .stex texture. </brief_description> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 01d8dc32e6..a42f508b59 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.1-dev"> +<class name="String" category="Built-In Types" version="3.1"> <brief_description> Built-in string class. </brief_description> @@ -490,6 +490,15 @@ Returns the string's amount of characters. </description> </method> + <method name="lstrip"> + <return type="String"> + </return> + <argument index="0" name="chars" type="String"> + </argument> + <description> + Returns a copy of the string with characters removed from the left. + </description> + </method> <method name="match"> <return type="bool"> </return> @@ -634,6 +643,30 @@ Returns the right side of the string from a given position. </description> </method> + <method name="rsplit"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="divisor" type="String"> + </argument> + <argument index="1" name="allow_empty" type="bool" default="True"> + </argument> + <argument index="2" name="maxsplit" type="int" default="0"> + </argument> + <description> + Splits the string by a [code]divisor[/code] string and returns an array of the substrings, starting from right. + [b]Example:[/b] "One,Two,Three" will return ["One","Two","Three"] if split by ",". + If [code]maxsplit[/code] is specified, then it is number of splits to do, default is 0 which splits all the items. + </description> + </method> + <method name="rstrip"> + <return type="String"> + </return> + <argument index="0" name="chars" type="String"> + </argument> + <description> + Returns a copy of the string with characters removed from the right. + </description> + </method> <method name="sha256_buffer"> <return type="PoolByteArray"> </return> @@ -666,7 +699,8 @@ <argument index="2" name="maxsplit" type="int" default="0"> </argument> <description> - Splits the string by a divisor string and returns an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". + Splits the string by a divisor string and returns an array of the substrings. + [b]Example:[/b] "One,Two,Three" will return ["One","Two","Three"] if split by ",". If [code]maxsplit[/code] is given, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements) </description> </method> @@ -678,7 +712,8 @@ <argument index="1" name="allow_empty" type="bool" default="True"> </argument> <description> - Splits the string in floats by using a divisor string and returns an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". + Splits the string in floats by using a divisor string and returns an array of the substrings. + [b]Example:[/b] "1,2.5,3" will return [1,2.5,3] if split by ",". </description> </method> <method name="strip_edges"> @@ -745,6 +780,24 @@ Converts the String (which is an array of characters) to [PoolByteArray] (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). </description> </method> + <method name="trim_prefix"> + <return type="String"> + </return> + <argument index="0" name="prefix" type="String"> + </argument> + <description> + Removes a given string from the start if it starts with it or leaves the string unchanged. + </description> + </method> + <method name="trim_suffix"> + <return type="String"> + </return> + <argument index="0" name="suffix" type="String"> + </argument> + <description> + Removes a given string from the end if it ends with it or leaves the string unchanged. + </description> + </method> <method name="xml_escape"> <return type="String"> </return> diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index 1e68d83237..dee3e6db49 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.1-dev"> +<class name="StyleBox" inherits="Resource" category="Core" version="3.1"> <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 b5000da265..a9eeeddd93 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.1-dev"> +<class name="StyleBoxEmpty" inherits="StyleBox" category="Core" version="3.1"> <brief_description> Empty stylebox (does not display anything). </brief_description> diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index a64ca31ff0..641d6214a4 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.1-dev"> +<class name="StyleBoxFlat" inherits="StyleBox" category="Core" version="3.1"> <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 9fa2790a4b..146b4b0a3d 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.1-dev"> +<class name="StyleBoxLine" inherits="StyleBox" category="Core" version="3.1"> <brief_description> </brief_description> <description> @@ -13,7 +13,9 @@ <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 name="grow_begin" type="float" setter="set_grow_begin" getter="get_grow_begin"> + </member> + <member name="grow_end" type="float" setter="set_grow_end" getter="get_grow_end"> </member> <member name="thickness" type="int" setter="set_thickness" getter="get_thickness"> </member> diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index 6245400943..d8c378fde2 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.1-dev"> +<class name="StyleBoxTexture" inherits="StyleBox" category="Core" version="3.1"> <brief_description> Texture Based 3x3 scale style. </brief_description> @@ -59,11 +59,11 @@ </member> <member name="modulate_color" type="Color" setter="set_modulate" getter="get_modulate"> </member> - <member name="normal_map" type="Resource" setter="set_normal_map" getter="get_normal_map"> + <member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map"> </member> <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect"> </member> - <member name="texture" type="Resource" setter="set_texture" getter="get_texture"> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> </member> </members> <signals> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 71cfc9bb9a..deda7bc292 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.1-dev"> +<class name="SurfaceTool" inherits="Reference" category="Core" version="3.1"> <brief_description> Helper tool to create geometry. </brief_description> @@ -170,7 +170,7 @@ </return> <argument index="0" name="existing" type="ArrayMesh" default="null"> </argument> - <argument index="1" name="flags" type="int" default="97792"> + <argument index="1" name="flags" type="int" default="97280"> </argument> <description> Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh]. @@ -196,8 +196,11 @@ <method name="generate_normals"> <return type="void"> </return> + <argument index="0" name="flip" type="bool" default="false"> + </argument> <description> Generates normals from Vertices so you do not have to do it manually. + Setting "flip" [code]true[/code] inverts resulting normals. </description> </method> <method name="generate_tangents"> diff --git a/doc/classes/TCP_Server.xml b/doc/classes/TCP_Server.xml index cac81f8e05..4e3544ce5c 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.1-dev"> +<class name="TCP_Server" inherits="Reference" category="Core" version="3.1"> <brief_description> TCP Server. </brief_description> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index eb3b270938..5acfd6194e 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.1-dev"> +<class name="TabContainer" inherits="Container" category="Core" version="3.1"> <brief_description> Tabbed Container. </brief_description> @@ -78,6 +78,12 @@ Returns the title of the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. </description> </method> + <method name="get_tabs_rearrange_group" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="set_popup"> <return type="void"> </return> @@ -120,11 +126,21 @@ Sets a title for the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. </description> </method> + <method name="set_tabs_rearrange_group"> + <return type="void"> + </return> + <argument index="0" name="group_id" type="int"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab"> The current tab index. When set, this index's [Control] node's [code]visible[/code] property is set to [code]true[/code] and all others are set to [code]false[/code]. </member> + <member name="drag_to_rearrange_enabled" type="bool" setter="set_drag_to_rearrange_enabled" getter="get_drag_to_rearrange_enabled"> + </member> <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="TabContainer.TabAlign"> The alignment of all tabs in the tab container. See the [code]ALIGN_*[/code] constants for details. </member> diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index 7c3e28ec3c..fc1d0476ed 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.1-dev"> +<class name="Tabs" inherits="Control" category="Core" version="3.1"> <brief_description> Tabs Control. </brief_description> @@ -35,6 +35,12 @@ <description> </description> </method> + <method name="get_select_with_rmb" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="get_tab_count" qualifiers="const"> <return type="int"> </return> @@ -80,6 +86,12 @@ <description> </description> </method> + <method name="get_tabs_rearrange_group" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="move_tab"> <return type="void"> </return> @@ -99,6 +111,14 @@ <description> </description> </method> + <method name="set_select_with_rmb"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_tab_disabled"> <return type="void"> </return> @@ -129,10 +149,20 @@ <description> </description> </method> + <method name="set_tabs_rearrange_group"> + <return type="void"> + </return> + <argument index="0" name="group_id" type="int"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab"> </member> + <member name="drag_to_rearrange_enabled" type="bool" setter="set_drag_to_rearrange_enabled" getter="get_drag_to_rearrange_enabled"> + </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"> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index c39baa8a8c..a958c3fcfa 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.1-dev"> +<class name="TextEdit" inherits="Control" category="Core" version="3.1"> <brief_description> Multiline text editing control. </brief_description> @@ -99,6 +99,8 @@ </argument> <argument index="2" name="can_be_hidden" type="bool" default="true"> </argument> + <argument index="3" name="wrap_index" type="int" default="0"> + </argument> <description> </description> </method> @@ -130,6 +132,21 @@ <description> </description> </method> + <method name="get_breakpoints" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return an array containing the line number of each breakpoint. + </description> + </method> + <method name="get_keyword_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="keyword" type="String"> + </argument> + <description> + </description> + </method> <method name="get_line" qualifiers="const"> <return type="String"> </return> @@ -193,6 +210,14 @@ <description> </description> </method> + <method name="has_keyword_color" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="keyword" type="String"> + </argument> + <description> + </description> + </method> <method name="insert_text_at_cursor"> <return type="void"> </return> @@ -247,6 +272,13 @@ Perform redo operation. </description> </method> + <method name="remove_breakpoints"> + <return type="void"> + </return> + <description> + Removes all the breakpoints (without firing "breakpoint_toggled" signal). + </description> + </method> <method name="search" qualifiers="const"> <return type="PoolIntArray"> </return> @@ -326,6 +358,9 @@ </method> </methods> <members> + <member name="breakpoint_gutter" type="bool" setter="set_breakpoint_gutter_enabled" getter="is_breakpoint_gutter_enabled"> + If [code]true[/code] the breakpoint gutter is visible. + </member> <member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled"> If [code]true[/code] the caret (visual cursor) blinks. </member> @@ -368,7 +403,7 @@ <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 name="wrap_enabled" type="bool" setter="set_wrap_enabled" getter="is_wrap_enabled"> </member> </members> <signals> @@ -492,6 +527,8 @@ </theme_item> <theme_item name="read_only" type="StyleBox"> </theme_item> + <theme_item name="safe_line_number_color" type="Color"> + </theme_item> <theme_item name="selection_color" type="Color"> </theme_item> <theme_item name="symbol_color" type="Color"> diff --git a/doc/classes/TextFile.xml b/doc/classes/TextFile.xml new file mode 100644 index 0000000000..f8c1fd690e --- /dev/null +++ b/doc/classes/TextFile.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextFile" inherits="Resource" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index 997324992a..a9be42d1a1 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Texture" inherits="Resource" category="Core" version="3.1-dev"> +<class name="Texture" inherits="Resource" category="Core" version="3.1"> <brief_description> Texture for 2D and 3D. </brief_description> <description> A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite] or GUI [Control]. + Textures are often created by loading them from a file. See [method @GDScript.load]. </description> <tutorials> </tutorials> @@ -127,7 +128,7 @@ <constant name="FLAG_MIRRORED_REPEAT" value="32" enum="Flags"> Repeats texture with alternate sections mirrored. </constant> - <constant name="FLAG_VIDEO_SURFACE" value="4096" enum="Flags"> + <constant name="FLAG_VIDEO_SURFACE" value="2048" enum="Flags"> Texture is a video surface. </constant> </constants> diff --git a/doc/classes/Texture3D.xml b/doc/classes/Texture3D.xml new file mode 100644 index 0000000000..691d1f229e --- /dev/null +++ b/doc/classes/Texture3D.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Texture3D" inherits="TextureLayered" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/TextureArray.xml b/doc/classes/TextureArray.xml new file mode 100644 index 0000000000..a08d8421f1 --- /dev/null +++ b/doc/classes/TextureArray.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextureArray" inherits="TextureLayered" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/TextureButton.xml b/doc/classes/TextureButton.xml index 1f9c6acb47..7e54ab9fe8 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.1-dev"> +<class name="TextureButton" inherits="BaseButton" category="Core" version="3.1"> <brief_description> Texture-based button. Supports Pressed, Hover, Disabled and Focused states. </brief_description> diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml new file mode 100644 index 0000000000..026144cf5a --- /dev/null +++ b/doc/classes/TextureLayered.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextureLayered" inherits="Resource" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="create"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="depth" type="int"> + </argument> + <argument index="3" name="format" type="int" enum="Image.Format"> + </argument> + <argument index="4" name="flags" type="int" default="4"> + </argument> + <description> + </description> + </method> + <method name="get_depth" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_format" qualifiers="const"> + <return type="int" enum="Image.Format"> + </return> + <description> + </description> + </method> + <method name="get_height" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_layer_data" qualifiers="const"> + <return type="Image"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_width" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_data_partial"> + <return type="void"> + </return> + <argument index="0" name="image" type="Image"> + </argument> + <argument index="1" name="x_offset" type="int"> + </argument> + <argument index="2" name="y_offset" type="int"> + </argument> + <argument index="3" name="layer" type="int"> + </argument> + <argument index="4" name="mipmap" type="int" default="0"> + </argument> + <description> + </description> + </method> + <method name="set_layer_data"> + <return type="void"> + </return> + <argument index="0" name="image" type="Image"> + </argument> + <argument index="1" name="layer" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> + </member> + <member name="flags" type="int" setter="set_flags" getter="get_flags"> + </member> + </members> + <constants> + <constant name="FLAG_MIPMAPS" value="1" enum="Flags"> + </constant> + <constant name="FLAG_REPEAT" value="2" enum="Flags"> + </constant> + <constant name="FLAG_FILTER" value="4" enum="Flags"> + </constant> + <constant name="FLAGS_DEFAULT" value="4" enum="Flags"> + </constant> + </constants> +</class> diff --git a/doc/classes/TextureProgress.xml b/doc/classes/TextureProgress.xml index 3c4ed13746..f74420e8b1 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.1-dev"> +<class name="TextureProgress" inherits="Range" category="Core" version="3.1"> <brief_description> Texture-based progress bar. Useful for loading screens and life or stamina bars. </brief_description> @@ -51,6 +51,12 @@ <member name="texture_under" type="Texture" setter="set_under_texture" getter="get_under_texture"> [Texture] that draws under the progress bar. The bar's background. </member> + <member name="tint_over" type="Color" setter="set_tint_over" getter="get_tint_over"> + </member> + <member name="tint_progress" type="Color" setter="set_tint_progress" getter="get_tint_progress"> + </member> + <member name="tint_under" type="Color" setter="set_tint_under" getter="get_tint_under"> + </member> </members> <constants> <constant name="FILL_LEFT_TO_RIGHT" value="0" enum="FillMode"> @@ -71,5 +77,11 @@ <constant name="FILL_COUNTER_CLOCKWISE" value="5" enum="FillMode"> Turns the node into a radial bar. The [member texture_progress] fills counter-clockwise. See [member radial_center_offset], [member radial_initial_angle] and [member radial_fill_degrees] to refine its behavior. </constant> + <constant name="FILL_BILINEAR_LEFT_AND_RIGHT" value="6" enum="FillMode"> + </constant> + <constant name="FILL_BILINEAR_TOP_AND_BOTTOM" value="7" enum="FillMode"> + </constant> + <constant name="FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE" value="8" enum="FillMode"> + </constant> </constants> </class> diff --git a/doc/classes/TextureRect.xml b/doc/classes/TextureRect.xml index 8d18adcc36..95afc5d281 100644 --- a/doc/classes/TextureRect.xml +++ b/doc/classes/TextureRect.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextureRect" inherits="Control" category="Core" version="3.1-dev"> +<class name="TextureRect" inherits="Control" category="Core" version="3.1"> <brief_description> - Draws a sprite or a texture inside a User Interface. The texture can tile or not. + Control for drawing textures. </brief_description> <description> - Use TextureRect to draw icons and sprites in your User Interfaces. To create panels and menu boxes, take a look at [NinePatchFrame]. Its Stretch Mode property controls the texture's scale and placement. It can scale, tile and stay centered inside its bounding rectangle. TextureRect is one of the 5 most common nodes to create game UI. + Used to draw icons and sprites in a user interface. The texture's placement can be controlled with the [member stretch_mode] property. It can scale, tile, or stay centered inside its bounding rectangle. </description> <tutorials> </tutorials> @@ -14,10 +14,10 @@ </methods> <members> <member name="expand" type="bool" setter="set_expand" getter="has_expand"> - If [code]true[/code], the texture scales to fit its bounding rectangle. Default value: [code]false[/code]. + If [code]true[/code] the texture scales to fit its bounding rectangle. Default value: [code]false[/code]. </member> <member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureRect.StretchMode"> - Controls the texture's behavior when you resize the node's bounding rectangle. Set it to one of the [code]STRETCH_*[/code] constants. See the constants to learn more. + Controls the texture's behavior when resizing the node's bounding rectangle. See [enum StretchMode]. </member> <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> The node's [Texture] resource. diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index 4134936764..fe43b54d5e 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.1-dev"> +<class name="Theme" inherits="Resource" category="Core" version="3.1"> <brief_description> Theme for controls. </brief_description> diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index c5aac8f1ce..48d075c7f5 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.1-dev"> +<class name="Thread" inherits="Reference" category="Core" version="3.1"> <brief_description> A unit of execution in a process. </brief_description> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index 0a5fc1951b..73d60e49b7 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.1-dev"> +<class name="TileMap" inherits="Node2D" category="Core" version="3.1"> <brief_description> Node for 2D tile-based maps. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/2d/using_tilemaps.html</link> </tutorials> <demos> </demos> @@ -16,7 +16,14 @@ <return type="void"> </return> <description> - Clear all cells. + Clears all cells. + </description> + </method> + <method name="fix_invalid_tiles"> + <return type="void"> + </return> + <description> + Clears cells that do not exist in the tileset. </description> </method> <method name="get_cell" qualifiers="const"> @@ -27,7 +34,7 @@ <argument index="1" name="y" type="int"> </argument> <description> - Return the tile index of the referenced cell. + Returns the tile index of the given cell. </description> </method> <method name="get_cellv" qualifiers="const"> @@ -36,7 +43,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Return the tile index of the cell referenced by a Vector2. + Returns the tile index of the cell given by a Vector2. </description> </method> <method name="get_collision_layer_bit" qualifiers="const"> @@ -45,6 +52,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Returns [code]true[/code] if the given collision layer bit is set. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -53,13 +61,14 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Returns [code]true[/code] if the given collision mask bit is set. </description> </method> <method name="get_used_cells" qualifiers="const"> <return type="Array"> </return> <description> - Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). + Returns a [Vector2] array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from [code]-1[/code]). </description> </method> <method name="get_used_cells_by_id" qualifiers="const"> @@ -68,12 +77,14 @@ <argument index="0" name="id" type="int"> </argument> <description> + Returns an array of all cells with the given tile id. </description> </method> <method name="get_used_rect"> <return type="Rect2"> </return> <description> + Returns a rectangle enclosing the used (non-empty) tiles of the map. </description> </method> <method name="is_cell_transposed" qualifiers="const"> @@ -84,7 +95,7 @@ <argument index="1" name="y" type="int"> </argument> <description> - Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector). + Returns [code]true[/code] if the given cell is transposed, i.e. the x and y axes are swapped. </description> </method> <method name="is_cell_x_flipped" qualifiers="const"> @@ -95,7 +106,7 @@ <argument index="1" name="y" type="int"> </argument> <description> - Return whether the referenced cell is flipped over the X axis. + Returns [code]true[/code] if the given cell is flipped in the x axis. </description> </method> <method name="is_cell_y_flipped" qualifiers="const"> @@ -106,7 +117,7 @@ <argument index="1" name="y" type="int"> </argument> <description> - Return whether the referenced cell is flipped over the Y axis. + Returns [code]true[/code] if the given cell is flipped in the y axis. </description> </method> <method name="map_to_world" qualifiers="const"> @@ -117,8 +128,8 @@ <argument index="1" name="ignore_half_ofs" type="bool" default="false"> </argument> <description> - Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. - Optionally, the tilemap's potential half offset can be ignored. + Returns the global position corresponding to the given tilemap (grid-based) coordinates. + Optionally, the tilemap's half offset can be ignored. </description> </method> <method name="set_cell"> @@ -139,9 +150,21 @@ <argument index="6" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Set the tile index for the cell referenced by its grid-based X and Y coordinates. - A tile index of -1 clears the cell. - Optionally, the tile can also be flipped over the X and Y coordinates, transposed, or be given autotile coordinates. + Sets the tile index for the cell given by a Vector2. + An index of [code]-1[/code] clears the cell. + Optionally, the tile can also be flipped, transposed, or given autotile coordinates. + Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons. + If you need these to be immediately updated, you can call [method update_dirty_quadrants]. + </description> + </method> + <method name="set_celld"> + <return type="void"> + </return> + <argument index="0" name="position" type="Vector2"> + </argument> + <argument index="1" name="data" type="Dictionary"> + </argument> + <description> </description> </method> <method name="set_cellv"> @@ -158,9 +181,11 @@ <argument index="4" name="transpose" type="bool" default="false"> </argument> <description> - Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. - A tile index of -1 clears the cell. - Optionally, the tile can also be flipped over the X and Y axes or transposed. + Sets the tile index for the given cell. + An index of [code]-1[/code] clears the cell. + Optionally, the tile can also be flipped or transposed. + Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons. + If you need these to be immediately updated, you can call [method update_dirty_quadrants]. </description> </method> <method name="set_collision_layer_bit"> @@ -171,6 +196,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> + Sets the given collision layer bit. </description> </method> <method name="set_collision_mask_bit"> @@ -181,6 +207,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> + Sets the given collision mask bit. </description> </method> <method name="update_bitmask_area"> @@ -189,7 +216,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based X and Y coordinates. + Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based x and y coordinates. </description> </method> <method name="update_bitmask_region"> @@ -200,8 +227,15 @@ <argument index="1" name="end" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Applies autotiling rules to the cells in the given region (specified by grid-based X and Y coordinates). - Calling with invalid (or missing) parameters applies autotiling rules for the entire TileMap. + Applies autotiling rules to the cells in the given region (specified by grid-based x and y coordinates). + Calling with invalid (or missing) parameters applies autotiling rules for the entire tilemap. + </description> + </method> + <method name="update_dirty_quadrants"> + <return type="void"> + </return> + <description> + Updates the tile map's quadrants, allowing things such as navigation and collision shapes to be immediately used if modified. </description> </method> <method name="world_to_map" qualifiers="const"> @@ -210,7 +244,7 @@ <argument index="0" name="world_position" type="Vector2"> </argument> <description> - Return the tilemap (grid-based) coordinates corresponding to the absolute world position given as an argument. + Returns the tilemap (grid-based) coordinatescorresponding to the given global position. </description> </method> </methods> @@ -296,6 +330,7 @@ Tile origin at its center. </constant> <constant name="TILE_ORIGIN_BOTTOM_LEFT" value="2" enum="TileOrigin"> + Tile origin at its bottom-left corner. </constant> </constants> </class> diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 3b9a34abff..56bb33c5e1 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.1-dev"> +<class name="TileSet" inherits="Resource" category="Core" version="3.1"> <brief_description> Tile library for tilemaps. </brief_description> @@ -58,7 +58,7 @@ <return type="void"> </return> <description> - Clear all tiles. + Clears all tiles. </description> </method> <method name="create_tile"> @@ -67,7 +67,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Create a new tile which will be referenced by the given ID. + Creates a new tile which will be referenced by the given ID. </description> </method> <method name="find_tile_by_name" qualifiers="const"> @@ -76,21 +76,21 @@ <argument index="0" name="name" type="String"> </argument> <description> - Find the first tile matching the given name. + Returns the first tile matching the given name. </description> </method> <method name="get_last_unused_tile_id" qualifiers="const"> <return type="int"> </return> <description> - Return the ID following the last currently used ID, useful when creating a new tile. + Returns the ID following the last currently used ID, useful when creating a new tile. </description> </method> <method name="get_tiles_ids" qualifiers="const"> <return type="Array"> </return> <description> - Return an array of all currently used tile IDs. + Returns an array of all currently used tile IDs. </description> </method> <method name="remove_tile"> @@ -99,7 +99,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Remove the tile referenced by the given ID. + Removes the tile referenced by the given ID. </description> </method> <method name="tile_add_shape"> @@ -124,7 +124,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the light occluder of the tile. + Returns the light occluder of the tile. </description> </method> <method name="tile_get_material" qualifiers="const"> @@ -133,7 +133,15 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the material of the tile. + Returns the material of the tile. + </description> + </method> + <method name="tile_get_modulate" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> </description> </method> <method name="tile_get_name" qualifiers="const"> @@ -142,7 +150,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the name of the tile. + Returns the name of the tile. </description> </method> <method name="tile_get_navigation_polygon" qualifiers="const"> @@ -151,7 +159,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the navigation polygon of the tile. + Returns the navigation polygon of the tile. </description> </method> <method name="tile_get_navigation_polygon_offset" qualifiers="const"> @@ -160,7 +168,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the offset of the tile's navigation polygon. + Returns the offset of the tile's navigation polygon. </description> </method> <method name="tile_get_normal_map" qualifiers="const"> @@ -177,7 +185,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the offset of the tile's light occluder. + Returns the offset of the tile's light occluder. </description> </method> <method name="tile_get_region" qualifiers="const"> @@ -186,7 +194,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the tile sub-region in the texture. + Returns the tile sub-region in the texture. </description> </method> <method name="tile_get_shape" qualifiers="const"> @@ -233,7 +241,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the array of shapes of the tile. + Returns the array of shapes of the tile. </description> </method> <method name="tile_get_texture" qualifiers="const"> @@ -242,7 +250,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the texture of the tile. + Returns the texture of the tile. </description> </method> <method name="tile_get_texture_offset" qualifiers="const"> @@ -251,7 +259,23 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the texture offset of the tile. + Returns the texture offset of the tile. + </description> + </method> + <method name="tile_get_tile_mode" qualifiers="const"> + <return type="int" enum="TileSet.TileMode"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="tile_get_z_index" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> </description> </method> <method name="tile_set_light_occluder"> @@ -262,7 +286,7 @@ <argument index="1" name="light_occluder" type="OccluderPolygon2D"> </argument> <description> - Set a light occluder for the tile. + Sets a light occluder for the tile. </description> </method> <method name="tile_set_material"> @@ -273,7 +297,18 @@ <argument index="1" name="material" type="ShaderMaterial"> </argument> <description> - Set the material of the tile. + Sets the tile's material. + </description> + </method> + <method name="tile_set_modulate"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + Sets the tile's modulation color. </description> </method> <method name="tile_set_name"> @@ -284,7 +319,7 @@ <argument index="1" name="name" type="String"> </argument> <description> - Set the name of the tile, for descriptive purposes. + Sets the tile's name. </description> </method> <method name="tile_set_navigation_polygon"> @@ -295,7 +330,7 @@ <argument index="1" name="navigation_polygon" type="NavigationPolygon"> </argument> <description> - Set a navigation polygon for the tile. + Sets the tile's navigation polygon. </description> </method> <method name="tile_set_navigation_polygon_offset"> @@ -306,7 +341,7 @@ <argument index="1" name="navigation_polygon_offset" type="Vector2"> </argument> <description> - Set an offset for the tile's navigation polygon. + Sets an offset for the tile's navigation polygon. </description> </method> <method name="tile_set_normal_map"> @@ -317,6 +352,7 @@ <argument index="1" name="normal_map" type="Texture"> </argument> <description> + Sets the tile's normal map texture. </description> </method> <method name="tile_set_occluder_offset"> @@ -338,7 +374,7 @@ <argument index="1" name="region" type="Rect2"> </argument> <description> - Set the tile sub-region in the texture. This is common in texture atlases. + Set the tile's sub-region in the texture. This is common in texture atlases. </description> </method> <method name="tile_set_shape"> @@ -385,7 +421,7 @@ <argument index="1" name="shapes" type="Array"> </argument> <description> - Set an array of shapes for the tile, enabling physics to collide with it. + Sets an array of shapes for the tile, enabling collision. </description> </method> <method name="tile_set_texture"> @@ -396,7 +432,7 @@ <argument index="1" name="texture" type="Texture"> </argument> <description> - Set the texture of the tile. + Sets the tile's texture. </description> </method> <method name="tile_set_texture_offset"> @@ -407,14 +443,38 @@ <argument index="1" name="texture_offset" type="Vector2"> </argument> <description> - Set the texture offset of the tile. + Sets the tile's texture offset. + </description> + </method> + <method name="tile_set_tile_mode"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="tilemode" type="int" enum="TileSet.TileMode"> + </argument> + <description> + Sets the tile's [enum TileMode]. + </description> + </method> + <method name="tile_set_z_index"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="z_index" type="int"> + </argument> + <description> + Sets the tile's drawing index. </description> </method> </methods> <constants> <constant name="BITMASK_2X2" value="0" enum="BitmaskMode"> </constant> - <constant name="BITMASK_3X3" value="1" enum="BitmaskMode"> + <constant name="BITMASK_3X3_MINIMAL" value="1" enum="BitmaskMode"> + </constant> + <constant name="BITMASK_3X3" value="2" enum="BitmaskMode"> </constant> <constant name="BIND_TOPLEFT" value="1" enum="AutotileBindings"> </constant> @@ -432,5 +492,11 @@ </constant> <constant name="BIND_BOTTOMRIGHT" value="256" enum="AutotileBindings"> </constant> + <constant name="SINGLE_TILE" value="0" enum="TileMode"> + </constant> + <constant name="AUTO_TILE" value="1" enum="TileMode"> + </constant> + <constant name="ATLAS_TILE" value="2" enum="TileMode"> + </constant> </constants> </class> diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 892b14a933..d1c8722901 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.1-dev"> +<class name="Timer" inherits="Node" category="Core" version="3.1"> <brief_description> A countdown timer. </brief_description> @@ -21,8 +21,10 @@ <method name="start"> <return type="void"> </return> + <argument index="0" name="time_sec" type="float" default="-1"> + </argument> <description> - Starts the timer. This also resets the remaining time to [code]wait_time[/code]. + Starts the timer. Sets [code]wait_time[/code] to [code]time_sec[/code] if [code]time_sec[/code] > 0. This also resets the remaining time to [code]wait_time[/code]. Note: this method will not resume a paused timer. See [method set_paused]. </description> </method> diff --git a/doc/classes/ToolButton.xml b/doc/classes/ToolButton.xml index 916585ecf7..d8db95a854 100644 --- a/doc/classes/ToolButton.xml +++ b/doc/classes/ToolButton.xml @@ -1,11 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ToolButton" inherits="Button" category="Core" version="3.1-dev"> +<class name="ToolButton" inherits="Button" category="Core" version="3.1"> <brief_description> Flat button helper class. </brief_description> <description> This is a helper class to generate a flat [Button] (see [method Button.set_flat]), creating a ToolButton is equivalent to: - [codeblock] var btn = Button.new() btn.set_flat(true) diff --git a/doc/classes/TouchScreenButton.xml b/doc/classes/TouchScreenButton.xml index 50bb23f5d9..1b37ce95ba 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.1-dev"> +<class name="TouchScreenButton" inherits="Node2D" category="Core" version="3.1"> <brief_description> Button for touch screen devices. </brief_description> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 2ebdea9d5e..24c009d922 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.1-dev"> +<class name="Transform" category="Built-In Types" version="3.1"> <brief_description> 3D Transformation. 3x4 matrix. </brief_description> @@ -7,7 +7,8 @@ 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/math/index.html</link> + <link>http://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html</link> </tutorials> <demos> </demos> @@ -98,7 +99,9 @@ <argument index="1" name="up" type="Vector3"> </argument> <description> - Rotate the transform around the up vector to face the target. + Returns a copy of the transform rotated such that its -Z axis points towards the [code]target[/code] position. + The transform will first be rotated around the given [code]up[/code] vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the [code]target[/code] and [code]up[/code] vectors. + Operations take place in global space. </description> </method> <method name="orthonormalized"> @@ -165,5 +168,13 @@ </member> </members> <constants> + <constant name="IDENTITY" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + </constant> + <constant name="FLIP_X" value="Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + </constant> + <constant name="FLIP_Y" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + </constant> + <constant name="FLIP_Z" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + </constant> </constants> </class> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 11b8b37ebd..b38d9a1a86 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.1-dev"> +<class name="Transform2D" category="Built-In Types" version="3.1"> <brief_description> 2D Transformation. 3x2 matrix. </brief_description> @@ -173,5 +173,11 @@ </member> </members> <constants> + <constant name="IDENTITY" value="Transform2D( 1, 0, 0, 1, 0, 0 )"> + </constant> + <constant name="FLIP_X" value="Transform2D( -1, 0, 0, 1, 0, 0 )"> + </constant> + <constant name="FLIP_Y" value="Transform2D( 1, 0, 0, -1, 0, 0 )"> + </constant> </constants> </class> diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index d3964b8f02..c4e9dbfb70 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.1-dev"> +<class name="Translation" inherits="Resource" category="Core" version="3.1"> <brief_description> Language Translation. </brief_description> diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index a95ae9b2a3..52d2b2cc47 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.1-dev"> +<class name="TranslationServer" inherits="Object" category="Core" version="3.1"> <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 7e8cc1179c..533df57564 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.1-dev"> +<class name="Tree" inherits="Control" category="Core" version="3.1"> <brief_description> Control to show a tree of items. </brief_description> @@ -94,6 +94,8 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> + If [member drop_mode_flags] includes [code]DROP_MODE_INBETWEEN[/code], returns -1 if [code]position[/code] is the upper part of a tree item at that position, 1 for the lower part, and additionally 0 for the middle part if [member drop_mode_flags] includes [code]DROP_MODE_ON_ITEM[/code]. + Otherwise, returns 0. If there are no tree item at [code]position[/code], returns -100. </description> </method> <method name="get_edited" qualifiers="const"> @@ -228,7 +230,7 @@ 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. + The drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. Once dropping is done, reverts to [code]DROP_MODE_DISABLED[/code]. Setting this during [method can_drop_data] is recommended. </member> <member name="hide_folding" type="bool" setter="set_hide_folding" getter="is_folding_hidden"> If [code]true[/code] the folding arrow is hidden. diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 21b3223cd3..57e0f2825a 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.1-dev"> +<class name="TreeItem" inherits="Object" category="Core" version="3.1"> <brief_description> Control for a single item inside a [Tree]. </brief_description> @@ -308,7 +308,7 @@ <argument index="0" name="child" type="Object"> </argument> <description> - Removes the child TreeItem at index [code]index[/code]. + Removes the given child TreeItem. </description> </method> <method name="select"> diff --git a/doc/classes/TriangleMesh.xml b/doc/classes/TriangleMesh.xml index a55130744f..2bdc7b61f4 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.1-dev"> +<class name="TriangleMesh" inherits="Reference" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index dabf8a59b3..123226183a 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -1,18 +1,20 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Tween" inherits="Node" category="Core" version="3.1-dev"> +<class name="Tween" inherits="Node" category="Core" version="3.1"> <brief_description> - Node useful for animations with unknown start and end points. + Smoothly animates a node's properties over time. </brief_description> <description> - Node useful for animations with unknown start and end points, procedural animations, making one node follow another, and other simple behavior. - Because it is easy to get it wrong, here is a quick usage example: + Tweens are useful for animations requiring a numerical property to be interpolated over a range of values. The name *tween* comes from *in-betweening*, an animation technique where you specify *keyframes* and the computer interpolates the frames that appear between them. + Here is a brief usage example that causes a 2D node to move smoothly between two positions: [codeblock] var tween = get_node("Tween") - tween.interpolate_property(get_node("Node2D_to_move"), "transform/origin", Vector2(0,0), Vector2(100,100), 1, Tween.TRANS_LINEAR, Tween.EASE_IN_OUT) + tween.interpolate_property($Node2D, "position", + Vector2(0, 0), Vector2(100, 100), 1, + Tween.TRANS_LINEAR, Tween.EASE_IN_OUT) tween.start() [/codeblock] - Some of the methods of this class require a property name. You can get the property name by hovering over the property in the inspector of the editor. - Many of the methods accept [code]trans_type[/code] and [code]ease_type[/code]. The first accepts an TRANS_* constant, and refers to the way the timing of the animation is handled (you might want to see [code]http://easings.net/[/code] for some examples). The second accepts an EASE_* constant, and controls the where [code]trans_type[/code] is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different TRANS_* constants with EASE_IN_OUT, and use the one that looks best. + Many methods require a property name, such as "position" above. You can find the correct property name by hovering over the property in the Inspector. + Many of the methods accept [code]trans_type[/code] and [code]ease_type[/code]. The first accepts an [enum TransitionType] constant, and refers to the way the timing of the animation is handled (see [code]http://easings.net/[/code] for some examples). The second accepts an [enum EaseType] constant, and controls the where [code]trans_type[/code] is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different [enum TransitionType] constants with [enum EASE_IN_OUT], and use the one that looks best. </description> <tutorials> </tutorials> @@ -41,8 +43,8 @@ <argument index="8" name="delay" type="float" default="0"> </argument> <description> - Follow [code]method[/code] of [code]object[/code] and apply the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] later. Methods are animated by calling them with consequitive values. - [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + Follows [code]method[/code] of [code]object[/code] and applies the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] later. Methods are called with consecutive values. + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information </description> </method> <method name="follow_property"> @@ -67,15 +69,15 @@ <argument index="8" name="delay" type="float" default="0"> </argument> <description> - Follow [code]property[/code] of [code]object[/code] and apply it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Note that [code]target:target_property[/code] would equal [code]object:property[/code] at the end of the tween. - [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + Follows [code]property[/code] of [code]object[/code] and applies it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information </description> </method> <method name="get_runtime" qualifiers="const"> <return type="float"> </return> <description> - Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. + Returns the total time needed for all tweens to end. If you have two tweens, one lasting 10 seconds and the other 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. </description> </method> <method name="interpolate_callback"> @@ -98,7 +100,7 @@ <argument index="7" name="arg5" type="Variant" default="null"> </argument> <description> - Call [code]callback[/code] of [code]object[/code] after [code]duration[/code]. [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. + Calls [code]callback[/code] of [code]object[/code] after [code]duration[/code]. [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. </description> </method> <method name="interpolate_deferred_callback"> @@ -121,7 +123,7 @@ <argument index="7" name="arg5" type="Variant" default="null"> </argument> <description> - Call [code]callback[/code] of [code]object[/code] after [code]duration[/code] on the main thread (similar to [method Object.call_deferred]). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. + Calls [code]callback[/code] of [code]object[/code] after [code]duration[/code] on the main thread (similar to [method Object.call_deferred]). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. </description> </method> <method name="interpolate_method"> @@ -144,8 +146,8 @@ <argument index="7" name="delay" type="float" default="0"> </argument> <description> - Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecutive values. - [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + Animates [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are called with consecutive values. + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information </description> </method> <method name="interpolate_property"> @@ -168,15 +170,15 @@ <argument index="7" name="delay" type="float" default="0"> </argument> <description> - Animate [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. - [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + Animates [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Setting the initial value to [code]null[/code] uses the current value of the property. + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information </description> </method> <method name="is_active" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended. + Returns [code]true[/code] if any tweens are currently running. Note that this method doesn't consider tweens that have ended. </description> </method> <method name="remove"> @@ -187,14 +189,14 @@ <argument index="1" name="key" type="String" default=""""> </argument> <description> - Stop animating and completely remove a tween, given its object and property/method pair. Passing empty String as key will remove all tweens for given object. + Stops animation and removes a tween, given its object and property/method pair. By default, all tweens are removed, unless [code]key[/code] is specified. </description> </method> <method name="remove_all"> <return type="bool"> </return> <description> - Stop animating and completely remove all tweens. + Stops animation and removes all tweens. </description> </method> <method name="reset"> @@ -205,7 +207,7 @@ <argument index="1" name="key" type="String" default=""""> </argument> <description> - Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. Passing empty String as key will reset all tweens for given object. + Resets a tween to its initial value (the one given, not the one before the tween), given its object and property/method pair. By default, all tweens are removed, unless [code]key[/code] is specified. </description> </method> <method name="reset_all"> @@ -223,14 +225,14 @@ <argument index="1" name="key" type="String" default=""""> </argument> <description> - Continue animating a stopped tween, given its object and property/method pair. Passing empty String as key will resume all tweens for given object. + Continues animating a stopped tween, given its object and property/method pair. By default, all tweens are resumed, unless [code]key[/code] is specified. </description> </method> <method name="resume_all"> <return type="bool"> </return> <description> - Continue animating all stopped tweens. + Continues animating all stopped tweens. </description> </method> <method name="seek"> @@ -239,7 +241,7 @@ <argument index="0" name="time" type="float"> </argument> <description> - Seek the animation to the given [code]time[/code] in seconds. + Sets the interpolation to the given [code]time[/code] in seconds. </description> </method> <method name="set_active"> @@ -248,14 +250,14 @@ <argument index="0" name="active" type="bool"> </argument> <description> - 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. + Activates/deactivates the tween. See also [method stop_all] and [method resume_all]. </description> </method> <method name="start"> <return type="bool"> </return> <description> - Start the tween node. You can define tweens both before and after this. + Starts the tween. You can define animations both before and after this. </description> </method> <method name="stop"> @@ -266,14 +268,14 @@ <argument index="1" name="key" type="String" default=""""> </argument> <description> - Stop animating a tween, given its object and property/method pair. Passing empty String as key will stop all tweens for given object. + Stops a tween, given its object and property/method pair. By default, all tweens are stopped, unless [code]key[/code] is specified. </description> </method> <method name="stop_all"> <return type="bool"> </return> <description> - Stop animating all tweens. + Stops animating all tweens. </description> </method> <method name="targeting_method"> @@ -298,8 +300,8 @@ <argument index="8" name="delay" type="float" default="0"> </argument> <description> - Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecutive values. - [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + Animates [code]method[/code] of [code]object[/code] from the value returned by [code]initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecutive values. + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information </description> </method> <method name="targeting_property"> @@ -324,8 +326,8 @@ <argument index="8" name="delay" type="float" default="0"> </argument> <description> - Animate [code]property[/code] of [code]object[/code] from the current value of the [code]initial_val[/code] property of [code]initial[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. - [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + Animates [code]property[/code] of [code]object[/code] from the current value of the [code]initial_val[/code] property of [code]initial[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. + Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information </description> </method> <method name="tell" qualifiers="const"> @@ -338,12 +340,13 @@ </methods> <members> <member name="playback_process_mode" type="int" setter="set_tween_process_mode" getter="get_tween_process_mode" enum="Tween.TweenProcessMode"> + The tween's animation process thread. See [enum TweenProcessMode]. Default value: [enum TWEEN_PROCESS_IDLE]. </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. + The tween's speed multiplier. For example, set it to [code]1.0[/code] for normal speed, [code]2.0[/code] for two times normal speed, or [code]0.5[/code] for half of the normal speed. A value of [code]0[/code] pauses the animation, but see also [method set_active] or [method stop_all] for this. </member> <member name="repeat" type="bool" setter="set_repeat" getter="is_repeat"> - If [code]true[/code], the tween will repeat. + If [code]true[/code] the tween loops. </member> </members> <signals> @@ -353,7 +356,7 @@ <argument index="1" name="key" type="NodePath"> </argument> <description> - This signal is emitted when a tween ends. + Emitted when a tween ends. </description> </signal> <signal name="tween_started"> @@ -362,7 +365,7 @@ <argument index="1" name="key" type="NodePath"> </argument> <description> - This signal is emitted when a tween starts. + Emitted when a tween starts. </description> </signal> <signal name="tween_step"> @@ -375,61 +378,61 @@ <argument index="3" name="value" type="Object"> </argument> <description> - This signal is emitted each step of the tweening. + Emitted at each step of the animation. </description> </signal> </signals> <constants> <constant name="TWEEN_PROCESS_PHYSICS" value="0" enum="TweenProcessMode"> - The [code]Tween[/code] should use [code]_physics_process[/code] for timekeeping when this is enabled. + The tween updates with the [code]_physics_process[/code] callback. </constant> <constant name="TWEEN_PROCESS_IDLE" value="1" enum="TweenProcessMode"> - The [code]Tween[/code] should use [code]_process[/code] for timekeeping when this is enabled (default). + The tween updates with the [code]_process[/code] callback. </constant> <constant name="TRANS_LINEAR" value="0" enum="TransitionType"> - Means that the animation is interpolated linearly. + The animation is interpolated linearly. </constant> <constant name="TRANS_SINE" value="1" enum="TransitionType"> - Means that the animation is interpolated using a sine wave. + The animation is interpolated using a sine function. </constant> <constant name="TRANS_QUINT" value="2" enum="TransitionType"> - Means that the animation is interpolated with a quinary (to the power of 5) function. + The animation is interpolated with a quintic (to the power of 5) function. </constant> <constant name="TRANS_QUART" value="3" enum="TransitionType"> - Means that the animation is interpolated with a quartic (to the power of 4) function. + The animation is interpolated with a quartic (to the power of 4) function. </constant> <constant name="TRANS_QUAD" value="4" enum="TransitionType"> - Means that the animation is interpolated with a quadratic (to the power of 2) function. + The animation is interpolated with a quadratic (to the power of 2) function. </constant> <constant name="TRANS_EXPO" value="5" enum="TransitionType"> - Means that the animation is interpolated with an exponential (some number to the power of x) function. + The animation is interpolated with an exponential (to the power of x) function. </constant> <constant name="TRANS_ELASTIC" value="6" enum="TransitionType"> - Means that the animation is interpolated with elasticity, wiggling around the edges. + The animation is interpolated with elasticity, wiggling around the edges. </constant> <constant name="TRANS_CUBIC" value="7" enum="TransitionType"> - Means that the animation is interpolated with a cubic (to the power of 3) function. + The animation is interpolated with a cubic (to the power of 3) function. </constant> <constant name="TRANS_CIRC" value="8" enum="TransitionType"> - Means that the animation is interpolated with a function using square roots. + The animation is interpolated with a function using square roots. </constant> <constant name="TRANS_BOUNCE" value="9" enum="TransitionType"> - Means that the animation is interpolated by bouncing at, but never surpassing, the end. + The animation is interpolated by bouncing at the end. </constant> <constant name="TRANS_BACK" value="10" enum="TransitionType"> - Means that the animation is interpolated backing out at edges. + The animation is interpolated backing out at ends. </constant> <constant name="EASE_IN" value="0" enum="EaseType"> - Signifies that the interpolation should be focused in the beginning. + The interpolation starts slowly and speeds up towards the end. </constant> <constant name="EASE_OUT" value="1" enum="EaseType"> - Signifies that the interpolation should be focused in the end. + The interpolation starts quickly and slows down towards the end. </constant> <constant name="EASE_IN_OUT" value="2" enum="EaseType"> - Signifies that the interpolation should be focused in both ends. + A combination of EASE_IN and EASE_OUT. The interpolation is slowest at both ends. </constant> <constant name="EASE_OUT_IN" value="3" enum="EaseType"> - Signifies that the interpolation should be focused in both ends, but they should be switched (a bit hard to explain, try it for yourself to be sure). + A combination of EASE_IN and EASE_OUT. The interpolation is fastest at both ends. </constant> </constants> </class> diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index 13f0a506da..b9550c17fb 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.1-dev"> +<class name="UndoRedo" inherits="Object" category="Core" version="3.1"> <brief_description> Helper to manage UndoRedo in the editor or custom tools. </brief_description> @@ -117,13 +117,13 @@ </description> </method> <method name="redo"> - <return type="void"> + <return type="bool"> </return> <description> </description> </method> <method name="undo"> - <return type="void"> + <return type="bool"> </return> <description> </description> diff --git a/doc/classes/VBoxContainer.xml b/doc/classes/VBoxContainer.xml index d1eb013f29..43a7be74c3 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.1-dev"> +<class name="VBoxContainer" inherits="BoxContainer" category="Core" version="3.1"> <brief_description> Vertical box container. </brief_description> diff --git a/doc/classes/VScrollBar.xml b/doc/classes/VScrollBar.xml index 9958b40027..5486140870 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.1-dev"> +<class name="VScrollBar" inherits="ScrollBar" category="Core" version="3.1"> <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 2b7027076c..4890b2d930 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.1-dev"> +<class name="VSeparator" inherits="Separator" category="Core" version="3.1"> <brief_description> Vertical version of [Separator]. </brief_description> diff --git a/doc/classes/VSlider.xml b/doc/classes/VSlider.xml index 404626c32d..1dc1b795f7 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.1-dev"> +<class name="VSlider" inherits="Slider" category="Core" version="3.1"> <brief_description> Vertical slider. </brief_description> diff --git a/doc/classes/VSplitContainer.xml b/doc/classes/VSplitContainer.xml index 903539fd54..2203035db3 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.1-dev"> +<class name="VSplitContainer" inherits="SplitContainer" category="Core" version="3.1"> <brief_description> Vertical split container. </brief_description> diff --git a/doc/classes/Variant.xml b/doc/classes/Variant.xml index 27e6799fd4..b2d21921a1 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.1-dev"> +<class name="Variant" category="Core" version="3.1"> <brief_description> The most important data type in Godot. </brief_description> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 7666425e86..4bc18b926e 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Vector2" category="Built-In Types" version="3.1-dev"> +<class name="Vector2" category="Built-In Types" version="3.1"> <brief_description> - Vector used for 2D Math. + Vector used for 2D math. </brief_description> <description> - 2-element structure that can be used to represent positions in 2d-space, or any other pair of numeric values. + 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/math/index.html</link> </tutorials> <demos> </demos> @@ -34,8 +34,8 @@ <return type="float"> </return> <description> - Returns the result of atan2 when called with the Vector's x and y as parameters (Math::atan2(x,y)). - Be aware that it therefore returns an angle oriented clockwise with regard to the (0, 1) unit vector, and not an angle oriented counter-clockwise with regard to the (1, 0) unit vector (which would be the typical trigonometric representation of the angle when calling Math::atan2(y,x)). + Returns the vector's angle in radians with respect to the x-axis, or [code](1, 0)[/code] vector. + Equivalent to the result of atan2 when called with the vector's x and y as parameters: [code]atan2(x, y)[/code]. </description> </method> <method name="angle_to"> @@ -60,7 +60,7 @@ <return type="float"> </return> <description> - Returns the ratio of X to Y. + Returns the ratio of x to y. </description> </method> <method name="bounce"> @@ -69,7 +69,14 @@ <argument index="0" name="n" type="Vector2"> </argument> <description> - Bounce returns the vector "bounced off" from the given plane, specified by its normal vector. + Returns the vector "bounced off" from a plane defined by the given normal. + </description> + </method> + <method name="ceil"> + <return type="Vector2"> + </return> + <description> + Returns the vector with all components rounded up. </description> </method> <method name="clamped"> @@ -81,6 +88,15 @@ Returns the vector with a maximum length. </description> </method> + <method name="cross"> + <return type="float"> + </return> + <argument index="0" name="with" type="Vector2"> + </argument> + <description> + Returns the 2 dimensional analog of the cross product with the given vector. + </description> + </method> <method name="cubic_interpolate"> <return type="Vector2"> </return> @@ -93,7 +109,7 @@ <argument index="3" name="t" type="float"> </argument> <description> - Cubicly interpolates between this Vector and "b", using "pre_a" and "post_b" as handles, and returning the result at position "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is. + Cubicly interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], or a percentage of how far along the interpolation is. </description> </method> <method name="distance_squared_to"> @@ -102,7 +118,7 @@ <argument index="0" name="to" type="Vector2"> </argument> <description> - Returns the squared distance to vector "b". Prefer this function over "distance_to" if you need to sort vectors or need the squared distance for some formula. + Returns the squared distance to vector [code]b[/code]. Prefer this function over [method distance_to] if you need to sort vectors or need the squared distance for some formula. </description> </method> <method name="distance_to"> @@ -111,7 +127,7 @@ <argument index="0" name="to" type="Vector2"> </argument> <description> - Returns the distance to vector "b". + Returns the distance to vector [code]b[/code]. </description> </method> <method name="dot"> @@ -120,35 +136,35 @@ <argument index="0" name="with" type="Vector2"> </argument> <description> - Returns the dot product with vector "b". + Returns the dot product with vector [code]b[/code]. </description> </method> <method name="floor"> <return type="Vector2"> </return> <description> - Remove the fractional part of x and y. + Returns the vector with all components rounded down. </description> </method> <method name="is_normalized"> <return type="bool"> </return> <description> - Returns whether the vector is normalized or not. + Returns [code]true[/code] if the vector is normalized. </description> </method> <method name="length"> <return type="float"> </return> <description> - Returns the length of the vector. + Returns the vector's length. </description> </method> <method name="length_squared"> <return type="float"> </return> <description> - Returns the squared length of the vector. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. + Returns the vector's length squared. Prefer this function over [member length] if you need to sort vectors or need the squared length for some formula. </description> </method> <method name="linear_interpolate"> @@ -159,14 +175,23 @@ <argument index="1" name="t" type="float"> </argument> <description> - Returns the result of the linear interpolation between this vector and "b", by amount "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is. + Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], a percentage of how far along the interpolation is. </description> </method> <method name="normalized"> <return type="Vector2"> </return> <description> - Returns a normalized vector to unit length. + Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. + </description> + </method> + <method name="project"> + <return type="Vector2"> + </return> + <argument index="0" name="b" type="Vector2"> + </argument> + <description> + Returns the vector projected onto the vector [code]b[/code]. </description> </method> <method name="reflect"> @@ -175,7 +200,7 @@ <argument index="0" name="n" type="Vector2"> </argument> <description> - Reflects the vector along the given plane, specified by its normal vector. + Returns the vector reflected from a plane defined by the given normal. </description> </method> <method name="rotated"> @@ -184,7 +209,26 @@ <argument index="0" name="phi" type="float"> </argument> <description> - Rotates the vector by "phi" radians. + Returns the vector rotated by [code]phi[/code] radians. + </description> + </method> + <method name="round"> + <return type="Vector2"> + </return> + <description> + Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. + </description> + </method> + <method name="slerp"> + <return type="Vector2"> + </return> + <argument index="0" name="b" type="Vector2"> + </argument> + <argument index="1" name="t" type="float"> + </argument> + <description> + Returns the result of SLERP between this vector and "b", by amount "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is. + Both vectors need to be normalized. </description> </method> <method name="slide"> @@ -193,7 +237,7 @@ <argument index="0" name="n" type="Vector2"> </argument> <description> - Slide returns the component of the vector along the given plane, specified by its normal vector. + Returns the component of the vector along a plane defined by the given normal. </description> </method> <method name="snapped"> @@ -202,7 +246,7 @@ <argument index="0" name="by" type="Vector2"> </argument> <description> - Snaps the vector to a grid with the given size. + Returns the vector snapped to a grid with the given size. </description> </method> <method name="tangent"> @@ -215,12 +259,24 @@ </methods> <members> <member name="x" type="float" setter="" getter=""> - X component of the vector. + The vector's x component. </member> <member name="y" type="float" setter="" getter=""> - Y component of the vector. + The vector's y component. </member> </members> <constants> + <constant name="ZERO" value="Vector2( 0, 0 )"> + </constant> + <constant name="INF" value="Vector2( inf, inf )"> + </constant> + <constant name="LEFT" value="Vector2( -1, 0 )"> + </constant> + <constant name="RIGHT" value="Vector2( 1, 0 )"> + </constant> + <constant name="UP" value="Vector2( 0, -1 )"> + </constant> + <constant name="DOWN" value="Vector2( 0, 1 )"> + </constant> </constants> </class> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 09afa17282..b4dcc6c6aa 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.1-dev"> +<class name="Vector3" category="Built-In Types" version="3.1"> <brief_description> Vector class, which performs basic 3D vector math operations. </brief_description> @@ -7,7 +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 + <link>http://docs.godotengine.org/en/3.0/tutorials/math/index.html</link> </tutorials> <demos> </demos> @@ -38,7 +38,7 @@ <argument index="0" name="to" type="Vector3"> </argument> <description> - Returns the vector's minimum angle to the vector [code]to[/code]. + Returns the minimum angle to the given vector. </description> </method> <method name="bounce"> @@ -47,7 +47,7 @@ <argument index="0" name="n" type="Vector3"> </argument> <description> - Bounce returns the vector "bounced off" from the given plane, specified by its normal vector. + Returns the vector "bounced off" from a plane defined by the given normal. </description> </method> <method name="ceil"> @@ -87,7 +87,7 @@ <argument index="0" name="b" type="Vector3"> </argument> <description> - Returns the squared distance to [code]b[/code]. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula. + Returns the squared distance to [code]b[/code]. Prefer this function over [method distance_to] if you need to sort vectors or need the squared distance for some formula. </description> </method> <method name="distance_to"> @@ -96,7 +96,7 @@ <argument index="0" name="b" type="Vector3"> </argument> <description> - Returns the distance to b. + Returns the distance to [code]b[/code]. </description> </method> <method name="dot"> @@ -105,7 +105,7 @@ <argument index="0" name="b" type="Vector3"> </argument> <description> - Returns the dot product with b. + Returns the dot product with [code]b[/code]. </description> </method> <method name="floor"> @@ -119,28 +119,28 @@ <return type="Vector3"> </return> <description> - Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) + Returns the inverse of the vector. This is the same as [code]Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z )[/code]. </description> </method> <method name="is_normalized"> <return type="bool"> </return> <description> - Returns whether the vector is normalized or not. + Returns [code]true[/code] if the vector is normalized. </description> </method> <method name="length"> <return type="float"> </return> <description> - Returns the length of the vector. + Returns the vector's length. </description> </method> <method name="length_squared"> <return type="float"> </return> <description> - Returns the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. + Returns the vector's length squared. Prefer this function over [method length] if you need to sort vectors or need the squared length for some formula. </description> </method> <method name="linear_interpolate"> @@ -151,28 +151,28 @@ <argument index="1" name="t" type="float"> </argument> <description> - Linearly interpolates the vector to a given one (b), by the given amount (t). (t) should be a float of 0.0-1.0, a percentage of how far along the interpolation is. + Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], a percentage of how far along the interpolation is. </description> </method> <method name="max_axis"> <return type="int"> </return> <description> - Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest. + Returns the axis of the vector's largest value. See [code]AXIS_*[/code] constants. </description> </method> <method name="min_axis"> <return type="int"> </return> <description> - Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest. + Returns the axis of the vector's smallest value. See [code]AXIS_*[/code] constants. </description> </method> <method name="normalized"> <return type="Vector3"> </return> <description> - Returns a copy of the normalized vector to unit length. This is the same as v / v.length(). + Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. </description> </method> <method name="outer"> @@ -181,7 +181,16 @@ <argument index="0" name="b" type="Vector3"> </argument> <description> - Returns the outer product with b. + Returns the outer product with [code]b[/code]. + </description> + </method> + <method name="project"> + <return type="Vector3"> + </return> + <argument index="0" name="b" type="Vector3"> + </argument> + <description> + Returns the vector projected onto the vector [code]b[/code]. </description> </method> <method name="reflect"> @@ -190,7 +199,7 @@ <argument index="0" name="n" type="Vector3"> </argument> <description> - Reflects the vector along the given plane, specified by its normal vector. + Returns the vector reflected from a plane defined by the given normal. </description> </method> <method name="rotated"> @@ -201,7 +210,26 @@ <argument index="1" name="phi" type="float"> </argument> <description> - Rotates the vector around some axis by phi radians. The axis must be a normalized vector. + Rotates the vector around a given axis by [code]phi[/code] radians. The axis must be a normalized vector. + </description> + </method> + <method name="round"> + <return type="Vector3"> + </return> + <description> + Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. + </description> + </method> + <method name="slerp"> + <return type="Vector3"> + </return> + <argument index="0" name="b" type="Vector3"> + </argument> + <argument index="1" name="t" type="float"> + </argument> + <description> + Returns the result of SLERP between this vector and "b", by amount "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is. + Both vectors need to be normalized. </description> </method> <method name="slide"> @@ -210,7 +238,7 @@ <argument index="0" name="n" type="Vector3"> </argument> <description> - Slide returns the component of the vector along the given plane, specified by its normal vector. + Returns the component of the vector along a plane defined by the given normal. </description> </method> <method name="snapped"> @@ -232,18 +260,18 @@ </methods> <members> <member name="x" type="float" setter="" getter=""> - X component of the vector. + The vector's x component. </member> <member name="y" type="float" setter="" getter=""> - Y component of the vector. + The vector's y component. </member> <member name="z" type="float" setter="" getter=""> - Z component of the vector. + The vector's z component. </member> </members> <constants> <constant name="AXIS_X" value="0"> - Enumerated value for the X axis. Returned by functions like max_axis or min_axis. + Enumerated value for the X axis. Returned by [method max_axis] and [method min_axis]. </constant> <constant name="AXIS_Y" value="1"> Enumerated value for the Y axis. @@ -251,5 +279,21 @@ <constant name="AXIS_Z" value="2"> Enumerated value for the Z axis. </constant> + <constant name="ZERO" value="Vector3( 0, 0, 0 )"> + </constant> + <constant name="INF" value="Vector3( inf, inf, inf )"> + </constant> + <constant name="LEFT" value="Vector3( -1, 0, 0 )"> + </constant> + <constant name="RIGHT" value="Vector3( 1, 0, 0 )"> + </constant> + <constant name="UP" value="Vector3( 0, 1, 0 )"> + </constant> + <constant name="DOWN" value="Vector3( 0, -1, 0 )"> + </constant> + <constant name="FORWARD" value="Vector3( 0, 0, -1 )"> + </constant> + <constant name="BACK" value="Vector3( 0, 0, 1 )"> + </constant> </constants> </class> diff --git a/doc/classes/VehicleBody.xml b/doc/classes/VehicleBody.xml index 873490c0c8..3ce0cadde9 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="RigidBody" category="Core" version="3.1-dev"> +<class name="VehicleBody" inherits="RigidBody" category="Core" version="3.1"> <brief_description> Physics body that simulates the behaviour of a car. </brief_description> diff --git a/doc/classes/VehicleWheel.xml b/doc/classes/VehicleWheel.xml index ccc4b964c1..f2c6f5f287 100644 --- a/doc/classes/VehicleWheel.xml +++ b/doc/classes/VehicleWheel.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VehicleWheel" inherits="Spatial" category="Core" version="3.1-dev"> +<class name="VehicleWheel" inherits="Spatial" category="Core" version="3.1"> <brief_description> - Physics object that simulates the behaviour of a wheel. + Physics object that simulates the behaviour of a wheel. </brief_description> <description> - This node needs to be used as a child node of [VehicleBody] and simulates the behaviour of one of its wheels. This node also acts as a collider to detect if the wheel is touching a surface. + This node needs to be used as a child node of [VehicleBody] and simulates the behaviour of one of its wheels. This node also acts as a collider to detect if the wheel is touching a surface. </description> <tutorials> </tutorials> @@ -31,16 +31,16 @@ The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car. </member> <member name="damping_relaxation" type="float" setter="set_damping_relaxation" getter="get_damping_relaxation"> - The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slighly higher then the [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5 + The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5 </member> <member name="suspension_max_force" type="float" setter="set_suspension_max_force" getter="get_suspension_max_force"> - The maximum force the spring can resist. This value should be higher then a quarter of the [member RigidBody.mass] of the [VehicleBody] or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number. + The maximum force the spring can resist. This value should be higher than a quarter of the [member RigidBody.mass] of the [VehicleBody] or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number. </member> <member name="suspension_stiffness" type="float" setter="set_suspension_stiffness" getter="get_suspension_stiffness"> - This value defines the stiffness of the suspension. Use a value lower then 50 for an offroad car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. + This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. </member> <member name="suspension_travel" type="float" setter="set_suspension_travel" getter="get_suspension_travel"> - This is the distance the suspension can travel. As Godots measures are in meters keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car . + This is the distance the suspension can travel. As Godot measures are in meters keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car . </member> <member name="use_as_steering" type="bool" setter="set_use_as_steering" getter="is_used_as_steering"> If true this wheel will be turned when the car steers. @@ -49,14 +49,14 @@ If true this wheel transfers engine force to the ground to propel the vehicle forward. </member> <member name="wheel_friction_slip" type="float" setter="set_friction_slip" getter="get_friction_slip"> - This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower then the front wheels, or use a lower value to simulate tire wear. + This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear. It's best to set this to 1.0 when starting out. </member> <member name="wheel_radius" type="float" setter="set_radius" getter="get_radius"> The radius of the wheel in meters. </member> <member name="wheel_rest_length" type="float" setter="set_suspension_rest_length" getter="get_suspension_rest_length"> - This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest lenght to move the wheel down to the position it should be in when the car is in rest. + This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest. </member> <member name="wheel_roll_influence" type="float" setter="set_roll_influence" getter="get_roll_influence"> This value effects the roll of your vehicle. If set to 0.0 for all wheels your vehicle will be prone to rolling over while a value of 1.0 will resist body roll. diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index aa827c6e2c..9ffa3aa52b 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VideoPlayer" inherits="Control" category="Core" version="3.1-dev"> +<class name="VideoPlayer" inherits="Control" category="Core" version="3.1"> <brief_description> - Control to play video files. + Control for playing video streams. </brief_description> <description> - This control has the ability to play video streams. The only format accepted is the OGV Theora, so any other format must be converted before using in a project. + Control node for playing video streams. Supported formats are WebM and OGV Theora. </description> <tutorials> </tutorials> @@ -15,51 +15,56 @@ <return type="String"> </return> <description> - Get the name of the video stream. + Returns the video stream's name. </description> </method> <method name="get_video_texture"> <return type="Texture"> </return> <description> - Get the current frame of the video as a [Texture]. + Returns the current frame as a [Texture]. </description> </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> <description> - Get whether or not the video is playing. + Returns [code]true[/code] if the video is playing. </description> </method> <method name="play"> <return type="void"> </return> <description> - Start the video playback. + Starts the video playback. </description> </method> <method name="stop"> <return type="void"> </return> <description> - Stop the video playback. + Stops the video playback. </description> </method> </methods> <members> <member name="audio_track" type="int" setter="set_audio_track" getter="get_audio_track"> + The embedded audio track to play. </member> <member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay"> + If [code]true[/code] playback starts when the scene loads. Default value: [code]false[/code]. </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. + Amount of time in milliseconds to store in buffer while playing. </member> <member name="bus" type="String" setter="set_bus" getter="get_bus"> + Audio bus to use for sound playback. </member> <member name="expand" type="bool" setter="set_expand" getter="has_expand"> + If [code]true[/code] the video scales to the control size. Default value: [code]true[/code]. </member> <member name="paused" type="bool" setter="set_paused" getter="is_paused"> + If [code]true[/code] the video is paused. </member> <member name="stream" type="VideoStream" setter="set_stream" getter="get_stream"> </member> @@ -67,11 +72,19 @@ 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. + Audio volume as a linear value. </member> <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> + Audio volume in dB. </member> </members> + <signals> + <signal name="finished"> + <description> + Emitted when playback is finished. + </description> + </signal> + </signals> <constants> </constants> </class> diff --git a/doc/classes/VideoStream.xml b/doc/classes/VideoStream.xml index c777673cf4..6bfa48511b 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.1-dev"> +<class name="VideoStream" inherits="Resource" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 6aac66269d..05649193a6 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -1,19 +1,19 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Viewport" inherits="Node" category="Core" version="3.1-dev"> +<class name="Viewport" inherits="Node" category="Core" version="3.1"> <brief_description> Creates a sub-view into the screen. </brief_description> <description> A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will render on it too. Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports. - If a viewport is a child of a [Control], it will automatically take up its same rect and position, otherwise they must be set manually. + If a viewport is a child of a [ViewportContainer], it will automatically take up its size, otherwise it must be set manually. Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it. Also, viewports can be assigned to different screens in case the devices have multiple screens. 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/2d/2d_transforms.html</link> + <link>http://docs.godotengine.org/en/3.0/tutorials/viewports/index.html</link> </tutorials> <demos> </demos> @@ -22,35 +22,35 @@ <return type="World"> </return> <description> - Return the 3D world of the viewport, or if no such present, the one of the parent viewport. + Returns the 3D world of the viewport, or if none the world of the parent viewport. </description> </method> <method name="find_world_2d" qualifiers="const"> <return type="World2D"> </return> <description> - Return the 2D world of the viewport. + Returns the 2D world of the viewport. </description> </method> <method name="get_camera" qualifiers="const"> <return type="Camera"> </return> <description> - Return the active 3D camera. + Returns the active 3D camera. </description> </method> <method name="get_final_transform" qualifiers="const"> <return type="Transform2D"> </return> <description> - Get the total transform of the viewport. + Returns the total transform of the viewport. </description> </method> <method name="get_mouse_position" qualifiers="const"> <return type="Vector2"> </return> <description> - Get the mouse position, relative to the viewport. + Returns the mouse position relative to the viewport. </description> </method> <method name="get_render_info"> @@ -59,35 +59,35 @@ <argument index="0" name="info" type="int" enum="Viewport.RenderInfo"> </argument> <description> - Get the specific information about the viewport from rendering pipeline. + Returns information about the viewport from the rendering pipeline. </description> </method> <method name="get_size_override" qualifiers="const"> <return type="Vector2"> </return> <description> - Get the size override set with [method set_size_override]. + Returns the size override set with [method set_size_override]. </description> </method> <method name="get_texture" qualifiers="const"> <return type="ViewportTexture"> </return> <description> - Get the viewport's texture, for use with various objects that you want to texture with the viewport. + Returns the viewport's texture. </description> </method> <method name="get_viewport_rid" qualifiers="const"> <return type="RID"> </return> <description> - Get the viewport RID from the [VisualServer]. + Returns the viewport's RID from the [VisualServer]. </description> </method> <method name="get_visible_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return the final, visible rect in global screen coordinates. + Returns the visible rectangle in global screen coordinates. </description> </method> <method name="gui_get_drag_data" qualifiers="const"> @@ -101,7 +101,7 @@ <return type="bool"> </return> <description> - Returns whether there are shown modals on-screen. + Returns [code]true[/code] if there are visible modals on-screen. </description> </method> <method name="input"> @@ -116,14 +116,14 @@ <return type="bool"> </return> <description> - Get the enabled status of the size override set with [method set_size_override]. + Returns [code]true[/code] if the size override is enabled. See [method set_size_override]. </description> </method> <method name="is_size_override_stretch_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Get the enabled status of the size stretch override set with [method set_size_override_stretch]. + Returns [code]true[/code] if the size stretch override is enabled. See [method set_size_override_stretch]. </description> </method> <method name="set_attach_to_screen_rect"> @@ -144,7 +144,7 @@ <argument index="2" name="margin" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size. + Sets the size override of the viewport. If the [code]enable[/code] parameter is [code]true[/code] the override is used, otherwise it uses the default size. If the size parameter is [code](-1, -1)[/code], it won't update the size. </description> </method> <method name="set_size_override_stretch"> @@ -153,7 +153,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether the size override affects stretch as well. + If [code]true[/code] the size override affects stretch as well. </description> </method> <method name="unhandled_input"> @@ -168,7 +168,7 @@ <return type="void"> </return> <description> - Force update of the 2D and 3D worlds. + Forces update of the 2D and 3D worlds. </description> </method> <method name="warp_mouse"> @@ -177,7 +177,7 @@ <argument index="0" name="to_position" type="Vector2"> </argument> <description> - Warp the mouse to a position, relative to the viewport. + Warps the mouse to a position relative to the viewport. </description> </method> </methods> @@ -212,6 +212,9 @@ <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="keep_3d_linear" type="bool" setter="set_keep_3d_linear" getter="get_keep_3d_linear"> + If [code]true[/code] the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output. + </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> @@ -273,7 +276,7 @@ Do not update the render target. </constant> <constant name="UPDATE_ONCE" value="1" enum="UpdateMode"> - Update the render target once, then switch to [code]UPDATE_DISABLED[/code] + Update the render target once, then switch to [code]UPDATE_DISABLED[/code]. </constant> <constant name="UPDATE_WHEN_VISIBLE" value="2" enum="UpdateMode"> Update the render target only when it is visible. This is the default value. @@ -326,6 +329,7 @@ Objects are displayed without light information. </constant> <constant name="DEBUG_DRAW_OVERDRAW" value="2" enum="DebugDraw"> + Objected are displayed semi-transparent with additive blending so you can see where they intersect. </constant> <constant name="DEBUG_DRAW_WIREFRAME" value="3" enum="DebugDraw"> Objects are displayed in wireframe style. @@ -350,10 +354,13 @@ <constant name="USAGE_3D_NO_EFFECTS" value="3" enum="Usage"> </constant> <constant name="CLEAR_MODE_ALWAYS" value="0" enum="ClearMode"> + Always clear the render target before drawing. </constant> <constant name="CLEAR_MODE_NEVER" value="1" enum="ClearMode"> + Never clear the render target. </constant> <constant name="CLEAR_MODE_ONLY_NEXT_FRAME" value="2" enum="ClearMode"> + Clear the render target next frame, then switch to [code]CLEAR_MODE_NEVER[/code]. </constant> </constants> </class> diff --git a/doc/classes/ViewportContainer.xml b/doc/classes/ViewportContainer.xml index 8c89a2c1be..8c60fb473d 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.1-dev"> +<class name="ViewportContainer" inherits="Container" category="Core" version="3.1"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ViewportTexture.xml b/doc/classes/ViewportTexture.xml index 6900c6563d..67f1e09c75 100644 --- a/doc/classes/ViewportTexture.xml +++ b/doc/classes/ViewportTexture.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ViewportTexture" inherits="Texture" category="Core" version="3.1-dev"> +<class name="ViewportTexture" inherits="Texture" category="Core" version="3.1"> <brief_description> + Texture which displays the content of a [Viewport]. </brief_description> <description> + Displays the content of a [Viewport] node as a dynamic [Texture]. This can be used to mix controls, 2D, and 3D elements in the same scene. + To create a ViewportTexture in code, use the [method Viewport.get_texture] method on the target viewport. </description> <tutorials> </tutorials> @@ -12,6 +15,7 @@ </methods> <members> <member name="viewport_path" type="NodePath" setter="set_viewport_path_in_scene" getter="get_viewport_path_in_scene"> + The path to the [Viewport] node to display. This is relative to the scene root, not to the node which uses the texture. </member> </members> <constants> diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 0094a9b3cc..83ba9495e5 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.1-dev"> +<class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core" version="3.1"> <brief_description> Enable certain nodes only when visible. </brief_description> diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index 6b66d76733..8dfbaec6e8 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.1-dev"> +<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.1"> <brief_description> Enable certain nodes only when visible. </brief_description> diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml index c430a1336d..2f22dc99bf 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.1-dev"> +<class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.1"> <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 67b3525eb4..b98f2794d2 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.1-dev"> +<class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.1"> <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 81e1bcf7f7..30dedb06f4 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.1-dev"> +<class name="VisualInstance" inherits="Spatial" category="Core" version="3.1"> <brief_description> </brief_description> <description> @@ -16,6 +16,14 @@ Returns the [AABB] (also known as the bounding box) for this VisualInstance. </description> </method> + <method name="get_layer_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + </description> + </method> <method name="get_transformed_aabb" qualifiers="const"> <return type="AABB"> </return> @@ -34,6 +42,16 @@ It is recommended to only use set_base if you know what you're doing. </description> </method> + <method name="set_layer_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="layers" type="int" setter="set_layer_mask" getter="get_layer_mask"> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 505a3d1474..395fb9e829 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.1-dev"> +<class name="VisualServer" inherits="Object" category="Core" version="3.1"> <brief_description> Server for anything visible. </brief_description> @@ -175,7 +175,9 @@ </argument> <argument index="1" name="mesh" type="RID"> </argument> - <argument index="2" name="skeleton" type="RID"> + <argument index="2" name="texture" type="RID"> + </argument> + <argument index="3" name="normal_map" type="RID"> </argument> <description> Adds a [Mesh] to the [CanvasItem]'s draw commands. Only affects its aabb at the moment. @@ -188,7 +190,9 @@ </argument> <argument index="1" name="mesh" type="RID"> </argument> - <argument index="2" name="skeleton" type="RID"> + <argument index="2" name="texture" type="RID"> + </argument> + <argument index="3" name="normal_map" type="RID"> </argument> <description> Adds a [MultiMesh] to the [CanvasItem]'s draw commands. Only affects its aabb at the moment. @@ -324,7 +328,7 @@ </argument> <description> Adds a [Transform2D] command to the [CanvasItem]'s draw commands. - This sets the extra_matrix uniform when executed. This affects the later command's of the canvas item. + This sets the extra_matrix uniform when executed. This affects the later commands of the canvas item. </description> </method> <method name="canvas_item_add_texture_rect"> @@ -384,14 +388,17 @@ </argument> <argument index="4" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )"> </argument> - <argument index="5" name="texture" type="RID"> + <argument index="5" name="bones" type="PoolIntArray" default="PoolIntArray( )"> + </argument> + <argument index="6" name="weights" type="PoolRealArray" default="PoolRealArray( )"> </argument> - <argument index="6" name="count" type="int" default="-1"> + <argument index="7" name="texture" type="RID"> </argument> - <argument index="7" name="normal_map" type="RID"> + <argument index="8" name="count" type="int" default="-1"> + </argument> + <argument index="9" name="normal_map" type="RID"> </argument> <description> - Adds a triangle array to the [CanvasItem]'s draw commands. </description> </method> <method name="canvas_item_clear"> @@ -966,8 +973,9 @@ </return> <argument index="0" name="swap_buffers" type="bool" default="true"> </argument> + <argument index="1" name="frame_step" type="float" default="0.0"> + </argument> <description> - Draws a frame. </description> </method> <method name="environment_create"> @@ -1199,13 +1207,15 @@ </argument> <argument index="7" name="light_affect" type="float"> </argument> - <argument index="8" name="color" type="Color"> + <argument index="8" name="ao_channel_affect" type="float"> </argument> - <argument index="9" name="quality" type="int" enum="VisualServer.EnvironmentSSAOQuality"> + <argument index="9" name="color" type="Color"> </argument> - <argument index="10" name="blur" type="int" enum="VisualServer.EnvironmentSSAOBlur"> + <argument index="10" name="quality" type="int" enum="VisualServer.EnvironmentSSAOQuality"> </argument> - <argument index="11" name="bilateral_sharpness" type="float"> + <argument index="11" name="blur" type="int" enum="VisualServer.EnvironmentSSAOBlur"> + </argument> + <argument index="12" name="bilateral_sharpness" type="float"> </argument> <description> </description> @@ -1266,8 +1276,9 @@ </return> <argument index="0" name="swap_buffers" type="bool" default="true"> </argument> + <argument index="1" name="frame_step" type="float" default="0.0"> + </argument> <description> - Draws a frame. Same as [method draw]. </description> </method> <method name="force_sync"> @@ -1325,7 +1336,7 @@ <method name="gi_probe_get_bias" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1349,7 +1360,7 @@ <method name="gi_probe_get_dynamic_data" qualifiers="const"> <return type="PoolIntArray"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1357,7 +1368,7 @@ <method name="gi_probe_get_dynamic_range" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1365,7 +1376,7 @@ <method name="gi_probe_get_energy" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1373,7 +1384,7 @@ <method name="gi_probe_get_normal_bias" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1381,7 +1392,7 @@ <method name="gi_probe_get_propagation" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1389,7 +1400,7 @@ <method name="gi_probe_get_to_cell_xform" qualifiers="const"> <return type="Transform"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1397,7 +1408,7 @@ <method name="gi_probe_is_compressed" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1405,7 +1416,7 @@ <method name="gi_probe_is_interior" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1413,9 +1424,9 @@ <method name="gi_probe_set_bias"> <return type="void"> </return> - <argument index="0" name="bias" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="bias" type="float"> </argument> <description> </description> @@ -1443,9 +1454,9 @@ <method name="gi_probe_set_compress"> <return type="void"> </return> - <argument index="0" name="enable" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="enable" type="bool"> </argument> <description> </description> @@ -1453,9 +1464,9 @@ <method name="gi_probe_set_dynamic_data"> <return type="void"> </return> - <argument index="0" name="data" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="PoolIntArray"> + <argument index="1" name="data" type="PoolIntArray"> </argument> <description> </description> @@ -1463,9 +1474,9 @@ <method name="gi_probe_set_dynamic_range"> <return type="void"> </return> - <argument index="0" name="range" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="range" type="int"> </argument> <description> </description> @@ -1473,9 +1484,9 @@ <method name="gi_probe_set_energy"> <return type="void"> </return> - <argument index="0" name="energy" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="energy" type="float"> </argument> <description> </description> @@ -1483,9 +1494,9 @@ <method name="gi_probe_set_interior"> <return type="void"> </return> - <argument index="0" name="enable" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="enable" type="bool"> </argument> <description> </description> @@ -1493,9 +1504,9 @@ <method name="gi_probe_set_normal_bias"> <return type="void"> </return> - <argument index="0" name="bias" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="bias" type="float"> </argument> <description> </description> @@ -1503,9 +1514,9 @@ <method name="gi_probe_set_propagation"> <return type="void"> </return> - <argument index="0" name="propagation" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="propagation" type="float"> </argument> <description> </description> @@ -1513,9 +1524,9 @@ <method name="gi_probe_set_to_cell_xform"> <return type="void"> </return> - <argument index="0" name="xform" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="Transform"> + <argument index="1" name="xform" type="Transform"> </argument> <description> </description> @@ -2251,7 +2262,7 @@ </argument> <argument index="3" name="blend_shapes" type="Array" default="[ ]"> </argument> - <argument index="4" name="compress_format" type="int" default="97792"> + <argument index="4" name="compress_format" type="int" default="97280"> </argument> <description> Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE_* constants for types. @@ -2430,6 +2441,32 @@ Returns the format of a mesh's surface. </description> </method> + <method name="mesh_surface_get_format_offset" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="format" type="int"> + </argument> + <argument index="1" name="vertex_len" type="int"> + </argument> + <argument index="2" name="index_len" type="int"> + </argument> + <argument index="3" name="array_index" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_format_stride" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="format" type="int"> + </argument> + <argument index="1" name="vertex_len" type="int"> + </argument> + <argument index="2" name="index_len" type="int"> + </argument> + <description> + </description> + </method> <method name="mesh_surface_get_index_array" qualifiers="const"> <return type="PoolByteArray"> </return> @@ -2487,6 +2524,20 @@ Sets a mesh's surface's material. </description> </method> + <method name="mesh_surface_update_region"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <argument index="2" name="offset" type="int"> + </argument> + <argument index="3" name="data" type="PoolByteArray"> + </argument> + <description> + </description> + </method> <method name="multimesh_allocate"> <return type="void"> </return> @@ -2498,6 +2549,8 @@ </argument> <argument index="3" name="color_format" type="int" enum="VisualServer.MultimeshColorFormat"> </argument> + <argument index="4" name="custom_data_format" type="int" enum="VisualServer.MultimeshCustomDataFormat" default="0"> + </argument> <description> </description> </method> @@ -2543,6 +2596,16 @@ <description> </description> </method> + <method name="multimesh_instance_get_custom_data" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="multimesh" type="RID"> + </argument> + <argument index="1" name="index" type="int"> + </argument> + <description> + </description> + </method> <method name="multimesh_instance_get_transform" qualifiers="const"> <return type="Transform"> </return> @@ -2575,6 +2638,18 @@ <description> </description> </method> + <method name="multimesh_instance_set_custom_data"> + <return type="void"> + </return> + <argument index="0" name="multimesh" type="RID"> + </argument> + <argument index="1" name="index" type="int"> + </argument> + <argument index="2" name="custom_data" type="Color"> + </argument> + <description> + </description> + </method> <method name="multimesh_instance_set_transform"> <return type="void"> </return> @@ -2599,6 +2674,16 @@ <description> </description> </method> + <method name="multimesh_set_as_bulk_array"> + <return type="void"> + </return> + <argument index="0" name="multimesh" type="RID"> + </argument> + <argument index="1" name="array" type="PoolRealArray"> + </argument> + <description> + </description> + </method> <method name="multimesh_set_mesh"> <return type="void"> </return> @@ -3215,12 +3300,15 @@ </argument> <argument index="2" name="height" type="int"> </argument> - <argument index="3" name="format" type="int" enum="Image.Format"> + <argument index="3" name="depth_3d" type="int"> + </argument> + <argument index="4" name="format" type="int" enum="Image.Format"> + </argument> + <argument index="5" name="type" type="int" enum="VisualServer.TextureType"> </argument> - <argument index="4" name="flags" type="int" default="7"> + <argument index="6" name="flags" type="int" default="7"> </argument> <description> - Allocates space for a texture's image or video. </description> </method> <method name="texture_create"> @@ -3253,12 +3341,20 @@ </return> <argument index="0" name="texture" type="RID"> </argument> - <argument index="1" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> + <argument index="1" name="cube_side" type="int" default="0"> </argument> <description> 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_depth" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> <method name="texture_get_flags" qualifiers="const"> <return type="int"> </return> @@ -3304,6 +3400,14 @@ Returns the opengl id of the texture's image. </description> </method> + <method name="texture_get_type" qualifiers="const"> + <return type="int" enum="VisualServer.TextureType"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> <method name="texture_get_width" qualifiers="const"> <return type="int"> </return> @@ -3320,12 +3424,38 @@ </argument> <argument index="1" name="image" type="Image"> </argument> - <argument index="2" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> + <argument index="2" name="layer" type="int" default="0"> </argument> <description> Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side. </description> </method> + <method name="texture_set_data_partial"> + <return type="void"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="image" type="Image"> + </argument> + <argument index="2" name="src_x" type="int"> + </argument> + <argument index="3" name="src_y" type="int"> + </argument> + <argument index="4" name="src_w" type="int"> + </argument> + <argument index="5" name="src_h" type="int"> + </argument> + <argument index="6" name="dst_x" type="int"> + </argument> + <argument index="7" name="dst_y" type="int"> + </argument> + <argument index="8" name="dst_mip" type="int"> + </argument> + <argument index="9" name="layer" type="int" default="0"> + </argument> + <description> + </description> + </method> <method name="texture_set_flags"> <return type="void"> </return> @@ -3366,8 +3496,9 @@ </argument> <argument index="2" name="height" type="int"> </argument> + <argument index="3" name="depth" type="int"> + </argument> <description> - Overwrites the texture's width and height. </description> </method> <method name="textures_keep_original"> @@ -3713,7 +3844,11 @@ </method> </methods> <signals> - <signal name="frame_drawn_in_thread"> + <signal name="frame_post_draw"> + <description> + </description> + </signal> + <signal name="frame_pre_draw"> <description> </description> </signal> @@ -3758,6 +3893,14 @@ <constant name="CUBEMAP_BACK" value="5" enum="CubeMapSide"> Marks the back side of a cubemap. </constant> + <constant name="TEXTURE_TYPE_2D" value="0" enum="TextureType"> + </constant> + <constant name="TEXTURE_TYPE_CUBEMAP" value="1" enum="TextureType"> + </constant> + <constant name="TEXTURE_TYPE_2D_ARRAY" value="2" enum="TextureType"> + </constant> + <constant name="TEXTURE_TYPE_3D" value="3" enum="TextureType"> + </constant> <constant name="TEXTURE_FLAG_MIPMAPS" value="1" enum="TextureFlags"> Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. </constant> @@ -3777,10 +3920,7 @@ <constant name="TEXTURE_FLAG_MIRRORED_REPEAT" value="32" enum="TextureFlags"> Repeat texture with alternate sections mirrored. </constant> - <constant name="TEXTURE_FLAG_CUBEMAP" value="2048" enum="TextureFlags"> - Texture is a cubemap. - </constant> - <constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="4096" enum="TextureFlags"> + <constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="2048" enum="TextureFlags"> Texture is a video surface. </constant> <constant name="TEXTURE_FLAGS_DEFAULT" value="7" enum="TextureFlags"> @@ -3886,7 +4026,7 @@ <constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288" enum="ArrayFormat"> Flag used to mark that the array uses 16 bit bones instead of 8 bit. </constant> - <constant name="ARRAY_COMPRESS_DEFAULT" value="97792" enum="ArrayFormat"> + <constant name="ARRAY_COMPRESS_DEFAULT" value="97280" enum="ArrayFormat"> Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly. </constant> <constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType"> @@ -4093,7 +4233,9 @@ </constant> <constant name="INSTANCE_FLAG_USE_BAKED_LIGHT" value="0" enum="InstanceFlags"> </constant> - <constant name="INSTANCE_FLAG_MAX" value="1" enum="InstanceFlags"> + <constant name="INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="1" enum="InstanceFlags"> + </constant> + <constant name="INSTANCE_FLAG_MAX" value="2" enum="InstanceFlags"> </constant> <constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting"> </constant> diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml new file mode 100644 index 0000000000..ab00080fef --- /dev/null +++ b/doc/classes/VisualShader.xml @@ -0,0 +1,183 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShader" inherits="Shader" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_node"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <argument index="1" name="node" type="VisualShaderNode"> + </argument> + <argument index="2" name="position" type="Vector2"> + </argument> + <argument index="3" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="can_connect_nodes" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> + <method name="connect_nodes"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> + <method name="disconnect_nodes"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node" qualifiers="const"> + <return type="VisualShaderNode"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_connections" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <description> + </description> + </method> + <method name="get_node_list" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <description> + </description> + </method> + <method name="get_node_position" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_valid_node_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <description> + </description> + </method> + <method name="is_node_connection" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_node"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Shader.Mode"> + </argument> + <description> + </description> + </method> + <method name="set_node_position"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="VisualShader.Type"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <argument index="2" name="position" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="graph_offset" type="Vector2" setter="set_graph_offset" getter="get_graph_offset"> + </member> + </members> + <constants> + <constant name="TYPE_VERTEX" value="0" enum="Type"> + </constant> + <constant name="TYPE_FRAGMENT" value="1" enum="Type"> + </constant> + <constant name="TYPE_LIGHT" value="2" enum="Type"> + </constant> + <constant name="TYPE_MAX" value="3" enum="Type"> + </constant> + <constant name="NODE_ID_INVALID" value="-1"> + </constant> + <constant name="NODE_ID_OUTPUT" value="0"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml new file mode 100644 index 0000000000..ffcaf85eea --- /dev/null +++ b/doc/classes/VisualShaderNode.xml @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNode" inherits="Resource" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_input_port_default_value" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="port" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_input_port_default_value"> + <return type="void"> + </return> + <argument index="0" name="port" type="int"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="default_input_values" type="Array" setter="_set_default_input_values" getter="_get_default_input_values"> + </member> + <member name="output_port_for_preview" type="int" setter="set_output_port_for_preview" getter="get_output_port_for_preview"> + </member> + </members> + <signals> + <signal name="editor_refresh_request"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeColorConstant.xml b/doc/classes/VisualShaderNodeColorConstant.xml new file mode 100644 index 0000000000..f1079e0056 --- /dev/null +++ b/doc/classes/VisualShaderNodeColorConstant.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeColorConstant" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="constant" type="Color" setter="set_constant" getter="get_constant"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeColorOp.xml b/doc/classes/VisualShaderNodeColorOp.xml new file mode 100644 index 0000000000..d23c674503 --- /dev/null +++ b/doc/classes/VisualShaderNodeColorOp.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeColorOp" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="operator" type="int" setter="set_operator" getter="get_operator" enum="VisualShaderNodeColorOp.Operator"> + </member> + </members> + <constants> + <constant name="OP_SCREEN" value="0" enum="Operator"> + </constant> + <constant name="OP_DIFFERENCE" value="1" enum="Operator"> + </constant> + <constant name="OP_DARKEN" value="2" enum="Operator"> + </constant> + <constant name="OP_LIGHTEN" value="3" enum="Operator"> + </constant> + <constant name="OP_OVERLAY" value="4" enum="Operator"> + </constant> + <constant name="OP_DODGE" value="5" enum="Operator"> + </constant> + <constant name="OP_BURN" value="6" enum="Operator"> + </constant> + <constant name="OP_SOFT_LIGHT" value="7" enum="Operator"> + </constant> + <constant name="OP_HARD_LIGHT" value="8" enum="Operator"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeColorUniform.xml b/doc/classes/VisualShaderNodeColorUniform.xml new file mode 100644 index 0000000000..0b97c104a2 --- /dev/null +++ b/doc/classes/VisualShaderNodeColorUniform.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeColorUniform" inherits="VisualShaderNodeUniform" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeCubeMap.xml b/doc/classes/VisualShaderNodeCubeMap.xml new file mode 100644 index 0000000000..9c56a23b7f --- /dev/null +++ b/doc/classes/VisualShaderNodeCubeMap.xml @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeCubeMap" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="cube_map" type="CubeMap" setter="set_cube_map" getter="get_cube_map"> + </member> + <member name="texture_type" type="int" setter="set_texture_type" getter="get_texture_type" enum="VisualShaderNodeCubeMap.TextureType"> + </member> + </members> + <constants> + <constant name="TYPE_DATA" value="0" enum="TextureType"> + </constant> + <constant name="TYPE_COLOR" value="1" enum="TextureType"> + </constant> + <constant name="TYPE_NORMALMAP" value="2" enum="TextureType"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeCubeMapUniform.xml b/doc/classes/VisualShaderNodeCubeMapUniform.xml new file mode 100644 index 0000000000..fc95e4ddd9 --- /dev/null +++ b/doc/classes/VisualShaderNodeCubeMapUniform.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeCubeMapUniform" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeDotProduct.xml b/doc/classes/VisualShaderNodeDotProduct.xml new file mode 100644 index 0000000000..c82f4cec3b --- /dev/null +++ b/doc/classes/VisualShaderNodeDotProduct.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeDotProduct" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeInput.xml b/doc/classes/VisualShaderNodeInput.xml new file mode 100644 index 0000000000..29de7f81d1 --- /dev/null +++ b/doc/classes/VisualShaderNodeInput.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeInput" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="input_name" type="String" setter="set_input_name" getter="get_input_name"> + </member> + </members> + <signals> + <signal name="input_type_changed"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeOutput.xml b/doc/classes/VisualShaderNodeOutput.xml new file mode 100644 index 0000000000..7b65c6fd5e --- /dev/null +++ b/doc/classes/VisualShaderNodeOutput.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeOutput" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeScalarConstant.xml b/doc/classes/VisualShaderNodeScalarConstant.xml new file mode 100644 index 0000000000..424fb2b3bd --- /dev/null +++ b/doc/classes/VisualShaderNodeScalarConstant.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeScalarConstant" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="constant" type="float" setter="set_constant" getter="get_constant"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeScalarFunc.xml b/doc/classes/VisualShaderNodeScalarFunc.xml new file mode 100644 index 0000000000..7362ededce --- /dev/null +++ b/doc/classes/VisualShaderNodeScalarFunc.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeScalarFunc" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeScalarFunc.Function"> + </member> + </members> + <constants> + <constant name="FUNC_SIN" value="0" enum="Function"> + </constant> + <constant name="FUNC_COS" value="1" enum="Function"> + </constant> + <constant name="FUNC_TAN" value="2" enum="Function"> + </constant> + <constant name="FUNC_ASIN" value="3" enum="Function"> + </constant> + <constant name="FUNC_ACOS" value="4" enum="Function"> + </constant> + <constant name="FUNC_ATAN" value="5" enum="Function"> + </constant> + <constant name="FUNC_SINH" value="6" enum="Function"> + </constant> + <constant name="FUNC_COSH" value="7" enum="Function"> + </constant> + <constant name="FUNC_TANH" value="8" enum="Function"> + </constant> + <constant name="FUNC_LOG" value="9" enum="Function"> + </constant> + <constant name="FUNC_EXP" value="10" enum="Function"> + </constant> + <constant name="FUNC_SQRT" value="11" enum="Function"> + </constant> + <constant name="FUNC_ABS" value="12" enum="Function"> + </constant> + <constant name="FUNC_SIGN" value="13" enum="Function"> + </constant> + <constant name="FUNC_FLOOR" value="14" enum="Function"> + </constant> + <constant name="FUNC_ROUND" value="15" enum="Function"> + </constant> + <constant name="FUNC_CEIL" value="16" enum="Function"> + </constant> + <constant name="FUNC_FRAC" value="17" enum="Function"> + </constant> + <constant name="FUNC_SATURATE" value="18" enum="Function"> + </constant> + <constant name="FUNC_NEGATE" value="19" enum="Function"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeScalarInterp.xml b/doc/classes/VisualShaderNodeScalarInterp.xml new file mode 100644 index 0000000000..8420b34dd3 --- /dev/null +++ b/doc/classes/VisualShaderNodeScalarInterp.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeScalarInterp" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeScalarOp.xml b/doc/classes/VisualShaderNodeScalarOp.xml new file mode 100644 index 0000000000..0ab0a46d0a --- /dev/null +++ b/doc/classes/VisualShaderNodeScalarOp.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeScalarOp" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="operator" type="int" setter="set_operator" getter="get_operator" enum="VisualShaderNodeScalarOp.Operator"> + </member> + </members> + <constants> + <constant name="OP_ADD" value="0" enum="Operator"> + </constant> + <constant name="OP_SUB" value="1" enum="Operator"> + </constant> + <constant name="OP_MUL" value="2" enum="Operator"> + </constant> + <constant name="OP_DIV" value="3" enum="Operator"> + </constant> + <constant name="OP_MOD" value="4" enum="Operator"> + </constant> + <constant name="OP_POW" value="5" enum="Operator"> + </constant> + <constant name="OP_MAX" value="6" enum="Operator"> + </constant> + <constant name="OP_MIN" value="7" enum="Operator"> + </constant> + <constant name="OP_ATAN2" value="8" enum="Operator"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeScalarUniform.xml b/doc/classes/VisualShaderNodeScalarUniform.xml new file mode 100644 index 0000000000..352355b475 --- /dev/null +++ b/doc/classes/VisualShaderNodeScalarUniform.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeScalarUniform" inherits="VisualShaderNodeUniform" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeTexture.xml b/doc/classes/VisualShaderNodeTexture.xml new file mode 100644 index 0000000000..18b2fc3b3f --- /dev/null +++ b/doc/classes/VisualShaderNodeTexture.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeTexture" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="source" type="int" setter="set_source" getter="get_source" enum="VisualShaderNodeTexture.Source"> + </member> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="texture_type" type="int" setter="set_texture_type" getter="get_texture_type" enum="VisualShaderNodeTexture.TextureType"> + </member> + </members> + <constants> + <constant name="SOURCE_TEXTURE" value="0" enum="Source"> + </constant> + <constant name="SOURCE_SCREEN" value="1" enum="Source"> + </constant> + <constant name="SOURCE_2D_TEXTURE" value="2" enum="Source"> + </constant> + <constant name="SOURCE_2D_NORMAL" value="3" enum="Source"> + </constant> + <constant name="TYPE_DATA" value="0" enum="TextureType"> + </constant> + <constant name="TYPE_COLOR" value="1" enum="TextureType"> + </constant> + <constant name="TYPE_NORMALMAP" value="2" enum="TextureType"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeTextureUniform.xml b/doc/classes/VisualShaderNodeTextureUniform.xml new file mode 100644 index 0000000000..1b5df52060 --- /dev/null +++ b/doc/classes/VisualShaderNodeTextureUniform.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeTextureUniform" inherits="VisualShaderNodeUniform" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="color_default" type="int" setter="set_color_default" getter="get_color_default" enum="VisualShaderNodeTextureUniform.ColorDefault"> + </member> + <member name="texture_type" type="int" setter="set_texture_type" getter="get_texture_type" enum="VisualShaderNodeTextureUniform.TextureType"> + </member> + </members> + <constants> + <constant name="TYPE_DATA" value="0" enum="TextureType"> + </constant> + <constant name="TYPE_COLOR" value="1" enum="TextureType"> + </constant> + <constant name="TYPE_NORMALMAP" value="2" enum="TextureType"> + </constant> + <constant name="TYPE_ANISO" value="3" enum="TextureType"> + </constant> + <constant name="COLOR_DEFAULT_WHITE" value="0" enum="ColorDefault"> + </constant> + <constant name="COLOR_DEFAULT_BLACK" value="1" enum="ColorDefault"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeTransformCompose.xml b/doc/classes/VisualShaderNodeTransformCompose.xml new file mode 100644 index 0000000000..e1bda001e3 --- /dev/null +++ b/doc/classes/VisualShaderNodeTransformCompose.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeTransformCompose" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeTransformConstant.xml b/doc/classes/VisualShaderNodeTransformConstant.xml new file mode 100644 index 0000000000..e86444563c --- /dev/null +++ b/doc/classes/VisualShaderNodeTransformConstant.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeTransformConstant" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="constant" type="Transform" setter="set_constant" getter="get_constant"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeTransformDecompose.xml b/doc/classes/VisualShaderNodeTransformDecompose.xml new file mode 100644 index 0000000000..ee6d5c5d74 --- /dev/null +++ b/doc/classes/VisualShaderNodeTransformDecompose.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeTransformDecompose" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeTransformMult.xml b/doc/classes/VisualShaderNodeTransformMult.xml new file mode 100644 index 0000000000..31aa40db96 --- /dev/null +++ b/doc/classes/VisualShaderNodeTransformMult.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeTransformMult" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="operator" type="int" setter="set_operator" getter="get_operator" enum="VisualShaderNodeTransformMult.Operator"> + </member> + </members> + <constants> + <constant name="OP_AxB" value="0" enum="Operator"> + </constant> + <constant name="OP_BxA" value="1" enum="Operator"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeTransformUniform.xml b/doc/classes/VisualShaderNodeTransformUniform.xml new file mode 100644 index 0000000000..65b1088247 --- /dev/null +++ b/doc/classes/VisualShaderNodeTransformUniform.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeTransformUniform" inherits="VisualShaderNodeUniform" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeTransformVecMult.xml b/doc/classes/VisualShaderNodeTransformVecMult.xml new file mode 100644 index 0000000000..d3fb445717 --- /dev/null +++ b/doc/classes/VisualShaderNodeTransformVecMult.xml @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeTransformVecMult" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="operator" type="int" setter="set_operator" getter="get_operator" enum="VisualShaderNodeTransformVecMult.Operator"> + </member> + </members> + <constants> + <constant name="OP_AxB" value="0" enum="Operator"> + </constant> + <constant name="OP_BxA" value="1" enum="Operator"> + </constant> + <constant name="OP_3x3_AxB" value="2" enum="Operator"> + </constant> + <constant name="OP_3x3_BxA" value="3" enum="Operator"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeUniform.xml b/doc/classes/VisualShaderNodeUniform.xml new file mode 100644 index 0000000000..2c02afd0a7 --- /dev/null +++ b/doc/classes/VisualShaderNodeUniform.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeUniform" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="uniform_name" type="String" setter="set_uniform_name" getter="get_uniform_name"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeVec3Constant.xml b/doc/classes/VisualShaderNodeVec3Constant.xml new file mode 100644 index 0000000000..7492f56223 --- /dev/null +++ b/doc/classes/VisualShaderNodeVec3Constant.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVec3Constant" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="constant" type="Vector3" setter="set_constant" getter="get_constant"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeVec3Uniform.xml b/doc/classes/VisualShaderNodeVec3Uniform.xml new file mode 100644 index 0000000000..79a21680fb --- /dev/null +++ b/doc/classes/VisualShaderNodeVec3Uniform.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVec3Uniform" inherits="VisualShaderNodeUniform" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeVectorCompose.xml b/doc/classes/VisualShaderNodeVectorCompose.xml new file mode 100644 index 0000000000..39798a82d1 --- /dev/null +++ b/doc/classes/VisualShaderNodeVectorCompose.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVectorCompose" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeVectorDecompose.xml b/doc/classes/VisualShaderNodeVectorDecompose.xml new file mode 100644 index 0000000000..8df12d8ba9 --- /dev/null +++ b/doc/classes/VisualShaderNodeVectorDecompose.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVectorDecompose" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeVectorFunc.xml b/doc/classes/VisualShaderNodeVectorFunc.xml new file mode 100644 index 0000000000..850b089645 --- /dev/null +++ b/doc/classes/VisualShaderNodeVectorFunc.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVectorFunc" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeVectorFunc.Function"> + </member> + </members> + <constants> + <constant name="FUNC_NORMALIZE" value="0" enum="Function"> + </constant> + <constant name="FUNC_SATURATE" value="1" enum="Function"> + </constant> + <constant name="FUNC_NEGATE" value="2" enum="Function"> + </constant> + <constant name="FUNC_RECIPROCAL" value="3" enum="Function"> + </constant> + <constant name="FUNC_RGB2HSV" value="4" enum="Function"> + </constant> + <constant name="FUNC_HSV2RGB" value="5" enum="Function"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeVectorInterp.xml b/doc/classes/VisualShaderNodeVectorInterp.xml new file mode 100644 index 0000000000..909cd7eacc --- /dev/null +++ b/doc/classes/VisualShaderNodeVectorInterp.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVectorInterp" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeVectorLen.xml b/doc/classes/VisualShaderNodeVectorLen.xml new file mode 100644 index 0000000000..ad87d0bd0a --- /dev/null +++ b/doc/classes/VisualShaderNodeVectorLen.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVectorLen" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeVectorOp.xml b/doc/classes/VisualShaderNodeVectorOp.xml new file mode 100644 index 0000000000..3e20168f15 --- /dev/null +++ b/doc/classes/VisualShaderNodeVectorOp.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVectorOp" inherits="VisualShaderNode" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="operator" type="int" setter="set_operator" getter="get_operator" enum="VisualShaderNodeVectorOp.Operator"> + </member> + </members> + <constants> + <constant name="OP_ADD" value="0" enum="Operator"> + </constant> + <constant name="OP_SUB" value="1" enum="Operator"> + </constant> + <constant name="OP_MUL" value="2" enum="Operator"> + </constant> + <constant name="OP_DIV" value="3" enum="Operator"> + </constant> + <constant name="OP_MOD" value="4" enum="Operator"> + </constant> + <constant name="OP_POW" value="5" enum="Operator"> + </constant> + <constant name="OP_MAX" value="6" enum="Operator"> + </constant> + <constant name="OP_MIN" value="7" enum="Operator"> + </constant> + <constant name="OP_CROSS" value="8" enum="Operator"> + </constant> + </constants> +</class> diff --git a/doc/classes/WeakRef.xml b/doc/classes/WeakRef.xml index adaa964630..4a0f3588c2 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.1-dev"> +<class name="WeakRef" inherits="Reference" category="Core" version="3.1"> <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/WebSocketClient.xml b/doc/classes/WebSocketClient.xml deleted file mode 100644 index 9c0685031c..0000000000 --- a/doc/classes/WebSocketClient.xml +++ /dev/null @@ -1,53 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="WebSocketClient" inherits="WebSocketMultiplayerPeer" category="Core" version="3.1-dev"> - <brief_description> - </brief_description> - <description> - </description> - <tutorials> - </tutorials> - <demos> - </demos> - <methods> - <method name="connect_to_url"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="url" type="String"> - </argument> - <argument index="1" name="protocols" type="PoolStringArray" default="PoolStringArray( )"> - </argument> - <argument index="2" name="gd_mp_api" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="disconnect_from_host"> - <return type="void"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="connection_closed"> - <description> - </description> - </signal> - <signal name="connection_error"> - <description> - </description> - </signal> - <signal name="connection_established"> - <argument index="0" name="protocol" type="String"> - </argument> - <description> - </description> - </signal> - <signal name="data_received"> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> diff --git a/doc/classes/WebSocketMultiplayerPeer.xml b/doc/classes/WebSocketMultiplayerPeer.xml deleted file mode 100644 index b49d4c48e0..0000000000 --- a/doc/classes/WebSocketMultiplayerPeer.xml +++ /dev/null @@ -1,31 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="WebSocketMultiplayerPeer" inherits="NetworkedMultiplayerPeer" category="Core" version="3.1-dev"> - <brief_description> - </brief_description> - <description> - </description> - <tutorials> - </tutorials> - <demos> - </demos> - <methods> - <method name="get_peer" qualifiers="const"> - <return type="WebSocketPeer"> - </return> - <argument index="0" name="peer_id" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <signals> - <signal name="peer_packet"> - <argument index="0" name="peer_source" type="int"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> diff --git a/doc/classes/WebSocketPeer.xml b/doc/classes/WebSocketPeer.xml deleted file mode 100644 index fba8322889..0000000000 --- a/doc/classes/WebSocketPeer.xml +++ /dev/null @@ -1,51 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="WebSocketPeer" inherits="PacketPeer" category="Core" version="3.1-dev"> - <brief_description> - </brief_description> - <description> - </description> - <tutorials> - </tutorials> - <demos> - </demos> - <methods> - <method name="close"> - <return type="void"> - </return> - <description> - </description> - </method> - <method name="get_write_mode" qualifiers="const"> - <return type="int" enum="WebSocketPeer.WriteMode"> - </return> - <description> - </description> - </method> - <method name="is_connected_to_host" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_write_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode"> - </argument> - <description> - </description> - </method> - <method name="was_string_packet" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - <constant name="WRITE_MODE_TEXT" value="0" enum="WriteMode"> - </constant> - <constant name="WRITE_MODE_BINARY" value="1" enum="WriteMode"> - </constant> - </constants> -</class> diff --git a/doc/classes/WebSocketServer.xml b/doc/classes/WebSocketServer.xml deleted file mode 100644 index 887df696ff..0000000000 --- a/doc/classes/WebSocketServer.xml +++ /dev/null @@ -1,69 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="WebSocketServer" inherits="WebSocketMultiplayerPeer" category="Core" version="3.1-dev"> - <brief_description> - </brief_description> - <description> - </description> - <tutorials> - </tutorials> - <demos> - </demos> - <methods> - <method name="has_peer" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_listening" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="listen"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="port" type="int"> - </argument> - <argument index="1" name="protocols" type="PoolStringArray" default="PoolStringArray( )"> - </argument> - <argument index="2" name="gd_mp_api" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="stop"> - <return type="void"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="client_connected"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="protocol" type="String"> - </argument> - <description> - </description> - </signal> - <signal name="client_disconnected"> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </signal> - <signal name="data_received"> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml index ef4f6196b5..39487f5020 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.1-dev"> +<class name="WindowDialog" inherits="Popup" category="Core" version="3.1"> <brief_description> Base class for window dialogs. </brief_description> diff --git a/doc/classes/World.xml b/doc/classes/World.xml index 810e659c74..540848e40a 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.1-dev"> +<class name="World" inherits="Resource" category="Core" version="3.1"> <brief_description> Class that has everything pertaining to a world. </brief_description> @@ -7,7 +7,7 @@ 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/ray-casting.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/World2D.xml b/doc/classes/World2D.xml index acde276c1d..780cdd181a 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.1-dev"> +<class name="World2D" inherits="Resource" category="Core" version="3.1"> <brief_description> Class that has everything pertaining to a 2D world. </brief_description> @@ -7,7 +7,7 @@ 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/physics/ray-casting.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml index 266f94c317..e68ad2800e 100644 --- a/doc/classes/WorldEnvironment.xml +++ b/doc/classes/WorldEnvironment.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="WorldEnvironment" inherits="Node" category="Core" version="3.1-dev"> +<class name="WorldEnvironment" inherits="Node" category="Core" version="3.1"> <brief_description> Default environment properties for the entire scene (post-processing effects, lightning and background settings). </brief_description> @@ -9,7 +9,7 @@ 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 + <link>http://docs.godotengine.org/en/3.0/tutorials/3d/environment_and_post_processing.html</link> </tutorials> <demos> </demos> diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml index 8855adec22..fb03ab1692 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.1-dev"> +<class name="XMLParser" inherits="Reference" category="Core" version="3.1"> <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 fdccfaf531..12b9cb623f 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.1-dev"> +<class name="YSort" inherits="Node2D" category="Core" version="3.1"> <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 ed95da869b..0fec8eb530 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.1-dev"> +<class name="bool" category="Built-In Types" version="3.1"> <brief_description> Boolean built-in type </brief_description> diff --git a/doc/classes/float.xml b/doc/classes/float.xml index c576c27687..ef3c3d72eb 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.1-dev"> +<class name="float" category="Built-In Types" version="3.1"> <brief_description> Float built-in type </brief_description> diff --git a/doc/classes/int.xml b/doc/classes/int.xml index a86353e97e..4855fa2848 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.1-dev"> +<class name="int" category="Built-In Types" version="3.1"> <brief_description> Integer built-in type. </brief_description> diff --git a/doc/tools/makemd.py b/doc/tools/makemd.py index a73a4337d0..056f1ca82d 100644 --- a/doc/tools/makemd.py +++ b/doc/tools/makemd.py @@ -93,6 +93,8 @@ def make_class_list(class_list, columns): s += '\n' f.write(s) + f.close() + def dokuize_text(txt): @@ -330,6 +332,8 @@ def make_doku_class(node): f.write('\n') f.write(dokuize_text(d.text.strip())) f.write('\n') + + f.close() for file in input_list: diff --git a/doc/tools/makerst.py b/doc/tools/makerst.py index 9e767bf3d6..93ad823d42 100644..100755 --- a/doc/tools/makerst.py +++ b/doc/tools/makerst.py @@ -4,11 +4,15 @@ import codecs import sys import os +import re import xml.etree.ElementTree as ET input_list = [] cur_file = "" +# http(s)://docs.godotengine.org/<langcode>/<tag>/path/to/page.html(#fragment-tag) +godot_docs_pattern = re.compile('^http(?:s)?:\/\/docs\.godotengine\.org\/(?:[a-zA-Z0-9\.\-_]*)\/(?:[a-zA-Z0-9\.\-_]*)\/(.*)\.html(#.*)?$') + for arg in sys.argv[1:]: if arg.endswith(os.sep): arg = arg[:-1] @@ -104,6 +108,8 @@ def make_class_list(class_list, columns): f.write("--+-------+") f.write("\n") + f.close() + def rstize_text(text, cclass): # Linebreak + tabs in the XML should become two line breaks unless in a "codeblock" @@ -153,9 +159,19 @@ def rstize_text(text, cclass): text = pre_text + "\n\n" + post_text pos += 2 + next_brac_pos = text.find('[') + + # Escape \ character, otherwise it ends up as an escape character in rst + pos = 0 + while True: + pos = text.find('\\', pos, next_brac_pos) + if pos == -1: + break + text = text[:pos] + "\\\\" + text[pos + 1:] + pos += 2 + # Escape * character to avoid interpreting it as emphasis pos = 0 - next_brac_pos = text.find('['); while True: pos = text.find('*', pos, next_brac_pos) if pos == -1: @@ -257,15 +273,17 @@ def rstize_text(text, cclass): elif cmd == 'code': tag_text = '``' inside_code = True + elif cmd.startswith('enum '): + tag_text = make_enum(cmd[5:]) else: tag_text = make_type(tag_text) escape_post = True # Properly escape things like `[Node]s` - if escape_post and post_text and post_text[0].isalnum(): # not punctuation, escape + if escape_post and post_text and post_text[0].isalnum(): # not punctuation, escape post_text = '\ ' + post_text - next_brac_pos = post_text.find('[',0) + next_brac_pos = post_text.find('[', 0) iter_pos = 0 while not inside_code: iter_pos = post_text.find('*', iter_pos, next_brac_pos) @@ -285,7 +303,6 @@ def rstize_text(text, cclass): else: iter_pos += 1 - text = pre_text + tag_text + post_text pos = len(pre_text) + len(tag_text) @@ -298,16 +315,27 @@ def make_type(t): return ':ref:`' + t + '<class_' + t.lower() + '>`' return t + def make_enum(t): global class_names p = t.find(".") + # Global enums such as Error are relative to @GlobalScope. if p >= 0: c = t[0:p] - e = t[p+1:] - if c in class_names: - return ':ref:`' + e + '<enum_' + c.lower() + '_' + e.lower() + '>`' + e = t[p + 1:] + # Variant enums live in GlobalScope but still use periods. + if c == "Variant": + c = "@GlobalScope" + e = "Variant." + e + else: + # Things in GlobalScope don't have a period. + c = "@GlobalScope" + e = t + if c in class_names: + return ':ref:`' + e + '<enum_' + c.lower() + '_' + e.lower() + '>`' return t + def make_method( f, name, @@ -339,7 +367,10 @@ def make_method( if not event: if -1 in mdata['argidx']: - t += make_type(mdata[-1].attrib['type']) + if 'enum' in mdata[-1].attrib: + t += make_enum(mdata[-1].attrib['enum']) + else: + t += make_type(mdata[-1].attrib['type']) else: t += 'void' t += ' ' @@ -361,7 +392,10 @@ def make_method( else: s += ' ' - s += make_type(arg.attrib['type']) + if 'enum' in arg.attrib: + s += make_enum(arg.attrib['enum']) + else: + s += make_type(arg.attrib['type']) if 'name' in arg.attrib: s += ' ' + arg.attrib['name'] else: @@ -558,6 +592,32 @@ def make_rst_class(node): f.write(make_heading('Description', '-')) f.write(rstize_text(descr.text.strip(), name) + "\n\n") + global godot_docs_pattern + tutorials = node.find('tutorials') + if tutorials != None and len(tutorials) > 0: + f.write(make_heading('Tutorials', '-')) + for t in tutorials: + link = t.text.strip() + match = godot_docs_pattern.search(link); + if match: + groups = match.groups() + if match.lastindex == 2: + # Doc reference with fragment identifier: emit direct link to section with reference to page, for example: + # `#calling-javascript-from-script in Exporting For Web` + f.write("- `" + groups[1] + " <../" + groups[0] + ".html" + groups[1] + ">`_ in :doc:`../" + groups[0] + "`\n") + # Commented out alternative: Instead just emit: + # `Subsection in Exporting For Web` + # f.write("- `Subsection <../" + groups[0] + ".html" + groups[1] + ">`_ in :doc:`../" + groups[0] + "`\n") + elif match.lastindex == 1: + # Doc reference, for example: + # `Math` + f.write("- :doc:`../" + groups[0] + "`\n") + else: + # External link, for example: + # `http://enet.bespin.org/usergroup0.html` + f.write("- `" + link + " <" + link + ">`_\n") + f.write("\n") + methods = node.find('methods') if methods != None and len(list(methods)) > 0: f.write(make_heading('Member Function Description', '-')) @@ -572,6 +632,8 @@ def make_rst_class(node): f.write("\n\n") f.write('\n') + f.close() + file_list = [] |