Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-09-20 14:32:42 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde 2021-01-04 14:33:44 +01:00
parent 8bfd96ee3f
commit 215d18814e
No known key found for this signature in database
GPG Key ID: C3336907360768E1
76 changed files with 1279 additions and 1469 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/classes/@GlobalScope.xml
View File

@ -944,6 +944,22 @@
[/codeblock]
</description>
</method>
<method name="snapped">
<return type="float">
</return>
<argument index="0" name="x" type="float">
</argument>
<argument index="1" name="step" type="float">
</argument>
<description>
Snaps float value [code]x[/code] to a given [code]step[/code]. This can also be used to round a floating point number to an arbitrary number of decimals.
[codeblock]
snapped(100, 32) # Returns 96
snapped(3.14159, 0.01) # Returns 3.14
[/codeblock]
See also [method ceil], [method floor], and [method round].
</description>
</method>
<method name="sqrt">
<return type="float">
</return>
@ -974,22 +990,6 @@
[/codeblock]
</description>
</method>
<method name="snapped">
<return type="float">
</return>
<argument index="0" name="x" type="float">
</argument>
<argument index="1" name="step" type="float">
</argument>
<description>
Snaps float value [code]x[/code] to a given [code]step[/code]. This can also be used to round a floating point number to an arbitrary number of decimals.
[codeblock]
snapped(100, 32) # Returns 96
snapped(3.14159, 0.01) # Returns 3.14
[/codeblock]
See also [method ceil], [method floor], and [method round].
</description>
</method>
<method name="str" qualifiers="vararg">
<return type="String">
</return>

2
doc/classes/AABB.xml
View File

@ -219,7 +219,7 @@
<argument index="0" name="aabb" type="AABB">
</argument>
<description>
Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [method @GDScript.is_equal_approx] on each component.
Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [method @GlobalScope.is_equal_approx] on each component.
</description>
</method>
<method name="merge">

4
doc/classes/Animation.xml
View File

@ -409,7 +409,7 @@
<argument index="1" name="key_idx" type="int">
</argument>
<description>
Returns the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]).
Returns the transition curve (easing) for a specific key (see the built-in math function [method @GlobalScope.ease]).
</description>
</method>
<method name="track_get_key_value" qualifiers="const">
@ -592,7 +592,7 @@
<argument index="2" name="transition" type="float">
</argument>
<description>
Sets the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]).
Sets the transition curve (easing) for a specific key (see the built-in math function [method @GlobalScope.ease]).
</description>
</method>
<method name="track_set_key_value">

20
doc/classes/AnimationNodeStateMachinePlayback.xml
View File

@ -21,6 +21,12 @@
<link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link>
</tutorials>
<methods>
<method name="get_current_length" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_current_node" qualifiers="const">
<return type="StringName">
</return>
@ -28,13 +34,6 @@
Returns the currently playing animation state.
</description>
</method>
<method name="get_travel_path" qualifiers="const">
<return type="PackedStringArray">
</return>
<description>
Returns the current travel path as computed internally by the A* algorithm.
</description>
</method>
<method name="get_current_play_position" qualifiers="const">
<return type="float">
</return>
@ -42,6 +41,13 @@
Returns the playback position within the current animation state.
</description>
</method>
<method name="get_travel_path" qualifiers="const">
<return type="PackedStringArray">
</return>
<description>
Returns the current travel path as computed internally by the A* algorithm.
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>

16
doc/classes/Array.xml
View File

@ -228,13 +228,6 @@
If [code]deep[/code] is [code]true[/code], a deep copy is 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="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="erase">
<return type="void">
</return>
@ -339,6 +332,13 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="max">
<return type="Variant">
</return>
@ -482,7 +482,7 @@
<return type="void">
</return>
<description>
Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as [method @GDScript.randi]. Call [method @GDScript.randomize] to ensure that a new seed will be used each time if you want non-reproducible shuffling.
Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as [method @GlobalScope.randi]. Call [method @GlobalScope.randomize] to ensure that a new seed will be used each time if you want non-reproducible shuffling.
</description>
</method>
<method name="size">

10
doc/classes/ArrayMesh.xml
View File

@ -209,19 +209,13 @@
</method>
</methods>
<members>
<member name="blend_shape_mode" type="int" setter="set_blend_shape_mode" getter="get_blend_shape_mode" enum="ArrayMesh.BlendShapeMode" default="1">
Sets the blend shape mode to one of [enum ArrayMesh.BlendShapeMode].
<member name="blend_shape_mode" type="int" setter="set_blend_shape_mode" getter="get_blend_shape_mode" enum="Mesh.BlendShapeMode" default="1">
Sets the blend shape mode to one of [enum Mesh.BlendShapeMode].
</member>
<member name="custom_aabb" type="AABB" setter="set_custom_aabb" getter="get_custom_aabb" default="AABB( 0, 0, 0, 0, 0, 0 )">
Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unexpected culling when using a shader to offset vertices.
</member>
</members>
<constants>
<constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode">
Blend shapes are normalized.
</constant>
<constant name="BLEND_SHAPE_MODE_RELATIVE" value="1" enum="BlendShapeMode">
Blend shapes are relative to base weight.
</constant>
</constants>
</class>

14
doc/classes/Camera2D.xml
View File

@ -52,7 +52,7 @@
<method name="get_drag_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description>
Returns the specified [enum Side]'s margin. See also [member drag_bottom_margin], [member drag_top_margin], [member drag_left_margin], and [member drag_right_margin].
@ -61,7 +61,7 @@
<method name="get_limit" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description>
Returns the camera limit for the specified [enum Side]. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right].
@ -85,7 +85,7 @@
<method name="set_drag_margin">
<return type="void">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<argument index="1" name="drag_margin" type="float">
</argument>
@ -96,7 +96,7 @@
<method name="set_limit">
<return type="void">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<argument index="1" name="limit" type="int">
</argument>
@ -118,10 +118,10 @@
<member name="drag_bottom_margin" type="float" setter="set_drag_margin" getter="get_drag_margin" default="0.2">
Bottom margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the bottom edge of the screen.
</member>
<member name="drag_horizontal_enabled" type="bool" setter="set_h_drag_enabled" getter="is_h_drag_enabled" default="false">
<member name="drag_horizontal_enabled" type="bool" setter="set_drag_horizontal_enabled" getter="is_drag_horizontal_enabled" default="false">
If [code]true[/code], the camera only moves when reaching the horizontal (left and right) drag margins. If [code]false[/code], the camera moves horizontally regardless of margins.
</member>
<member name="drag_horizontal_offset" type="float" setter="set_h_offset" getter="get_h_offset" default="0.0">
<member name="drag_horizontal_offset" type="float" setter="set_drag_horizontal_offset" getter="get_drag_horizontal_offset" default="0.0">
The relative horizontal drag offset of the camera between the right ([code]-1[/code]) and left ([code]1[/code]) drag margins.
[b]Note:[/b] Used to set the initial horizontal drag offset; determine the current offset; or force the current offset. It's not automatically updated when the horizontal drag margin is enabled or the drag margins are changed.
</member>
@ -137,7 +137,7 @@
<member name="drag_vertical_enabled" type="bool" setter="set_drag_vertical_enabled" getter="is_drag_vertical_enabled" default="false">
If [code]true[/code], the camera only moves when reaching the vertical (top and bottom) drag margins. If [code]false[/code], the camera moves vertically regardless of the drag margins.
</member>
<member name="drag_vertical_offset" type="float" setter="set_drag_verticaloffset" getter="get_drag_vertical_offset" default="0.0">
<member name="drag_vertical_offset" type="float" setter="set_drag_vertical_offset" getter="get_drag_vertical_offset" default="0.0">
The relative vertical drag offset of the camera between the bottom ([code]-1[/code]) and top ([code]1[/code]) drag margins.
[b]Note:[/b] Used to set the initial vertical drag offset; determine the current offset; or force the current offset. It's not automatically updated when the vertical drag margin is enabled or the drag margins are changed.
</member>

2
doc/classes/CanvasItem.xml
View File

@ -9,7 +9,7 @@
Canvas items are drawn in tree order. By default, children are on top of their parents so a root [CanvasItem] will be drawn behind everything. This behavior can be changed on a per-item basis.
A [CanvasItem] can also be hidden, which will also hide its children. It provides many ways to change parameters such as modulation (for itself and its children) and self modulation (only for itself), as well as its blend mode.
Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed.
[b]Note:[/b] Unless otherwise specified, all methods that have angle parameters must have angles specified as [i]radians[/i]. To convert degrees to radians, use [method @GDScript.deg2rad].
[b]Note:[/b] Unless otherwise specified, all methods that have angle parameters must have angles specified as [i]radians[/i]. To convert degrees to radians, use [method @GlobalScope.deg2rad].
</description>
<tutorials>
<link title="Viewport and canvas transforms">https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link>

4
doc/classes/Color.xml
View File

@ -5,7 +5,7 @@
</brief_description>
<description>
A color represented by red, green, blue, and alpha (RGBA) components. The alpha component is often used for transparency. Values are in floating-point and usually range from 0 to 1. Some properties (such as CanvasItem.modulate) may accept values greater than 1 (overbright or HDR colors).
You can also create a color from standardized color names by using [method @GDScript.ColorN] or directly using the color constants defined here. The standardized color set is based on the [url=https://en.wikipedia.org/wiki/X11_color_names]X11 color names[/url].
You can also create a color from standardized color names by using [code]ColorN[/code] ([b]FIXME:[/b] No longer true, a Color(String) constructor should be re-implemented for that) or directly using the color constants defined here. The standardized color set is based on the [url=https://en.wikipedia.org/wiki/X11_color_names]X11 color names[/url].
If you want to supply values in a range of 0 to 255, you should use [method @GDScript.Color8].
[b]Note:[/b] In a boolean context, a Color will evaluate to [code]false[/code] if it's equal to [code]Color(0, 0, 0, 1)[/code] (opaque black). Otherwise, a Color will always evaluate to [code]true[/code].
[url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/color_constants.png]Color constants cheatsheet[/url]
@ -158,7 +158,7 @@
<argument index="0" name="to" type="Color">
</argument>
<description>
Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
</description>
</method>
<method name="lerp">

52
doc/classes/Control.xml
View File

@ -213,17 +213,6 @@
Overrides the icon with given [code]name[/code] in the [member theme] resource the control uses. If [code]icon[/code] is [code]null[/code] or invalid, the override is cleared and the icon from assigned [Theme] is used.
</description>
</method>
<method name="add_theme_shader_override">
<return type="void">
</return>
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="shader" type="Shader">
</argument>
<description>
Overrides the [Shader] with given [code]name[/code] in the [member theme] resource the control uses. If [code]shader[/code] is [code]null[/code] or invalid, the override is cleared and the shader from assigned [Theme] is used.
</description>
</method>
<method name="add_theme_stylebox_override">
<return type="void">
</return>
@ -417,15 +406,6 @@
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_offset" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="side" type="int" enum="Side">
</argument>
<description>
Returns the anchor for the specified [enum Side]. A getter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top].
</description>
</method>
<method name="get_minimum_size" qualifiers="const">
<return type="Vector2">
</return>
@ -433,6 +413,15 @@
Returns the minimum size for this control. See [member rect_min_size].
</description>
</method>
<method name="get_offset" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="offset" type="int" enum="Side">
</argument>
<description>
Returns the anchor for the specified [enum Side]. A getter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top].
</description>
</method>
<method name="get_parent_area_size" qualifiers="const">
<return type="Vector2">
</return>
@ -685,15 +674,6 @@
Returns [code]true[/code] if icon with given [code]name[/code] has a valid override in this [Control] node.
</description>
</method>
<method name="has_theme_shader_override" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if [Shader] with given [code]name[/code] has a valid override in this [Control] node.
</description>
</method>
<method name="has_theme_stylebox" qualifiers="const">
<return type="bool">
</return>
@ -1063,6 +1043,13 @@
<member name="layout_direction" type="int" setter="set_layout_direction" getter="get_layout_direction" enum="Control.LayoutDirection" default="0">
Controls layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew).
</member>
<member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" enum="Control.CursorShape" default="0">
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" default="0">
Controls whether the control will be able to receive mouse button input events through [method _gui_input] and how these events should be handled. Also controls whether the control can receive the [signal mouse_entered], and [signal mouse_exited] signals. See the constants to learn what each does.
</member>
<member name="offset_bottom" type="float" setter="set_offset" getter="get_offset" default="0.0">
Distance between the node's bottom edge and its parent control, based on [member anchor_bottom].
Offsets are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Offsets update automatically when you move or resize the node.
@ -1079,13 +1066,6 @@
Distance between the node's top edge and its parent control, based on [member anchor_top].
Offsets are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Offsets update automatically when you move or resize the node.
</member>
<member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" enum="Control.CursorShape" default="0">
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" default="0">
Controls whether the control will be able to receive mouse button input events through [method _gui_input] and how these events should be handled. Also controls whether the control can receive the [signal mouse_entered], and [signal mouse_exited] signals. See the constants to learn what each does.
</member>
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" default="false">
Enables whether rendering of [CanvasItem] based children should be clipped to this control's rectangle. If [code]true[/code], parts of a child which would be visibly outside of this control's rectangle will not be rendered.
</member>

14
doc/classes/Dictionary.xml
View File

@ -215,13 +215,6 @@
Creates a copy of the dictionary, and returns it. The [code]deep[/code] parameter causes inner dictionaries and arrays to be copied recursively, but does not apply to objects.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the dictionary is empty.
</description>
</method>
<method name="erase">
<return type="bool">
</return>
@ -299,6 +292,13 @@
[b]Note:[/b] Dictionaries with the same keys/values but in a different order will have a different hash.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the dictionary is empty.
</description>
</method>
<method name="keys">
<return type="Array">
</return>

14
doc/classes/EditorInterface.xml
View File

@ -40,13 +40,6 @@
Returns the edited (current) scene's root [Node].
</description>
</method>
<method name="get_editor_settings">
<return type="EditorSettings">
</return>
<description>
Returns the editor's [EditorSettings] instance.
</description>
</method>
<method name="get_editor_main_control">
<return type="Control">
</return>
@ -55,6 +48,13 @@
[b]Note:[/b] This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically.
</description>
</method>
<method name="get_editor_settings">
<return type="EditorSettings">
</return>
<description>
Returns the editor's [EditorSettings] instance.
</description>
</method>
<method name="get_file_system_dock">
<return type="FileSystemDock">
</return>

36
doc/classes/EditorSceneImporterAssimp.xml
View File

@ -1,36 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSceneImporterAssimp" inherits="EditorSceneImporter" version="4.0">
<brief_description>
FBX 3D asset importer based on [url=http://assimp.org/]Assimp[/url].
</brief_description>
<description>
This is an FBX 3D asset importer based on [url=http://assimp.org/]Assimp[/url]. It currently has many known limitations and works best with static meshes. Most animated meshes won't import correctly.
If exporting a FBX scene from Autodesk Maya, use these FBX export settings:
[codeblock]
- Smoothing Groups
- Smooth Mesh
- Triangluate (for meshes with blend shapes)
- Bake Animation
- Resample All
- Deformed Models
- Skins
- Blend Shapes
- Curve Filters
- Constant Key Reducer
- Auto Tangents Only
- *Do not check* Constraints (as it will break the file)
- Can check Embed Media (embeds textures into the exported FBX file)
- Note that when importing embedded media, the texture and mesh will be a single immutable file.
- You will have to re-export then re-import the FBX if the texture has changed.
- Units: Centimeters
- Up Axis: Y
- Binary format in FBX 2017
[/codeblock]
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

13
doc/classes/EditorSceneImporterGLTF.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSceneImporterGLTF" inherits="EditorSceneImporter" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

160
doc/classes/EditorSceneImporterMesh.xml Normal file
View File

@ -0,0 +1,160 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSceneImporterMesh" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_blend_shape">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="add_surface">
<return type="void">
</return>
<argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType">
</argument>
<argument index="1" name="arrays" type="Array">
</argument>
<argument index="2" name="blend_shapes" type="Array" default="[ ]">
</argument>
<argument index="3" name="lods" type="Dictionary" default="{
}">
</argument>
<argument index="4" name="material" type="Material" default="null">
</argument>
<argument index="5" name="arg5" type="String" default="&quot;&quot;">
</argument>
<description>
</description>
</method>
<method name="clear">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_blend_shape_count" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_blend_shape_mode" qualifiers="const">
<return type="int" enum="Mesh.BlendShapeMode">
</return>
<description>
</description>
</method>
<method name="get_blend_shape_name" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="blend_shape_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_mesh">
<return type="ArrayMesh">
</return>
<description>
</description>
</method>
<method name="get_surface_arrays" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="surface_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_surface_blend_shape_arrays" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="surface_idx" type="int">
</argument>
<argument index="1" name="blend_shape_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_surface_count" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_surface_lod_count" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="surface_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_surface_lod_indices" qualifiers="const">
<return type="PackedInt32Array">
</return>
<argument index="0" name="surface_idx" type="int">
</argument>
<argument index="1" name="lod_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_surface_lod_size" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="surface_idx" type="int">
</argument>
<argument index="1" name="lod_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_surface_material" qualifiers="const">
<return type="Material">
</return>
<argument index="0" name="surface_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_surface_name" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="surface_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_surface_primitive_type">
<return type="int" enum="Mesh.PrimitiveType">
</return>
<argument index="0" name="surface_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="set_blend_shape_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="Mesh.BlendShapeMode">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="_data" type="Dictionary" setter="_set_data" getter="_get_data" default="{&quot;surfaces&quot;: [ ]}">
</member>
</members>
<constants>
</constants>
</class>

21
doc/classes/EditorSceneImporterMeshNode3D.xml Normal file
View File

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSceneImporterMeshNode3D" inherits="Node3D" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="mesh" type="EditorSceneImporterMesh" setter="set_mesh" getter="get_mesh">
</member>
<member name="skeleton_path" type="NodePath" setter="set_skeleton_path" getter="get_skeleton_path" default="NodePath(&quot;&quot;)">
</member>
<member name="skin" type="Skin" setter="set_skin" getter="get_skin">
</member>
</members>
<constants>
</constants>
</class>

4
doc/classes/EncodedObjectAsID.xml
View File

@ -4,7 +4,7 @@
Holds a reference to an [Object]'s instance ID.
</brief_description>
<description>
Utility class which holds a reference to the internal identifier of an [Object] instance, as given by [method Object.get_instance_id]. This ID can then be used to retrieve the object instance with [method @GDScript.instance_from_id].
Utility class which holds a reference to the internal identifier of an [Object] instance, as given by [method Object.get_instance_id]. This ID can then be used to retrieve the object instance with [method @GlobalScope.instance_from_id].
This class is used internally by the editor inspector and script debugger, but can also be used in plugins to pass and display objects as their IDs.
</description>
<tutorials>
@ -13,7 +13,7 @@
</methods>
<members>
<member name="object_id" type="int" setter="set_object_id" getter="get_object_id" default="0">
The [Object] identifier stored in this [EncodedObjectAsID] instance. The object instance can be retrieved with [method @GDScript.instance_from_id].
The [Object] identifier stored in this [EncodedObjectAsID] instance. The object instance can be retrieved with [method @GlobalScope.instance_from_id].
</member>
</members>
<constants>

14
doc/classes/Engine.xml
View File

@ -51,13 +51,6 @@
Returns the frames per second of the running game.
</description>
</method>
<method name="get_process_frames" qualifiers="const">
<return type="int">
</return>
<description>
Returns the total number of frames passed since engine initialization which is advanced on each [b]process frame[/b], regardless of whether the render loop is enabled. See also [method get_frames_drawn].
</description>
</method>
<method name="get_license_info" qualifiers="const">
<return type="Dictionary">
</return>
@ -93,6 +86,13 @@
Returns the fraction through the current physics tick we are at the time of rendering the frame. This can be used to implement fixed timestep interpolation.
</description>
</method>
<method name="get_process_frames" qualifiers="const">
<return type="int">
</return>
<description>
Returns the total number of frames passed since engine initialization which is advanced on each [b]process frame[/b], regardless of whether the render loop is enabled. See also [method get_frames_drawn].
</description>
</method>
<method name="get_singleton" qualifiers="const">
<return type="Object">
</return>

43
doc/classes/GLTFAccessor.xml Normal file
View File

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFAccessor" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="buffer_view" type="int" setter="set_buffer_view" getter="get_buffer_view" default="0">
</member>
<member name="byte_offset" type="int" setter="set_byte_offset" getter="get_byte_offset" default="0">
</member>
<member name="component_type" type="int" setter="set_component_type" getter="get_component_type" default="0">
</member>
<member name="count" type="int" setter="set_count" getter="get_count" default="0">
</member>
<member name="max" type="PackedFloat64Array" setter="set_max" getter="get_max" default="PackedFloat64Array( )">
</member>
<member name="min" type="PackedFloat64Array" setter="set_min" getter="get_min" default="PackedFloat64Array( )">
</member>
<member name="normalized" type="bool" setter="set_normalized" getter="get_normalized" default="false">
</member>
<member name="sparse_count" type="int" setter="set_sparse_count" getter="get_sparse_count" default="0">
</member>
<member name="sparse_indices_buffer_view" type="int" setter="set_sparse_indices_buffer_view" getter="get_sparse_indices_buffer_view" default="0">
</member>
<member name="sparse_indices_byte_offset" type="int" setter="set_sparse_indices_byte_offset" getter="get_sparse_indices_byte_offset" default="0">
</member>
<member name="sparse_indices_component_type" type="int" setter="set_sparse_indices_component_type" getter="get_sparse_indices_component_type" default="0">
</member>
<member name="sparse_values_buffer_view" type="int" setter="set_sparse_values_buffer_view" getter="get_sparse_values_buffer_view" default="0">
</member>
<member name="sparse_values_byte_offset" type="int" setter="set_sparse_values_byte_offset" getter="get_sparse_values_byte_offset" default="0">
</member>
<member name="type" type="int" setter="set_type" getter="get_type" default="0">
</member>
</members>
<constants>
</constants>
</class>

17
doc/classes/GLTFAnimation.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFAnimation" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="loop" type="bool" setter="set_loop" getter="get_loop" default="false">
</member>
</members>
<constants>
</constants>
</class>

25
doc/classes/GLTFBufferView.xml Normal file
View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFBufferView" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="buffer" type="int" setter="set_buffer" getter="get_buffer" default="-1">
</member>
<member name="byte_length" type="int" setter="set_byte_length" getter="get_byte_length" default="0">
</member>
<member name="byte_offset" type="int" setter="set_byte_offset" getter="get_byte_offset" default="0">
</member>
<member name="byte_stride" type="int" setter="set_byte_stride" getter="get_byte_stride" default="-1">
</member>
<member name="indices" type="bool" setter="set_indices" getter="get_indices" default="false">
</member>
</members>
<constants>
</constants>
</class>

23
doc/classes/GLTFCamera.xml Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFCamera" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="fov_size" type="float" setter="set_fov_size" getter="get_fov_size" default="75.0">
</member>
<member name="perspective" type="bool" setter="set_perspective" getter="get_perspective" default="true">
</member>
<member name="zfar" type="float" setter="set_zfar" getter="get_zfar" default="4000.0">
</member>
<member name="znear" type="float" setter="set_znear" getter="get_znear" default="0.05">
</member>
</members>
<constants>
</constants>
</class>

13
doc/classes/GLTFDocument.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFDocument" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

27
doc/classes/GLTFLight.xml Normal file
View File

@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFLight" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="color" type="Color" setter="set_color" getter="get_color" default="Color( 0, 0, 0, 1 )">
</member>
<member name="inner_cone_angle" type="float" setter="set_inner_cone_angle" getter="get_inner_cone_angle" default="0.0">
</member>
<member name="intensity" type="float" setter="set_intensity" getter="get_intensity" default="0.0">
</member>
<member name="outer_cone_angle" type="float" setter="set_outer_cone_angle" getter="get_outer_cone_angle" default="0.0">
</member>
<member name="range" type="float" setter="set_range" getter="get_range" default="0.0">
</member>
<member name="type" type="String" setter="set_type" getter="get_type" default="&quot;&quot;">
</member>
</members>
<constants>
</constants>
</class>

19
doc/classes/GLTFMesh.xml Normal file
View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFMesh" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="blend_weights" type="PackedFloat32Array" setter="set_blend_weights" getter="get_blend_weights" default="PackedFloat32Array( )">
</member>
<member name="mesh" type="EditorSceneImporterMesh" setter="set_mesh" getter="get_mesh">
</member>
</members>
<constants>
</constants>
</class>

43
doc/classes/GLTFNode.xml Normal file
View File

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFNode" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="camera" type="int" setter="set_camera" getter="get_camera" default="-1">
</member>
<member name="children" type="PackedInt32Array" setter="set_children" getter="get_children" default="PackedInt32Array( )">
</member>
<member name="fake_joint_parent" type="int" setter="set_fake_joint_parent" getter="get_fake_joint_parent" default="-1">
</member>
<member name="height" type="int" setter="set_height" getter="get_height" default="-1">
</member>
<member name="joint" type="bool" setter="set_joint" getter="get_joint" default="false">
</member>
<member name="light" type="int" setter="set_light" getter="get_light" default="-1">
</member>
<member name="mesh" type="int" setter="set_mesh" getter="get_mesh" default="-1">
</member>
<member name="parent" type="int" setter="set_parent" getter="get_parent" default="-1">
</member>
<member name="rotation" type="Quat" setter="set_rotation" getter="get_rotation" default="Quat( 0, 0, 0, 1 )">
</member>
<member name="scale" type="Vector3" setter="set_scale" getter="get_scale" default="Vector3( 1, 1, 1 )">
</member>
<member name="skeleton" type="int" setter="set_skeleton" getter="get_skeleton" default="-1">
</member>
<member name="skin" type="int" setter="set_skin" getter="get_skin" default="-1">
</member>
<member name="translation" type="Vector3" setter="set_translation" getter="get_translation" default="Vector3( 0, 0, 0 )">
</member>
<member name="xform" type="Transform" setter="set_xform" getter="get_xform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</member>
</members>
<constants>
</constants>
</class>

67
doc/classes/GLTFSkeleton.xml Normal file
View File

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFSkeleton" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_bone_attachment">
<return type="BoneAttachment3D">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<description>
</description>
</method>
<method name="get_bone_attachment_count">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_godot_bone_node">
<return type="Dictionary">
</return>
<description>
</description>
</method>
<method name="get_godot_skeleton">
<return type="Skeleton3D">
</return>
<description>
</description>
</method>
<method name="get_unique_names">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="set_godot_bone_node">
<return type="void">
</return>
<argument index="0" name="godot_bone_node" type="Dictionary">
</argument>
<description>
</description>
</method>
<method name="set_unique_names">
<return type="void">
</return>
<argument index="0" name="unique_names" type="Array">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="joints" type="PackedInt32Array" setter="set_joints" getter="get_joints" default="PackedInt32Array( )">
</member>
<member name="roots" type="PackedInt32Array" setter="set_roots" getter="get_roots" default="PackedInt32Array( )">
</member>
</members>
<constants>
</constants>
</class>

71
doc/classes/GLTFSkin.xml Normal file
View File

@ -0,0 +1,71 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFSkin" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_inverse_binds">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_joint_i_to_bone_i">
<return type="Dictionary">
</return>
<description>
</description>
</method>
<method name="get_joint_i_to_name">
<return type="Dictionary">
</return>
<description>
</description>
</method>
<method name="set_inverse_binds">
<return type="void">
</return>
<argument index="0" name="inverse_binds" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_joint_i_to_bone_i">
<return type="void">
</return>
<argument index="0" name="joint_i_to_bone_i" type="Dictionary">
</argument>
<description>
</description>
</method>
<method name="set_joint_i_to_name">
<return type="void">
</return>
<argument index="0" name="joint_i_to_name" type="Dictionary">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="godot_skin" type="Skin" setter="set_godot_skin" getter="get_godot_skin">
</member>
<member name="joints" type="PackedInt32Array" setter="set_joints" getter="get_joints" default="PackedInt32Array( )">
</member>
<member name="joints_original" type="PackedInt32Array" setter="set_joints_original" getter="get_joints_original" default="PackedInt32Array( )">
</member>
<member name="non_joints" type="PackedInt32Array" setter="set_non_joints" getter="get_non_joints" default="PackedInt32Array( )">
</member>
<member name="roots" type="PackedInt32Array" setter="set_roots" getter="get_roots" default="PackedInt32Array( )">
</member>
<member name="skeleton" type="int" setter="set_skeleton" getter="get_skeleton" default="-1">
</member>
<member name="skin_root" type="int" setter="set_skin_root" getter="get_skin_root" default="-1">
</member>
</members>
<constants>
</constants>
</class>

25
doc/classes/GLTFSpecGloss.xml Normal file
View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFSpecGloss" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="diffuse_factor" type="Color" setter="set_diffuse_factor" getter="get_diffuse_factor" default="Color( 1, 1, 1, 1 )">
</member>
<member name="diffuse_img" type="Image" setter="set_diffuse_img" getter="get_diffuse_img">
</member>
<member name="gloss_factor" type="float" setter="set_gloss_factor" getter="get_gloss_factor" default="1.0">
</member>
<member name="spec_gloss_img" type="Image" setter="set_spec_gloss_img" getter="get_spec_gloss_img">
</member>
<member name="specular_factor" type="Color" setter="set_specular_factor" getter="get_specular_factor" default="Color( 1, 1, 1, 1 )">
</member>
</members>
<constants>
</constants>
</class>

251
doc/classes/GLTFState.xml Normal file
View File

@ -0,0 +1,251 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFState" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_accessors">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_animation_player">
<return type="AnimationPlayer">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<description>
</description>
</method>
<method name="get_animation_players_count">
<return type="int">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<description>
</description>
</method>
<method name="get_animations">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_buffer_views">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_cameras">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_images">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_lights">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_materials">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_meshes">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_nodes">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_scene_node">
<return type="Node">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<description>
</description>
</method>
<method name="get_skeleton_to_node">
<return type="Dictionary">
</return>
<description>
</description>
</method>
<method name="get_skeletons">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_skins">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_textures">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_unique_names">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="set_accessors">
<return type="void">
</return>
<argument index="0" name="accessors" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_animations">
<return type="void">
</return>
<argument index="0" name="animations" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_buffer_views">
<return type="void">
</return>
<argument index="0" name="buffer_views" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_cameras">
<return type="void">
</return>
<argument index="0" name="cameras" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_images">
<return type="void">
</return>
<argument index="0" name="images" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_lights">
<return type="void">
</return>
<argument index="0" name="lights" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_materials">
<return type="void">
</return>
<argument index="0" name="materials" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_meshes">
<return type="void">
</return>
<argument index="0" name="meshes" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_nodes">
<return type="void">
</return>
<argument index="0" name="nodes" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_skeleton_to_node">
<return type="void">
</return>
<argument index="0" name="skeleton_to_node" type="Dictionary">
</argument>
<description>
</description>
</method>
<method name="set_skeletons">
<return type="void">
</return>
<argument index="0" name="skeletons" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_skins">
<return type="void">
</return>
<argument index="0" name="skins" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_textures">
<return type="void">
</return>
<argument index="0" name="textures" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_unique_names">
<return type="void">
</return>
<argument index="0" name="unique_names" type="Array">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="buffers" type="Array" setter="set_buffers" getter="get_buffers" default="[ ]">
</member>
<member name="glb_data" type="PackedByteArray" setter="set_glb_data" getter="get_glb_data" default="PackedByteArray( )">
</member>
<member name="json" type="Dictionary" setter="set_json" getter="get_json" default="{}">
</member>
<member name="major_version" type="int" setter="set_major_version" getter="get_major_version" default="0">
</member>
<member name="minor_version" type="int" setter="set_minor_version" getter="get_minor_version" default="0">
</member>
<member name="root_nodes" type="Array" setter="set_root_nodes" getter="get_root_nodes" default="[ ]">
</member>
<member name="scene_name" type="String" setter="set_scene_name" getter="get_scene_name" default="&quot;&quot;">
</member>
<member name="use_named_skin_binds" type="bool" setter="set_use_named_skin_binds" getter="get_use_named_skin_binds" default="false">
</member>
</members>
<constants>
</constants>
</class>

17
doc/classes/GLTFTexture.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFTexture" inherits="Resource" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="src_image" type="int" setter="set_src_image" getter="get_src_image" default="4">
</member>
</members>
<constants>
</constants>
</class>

2
doc/classes/GeometryInstance3D.xml
View File

@ -48,6 +48,8 @@
</member>
<member name="gi_mode" type="int" setter="set_gi_mode" getter="get_gi_mode" enum="GeometryInstance3D.GIMode" default="0">
</member>
<member name="lod_bias" type="float" setter="set_lod_bias" getter="get_lod_bias" default="1.0">
</member>
<member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance" default="0.0">
The GeometryInstance3D's max LOD distance.
[b]Note:[/b] This property currently has no effect.

12
doc/classes/GraphEdit.xml
View File

@ -281,6 +281,12 @@
Emitted at the end of a GraphNode movement.
</description>
</signal>
<signal name="node_deselected">
<argument index="0" name="node" type="Node">
</argument>
<description>
</description>
</signal>
<signal name="node_selected">
<argument index="0" name="node" type="Node">
</argument>
@ -288,12 +294,6 @@
Emitted when a GraphNode is selected.
</description>
</signal>
<signal name="node_deselected">
<argument index="0" name="node" type="Node">
</argument>
<description>
</description>
</signal>
<signal name="paste_nodes_request">
<description>
Emitted when the user presses [kbd]Ctrl + V[/kbd].

32
doc/classes/ItemList.xml
View File

@ -52,6 +52,22 @@
Removes all OpenType features from the item's text.
</description>
</method>
<method name="deselect">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Ensures the item associated with the specified index is not selected.
</description>
</method>
<method name="deselect_all">
<return type="void">
</return>
<description>
Ensures there are no items selected.
</description>
</method>
<method name="ensure_current_is_visible">
<return type="void">
</return>
@ -471,22 +487,6 @@
Sorts items in the list by their text.
</description>
</method>
<method name="deselect">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Ensures the item associated with the specified index is not selected.
</description>
</method>
<method name="deselect_all">
<return type="void">
</return>
<description>
Ensures there are no items selected.
</description>
</method>
</methods>
<members>
<member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect" default="false">

2
doc/classes/JSONParseResult.xml
View File

@ -21,7 +21,7 @@
The error message if the JSON source was not successfully parsed. See the [enum Error] constants.
</member>
<member name="result" type="Variant" setter="set_result" getter="get_result">
A [Variant] containing the parsed JSON. Use [method @GDScript.typeof] or the [code]is[/code] keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ([code]{}[/code]), a [Dictionary] will be returned. If the JSON source starts with brackets ([code][][/code]), an [Array] will be returned.
A [Variant] containing the parsed JSON. Use [method @GlobalScope.typeof] or the [code]is[/code] keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ([code]{}[/code]), a [Dictionary] will be returned. If the JSON source starts with brackets ([code][][/code]), an [Array] will be returned.
[b]Note:[/b] The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, parsing a JSON text will convert all numerical values to [float] types.
[b]Note:[/b] JSON objects do not preserve key order like Godot dictionaries, thus, you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements:
[codeblocks]

24
doc/classes/MainLoop.xml
View File

@ -19,7 +19,7 @@
print("Initialized:")
print(" Starting time: %s" % str(time_elapsed))
func _idle(delta):
func _process(delta):
time_elapsed += delta
# Return true to end the main loop.
return quit
@ -51,16 +51,6 @@
Called before the program exits.
</description>
</method>
<method name="_idle" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="delta" type="float">
</argument>
<description>
Called each idle frame with the time since the last idle frame as argument (in seconds). Equivalent to [method Node._process].
If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame.
</description>
</method>
<method name="_initialize" qualifiers="virtual">
<return type="void">
</return>
@ -68,7 +58,7 @@
Called once during initialization.
</description>
</method>
<method name="_iteration" qualifiers="virtual">
<method name="_physics_process" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="delta" type="float">
@ -78,6 +68,16 @@
If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame.
</description>
</method>
<method name="_process" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="delta" type="float">
</argument>
<description>
Called each process (idle) frame with the time since the last process frame as argument (in seconds). Equivalent to [method Node._process].
If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame.
</description>
</method>
</methods>
<signals>
<signal name="on_request_permissions_result">

6
doc/classes/Mesh.xml
View File

@ -242,5 +242,11 @@
</constant>
<constant name="ARRAY_FLAG_USE_8_BONE_WEIGHTS" value="134217728" enum="ArrayFormat">
</constant>
<constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode">
Blend shapes are normalized.
</constant>
<constant name="BLEND_SHAPE_MODE_RELATIVE" value="1" enum="BlendShapeMode">
Blend shapes are relative to base weight.
</constant>
</constants>
</class>

4
doc/classes/NinePatchRect.xml
View File

@ -12,7 +12,7 @@
<method name="get_patch_margin" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description>
Returns the size of the margin on the specified [enum Side].
@ -21,7 +21,7 @@
<method name="set_patch_margin">
<return type="void">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<argument index="1" name="value" type="int">
</argument>

2
doc/classes/Node3D.xml
View File

@ -6,7 +6,7 @@
<description>
Most basic 3D game object, with a 3D [Transform] and visibility settings. All other 3D game objects inherit from Node3D. Use [Node3D] 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 [Node3D] object is set as top-level. Affine operations in this coordinate system correspond to direct affine operations on the [Node3D]'s transform. The word local below refers to this coordinate system. The coordinate system that is attached to the [Node3D] object itself is referred to as object-local coordinate system.
[b]Note:[/b] Unless otherwise specified, all methods that have angle parameters must have angles specified as [i]radians[/i]. To convert degrees to radians, use [method @GDScript.deg2rad].
[b]Note:[/b] Unless otherwise specified, all methods that have angle parameters must have angles specified as [i]radians[/i]. To convert degrees to radians, use [method @GlobalScope.deg2rad].
</description>
<tutorials>
<link title="Introduction to 3D">https://docs.godotengine.org/en/latest/tutorials/3d/introduction_to_3d.html</link>

2
doc/classes/Object.xml
View File

@ -242,7 +242,7 @@
</return>
<description>
Returns the object's unique instance ID.
This ID can be saved in [EncodedObjectAsID], and can be used to retrieve the object instance with [method @GDScript.instance_from_id].
This ID can be saved in [EncodedObjectAsID], and can be used to retrieve the object instance with [method @GlobalScope.instance_from_id].
</description>
</method>
<method name="get_meta" qualifiers="const">

14
doc/classes/PackedByteArray.xml
View File

@ -92,13 +92,6 @@
Creates a copy of the array, and returns it.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="get_string_from_ascii">
<return type="String">
</return>
@ -171,6 +164,13 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>

14
doc/classes/PackedColorArray.xml
View File

@ -59,13 +59,6 @@
Creates a copy of the array, and returns it.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="has">
<return type="bool">
</return>
@ -93,6 +86,13 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>

14
doc/classes/PackedFloat32Array.xml
View File

@ -60,13 +60,6 @@
Creates a copy of the array, and returns it.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="has">
<return type="bool">
</return>
@ -94,6 +87,13 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>

14
doc/classes/PackedFloat64Array.xml
View File

@ -60,13 +60,6 @@
Creates a copy of the array, and returns it.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="has">
<return type="bool">
</return>
@ -94,6 +87,13 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>

14
doc/classes/PackedInt32Array.xml
View File

@ -60,13 +60,6 @@
Creates a copy of the array, and returns it.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="has">
<return type="bool">
</return>
@ -94,6 +87,13 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>

14
doc/classes/PackedInt64Array.xml
View File

@ -60,13 +60,6 @@
Creates a copy of the array, and returns it.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="has">
<return type="bool">
</return>
@ -94,6 +87,13 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>

58
doc/classes/PackedSceneGLTF.xml Normal file
View File

@ -0,0 +1,58 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PackedSceneGLTF" inherits="PackedScene" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="export_gltf">
<return type="int" enum="Error">
</return>
<argument index="0" name="node" type="Node">
</argument>
<argument index="1" name="path" type="String">
</argument>
<argument index="2" name="flags" type="int" default="0">
</argument>
<argument index="3" name="bake_fps" type="float" default="1000.0">
</argument>
<description>
</description>
</method>
<method name="import_gltf_scene">
<return type="Node">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="flags" type="int" default="0">
</argument>
<argument index="2" name="bake_fps" type="float" default="1000.0">
</argument>
<argument index="3" name="state" type="GLTFState" default="null">
</argument>
<description>
</description>
</method>
<method name="pack_gltf">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="flags" type="int" default="0">
</argument>
<argument index="2" name="bake_fps" type="float" default="1000.0">
</argument>
<argument index="3" name="state" type="GLTFState" default="null">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="_bundled" type="Dictionary" setter="_set_bundled_scene" getter="_get_bundled_scene" override="true" default="{&quot;conn_count&quot;: 0,&quot;conns&quot;: PackedInt32Array( ),&quot;editable_instances&quot;: [ ],&quot;names&quot;: PackedStringArray( ),&quot;node_count&quot;: 0,&quot;node_paths&quot;: [ ],&quot;nodes&quot;: PackedInt32Array( ),&quot;variants&quot;: [ ],&quot;version&quot;: 2}" />
</members>
<constants>
</constants>
</class>

14
doc/classes/PackedStringArray.xml
View File

@ -60,13 +60,6 @@
Creates a copy of the array, and returns it.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="has">
<return type="bool">
</return>
@ -94,6 +87,13 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>

14
doc/classes/PackedVector2Array.xml
View File

@ -60,13 +60,6 @@
Creates a copy of the array, and returns it.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="has">
<return type="bool">
</return>
@ -94,6 +87,13 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>

14
doc/classes/PackedVector3Array.xml
View File

@ -59,13 +59,6 @@
Creates a copy of the array, and returns it.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="has">
<return type="bool">
</return>
@ -93,6 +86,13 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the array is empty.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>

2
doc/classes/Plane.xml
View File

@ -142,7 +142,7 @@
<argument index="0" name="to_plane" type="Plane">
</argument>
<description>
Returns [code]true[/code] if this plane and [code]plane[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
Returns [code]true[/code] if this plane and [code]plane[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
</description>
</method>
<method name="is_point_over">

8
doc/classes/ProjectSettings.xml
View File

@ -1153,6 +1153,12 @@
<member name="rendering/quality/intended_usage/framebuffer_allocation.mobile" type="int" setter="" getter="" default="3">
Lower-end override for [member rendering/quality/intended_usage/framebuffer_allocation] on mobile devices, due to performance concerns or driver support.
</member>
<member name="rendering/quality/mesh_lod/threshold_pixels" type="float" setter="" getter="" default="1.0">
</member>
<member name="rendering/quality/rd_renderer/use_low_end_renderer" type="bool" setter="" getter="" default="false">
</member>
<member name="rendering/quality/rd_renderer/use_low_end_renderer.mobile" type="bool" setter="" getter="" default="true">
</member>
<member name="rendering/quality/reflection_atlas/reflection_count" type="int" setter="" getter="" default="64">
Number of cubemaps to store in the reflection atlas. The number of [ReflectionProbe]s in a scene will be limited by this amount. A higher number requires more VRAM.
</member>
@ -1281,6 +1287,8 @@
</member>
<member name="rendering/sdfgi/probe_ray_count" type="int" setter="" getter="" default="2">
</member>
<member name="rendering/spatial_indexer/update_iterations_per_frame" type="int" setter="" getter="" default="10">
</member>
<member name="rendering/threads/thread_model" type="int" setter="" getter="" default="1">
Thread model for rendering. Rendering on a thread can vastly improve performance, but synchronizing to the main thread can cause a bit more jitter.
</member>

2
doc/classes/Quat.xml
View File

@ -127,7 +127,7 @@
<argument index="0" name="to" type="Quat">
</argument>
<description>
Returns [code]true[/code] if this quaterion and [code]quat[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
Returns [code]true[/code] if this quaterion and [code]quat[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
</description>
</method>
<method name="is_normalized">

22
doc/classes/Rect2.xml
View File

@ -72,16 +72,6 @@
Returns a [Rect2] 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="intersection">
<return type="Rect2">
</return>
<argument index="0" name="b" type="Rect2">
</argument>
<description>
Returns the intersection of this [Rect2] and [code]b[/code].
If the rectangles do not intersect, an empty [Rect2] is returned.
</description>
</method>
<method name="encloses">
<return type="bool">
</return>
@ -134,7 +124,7 @@
<method name="grow_side">
<return type="Rect2">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="side" type="int">
</argument>
<argument index="1" name="amount" type="float">
</argument>
@ -158,6 +148,16 @@
Returns [code]true[/code] if the [Rect2] contains a point.
</description>
</method>
<method name="intersection">
<return type="Rect2">
</return>
<argument index="0" name="b" type="Rect2">
</argument>
<description>
Returns the intersection of this [Rect2] and [code]b[/code].
If the rectangles do not intersect, an empty [Rect2] is returned.
</description>
</method>
<method name="intersects">
<return type="bool">
</return>

22
doc/classes/Rect2i.xml
View File

@ -70,16 +70,6 @@
Returns a [Rect2i] 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="intersection">
<return type="Rect2i">
</return>
<argument index="0" name="b" type="Rect2i">
</argument>
<description>
Returns the intersection of this [Rect2i] and [code]b[/code].
If the rectangles do not intersect, an empty [Rect2i] is returned.
</description>
</method>
<method name="encloses">
<return type="bool">
</return>
@ -132,7 +122,7 @@
<method name="grow_side">
<return type="Rect2i">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="side" type="int">
</argument>
<argument index="1" name="amount" type="int">
</argument>
@ -156,6 +146,16 @@
Returns [code]true[/code] if the [Rect2i] contains a point.
</description>
</method>
<method name="intersection">
<return type="Rect2i">
</return>
<argument index="0" name="b" type="Rect2i">
</argument>
<description>
Returns the intersection of this [Rect2i] and [code]b[/code].
If the rectangles do not intersect, an empty [Rect2i] is returned.
</description>
</method>
<method name="intersects">
<return type="bool">
</return>

2
doc/classes/ReflectionProbe.xml
View File

@ -37,6 +37,8 @@
<member name="interior" type="bool" setter="set_as_interior" getter="is_set_as_interior" default="false">
If [code]true[/code], reflections will ignore sky contribution.
</member>
<member name="lod_threshold" type="float" setter="set_lod_threshold" getter="get_lod_threshold" default="1.0">
</member>
<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="0.0">
Sets the max distance away from the probe an object can be before it is culled.
</member>

2
doc/classes/RenderingDevice.xml
View File

@ -730,6 +730,8 @@
</argument>
<argument index="1" name="data" type="PackedByteArray" default="PackedByteArray( )">
</argument>
<argument index="2" name="use_as_storage" type="bool" default="false">
</argument>
<description>
</description>
</method>

38
doc/classes/RenderingServer.xml
View File

@ -859,6 +859,12 @@
Tries to free an object in the RenderingServer.
</description>
</method>
<method name="get_frame_setup_time_cpu" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_render_info">
<return type="int">
</return>
@ -1354,7 +1360,7 @@
<argument index="1" name="scenario" type="RID">
</argument>
<description>
Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update.
Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update.
[b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
</description>
</method>
@ -1366,7 +1372,7 @@
<argument index="1" name="scenario" type="RID">
</argument>
<description>
Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update.
Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update.
[b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
</description>
</method>
@ -1380,7 +1386,7 @@
<argument index="2" name="scenario" type="RID">
</argument>
<description>
Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update.
Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance3D] or [DirectionalLight3D]. Use [method @GlobalScope.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World3D] you want to query. This forces an update for all resources queued to update.
[b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
</description>
</method>
@ -2715,6 +2721,22 @@
Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method.
</description>
</method>
<method name="viewport_get_measured_render_time_cpu" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<description>
</description>
</method>
<method name="viewport_get_measured_render_time_gpu" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<description>
</description>
</method>
<method name="viewport_get_render_info">
<return type="int">
</return>
@ -2852,6 +2874,16 @@
Currently unimplemented in Godot 3.x.
</description>
</method>
<method name="viewport_set_measure_render_time">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="viewport_set_msaa">
<return type="void">
</return>

12
doc/classes/SceneTree.xml
View File

@ -260,7 +260,7 @@
The default [MultiplayerAPI] instance for this [SceneTree].
</member>
<member name="multiplayer_poll" type="bool" setter="set_multiplayer_poll_enabled" getter="is_multiplayer_poll_enabled" default="true">
If [code]true[/code] (default value), enables automatic polling of the [MultiplayerAPI] for this SceneTree during [signal idle_frame].
If [code]true[/code] (default value), enables automatic polling of the [MultiplayerAPI] for this SceneTree during [signal process_frame].
If [code]false[/code], you need to manually call [method MultiplayerAPI.poll] to process network packets and deliver RPCs/RSETs. This allows running RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual [Mutex] protection when accessing the [MultiplayerAPI] from threads.
</member>
<member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer">
@ -298,11 +298,6 @@
Emitted when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated.
</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>
@ -350,6 +345,11 @@
Emitted immediately before [method Node._physics_process] is called on every node in the [SceneTree].
</description>
</signal>
<signal name="process_frame">
<description>
Emitted immediately before [method Node._process] is called on every node in the [SceneTree].
</description>
</signal>
<signal name="server_disconnected">
<description>
Emitted whenever this [SceneTree]'s [member network_peer] disconnected from server. Only emitted on clients.

14
doc/classes/String.xml
View File

@ -135,13 +135,6 @@
Returns a copy of the string with indentation (leading tabs and spaces) removed.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the length of the string equals [code]0[/code].
</description>
</method>
<method name="ends_with">
<return type="bool">
</return>
@ -276,6 +269,13 @@
If the string is a path to a file or directory, returns [code]true[/code] if the path is absolute.
</description>
</method>
<method name="is_empty">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the length of the string equals [code]0[/code].
</description>
</method>
<method name="is_rel_path">
<return type="bool">
</return>

6
doc/classes/StyleBox.xml
View File

@ -39,7 +39,7 @@
<method name="get_default_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description>
Returns the default margin of the specified [enum Side].
@ -48,7 +48,7 @@
<method name="get_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description>
Returns the content margin offset for the specified [enum Side].
@ -72,7 +72,7 @@
<method name="set_default_margin">
<return type="void">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<argument index="1" name="offset" type="float">
</argument>

8
doc/classes/StyleBoxFlat.xml
View File

@ -27,7 +27,7 @@
<method name="get_border_width" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description>
Returns the specified [enum Side]'s border width.
@ -52,7 +52,7 @@
<method name="get_expand_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description>
Returns the size of the specified [enum Side]'s expand margin.
@ -61,7 +61,7 @@
<method name="set_border_width">
<return type="void">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<argument index="1" name="width" type="int">
</argument>
@ -116,7 +116,7 @@
<method name="set_expand_margin">
<return type="void">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<argument index="1" name="size" type="float">
</argument>

8
doc/classes/StyleBoxTexture.xml
View File

@ -12,7 +12,7 @@
<method name="get_expand_margin_size" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description>
Returns the expand margin size of the specified [enum Side].
@ -21,7 +21,7 @@
<method name="get_margin_size" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description>
Returns the margin size of the specified [enum Side].
@ -54,7 +54,7 @@
<method name="set_expand_margin_size">
<return type="void">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<argument index="1" name="size" type="float">
</argument>
@ -65,7 +65,7 @@
<method name="set_margin_size">
<return type="void">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<argument index="1" name="size" type="float">
</argument>

40
doc/classes/SurfaceTool.xml
View File

@ -31,15 +31,6 @@
Adds an index to index array if you are using indexed vertices. Does not need to be called before adding vertices.
</description>
</method>
<method name="add_smooth_group">
<return type="void">
</return>
<argument index="0" name="smooth" type="bool">
</argument>
<description>
Specifies whether the current vertex (if using only vertex arrays) or current index (if also using index arrays) should use smooth normals for normal calculation.
</description>
</method>
<method name="add_triangle_fan">
<return type="void">
</return>
@ -148,6 +139,16 @@
Removes the index array by expanding the vertex array.
</description>
</method>
<method name="generate_lod">
<return type="PackedInt32Array">
</return>
<argument index="0" name="nd_threshold" type="float">
</argument>
<argument index="1" name="target_index_count" type="int" default="3">
</argument>
<description>
</description>
</method>
<method name="generate_normals">
<return type="void">
</return>
@ -173,6 +174,12 @@
<description>
</description>
</method>
<method name="get_max_axis_length" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_skin_weight_count" qualifiers="const">
<return type="int" enum="SurfaceTool.SkinWeightCount">
</return>
@ -186,6 +193,12 @@
Shrinks the vertex array by creating an index array (avoids reusing vertices).
</description>
</method>
<method name="optimize_indices_for_cache">
<return type="void">
</return>
<description>
</description>
</method>
<method name="set_bones">
<return type="void">
</return>
@ -251,6 +264,15 @@
<description>
</description>
</method>
<method name="set_smooth_group">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
Specifies whether the current vertex (if using only vertex arrays) or current index (if also using index arrays) should use smooth normals for normal calculation.
</description>
</method>
<method name="set_tangent">
<return type="void">
</return>

6
doc/classes/TabContainer.xml
View File

@ -137,6 +137,9 @@
</method>
</methods>
<members>
<member name="all_tabs_in_front" type="bool" setter="set_all_tabs_in_front" getter="is_all_tabs_in_front" default="false">
If [code]true[/code], all tabs are drawn in front of the panel. If [code]false[/code], inactive tabs are drawn behind the panel.
</member>
<member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab" default="0">
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>
@ -149,9 +152,6 @@
<member name="tabs_visible" type="bool" setter="set_tabs_visible" getter="are_tabs_visible" default="true">
If [code]true[/code], tabs are visible. If [code]false[/code], tabs' content and titles are hidden.
</member>
<member name="all_tabs_in_front" type="bool" setter="set_all_tabs_in_front" getter="is_all_tabs_in_front" default="false">
If [code]true[/code], all tabs are drawn in front of the panel. If [code]false[/code], inactive tabs are drawn behind the panel.
</member>
<member name="use_hidden_tabs_for_min_size" type="bool" setter="set_use_hidden_tabs_for_min_size" getter="get_use_hidden_tabs_for_min_size" default="false">
If [code]true[/code], children [Control] nodes that are hidden have their minimum size take into account in the total, instead of only the currently visible one.
</member>

4
doc/classes/TextureProgressBar.xml
View File

@ -12,7 +12,7 @@
<method name="get_stretch_margin" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description>
</description>
@ -20,7 +20,7 @@
<method name="set_stretch_margin">
<return type="void">
</return>
<argument index="0" name="side" type="int" enum="Side">
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<argument index="1" name="value" type="int">
</argument>

2
doc/classes/Variant.xml
View File

@ -17,7 +17,7 @@
- VisualScript tracks properties inside Variants as well, but it also uses static typing. The GUI interface enforces that properties have a particular type that doesn't change over time.
- C# is statically typed, but uses the Mono [code]object[/code] type in place of Godot's Variant class when it needs to represent a dynamic value. [code]object[/code] is the Mono runtime's equivalent of the same concept.
- The statically-typed language NativeScript C++ does not define a built-in Variant-like class. Godot's GDNative bindings provide their own godot::Variant class for users; Any point at which the C++ code starts interacting with the Godot runtime is a place where you might have to start wrapping data inside Variant objects.
The global [method @GDScript.typeof] function returns the enumerated value of the Variant type stored in the current variable (see [enum Variant.Type]).
The global [method @GlobalScope.typeof] function returns the enumerated value of the Variant type stored in the current variable (see [enum Variant.Type]).
[codeblock]
var foo = 2
match typeof(foo):

26
doc/classes/Vector2.xml
View File

@ -66,7 +66,7 @@
<description>
Returns this vector's angle with respect to the positive X axis, or [code](1, 0)[/code] vector, in radians.
For example, [code]Vector2.RIGHT.angle()[/code] will return zero, [code]Vector2.DOWN.angle()[/code] will return [code]PI / 2[/code] (a quarter turn, or 90 degrees), and [code]Vector2(1, -1).angle()[/code] will return [code]-PI / 4[/code] (a negative eighth turn, or -45 degrees).
Equivalent to the result of [method @GDScript.atan2] when called with the vector's [member y] and [member x] as parameters: [code]atan2(y, x)[/code].
Equivalent to the result of [method @GlobalScope.atan2] when called with the vector's [member y] and [member x] as parameters: [code]atan2(y, x)[/code].
</description>
</method>
<method name="angle_to">
@ -196,7 +196,7 @@
<argument index="0" name="to" type="Vector2">
</argument>
<description>
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
</description>
</method>
<method name="is_normalized">
@ -390,13 +390,20 @@
<description>
</description>
</method>
<method name="orthogonal">
<return type="Vector2">
</return>
<description>
Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to the original, with the same length.
</description>
</method>
<method name="posmod">
<return type="Vector2">
</return>
<argument index="0" name="mod" type="float">
</argument>
<description>
Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]mod[/code].
Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]mod[/code].
</description>
</method>
<method name="posmodv">
@ -405,7 +412,7 @@
<argument index="0" name="modv" type="Vector2">
</argument>
<description>
Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]modv[/code]'s components.
Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]modv[/code]'s components.
</description>
</method>
<method name="project">
@ -432,7 +439,7 @@
<argument index="0" name="phi" type="float">
</argument>
<description>
Returns the vector rotated by [code]phi[/code] radians. See also [method @GDScript.deg2rad].
Returns the vector rotated by [code]phi[/code] radians. See also [method @GlobalScope.deg2rad].
</description>
</method>
<method name="round">
@ -446,7 +453,7 @@
<return type="Vector2">
</return>
<description>
Returns the vector with each component set to one or negative one, depending on the signs of the components, or zero if the component is zero, by calling [method @GDScript.sign] on each component.
Returns the vector with each component set to one or negative one, depending on the signs of the components, or zero if the component is zero, by calling [method @GlobalScope.sign] on each component.
</description>
</method>
<method name="slerp">
@ -479,13 +486,6 @@
Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals.
</description>
</method>
<method name="orthogonal">
<return type="Vector2">
</return>
<description>
Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to the original, with the same length.
</description>
</method>
</methods>
<members>
<member name="x" type="float" setter="" getter="" default="0.0">

8
doc/classes/Vector3.xml
View File

@ -171,7 +171,7 @@
<argument index="0" name="to" type="Vector3">
</argument>
<description>
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
</description>
</method>
<method name="is_normalized">
@ -410,7 +410,7 @@
<argument index="0" name="mod" type="float">
</argument>
<description>
Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]mod[/code].
Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]mod[/code].
</description>
</method>
<method name="posmodv">
@ -419,7 +419,7 @@
<argument index="0" name="modv" type="Vector3">
</argument>
<description>
Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]modv[/code]'s components.
Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]modv[/code]'s components.
</description>
</method>
<method name="project">
@ -462,7 +462,7 @@
<return type="Vector3">
</return>
<description>
Returns a vector with each component set to one or negative one, depending on the signs of this vector's components, or zero if the component is zero, by calling [method @GDScript.sign] on each component.
Returns a vector with each component set to one or negative one, depending on the signs of this vector's components, or zero if the component is zero, by calling [method @GlobalScope.sign] on each component.
</description>
</method>
<method name="slerp">

4
doc/classes/Viewport.xml
View File

@ -222,6 +222,8 @@
</member>
<member name="handle_input_locally" type="bool" setter="set_handle_input_locally" getter="is_handling_input_locally" default="true">
</member>
<member name="lod_threshold" type="float" setter="set_lod_threshold" getter="get_lod_threshold" default="1.0">
</member>
<member name="msaa" type="int" setter="set_msaa" getter="get_msaa" enum="Viewport.MSAA" default="0">
The multisample anti-aliasing mode. A higher number results in smoother edges at the cost of significantly worse performance. A value of 4 is best unless targeting very high-end systems.
</member>
@ -405,6 +407,8 @@
</constant>
<constant name="DEBUG_DRAW_GI_BUFFER" value="17" enum="DebugDraw">
</constant>
<constant name="DEBUG_DRAW_DISABLE_LOD" value="18" enum="DebugDraw">
</constant>
<constant name="DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST" value="0" enum="DefaultCanvasItemTextureFilter">
The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized.
</constant>

2
doc/classes/WeakRef.xml
View File

@ -4,7 +4,7 @@
Holds an [Object], but does not contribute to the reference count if the object is a reference.
</brief_description>
<description>
A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released.
A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GlobalScope.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released.
</description>
<tutorials>
</tutorials>

14
doc/classes/XRController3D.xml
View File

@ -19,13 +19,6 @@
If active, returns the name of the associated controller if provided by the AR/VR SDK used.
</description>
</method>
<method name="get_tracker_hand" qualifiers="const">
<return type="int" enum="XRPositionalTracker.TrackerHand">
</return>
<description>
Returns the hand holding this controller, if known. See [enum XRPositionalTracker.TrackerHand].
</description>
</method>
<method name="get_is_active" qualifiers="const">
<return type="bool">
</return>
@ -56,6 +49,13 @@
If provided by the [XRInterface], this returns a mesh associated with the controller. This can be used to visualize the controller.
</description>
</method>
<method name="get_tracker_hand" qualifiers="const">
<return type="int" enum="XRPositionalTracker.TrackerHand">
</return>
<description>
Returns the hand holding this controller, if known. See [enum XRPositionalTracker.TrackerHand].
</description>
</method>
<method name="is_button_pressed" qualifiers="const">
<return type="bool">
</return>

32
doc/classes/XRPositionalTracker.xml
View File

@ -12,13 +12,6 @@
<link title="VR tutorial index">https://docs.godotengine.org/en/latest/tutorials/vr/index.html</link>
</tutorials>
<methods>
<method name="get_tracker_hand" qualifiers="const">
<return type="int" enum="XRPositionalTracker.TrackerHand">
</return>
<description>
Returns the hand holding this tracker, if known. See [enum TrackerHand] constants.
</description>
</method>
<method name="get_joy_id" qualifiers="const">
<return type="int">
</return>
@ -47,6 +40,13 @@
Returns the world-space controller position.
</description>
</method>
<method name="get_tracker_hand" qualifiers="const">
<return type="int" enum="XRPositionalTracker.TrackerHand">
</return>
<description>
Returns the hand holding this tracker, if known. See [enum TrackerHand] constants.
</description>
</method>
<method name="get_tracker_id" qualifiers="const">
<return type="int">
</return>
@ -68,6 +68,15 @@
Returns the tracker's type, which will be one of the values from the [enum XRServer.TrackerType] enum.
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform">
</return>
<argument index="0" name="adjust_by_reference_frame" type="bool">
</argument>
<description>
Returns the transform combining this device's orientation and position.
</description>
</method>
<method name="is_tracking_orientation" qualifiers="const">
<return type="bool">
</return>
@ -82,15 +91,6 @@
Returns [code]true[/code] if this device is tracking position.
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform">
</return>
<argument index="0" name="adjust_by_reference_frame" type="bool">
</argument>
<description>
Returns the transform combining this device's orientation and position.
</description>
</method>
</methods>
<members>
<member name="rumble" type="float" setter="set_rumble" getter="get_rumble" default="0.0">

2
modules/fbx/doc_classes/EditorSceneImporterFBX.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSceneImporterFBX" inherits="EditorSceneImporter" version="3.2">
<class name="EditorSceneImporterFBX" inherits="EditorSceneImporter" version="4.0">
<brief_description>
FBX 3D asset importer.
</brief_description>

1117
modules/gdscript/doc_classes/@GDScript.xml
View File

File diff suppressed because it is too large Load Diff

2
modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml
View File

@ -92,7 +92,7 @@
<constant name="MATH_STEP_DECIMALS" value="24" enum="BuiltinFunc">
Return the number of digit places after the decimal that the first non-zero digit occurs.
</constant>
<constant name="MATH_STEPIFY" value="25" enum="BuiltinFunc">
<constant name="MATH_SNAPPED" value="25" enum="BuiltinFunc">
Return the input snapped to a given step.
</constant>
<constant name="MATH_LERP" value="26" enum="BuiltinFunc">