godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs 

[ci skip]
This commit is contained in:
Bojidar Marinov 2018-01-12 00:38:35 +02:00
parent 9b8e8b2220
commit ad79c70300
No known key found for this signature in database
GPG Key ID: 4D546A8F1E091856
71 changed files with 695 additions and 3092 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/@GlobalScope.xml
View File

@ -29,9 +29,6 @@
<member name="Geometry" type="Geometry" setter="" getter="">
[Geometry] singleton
</member>
<member name="GodotSharp" type="GodotSharp" setter="" getter="">
[GodotSharp] singleton
</member>
<member name="IP" type="IP" setter="" getter="">
[IP] singleton
</member>
@ -1285,7 +1282,7 @@
</constant>
<constant name="PROPERTY_USAGE_DEFAULT_INTL" value="71" enum="PropertyUsageFlags">
</constant>
<constant name="PROPERTY_USAGE_NOEDITOR" value="1048581" enum="PropertyUsageFlags">
<constant name="PROPERTY_USAGE_NOEDITOR" value="5" enum="PropertyUsageFlags">
</constant>
<constant name="METHOD_FLAG_NORMAL" value="1" enum="MethodFlags">
Flag for normal method

59
doc/classes/Animation.xml
View File

@ -50,20 +50,6 @@
Return the index of the specified track. If the track is not found, return -1.
</description>
</method>
<method name="get_length" qualifiers="const">
<return type="float">
</return>
<description>
Return the total length of the animation (in seconds).
</description>
</method>
<method name="get_step" qualifiers="const">
<return type="float">
</return>
<description>
Get the animation step value.
</description>
</method>
<method name="get_track_count" qualifiers="const">
<return type="int">
</return>
@ -71,13 +57,6 @@
Return the amount of tracks in the animation.
</description>
</method>
<method name="has_loop" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether the animation has the loop flag set.
</description>
</method>
<method name="method_track_get_key_indices" qualifiers="const">
<return type="PoolIntArray">
</return>
@ -122,33 +101,6 @@
Remove a track by specifying the track index.
</description>
</method>
<method name="set_length">
<return type="void">
</return>
<argument index="0" name="time_sec" type="float">
</argument>
<description>
Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
</description>
</method>
<method name="set_loop">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
</description>
</method>
<method name="set_step">
<return type="void">
</return>
<argument index="0" name="size_sec" type="float">
</argument>
<description>
Set the animation step value.
</description>
</method>
<method name="track_find_key" qualifiers="const">
<return type="int">
</return>
@ -456,6 +408,17 @@
</description>
</method>
</methods>
<members>
<member name="length" type="float" setter="set_length" getter="get_length">
The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
</member>
<member name="loop" type="bool" setter="set_loop" getter="has_loop">
A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
</member>
<member name="step" type="float" setter="set_step" getter="get_step">
The animation step value.
</member>
</members>
<constants>
<constant name="TYPE_VALUE" value="0" enum="TrackType">
Value tracks set values in node properties, but only those which can be Interpolated.

96
doc/classes/AnimationPlayer.xml
View File

@ -90,13 +90,6 @@
Returns the list of stored animation names.
</description>
</method>
<method name="get_autoplay" qualifiers="const">
<return type="String">
</return>
<description>
Returns the name of the animation that will be automatically played when the scene is loaded.
</description>
</method>
<method name="get_blend_time" qualifiers="const">
<return type="float">
</return>
@ -108,34 +101,6 @@
Get the blend time (in seconds) between two animations, referenced by their names.
</description>
</method>
<method name="get_current_animation" qualifiers="const">
<return type="String">
</return>
<description>
Returns the name of the animation being played.
</description>
</method>
<method name="get_current_animation_length" qualifiers="const">
<return type="float">
</return>
<description>
Get the length (in seconds) of the currently being played animation.
</description>
</method>
<method name="get_current_animation_position" qualifiers="const">
<return type="float">
</return>
<description>
Get the position (in seconds) of the currently playing animation.
</description>
</method>
<method name="get_speed_scale" qualifiers="const">
<return type="float">
</return>
<description>
Returns the speed scaling ratio of the current animation channel. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed.
</description>
</method>
<method name="has_animation" qualifiers="const">
<return type="bool">
</return>
@ -145,13 +110,6 @@
Returns [code]true[/code] if the [code]AnimationPlayer[/code] stores an [Animation] with key [code]name[/code].
</description>
</method>
<method name="is_active" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the player is active.
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
@ -226,24 +184,6 @@
Seek the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time.
</description>
</method>
<method name="set_active">
<return type="void">
</return>
<argument index="0" name="active" type="bool">
</argument>
<description>
Sets the player as active (playing). If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code].
</description>
</method>
<method name="set_autoplay">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Defines the name of the animation to play when the scene loads. Default value: [code]""[/code].
</description>
</method>
<method name="set_blend_time">
<return type="void">
</return>
@ -257,24 +197,6 @@
Specify a blend time (in seconds) between two animations, referenced by their names.
</description>
</method>
<method name="set_current_animation">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
<description>
Sets the name of the current animation. If already playing, restarts the animation. Ensure [member active] is [code]true[/code] to simulate [method play]. Default value: [code]""[/code].
</description>
</method>
<method name="set_speed_scale">
<return type="void">
</return>
<argument index="0" name="speed" type="float">
</argument>
<description>
Sets the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: [code]1[/code].
</description>
</method>
<method name="stop">
<return type="void">
</return>
@ -286,12 +208,30 @@
</method>
</methods>
<members>
<member name="autoplay" type="String" setter="set_autoplay" getter="get_autoplay">
The name of the animation to play when the scene loads. Default value: [code]""[/code].
</member>
<member name="current_animation" type="String" setter="set_current_animation" getter="get_current_animation">
The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also [method play]. Default value: [code]""[/code].
</member>
<member name="current_animation_length" type="float" setter="" getter="get_current_animation_length">
The length (in seconds) of the currently being played animation.
</member>
<member name="current_animation_position" type="float" setter="" getter="get_current_animation_position">
The position (in seconds) of the currently playing animation.
</member>
<member name="playback_active" type="bool" setter="set_active" getter="is_active">
If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code].
</member>
<member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time">
The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: [code]0[/code].
</member>
<member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationPlayer.AnimationProcessMode">
The process notification in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE].
</member>
<member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale">
The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: [code]1[/code].
</member>
<member name="root_node" type="NodePath" setter="set_root" getter="get_root">
The node from which node path references will travel. Default value: [code]".."[/code].
</member>

34
doc/classes/ArrayMesh.xml
View File

@ -51,12 +51,6 @@
<description>
</description>
</method>
<method name="get_blend_shape_mode" qualifiers="const">
<return type="int" enum="Mesh.BlendShapeMode">
</return>
<description>
</description>
</method>
<method name="get_blend_shape_name" qualifiers="const">
<return type="String">
</return>
@ -65,12 +59,6 @@
<description>
</description>
</method>
<method name="get_custom_aabb" qualifiers="const">
<return type="AABB">
</return>
<description>
</description>
</method>
<method name="get_surface_count" qualifiers="const">
<return type="int">
</return>
@ -84,22 +72,6 @@
<description>
</description>
</method>
<method name="set_blend_shape_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="Mesh.BlendShapeMode">
</argument>
<description>
</description>
</method>
<method name="set_custom_aabb">
<return type="void">
</return>
<argument index="0" name="aabb" type="AABB">
</argument>
<description>
</description>
</method>
<method name="surface_get_array_index_len" qualifiers="const">
<return type="int">
</return>
@ -212,6 +184,12 @@
</description>
</method>
</methods>
<members>
<member name="blend_shape_mode" type="int" setter="set_blend_shape_mode" getter="get_blend_shape_mode" enum="Mesh.BlendShapeMode">
</member>
<member name="custom_aabb" type="AABB" setter="set_custom_aabb" getter="get_custom_aabb">
</member>
</members>
<constants>
<constant name="NO_INDEX_ARRAY" value="-1">
Default value used for index_array_len when no indices are present.

14
doc/classes/AudioEffectReverb.xml
View File

@ -12,20 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_predelay_feedback" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_predelay_feedback">
<return type="void">
</return>
<argument index="0" name="feedback" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="damping" type="float" setter="set_damping" getter="get_damping">

14
doc/classes/AudioStreamSample.xml
View File

@ -11,20 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_data" qualifiers="const">
<return type="PoolByteArray">
</return>
<description>
</description>
</method>
<method name="set_data">
<return type="void">
</return>
<argument index="0" name="data" type="PoolByteArray">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format">

64
doc/classes/BakedLightmapData.xml
View File

@ -27,30 +27,6 @@
<description>
</description>
</method>
<method name="get_bounds" qualifiers="const">
<return type="AABB">
</return>
<description>
</description>
</method>
<method name="get_cell_space_transform" qualifiers="const">
<return type="Transform">
</return>
<description>
</description>
</method>
<method name="get_cell_subdiv" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_octree" qualifiers="const">
<return type="PoolByteArray">
</return>
<description>
</description>
</method>
<method name="get_user_count" qualifiers="const">
<return type="int">
</return>
@ -73,42 +49,18 @@
<description>
</description>
</method>
<method name="set_bounds">
<return type="void">
</return>
<argument index="0" name="bounds" type="AABB">
</argument>
<description>
</description>
</method>
<method name="set_cell_space_transform">
<return type="void">
</return>
<argument index="0" name="xform" type="Transform">
</argument>
<description>
</description>
</method>
<method name="set_cell_subdiv">
<return type="void">
</return>
<argument index="0" name="cell_subdiv" type="int">
</argument>
<description>
</description>
</method>
<method name="set_octree">
<return type="void">
</return>
<argument index="0" name="octree" type="PoolByteArray">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="bounds" type="AABB" setter="set_bounds" getter="get_bounds">
</member>
<member name="cell_space_transform" type="Transform" setter="set_cell_space_transform" getter="get_cell_space_transform">
</member>
<member name="cell_subdiv" type="int" setter="set_cell_subdiv" getter="get_cell_subdiv">
</member>
<member name="energy" type="float" setter="set_energy" getter="get_energy">
</member>
<member name="octree" type="PoolByteArray" setter="set_octree" getter="get_octree">
</member>
</members>
<constants>
</constants>

21
doc/classes/BoneAttachment.xml
View File

@ -11,23 +11,12 @@
<demos>
</demos>
<methods>
<method name="get_bone_name" qualifiers="const">
<return type="String">
</return>
<description>
Returns the name of the bone node attached to.
</description>
</method>
<method name="set_bone_name">
<return type="void">
</return>
<argument index="0" name="bone_name" type="String">
</argument>
<description>
Changes the name of the bone node
</description>
</method>
</methods>
<members>
<member name="bone_name" type="String" setter="set_bone_name" getter="get_bone_name">
The name of the attached bone.
</member>
</members>
<constants>
</constants>
</class>

57
doc/classes/Camera2D.xml
View File

@ -47,27 +47,6 @@
Returns the location of the [code]Camera2D[/code]'s screen-center, relative to the origin.
</description>
</method>
<method name="get_custom_viewport" qualifiers="const">
<return type="Node">
</return>
<description>
Returns the [Viewport] used by the camera if it is not using the default viewport.
</description>
</method>
<method name="get_h_offset" qualifiers="const">
<return type="float">
</return>
<description>
Returns the horizontal offset of the camera.
</description>
</method>
<method name="get_v_offset" qualifiers="const">
<return type="float">
</return>
<description>
Returns the vertical offset of the camera.
</description>
</method>
<method name="make_current">
<return type="void">
</return>
@ -83,33 +62,6 @@
This has no effect if smoothing is disabled.
</description>
</method>
<method name="set_custom_viewport">
<return type="void">
</return>
<argument index="0" name="viewport" type="Node">
</argument>
<description>
Assigns a custom [Viewport] node to the [code]Camera2D[/code]. If [code]viewport[/code] is not a [Viewport], it re-assigns the default viewport instead.
</description>
</method>
<method name="set_h_offset">
<return type="void">
</return>
<argument index="0" name="ofs" type="float">
</argument>
<description>
The camera's horizontal offset is set to [code]ofs[/code].
</description>
</method>
<method name="set_v_offset">
<return type="void">
</return>
<argument index="0" name="ofs" type="float">
</argument>
<description>
The camera's vertical offset is set to [code]ofs[/code].
</description>
</method>
</methods>
<members>
<member name="anchor_mode" type="int" setter="set_anchor_mode" getter="get_anchor_mode" enum="Camera2D.AnchorMode">
@ -118,6 +70,9 @@
<member name="current" type="bool" setter="_set_current" getter="is_current">
If [code]true[/code] the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera [code]current[/code] will disable this one.
</member>
<member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport">
The custom [Viewport] node attached to the [code]Camera2D[/code]. If null or not a [Viewport], uses the default viewport instead.
</member>
<member name="drag_margin_bottom" type="float" setter="set_drag_margin" getter="get_drag_margin">
Bottom margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen.
</member>
@ -163,6 +118,12 @@
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset">
The camera's offset, useful for looking around or camera shake animations.
</member>
<member name="offset_h" type="float" setter="set_h_offset" getter="get_h_offset">
The horizontal offset of the camera, relative to the drag margins. Default value: [code]0[/code]
</member>
<member name="offset_v" type="float" setter="set_v_offset" getter="get_v_offset">
The vertical offset of the camera, relative to the drag margins. Default value: [code]0[/code]
</member>
<member name="rotating" type="bool" setter="set_rotating" getter="is_rotating">
If [code]true[/code] the camera rotates with the target. Default value: [code]false[/code]
</member>

59
doc/classes/CanvasLayer.xml
View File

@ -11,27 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_custom_viewport" qualifiers="const">
<return type="Node">
</return>
<description>
Returns the [Viewport] used by the camera if it is not using the default viewport.
</description>
</method>
<method name="get_rotation" qualifiers="const">
<return type="float">
</return>
<description>
Return the base rotation for this layer in radians (helper).
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform2D">
</return>
<description>
Return the base transform for this layer.
</description>
</method>
<method name="get_world_2d" qualifiers="const">
<return type="World2D">
</return>
@ -39,47 +18,29 @@
Return the [World2D] used by this layer.
</description>
</method>
<method name="set_custom_viewport">
<return type="void">
</return>
<argument index="0" name="viewport" type="Node">
</argument>
<description>
Assigns a custom [Viewport] node to the [code]CanvasLayer[/code]. If [code]viewport[/code] is not a [Viewport], it re-assigns the default viewport instead.
</description>
</method>
<method name="set_rotation">
<return type="void">
</return>
<argument index="0" name="radians" type="float">
</argument>
<description>
Set the base rotation for this layer in radians (helper).
</description>
</method>
<method name="set_transform">
<return type="void">
</return>
<argument index="0" name="transform" type="Transform2D">
</argument>
<description>
Set the base transform for this layer.
</description>
</method>
</methods>
<members>
<member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport">
The custom [Viewport] node assigned to the [code]CanvasLayer[/code]. If null, uses the default viewport instead.
</member>
<member name="layer" type="int" setter="set_layer" getter="get_layer">
Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code].
</member>
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset">
The layer's base offset.
</member>
<member name="rotation" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
<member name="rotation" type="float" setter="set_rotation" getter="get_rotation">
The layer's rotation in radians.
</member>
<member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
The layer's rotation in degrees.
</member>
<member name="scale" type="Vector2" setter="set_scale" getter="get_scale">
The layer's scale.
</member>
<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
The layer's transform.
</member>
</members>
<constants>
</constants>

59
doc/classes/ColorPicker.xml
View File

@ -20,55 +20,18 @@
Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker.
</description>
</method>
<method name="get_pick_color" qualifiers="const">
<return type="Color">
</return>
<description>
Gets the current color.
</description>
</method>
<method name="is_editing_alpha" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether the color has transparency or not.
</description>
</method>
<method name="is_raw_mode" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether this color picker is in raw mode or not, raw mode will allow the color R, G, B component values to go beyond 1, you have to consider that the max value for color components is 1, going beyond that value will not have effect in the color, but can be used for special operations that require it (like tinting without darkening or rendering sprites in HDR).
</description>
</method>
<method name="set_edit_alpha">
<return type="void">
</return>
<argument index="0" name="show" type="bool">
</argument>
<description>
Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color.
</description>
</method>
<method name="set_pick_color">
<return type="void">
</return>
<argument index="0" name="color" type="Color">
</argument>
<description>
Select the current color.
</description>
</method>
<method name="set_raw_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="bool">
</argument>
<description>
Set whether this color picker is using raw mode or not, see [method is_raw_mode].
</description>
</method>
</methods>
<members>
<member name="color" type="Color" setter="set_pick_color" getter="get_pick_color">
The currently selected color.
</member>
<member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha">
If [code]true[/code], shows an alpha channel slider (transparency).
</member>
<member name="raw_mode" type="bool" setter="set_raw_mode" getter="is_raw_mode">
If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).
</member>
</members>
<signals>
<signal name="color_changed">
<argument index="0" name="color" type="Color">

57
doc/classes/Control.xml
View File

@ -178,13 +178,6 @@
Returns the mouse cursor shape the control displays on mouse hover, one of the [code]CURSOR_*[/code] constants.
</description>
</method>
<method name="get_default_cursor_shape" qualifiers="const">
<return type="int" enum="Control.CursorShape">
</return>
<description>
Returns the default cursor shape for this control. See enum [code]CURSOR_*[/code] for the list of shapes.
</description>
</method>
<method name="get_drag_data" qualifiers="virtual">
<return type="Object">
</return>
@ -200,13 +193,6 @@
Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
</description>
</method>
<method name="get_focus_mode" qualifiers="const">
<return type="int" enum="Control.FocusMode">
</return>
<description>
Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]).
</description>
</method>
<method name="get_focus_owner" qualifiers="const">
<return type="Control">
</return>
@ -224,13 +210,6 @@
<description>
</description>
</method>
<method name="get_global_position" qualifiers="const">
<return type="Vector2">
</return>
<description>
Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
</description>
</method>
<method name="get_global_rect" qualifiers="const">
<return type="Rect2">
</return>
@ -490,15 +469,6 @@
Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
</description>
</method>
<method name="set_default_cursor_shape">
<return type="void">
</return>
<argument index="0" name="shape" type="int" enum="Control.CursorShape">
</argument>
<description>
Sets the default cursor shape for this control. See [code]CURSOR_*[/code] for the list of available cursor shapes. Useful for Godot plugins and applications or games that use the system's mouse cursors.
</description>
</method>
<method name="set_drag_forwarding">
<return type="void">
</return>
@ -524,24 +494,6 @@
Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]).
</description>
</method>
<method name="set_focus_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="Control.FocusMode">
</argument>
<description>
Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals.
</description>
</method>
<method name="set_global_position">
<return type="void">
</return>
<argument index="0" name="position" type="Vector2">
</argument>
<description>
Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]).
</description>
</method>
<method name="set_margins_preset">
<return type="void">
</return>
@ -594,6 +546,9 @@
<member name="anchor_top" type="float" setter="_set_anchor" getter="get_anchor">
Anchors the top edge of the node to the origin, the center or the end of its parent container. It changes how the top margin updates when the node moves or changes size. Use one of the [code]ANCHOR_*[/code] constants. Default value: [code]ANCHOR_BEGIN[/code].
</member>
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" enum="Control.FocusMode">
The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals.
</member>
<member name="focus_neighbour_bottom" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour">
Tells Godot which node it should give keyboard focus to if the user presses Tab, the down arrow on the keyboard, or down on a gamepad. The node must be a [code]Control[/code]. If this property is not set, Godot will give focus to the closest [code]Control[/code] to the bottom of this one.
If the user presses Tab, Godot will give focus to the closest node to the right first, then to the bottom. If the user presses Shift+Tab, Godot will look to the left of the node, then above it.
@ -631,11 +586,17 @@
<member name="margin_top" type="float" setter="set_margin" getter="get_margin">
Distance between the node's top edge and its parent container, based on [member anchor_top].
</member>
<member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" enum="Control.CursorShape">
The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors.
</member>
<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" enum="Control.MouseFilter">
Controls whether the control will be able to receive mouse button input events through [method _gui_input] and how these events should be handled. Use one of the [code]MOUSE_FILTER_*[/code] constants. See the constants to learn what each does.
</member>
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents">
</member>
<member name="rect_global_position" type="Vector2" setter="set_global_position" getter="get_global_position">
The node's global position, relative to the world (usually to the top-left corner of the window).
</member>
<member name="rect_min_size" type="Vector2" setter="set_custom_minimum_size" getter="get_custom_minimum_size">
The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes.
</member>

19
doc/classes/CubeMap.xml
View File

@ -11,13 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_flags" qualifiers="const">
<return type="int">
</return>
<description>
Returns the render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details.
</description>
</method>
<method name="get_height" qualifiers="const">
<return type="int">
</return>
@ -41,15 +34,6 @@
Returns the [code]CubeMap[/code]'s width.
</description>
</method>
<method name="set_flags">
<return type="void">
</return>
<argument index="0" name="flags" type="int">
</argument>
<description>
Returns the render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details.
</description>
</method>
<method name="set_side">
<return type="void">
</return>
@ -63,6 +47,9 @@
</method>
</methods>
<members>
<member name="flags" type="int" setter="set_flags" getter="get_flags">
The render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details.
</member>
<member name="lossy_storage_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality">
The lossy storage quality of the [code]CubeMap[/code] if the storage mode is set to STORAGE_COMPRESS_LOSSY.
</member>

78
doc/classes/Engine.xml
View File

@ -25,13 +25,6 @@
Returns the frames per second of the running game.
</description>
</method>
<method name="get_iterations_per_second" qualifiers="const">
<return type="int">
</return>
<description>
Returns the number of fixed iterations per second (for fixed process and physics).
</description>
</method>
<method name="get_main_loop" qualifiers="const">
<return type="MainLoop">
</return>
@ -47,20 +40,6 @@
<description>
</description>
</method>
<method name="get_target_fps" qualifiers="const">
<return type="float">
</return>
<description>
Returns the desired frames per second. If the hardware cannot keep up, this setting may not be respected. It defaults to 0, which indicates no limit.
</description>
</method>
<method name="get_time_scale">
<return type="float">
</return>
<description>
Returns how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed.
</description>
</method>
<method name="get_version_info" qualifiers="const">
<return type="Dictionary">
</return>
@ -83,13 +62,6 @@
<description>
</description>
</method>
<method name="is_editor_hint" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the editor is running.
</description>
</method>
<method name="is_in_physics_frame" qualifiers="const">
<return type="bool">
</return>
@ -97,43 +69,21 @@
Returns [code]true[/code] if the game is inside the fixed process and physics phase of the game loop.
</description>
</method>
<method name="set_editor_hint">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Sets the running inside the editor hint if [code]enabled[/code] is [code]true[/code].
</description>
</method>
<method name="set_iterations_per_second">
<return type="void">
</return>
<argument index="0" name="iterations_per_second" type="int">
</argument>
<description>
Sets the number of fixed iterations per second (for fixed process and physics).
</description>
</method>
<method name="set_target_fps">
<return type="void">
</return>
<argument index="0" name="target_fps" type="int">
</argument>
<description>
Sets the target frames per second.
</description>
</method>
<method name="set_time_scale">
<return type="void">
</return>
<argument index="0" name="time_scale" type="float">
</argument>
<description>
Sets the time scale.
</description>
</method>
</methods>
<members>
<member name="editor_hint" type="bool" setter="set_editor_hint" getter="is_editor_hint">
If [code]true[/code], it is running inside the editor. Useful for tool scripts.
</member>
<member name="iterations_per_second" type="int" setter="set_iterations_per_second" getter="get_iterations_per_second">
The number of fixed iterations per second (for fixed process and physics).
</member>
<member name="target_fps" type="float" setter="set_target_fps" getter="get_target_fps">
The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit.
</member>
<member name="time_scale" type="float" setter="set_time_scale" getter="get_time_scale">
Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed.
</member>
</members>
<constants>
</constants>
</class>

23
doc/classes/File.xml
View File

@ -109,13 +109,6 @@
Returns the next 64 bits from the file as a floating point number.
</description>
</method>
<method name="get_endian_swap">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if endian swap is enabled for this file.
</description>
</method>
<method name="get_error" qualifiers="const">
<return type="int" enum="Error">
</return>
@ -274,16 +267,6 @@
Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file.
</description>
</method>
<method name="set_endian_swap">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
If [code]true[/code] the file's endianness is swapped. Use this if you're dealing with files written in big endian machines.
Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file.
</description>
</method>
<method name="store_16">
<return type="void">
</return>
@ -393,6 +376,12 @@
</description>
</method>
</methods>
<members>
<member name="endian_swap" type="bool" setter="set_endian_swap" getter="get_endian_swap">
If [code]true[/code] the file's endianness is swapped. Use this if you're dealing with files written in big endian machines.
Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file.
</member>
</members>
<constants>
<constant name="READ" value="1" enum="ModeFlags">
Opens the file for read operations.

57
doc/classes/FileDialog.xml
View File

@ -33,27 +33,6 @@
<description>
</description>
</method>
<method name="get_current_dir" qualifiers="const">
<return type="String">
</return>
<description>
Get the current working directory of the file dialog.
</description>
</method>
<method name="get_current_file" qualifiers="const">
<return type="String">
</return>
<description>
Get the current selected file of the file dialog (empty if none).
</description>
</method>
<method name="get_current_path" qualifiers="const">
<return type="String">
</return>
<description>
Get the current selected path (directory and file) of the file dialog (empty if none).
</description>
</method>
<method name="get_vbox">
<return type="VBoxContainer">
</return>
@ -68,37 +47,19 @@
Invalidate and update the current dialog content list.
</description>
</method>
<method name="set_current_dir">
<return type="void">
</return>
<argument index="0" name="dir" type="String">
</argument>
<description>
Set the current working directory of the file dialog.
</description>
</method>
<method name="set_current_file">
<return type="void">
</return>
<argument index="0" name="file" type="String">
</argument>
<description>
Set the current selected file name of the file dialog.
</description>
</method>
<method name="set_current_path">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Set the current selected file path of the file dialog.
</description>
</method>
</methods>
<members>
<member name="access" type="int" setter="set_access" getter="get_access" enum="FileDialog.Access">
</member>
<member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir">
The current working directory of the file dialog.
</member>
<member name="current_file" type="String" setter="set_current_file" getter="get_current_file">
The currently selected file of the file dialog.
</member>
<member name="current_path" type="String" setter="set_current_path" getter="get_current_path">
The currently selected file path of the file dialog.
</member>
<member name="filters" type="PoolStringArray" setter="set_filters" getter="get_filters">
</member>
<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode">

178
doc/classes/GIProbeData.xml
View File

@ -9,161 +9,31 @@
<demos>
</demos>
<methods>
<method name="get_bias" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_bounds" qualifiers="const">
<return type="AABB">
</return>
<description>
</description>
</method>
<method name="get_cell_size" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_dynamic_data" qualifiers="const">
<return type="PoolIntArray">
</return>
<description>
</description>
</method>
<method name="get_dynamic_range" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_energy" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_normal_bias" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_propagation" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_to_cell_xform" qualifiers="const">
<return type="Transform">
</return>
<description>
</description>
</method>
<method name="is_compressed" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_interior" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_bias">
<return type="void">
</return>
<argument index="0" name="bias" type="float">
</argument>
<description>
</description>
</method>
<method name="set_bounds">
<return type="void">
</return>
<argument index="0" name="bounds" type="AABB">
</argument>
<description>
</description>
</method>
<method name="set_cell_size">
<return type="void">
</return>
<argument index="0" name="cell_size" type="float">
</argument>
<description>
</description>
</method>
<method name="set_compress">
<return type="void">
</return>
<argument index="0" name="compress" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_dynamic_data">
<return type="void">
</return>
<argument index="0" name="dynamic_data" type="PoolIntArray">
</argument>
<description>
</description>
</method>
<method name="set_dynamic_range">
<return type="void">
</return>
<argument index="0" name="dynamic_range" type="int">
</argument>
<description>
</description>
</method>
<method name="set_energy">
<return type="void">
</return>
<argument index="0" name="energy" type="float">
</argument>
<description>
</description>
</method>
<method name="set_interior">
<return type="void">
</return>
<argument index="0" name="interior" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_normal_bias">
<return type="void">
</return>
<argument index="0" name="bias" type="float">
</argument>
<description>
</description>
</method>
<method name="set_propagation">
<return type="void">
</return>
<argument index="0" name="propagation" type="float">
</argument>
<description>
</description>
</method>
<method name="set_to_cell_xform">
<return type="void">
</return>
<argument index="0" name="to_cell_xform" type="Transform">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="bias" type="float" setter="set_bias" getter="get_bias">
</member>
<member name="bounds" type="AABB" setter="set_bounds" getter="get_bounds">
</member>
<member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size">
</member>
<member name="compress" type="bool" setter="set_compress" getter="is_compressed">
</member>
<member name="dynamic_data" type="PoolIntArray" setter="set_dynamic_data" getter="get_dynamic_data">
</member>
<member name="dynamic_range" type="int" setter="set_dynamic_range" getter="get_dynamic_range">
</member>
<member name="energy" type="float" setter="set_energy" getter="get_energy">
</member>
<member name="interior" type="bool" setter="set_interior" getter="is_interior">
</member>
<member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias">
</member>
<member name="propagation" type="float" setter="set_propagation" getter="get_propagation">
</member>
<member name="to_cell_xform" type="Transform" setter="set_to_cell_xform" getter="get_to_cell_xform">
</member>
</members>
<constants>
</constants>
</class>

92
doc/classes/GraphEdit.xml
View File

@ -49,26 +49,6 @@
Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" }
</description>
</method>
<method name="get_scroll_ofs" qualifiers="const">
<return type="Vector2">
</return>
<description>
Return the scroll offset.
</description>
</method>
<method name="get_snap" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_zoom" qualifiers="const">
<return type="float">
</return>
<description>
Return the current zoom value.
</description>
</method>
<method name="is_node_connected">
<return type="bool">
</return>
@ -84,36 +64,6 @@
Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode.
</description>
</method>
<method name="is_right_disconnects_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise.
</description>
</method>
<method name="is_using_snap" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_right_disconnects">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void.
</description>
</method>
<method name="set_scroll_ofs">
<return type="void">
</return>
<argument index="0" name="ofs" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_selected">
<return type="void">
</return>
@ -122,32 +72,24 @@
<description>
</description>
</method>
<method name="set_snap">
<return type="void">
</return>
<argument index="0" name="pixels" type="int">
</argument>
<description>
</description>
</method>
<method name="set_use_snap">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_zoom">
<return type="void">
</return>
<argument index="0" name="p_zoom" type="float">
</argument>
<description>
Set the zoom value of the GraphEdit. Zoom value is between [0.01; 1.728].
</description>
</method>
</methods>
<members>
<member name="right_disconnects" type="bool" setter="set_right_disconnects" getter="is_right_disconnects_enabled">
If [code]true[/code], enables disconnection of existing connections in the GraphEdit by dragging the right end.
</member>
<member name="scroll_offset" type="Vector2" setter="set_scroll_ofs" getter="get_scroll_ofs">
The scroll offset.
</member>
<member name="snap_distance" type="int" setter="set_snap" getter="get_snap">
The snapping distance in pixels.
</member>
<member name="use_snap" type="bool" setter="set_use_snap" getter="is_using_snap">
If [code]true[/code], enables snapping.
</member>
<member name="zoom" type="float" setter="set_zoom" getter="get_zoom">
The current zoom value.
</member>
</members>
<signals>
<signal name="_begin_node_move">
<description>

67
doc/classes/GraphNode.xml
View File

@ -95,19 +95,6 @@
Return the type of the output connection 'idx'.
</description>
</method>
<method name="get_offset" qualifiers="const">
<return type="Vector2">
</return>
<description>
Return the offset of the GraphNode.
</description>
</method>
<method name="get_overlay" qualifiers="const">
<return type="int" enum="GraphNode.Overlay">
</return>
<description>
</description>
</method>
<method name="get_slot_color_left" qualifiers="const">
<return type="Color">
</return>
@ -144,18 +131,6 @@
Return the (integer) type of right (output) 'idx' slot.
</description>
</method>
<method name="is_comment" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_selected">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_slot_enabled_left" qualifiers="const">
<return type="bool">
</return>
@ -174,39 +149,6 @@
Return true if right (output) slot 'idx' is enabled. False otherwise.
</description>
</method>
<method name="set_comment">
<return type="void">
</return>
<argument index="0" name="comment" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_offset">
<return type="void">
</return>
<argument index="0" name="offset" type="Vector2">
</argument>
<description>
Set the offset of the GraphNode.
</description>
</method>
<method name="set_overlay">
<return type="void">
</return>
<argument index="0" name="overlay" type="int" enum="GraphNode.Overlay">
</argument>
<description>
</description>
</method>
<method name="set_selected">
<return type="void">
</return>
<argument index="0" name="selected" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_slot">
<return type="void">
</return>
@ -233,8 +175,17 @@
</method>
</methods>
<members>
<member name="comment" type="bool" setter="set_comment" getter="is_comment">
</member>
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset">
The offset of the GraphNode, relative to the scroll offset of the [GraphEdit]. Note that you cannot use position directly, as [GraphEdit] is a [Container].
</member>
<member name="overlay" type="int" setter="set_overlay" getter="get_overlay" enum="GraphNode.Overlay">
</member>
<member name="resizable" type="bool" setter="set_resizable" getter="is_resizable">
</member>
<member name="selected" type="bool" setter="set_selected" getter="is_selected">
</member>
<member name="show_close" type="bool" setter="set_show_close_button" getter="is_close_button_visible">
</member>
<member name="title" type="String" setter="set_title" getter="get_title">

40
doc/classes/HTTPClient.xml
View File

@ -39,13 +39,6 @@
[code]verify_host[/code] will check the SSL identity of the host if set to [code]true[/code].
</description>
</method>
<method name="get_connection" qualifiers="const">
<return type="StreamPeer">
</return>
<description>
Returns the current connection.
</description>
</method>
<method name="get_response_body_length" qualifiers="const">
<return type="int">
</return>
@ -90,13 +83,6 @@
If [code]true[/code] this [code]HTTPClient[/code] has a response available.
</description>
</method>
<method name="is_blocking_mode_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
If [code]true[/code] blocking mode is enabled.
</description>
</method>
<method name="is_response_chunked" qualifiers="const">
<return type="bool">
</return>
@ -172,24 +158,6 @@
Sends the body data raw, as a byte array and does not encode it in any way.
</description>
</method>
<method name="set_blocking_mode">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
If set to true, execution will block until all data is read from the response.
</description>
</method>
<method name="set_connection">
<return type="void">
</return>
<argument index="0" name="connection" type="StreamPeer">
</argument>
<description>
Sets connection to use for this client.
</description>
</method>
<method name="set_read_chunk_size">
<return type="void">
</return>
@ -200,6 +168,14 @@
</description>
</method>
</methods>
<members>
<member name="blocking_mode_enabled" type="bool" setter="set_blocking_mode" getter="is_blocking_mode_enabled">
If [code]true[/code], execution will block until all data is read from the response.
</member>
<member name="connection" type="StreamPeer" setter="set_connection" getter="get_connection">
The connection to use for this client.
</member>
</members>
<constants>
<constant name="METHOD_GET" value="0" enum="Method">
HTTP GET method. The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.

19
doc/classes/HTTPRequest.xml
View File

@ -26,13 +26,6 @@
Returns the response body length.
</description>
</method>
<method name="get_download_file" qualifiers="const">
<return type="String">
</return>
<description>
Returns the file this request will download into.
</description>
</method>
<method name="get_downloaded_bytes" qualifiers="const">
<return type="int">
</return>
@ -63,20 +56,14 @@
<description>
</description>
</method>
<method name="set_download_file">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Sets the file to download into. Outputs the response body into the file if set.
</description>
</method>
</methods>
<members>
<member name="body_size_limit" type="int" setter="set_body_size_limit" getter="get_body_size_limit">
Maximum allowed size for response bodies.
</member>
<member name="download_file" type="String" setter="set_download_file" getter="get_download_file">
The file to download into. Will output any received file into it.
</member>
<member name="max_redirects" type="int" setter="set_max_redirects" getter="get_max_redirects">
Maximum number of allowed redirects.
</member>

40
doc/classes/ImageTexture.xml
View File

@ -46,20 +46,6 @@
Return the format of the [code]ImageTexture[/code], one of [Image].FORMAT_*.
</description>
</method>
<method name="get_lossy_storage_quality" qualifiers="const">
<return type="float">
</return>
<description>
Return the storage quality for [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY.
</description>
</method>
<method name="get_storage" qualifiers="const">
<return type="int" enum="ImageTexture.Storage">
</return>
<description>
Return the storage type. One of [code]ImageTexture[/code].STORAGE_*.
</description>
</method>
<method name="load">
<return type="void">
</return>
@ -78,15 +64,6 @@
Set the [Image] of this [code]ImageTexture[/code].
</description>
</method>
<method name="set_lossy_storage_quality">
<return type="void">
</return>
<argument index="0" name="quality" type="float">
</argument>
<description>
Set the storage quality in case of [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY.
</description>
</method>
<method name="set_size_override">
<return type="void">
</return>
@ -96,16 +73,15 @@
Resizes the [code]ImageTexture[/code] to the specified dimensions.
</description>
</method>
<method name="set_storage">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="ImageTexture.Storage">
</argument>
<description>
Set the storage type. One of [code]ImageTexture[/code].STORAGE_*.
</description>
</method>
</methods>
<members>
<member name="lossy_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality">
The storage quality for [code]ImageTexture[/code].STORAGE_COMPRESS_LOSSY.
</member>
<member name="storage" type="int" setter="set_storage" getter="get_storage" enum="ImageTexture.Storage">
The storage type (raw, lossy, or compressed).
</member>
</members>
<constants>
<constant name="STORAGE_RAW" value="0" enum="Storage">
[Image] data is stored raw and unaltered.

16
doc/classes/ItemList.xml
View File

@ -53,12 +53,6 @@
Ensure selection is visible, adjusting the scroll position as necessary.
</description>
</method>
<method name="get_fixed_icon_size" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_item_at_position" qualifiers="const">
<return type="int">
</return>
@ -198,14 +192,6 @@
Note: This method does not trigger the item selection signal.
</description>
</method>
<method name="set_fixed_icon_size">
<return type="void">
</return>
<argument index="0" name="size" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_item_custom_bg_color">
<return type="void">
</return>
@ -328,6 +314,8 @@
</member>
<member name="fixed_column_width" type="int" setter="set_fixed_column_width" getter="get_fixed_column_width">
</member>
<member name="fixed_icon_size" type="Vector2" setter="set_fixed_icon_size" getter="get_fixed_icon_size">
</member>
<member name="icon_mode" type="int" setter="set_icon_mode" getter="get_icon_mode" enum="ItemList.IconMode">
</member>
<member name="icon_scale" type="float" setter="set_icon_scale" getter="get_icon_scale">

19
doc/classes/Label.xml
View File

@ -33,13 +33,6 @@
Returns the total length of the text.
</description>
</method>
<method name="get_visible_characters" qualifiers="const">
<return type="int">
</return>
<description>
Returns the restricted number of characters to display. Returns -1 if unrestricted.
</description>
</method>
<method name="get_visible_line_count" qualifiers="const">
<return type="int">
</return>
@ -47,15 +40,6 @@
Returns the number of lines shown. Useful if the [code]Label[/code] 's height cannot currently display all lines.
</description>
</method>
<method name="set_visible_characters">
<return type="void">
</return>
<argument index="0" name="amount" type="int">
</argument>
<description>
Restricts the number of characters to display. Set to -1 to disable.
</description>
</method>
</methods>
<members>
<member name="align" type="int" setter="set_align" getter="get_align" enum="Label.Align">
@ -85,6 +69,9 @@
<member name="valign" type="int" setter="set_valign" getter="get_valign" enum="Label.VAlign">
Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the [code]VALIGN_*[/code] constants.
</member>
<member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters">
Restricts the number of characters to display. Set to -1 to disable.
</member>
</members>
<constants>
<constant name="ALIGN_LEFT" value="0" enum="Align">

19
doc/classes/LineEdit.xml
View File

@ -34,13 +34,6 @@
Clears the current selection.
</description>
</method>
<method name="get_cursor_position" qualifiers="const">
<return type="int">
</return>
<description>
Returns the cursor position inside the [code]LineEdit[/code].
</description>
</method>
<method name="get_menu" qualifiers="const">
<return type="PopupMenu">
</return>
@ -81,15 +74,6 @@
Selects the whole [String].
</description>
</method>
<method name="set_cursor_position">
<return type="void">
</return>
<argument index="0" name="position" type="int">
</argument>
<description>
Sets the cursor position inside the [code]LineEdit[/code]. The text may scroll if needed.
</description>
</method>
</methods>
<members>
<member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align">
@ -101,6 +85,9 @@
<member name="caret_blink_speed" type="float" setter="cursor_set_blink_speed" getter="cursor_get_blink_speed">
Duration (in seconds) of a caret's blinking cycle.
</member>
<member name="caret_position" type="int" setter="set_cursor_position" getter="get_cursor_position">
The cursor's position inside the [code]LineEdit[/code]. When set, the text may scroll to accomodate it.
</member>
<member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled">
If [code]true[/code] the context menu will appear when right clicked.
</member>

33
doc/classes/NetworkedMultiplayerPeer.xml
View File

@ -32,13 +32,6 @@
Returns the ID of this [code]NetworkedMultiplayerPeer[/code].
</description>
</method>
<method name="is_refusing_new_connections" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code].
</description>
</method>
<method name="poll">
<return type="void">
</return>
@ -46,15 +39,6 @@
Waits up to 1 second to receive a new network event.
</description>
</method>
<method name="set_refuse_new_connections">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
If [code]true[/code] this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code].
</description>
</method>
<method name="set_target_peer">
<return type="void">
</return>
@ -64,16 +48,15 @@
The peer to which packets will be sent. Default value: [code]0[/code].
</description>
</method>
<method name="set_transfer_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="NetworkedMultiplayerPeer.TransferMode">
</argument>
<description>
The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode].
</description>
</method>
</methods>
<members>
<member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections">
If [code]true[/code] this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code].
</member>
<member name="transfer_mode" type="int" setter="set_transfer_mode" getter="get_transfer_mode" enum="NetworkedMultiplayerPeer.TransferMode">
The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode].
</member>
</members>
<signals>
<signal name="connection_failed">
<description>

58
doc/classes/Node.xml
View File

@ -184,13 +184,6 @@
Returns an array of references to node's children.
</description>
</method>
<method name="get_filename" qualifiers="const">
<return type="String">
</return>
<description>
Returns a filename that may be contained by the node. When a scene is instanced from a file, its topmost node contains the filename from which it was loaded (see [method set_filename]).
</description>
</method>
<method name="get_groups" qualifiers="const">
<return type="Array">
</return>
@ -205,13 +198,6 @@
Returns the node's index, i.e. its position among the siblings of its parent.
</description>
</method>
<method name="get_name" qualifiers="const">
<return type="String">
</return>
<description>
Returns the name of the node. This name is unique among the siblings (other child nodes from the same parent).
</description>
</method>
<method name="get_network_master" qualifiers="const">
<return type="int">
</return>
@ -255,13 +241,6 @@
<description>
</description>
</method>
<method name="get_owner" qualifiers="const">
<return type="Node">
</return>
<description>
Returns the node owner (see [method set_owner]).
</description>
</method>
<method name="get_parent" qualifiers="const">
<return type="Node">
</return>
@ -659,24 +638,6 @@
Sets the folded state of the node in the Scene dock.
</description>
</method>
<method name="set_filename">
<return type="void">
</return>
<argument index="0" name="filename" type="String">
</argument>
<description>
A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.
</description>
</method>
<method name="set_name">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Sets the name of the node. The name must be unique within the parent. Using an existing name will cause the node to be automatically renamed.
</description>
</method>
<method name="set_network_master">
<return type="void">
</return>
@ -688,15 +649,6 @@
Sets the node network master to the peer with the given peer ID. The network master is the peer that has authority over it on the network. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server).
</description>
</method>
<method name="set_owner">
<return type="void">
</return>
<argument index="0" name="owner" type="Node">
</argument>
<description>
Sets the node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows for the creation of complex [SceneTree]s, with instancing and subinstancing.
</description>
</method>
<method name="set_physics_process">
<return type="void">
</return>
@ -768,6 +720,16 @@
</method>
</methods>
<members>
<member name="filename" type="String" setter="set_filename" getter="get_filename">
When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.
</member>
<member name="name" type="String" setter="set_name" getter="get_name">
The name of the node. This name is unique among the siblings (other child nodes from the same parent).
When set to an existing name, the node will be automatically renamed
</member>
<member name="owner" type="Node" setter="set_owner" getter="get_owner">
The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows for the creation of complex [SceneTree]s, with instancing and subinstancing.
</member>
<member name="pause_mode" type="int" setter="set_pause_mode" getter="get_pause_mode" enum="Node.PauseMode">
</member>
</members>

17
doc/classes/Node2D.xml
View File

@ -38,12 +38,6 @@
Returns the [Transform2D] relative to this node's parent.
</description>
</method>
<method name="get_rotation" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="global_translate">
<return type="void">
</return>
@ -93,14 +87,6 @@
Applies a rotation to the node, in radians, starting from its current rotation.
</description>
</method>
<method name="set_rotation">
<return type="void">
</return>
<argument index="0" name="radians" type="float">
</argument>
<description>
</description>
</method>
<method name="to_global" qualifiers="const">
<return type="Vector2">
</return>
@ -148,6 +134,9 @@
<member name="position" type="Vector2" setter="set_position" getter="get_position">
Position, relative to the node's parent.
</member>
<member name="rotation" type="float" setter="set_rotation" getter="get_rotation">
Rotation in radians, relative to the node's parent.
</member>
<member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
Rotation in degrees, relative to the node's parent.
</member>

263
doc/classes/OS.xml
View File

@ -99,20 +99,6 @@
Returns the scancode of the given string (e.g. "Escape")
</description>
</method>
<method name="get_borderless_window" qualifiers="const">
<return type="bool">
</return>
<description>
Returns true if the current window is borderless.
</description>
</method>
<method name="get_clipboard" qualifiers="const">
<return type="String">
</return>
<description>
Get clipboard from the host OS.
</description>
</method>
<method name="get_cmdline_args">
<return type="PoolStringArray">
</return>
@ -120,13 +106,6 @@
Returns the command line arguments passed to the engine.
</description>
</method>
<method name="get_current_screen" qualifiers="const">
<return type="int">
</return>
<description>
Returns the current screen index (0 padded).
</description>
</method>
<method name="get_date" qualifiers="const">
<return type="Dictionary">
</return>
@ -178,12 +157,6 @@
Returns the path to the current engine executable.
</description>
</method>
<method name="get_exit_code" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_latin_keyboard_variant" qualifiers="const">
<return type="String">
</return>
@ -281,13 +254,6 @@
xxxhdpi - 640 dpi
</description>
</method>
<method name="get_screen_orientation" qualifiers="const">
<return type="int" enum="OS.ScreenOrientation">
</return>
<description>
Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class.
</description>
</method>
<method name="get_screen_position" qualifiers="const">
<return type="Vector2">
</return>
@ -403,20 +369,6 @@
<description>
</description>
</method>
<method name="get_window_position" qualifiers="const">
<return type="Vector2">
</return>
<description>
Returns the window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right.
</description>
</method>
<method name="get_window_size" qualifiers="const">
<return type="Vector2">
</return>
<description>
Returns the size of the window (without counting window manager decorations).
</description>
</method>
<method name="has_environment" qualifiers="const">
<return type="bool">
</return>
@ -464,20 +416,6 @@
Returns [code]false[/code] if the build is a release build.
</description>
</method>
<method name="is_in_low_processor_usage_mode" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if low cpu usage mode is enabled.
</description>
</method>
<method name="is_keep_screen_on" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the screen is being kept on.
</description>
</method>
<method name="is_ok_left_and_cancel_right" qualifiers="const">
<return type="bool">
</return>
@ -508,41 +446,6 @@
If [code]true[/code], the [code]user://[/code] file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable.
</description>
</method>
<method name="is_vsync_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if synchronizing the framerate to the monitor's refresh rate is enabled.
</description>
</method>
<method name="is_window_fullscreen" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the window is in fullscreen mode.
</description>
</method>
<method name="is_window_maximized" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the window is maximized.
</description>
</method>
<method name="is_window_minimized" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the window is minimized.
</description>
</method>
<method name="is_window_resizable" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the window is resizable.
</description>
</method>
<method name="kill">
<return type="int" enum="Error">
</return>
@ -636,42 +539,6 @@
Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX.
</description>
</method>
<method name="set_borderless_window">
<return type="void">
</return>
<argument index="0" name="borderless" type="bool">
</argument>
<description>
Removes the window frame.
</description>
</method>
<method name="set_clipboard">
<return type="void">
</return>
<argument index="0" name="clipboard" type="String">
</argument>
<description>
Sets clipboard to the OS.
</description>
</method>
<method name="set_current_screen">
<return type="void">
</return>
<argument index="0" name="screen" type="int">
</argument>
<description>
Sets the current screen by index.
</description>
</method>
<method name="set_exit_code">
<return type="void">
</return>
<argument index="0" name="code" type="int">
</argument>
<description>
Sets the exit code that will be returned by the game.
</description>
</method>
<method name="set_icon">
<return type="void">
</return>
@ -689,33 +556,6 @@
<description>
</description>
</method>
<method name="set_keep_screen_on">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Sets keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS)
</description>
</method>
<method name="set_low_processor_usage_mode">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set to [code]true[/code] to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. Use this in tool mode to reduce CPU usage.
</description>
</method>
<method name="set_screen_orientation">
<return type="void">
</return>
<argument index="0" name="orientation" type="int" enum="OS.ScreenOrientation">
</argument>
<description>
Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class.
</description>
</method>
<method name="set_thread_name">
<return type="int" enum="Error">
</return>
@ -734,69 +574,6 @@
Enables backup saves if [code]enabled[/code] is [code]true[/code].
</description>
</method>
<method name="set_use_vsync">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
If [code]true[/code] the framerate will synchronize to the monitor's refresh rate.
</description>
</method>
<method name="set_window_fullscreen">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Sets window fullscreen mode to the [i]enabled[/i] argument, [i]enabled[/i] is a toggle for the fullscreen mode, calling the function with [i]enabled[/i] true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with [i]enabled[/i] false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode.
</description>
</method>
<method name="set_window_maximized">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set [code]true[/code] to maximize the window.
</description>
</method>
<method name="set_window_minimized">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set [code]true[/code] to minimize the window.
</description>
</method>
<method name="set_window_position">
<return type="void">
</return>
<argument index="0" name="position" type="Vector2">
</argument>
<description>
Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen).
</description>
</method>
<method name="set_window_resizable">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Sets the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings.
</description>
</method>
<method name="set_window_size">
<return type="void">
</return>
<argument index="0" name="size" type="Vector2">
</argument>
<description>
Sets the window size to the specified size.
</description>
</method>
<method name="set_window_title">
<return type="void">
</return>
@ -827,6 +604,46 @@
</description>
</method>
</methods>
<members>
<member name="clipboard" type="String" setter="set_clipboard" getter="get_clipboard">
The clipboard from the host OS. Might be unavailable on some platforms.
</member>
<member name="current_screen" type="int" setter="set_current_screen" getter="get_current_screen">
The current screen index (starting from 0).
</member>
<member name="exit_code" type="int" setter="set_exit_code" getter="get_exit_code">
</member>
<member name="keep_screen_on" type="bool" setter="set_keep_screen_on" getter="is_keep_screen_on">
</member>
<member name="low_processor_usage_mode" type="bool" setter="set_low_processor_usage_mode" getter="is_in_low_processor_usage_mode">
</member>
<member name="screen_orientation" type="int" setter="set_screen_orientation" getter="get_screen_orientation" enum="_OS.ScreenOrientation">
The current screen orientation.
</member>
<member name="vsync_enabled" type="bool" setter="set_use_vsync" getter="is_vsync_enabled">
</member>
<member name="window_borderless" type="bool" setter="set_borderless_window" getter="get_borderless_window">
If [code]true[/code], removes the window frame.
</member>
<member name="window_fullscreen" type="bool" setter="set_window_fullscreen" getter="is_window_fullscreen">
If [code]true[/code], the window is fullscreen.
</member>
<member name="window_maximized" type="bool" setter="set_window_maximized" getter="is_window_maximized">
If [code]true[/code], the window is maximized.
</member>
<member name="window_minimized" type="bool" setter="set_window_minimized" getter="is_window_minimized">
If [code]true[/code], the window is minimized.
</member>
<member name="window_position" type="Vector2" setter="set_window_position" getter="get_window_position">
The window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right.
</member>
<member name="window_resizable" type="bool" setter="set_window_resizable" getter="is_window_resizable">
If [code]true[/code], the window is resizable by the user.
</member>
<member name="window_size" type="Vector2" setter="set_window_size" getter="get_window_size">
The size of the window (without counting window manager decorations).
</member>
</members>
<constants>
<constant name="DAY_SUNDAY" value="0" enum="Weekday">
</constant>

18
doc/classes/PacketPeer.xml
View File

@ -39,12 +39,6 @@
Get a Variant.
</description>
</method>
<method name="is_object_decoding_allowed" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="put_packet">
<return type="int" enum="Error">
</return>
@ -63,15 +57,11 @@
Send a Variant as a packet.
</description>
</method>
<method name="set_allow_object_decoding">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="allow_object_decoding" type="bool" setter="set_allow_object_decoding" getter="is_object_decoding_allowed">
</member>
</members>
<constants>
</constants>
</class>

46
doc/classes/PacketPeerStream.xml
View File

@ -11,44 +11,16 @@
<demos>
</demos>
<methods>
<method name="get_input_buffer_max_size" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_output_buffer_max_size" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="set_input_buffer_max_size">
<return type="void">
</return>
<argument index="0" name="max_size_bytes" type="int">
</argument>
<description>
</description>
</method>
<method name="set_output_buffer_max_size">
<return type="void">
</return>
<argument index="0" name="max_size_bytes" type="int">
</argument>
<description>
</description>
</method>
<method name="set_stream_peer">
<return type="void">
</return>
<argument index="0" name="peer" type="Reference">
</argument>
<description>
Set the [StreamPeer] object to be wrapped.
</description>
</method>
</methods>
<members>
<member name="input_buffer_max_size" type="int" setter="set_input_buffer_max_size" getter="get_input_buffer_max_size">
</member>
<member name="output_buffer_max_size" type="int" setter="set_output_buffer_max_size" getter="get_output_buffer_max_size">
</member>
<member name="stream_peer" type="StreamPeer" setter="set_stream_peer" getter="get_stream_peer">
The wrapped [StreamPeer] object.
</member>
</members>
<constants>
</constants>
</class>

140
doc/classes/PathFollow.xml
View File

@ -12,122 +12,32 @@
<demos>
</demos>
<methods>
<method name="get_cubic_interpolation" qualifiers="const">
<return type="bool">
</return>
<description>
This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly.
</description>
</method>
<method name="get_h_offset" qualifiers="const">
<return type="float">
</return>
<description>
Returns the X displacement this node has from its parent [Path].
</description>
</method>
<method name="get_offset" qualifiers="const">
<return type="float">
</return>
<description>
Returns the distance along the path in 3D units.
</description>
</method>
<method name="get_rotation_mode" qualifiers="const">
<return type="int" enum="PathFollow.RotationMode">
</return>
<description>
Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode.
</description>
</method>
<method name="get_unit_offset" qualifiers="const">
<return type="float">
</return>
<description>
Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last).
</description>
</method>
<method name="get_v_offset" qualifiers="const">
<return type="float">
</return>
<description>
Returns the Y displacement this node has from its parent [Path].
</description>
</method>
<method name="has_loop" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether this node wraps its offsets around, or truncates them to the path ends.
</description>
</method>
<method name="set_cubic_interpolation">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
The points along the [Curve3D] of the [Path] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
This method controls whether the position between two cached points is interpolated linearly, or cubicly.
</description>
</method>
<method name="set_h_offset">
<return type="void">
</return>
<argument index="0" name="h_offset" type="float">
</argument>
<description>
Moves this node in the X axis. As this node's position will be set every time its offset is set, this allows many PathFollow to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset.
A similar effect may be achieved moving the this node's descendants.
</description>
</method>
<method name="set_loop">
<return type="void">
</return>
<argument index="0" name="loop" type="bool">
</argument>
<description>
If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths.
</description>
</method>
<method name="set_offset">
<return type="void">
</return>
<argument index="0" name="offset" type="float">
</argument>
<description>
Sets the distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path.
</description>
</method>
<method name="set_rotation_mode">
<return type="void">
</return>
<argument index="0" name="rotation_mode" type="int" enum="PathFollow.RotationMode">
</argument>
<description>
Allows or forbids rotation on one or more axes, per the constants below.
</description>
</method>
<method name="set_unit_offset">
<return type="void">
</return>
<argument index="0" name="unit_offset" type="float">
</argument>
<description>
Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
</description>
</method>
<method name="set_v_offset">
<return type="void">
</return>
<argument index="0" name="v_offset" type="float">
</argument>
<description>
Moves this node in the Y axis, for the same reasons of [method set_h_offset].
</description>
</method>
</methods>
<members>
<member name="cubic_interp" type="bool" setter="set_cubic_interpolation" getter="get_cubic_interpolation">
If [code]true[/code] the position between two cached points is interpolated cubically, and linearly otherwise.
The points along the [Curve3D] of the [Path] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
</member>
<member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset">
The node's offset along the curve.
</member>
<member name="loop" type="bool" setter="set_loop" getter="has_loop">
If [code]true[/code], any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths.
</member>
<member name="offset" type="float" setter="set_offset" getter="get_offset">
The distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path.
</member>
<member name="rotation_mode" type="int" setter="set_rotation_mode" getter="get_rotation_mode" enum="PathFollow.RotationMode">
Allows or forbids rotation on one or more axes, depending on the constants being used.
</member>
<member name="unit_offset" type="float" setter="set_unit_offset" getter="get_unit_offset">
The distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
</member>
<member name="v_offset" type="float" setter="set_v_offset" getter="get_v_offset">
The node's offset perpendicular to the curve.
</member>
</members>
<constants>
<constant name="ROTATION_NONE" value="0" enum="RotationMode">
Forbids the PathFollow to rotate.

142
doc/classes/PathFollow2D.xml
View File

@ -12,122 +12,34 @@
<demos>
</demos>
<methods>
<method name="get_cubic_interpolation" qualifiers="const">
<return type="bool">
</return>
<description>
This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly.
</description>
</method>
<method name="get_h_offset" qualifiers="const">
<return type="float">
</return>
<description>
Returns the horizontal displacement this node has from its parent [Path2D].
</description>
</method>
<method name="get_offset" qualifiers="const">
<return type="float">
</return>
<description>
Returns the distance along the path in pixels.
</description>
</method>
<method name="get_unit_offset" qualifiers="const">
<return type="float">
</return>
<description>
Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last).
</description>
</method>
<method name="get_v_offset" qualifiers="const">
<return type="float">
</return>
<description>
Returns the vertical displacement this node has from its parent [Path2D].
</description>
</method>
<method name="has_loop" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether this node wraps its offsets around, or truncates them to the path ends.
</description>
</method>
<method name="is_rotating" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether this node rotates to follow the path.
</description>
</method>
<method name="set_cubic_interpolation">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
The points along the [Curve2D] of the [Path2D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
This method controls whether the position between two cached points is interpolated linearly, or cubicly.
</description>
</method>
<method name="set_h_offset">
<return type="void">
</return>
<argument index="0" name="h_offset" type="float">
</argument>
<description>
Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset.
A similar effect may be achieved moving this node's descendants.
</description>
</method>
<method name="set_loop">
<return type="void">
</return>
<argument index="0" name="loop" type="bool">
</argument>
<description>
If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths.
</description>
</method>
<method name="set_offset">
<return type="void">
</return>
<argument index="0" name="offset" type="float">
</argument>
<description>
Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path.
</description>
</method>
<method name="set_rotate">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
If set, this node rotates to follow the path, making its descendants rotate.
</description>
</method>
<method name="set_unit_offset">
<return type="void">
</return>
<argument index="0" name="unit_offset" type="float">
</argument>
<description>
Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
</description>
</method>
<method name="set_v_offset">
<return type="void">
</return>
<argument index="0" name="v_offset" type="float">
</argument>
<description>
Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset].
</description>
</method>
</methods>
<members>
<member name="cubic_interp" type="bool" setter="set_cubic_interpolation" getter="get_cubic_interpolation">
If [code]true[/code] the position between two cached points is interpolated cubically, and linearly otherwise.
The points along the [Curve2D] of the [Path2D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
</member>
<member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset">
The node's offset along the curve.
</member>
<member name="lookahead" type="float" setter="set_lookahead" getter="get_lookahead">
</member>
<member name="loop" type="bool" setter="set_loop" getter="has_loop">
If [code]true[/code], any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths.
</member>
<member name="offset" type="float" setter="set_offset" getter="get_offset">
The distance along the path in pixels.
</member>
<member name="rotate" type="bool" setter="set_rotate" getter="is_rotating">
If [code]true[/code], this node rotates to follow the path, making its descendants rotate.
</member>
<member name="unit_offset" type="float" setter="set_unit_offset" getter="get_unit_offset">
The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
</member>
<member name="v_offset" type="float" setter="set_v_offset" getter="get_v_offset">
The node's offset perpendicular to the curve.
</member>
</members>
<constants>
</constants>
</class>

138
doc/classes/Physics2DDirectBodyState.xml
View File

@ -11,13 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_angular_velocity" qualifiers="const">
<return type="float">
</return>
<description>
Return the angular velocity of the body.
</description>
</method>
<method name="get_contact_collider" qualifiers="const">
<return type="RID">
</return>
@ -115,27 +108,6 @@
Return the local shape index of the collision.
</description>
</method>
<method name="get_inverse_inertia" qualifiers="const">
<return type="float">
</return>
<description>
Return the inverse of the inertia of the body.
</description>
</method>
<method name="get_inverse_mass" qualifiers="const">
<return type="float">
</return>
<description>
Return the inverse of the mass of the body.
</description>
</method>
<method name="get_linear_velocity" qualifiers="const">
<return type="Vector2">
</return>
<description>
Return the current linear velocity of the body.
</description>
</method>
<method name="get_space_state">
<return type="Physics2DDirectSpaceState">
</return>
@ -143,41 +115,6 @@
Return the current state of space, useful for queries.
</description>
</method>
<method name="get_step" qualifiers="const">
<return type="float">
</return>
<description>
Return the timestep (delta) used for the simulation.
</description>
</method>
<method name="get_total_angular_damp" qualifiers="const">
<return type="float">
</return>
<description>
Return the rate at which the body stops rotating, if there are not any other forces moving it.
</description>
</method>
<method name="get_total_gravity" qualifiers="const">
<return type="Vector2">
</return>
<description>
Return the total gravity vector being currently applied to this body.
</description>
</method>
<method name="get_total_linear_damp" qualifiers="const">
<return type="float">
</return>
<description>
Return the rate at which the body stops moving, if there are not any other forces moving it.
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform2D">
</return>
<description>
Return the transform matrix of the body.
</description>
</method>
<method name="integrate_forces">
<return type="void">
</return>
@ -185,50 +122,39 @@
Call the built-in force integration code.
</description>
</method>
<method name="is_sleeping" qualifiers="const">
<return type="bool">
</return>
<description>
Return true if this body is currently sleeping (not active).
</description>
</method>
<method name="set_angular_velocity">
<return type="void">
</return>
<argument index="0" name="velocity" type="float">
</argument>
<description>
Change the angular velocity of the body.
</description>
</method>
<method name="set_linear_velocity">
<return type="void">
</return>
<argument index="0" name="velocity" type="Vector2">
</argument>
<description>
Change the linear velocity of the body.
</description>
</method>
<method name="set_sleep_state">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set the sleeping state of the body, only affects character/rigid bodies.
</description>
</method>
<method name="set_transform">
<return type="void">
</return>
<argument index="0" name="transform" type="Transform2D">
</argument>
<description>
Change the transform matrix of the body.
</description>
</method>
</methods>
<members>
<member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity">
The angular velocity of the body.
</member>
<member name="inverse_inertia" type="float" setter="" getter="get_inverse_inertia">
The inverse of the inertia of the body.
</member>
<member name="inverse_mass" type="float" setter="" getter="get_inverse_mass">
The inverse of the mass of the body.
</member>
<member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity">
The linear velocity of the body.
</member>
<member name="sleeping" type="bool" setter="set_sleep_state" getter="is_sleeping">
[code]true[/code] if this body is currently sleeping (not active).
</member>
<member name="step" type="float" setter="" getter="get_step">
The timestep (delta) used for the simulation.
</member>
<member name="total_angular_damp" type="float" setter="" getter="get_total_angular_damp">
The rate at which the body stops rotating, if there are not any other forces moving it.
</member>
<member name="total_gravity" type="Vector2" setter="" getter="get_total_gravity">
The total gravity vector being currently applied to this body.
</member>
<member name="total_linear_damp" type="float" setter="" getter="get_total_linear_damp">
The rate at which the body stops moving, if there are not any other forces moving it.
</member>
<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
The transformation matrix of the body.
</member>
</members>
<constants>
</constants>
</class>

116
doc/classes/Physics2DShapeQueryParameters.xml
View File

@ -11,84 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_collision_layer" qualifiers="const">
<return type="int">
</return>
<description>
Return the physics layer the shape belongs to.
</description>
</method>
<method name="get_exclude" qualifiers="const">
<return type="Array">
</return>
<description>
Return the list of objects, or object [RID]s, that will be excluded from collisions.
</description>
</method>
<method name="get_margin" qualifiers="const">
<return type="float">
</return>
<description>
Return the collision margin for the shape.
</description>
</method>
<method name="get_motion" qualifiers="const">
<return type="Vector2">
</return>
<description>
Return the current movement speed of the shape.
</description>
</method>
<method name="get_shape_rid" qualifiers="const">
<return type="RID">
</return>
<description>
Return the [RID] of the shape queried.
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform2D">
</return>
<description>
Return the transform matrix of the shape queried.
</description>
</method>
<method name="set_collision_layer">
<return type="void">
</return>
<argument index="0" name="collision_layer" type="int">
</argument>
<description>
Set the physics layer the shape belongs to.
</description>
</method>
<method name="set_exclude">
<return type="void">
</return>
<argument index="0" name="exclude" type="Array">
</argument>
<description>
Set the list of objects, or object [RID]s, that will be excluded from collisions.
</description>
</method>
<method name="set_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="float">
</argument>
<description>
Set the collision margin for the shape. A collision margin is an amount (in pixels) that the shape will grow when computing collisions, to account for numerical imprecision.
</description>
</method>
<method name="set_motion">
<return type="void">
</return>
<argument index="0" name="motion" type="Vector2">
</argument>
<description>
Set the current movement speed of the shape.
</description>
</method>
<method name="set_shape">
<return type="void">
</return>
@ -98,25 +20,27 @@
Set the [Shape2D] that will be used for collision/intersection queries.
</description>
</method>
<method name="set_shape_rid">
<return type="void">
</return>
<argument index="0" name="shape" type="RID">
</argument>
<description>
Set the [RID] of the shape to be used in queries.
</description>
</method>
<method name="set_transform">
<return type="void">
</return>
<argument index="0" name="transform" type="Transform2D">
</argument>
<description>
Set the transformation matrix of the shape. This is necessary to set its position/rotation/scale.
</description>
</method>
</methods>
<members>
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer">
The physics layer the query should be made on.
</member>
<member name="exclude" type="Array" setter="set_exclude" getter="get_exclude">
The list of objects or object [RID]s, that will be excluded from collisions.
</member>
<member name="margin" type="float" setter="set_margin" getter="get_margin">
The collision margin for the shape.
</member>
<member name="motion" type="Vector2" setter="set_motion" getter="get_motion">
The motion of the shape being queried for.
</member>
<member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid">
The [RID] of the queried shape. See [method set_shape] also.
</member>
<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
the transform matrix of the queried shape.
</member>
</members>
<constants>
</constants>
</class>

74
doc/classes/Physics2DTestMotionResult.xml
View File

@ -9,61 +9,27 @@
<demos>
</demos>
<methods>
<method name="get_collider" qualifiers="const">
<return type="Object">
</return>
<description>
</description>
</method>
<method name="get_collider_id" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_collider_rid" qualifiers="const">
<return type="RID">
</return>
<description>
</description>
</method>
<method name="get_collider_shape" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_collider_velocity" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_collision_normal" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_collision_point" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_motion" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_motion_remainder" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="collider" type="Object" setter="" getter="get_collider">
</member>
<member name="collider_id" type="int" setter="" getter="get_collider_id">
</member>
<member name="collider_rid" type="RID" setter="" getter="get_collider_rid">
</member>
<member name="collider_shape" type="int" setter="" getter="get_collider_shape">
</member>
<member name="collider_velocity" type="Vector2" setter="" getter="get_collider_velocity">
</member>
<member name="collision_normal" type="Vector2" setter="" getter="get_collision_normal">
</member>
<member name="collision_point" type="Vector2" setter="" getter="get_collision_point">
</member>
<member name="motion" type="Vector2" setter="" getter="get_motion">
</member>
<member name="motion_remainder" type="Vector2" setter="" getter="get_motion_remainder">
</member>
</members>
<constants>
</constants>
</class>

140
doc/classes/PhysicsDirectBodyState.xml
View File

@ -37,18 +37,6 @@
<description>
</description>
</method>
<method name="get_angular_velocity" qualifiers="const">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="get_center_of_mass" qualifiers="const">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="get_contact_collider" qualifiers="const">
<return type="RID">
</return>
@ -127,111 +115,55 @@
<description>
</description>
</method>
<method name="get_inverse_inertia" qualifiers="const">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="get_inverse_mass" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_linear_velocity" qualifiers="const">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="get_principal_inertia_axes" qualifiers="const">
<return type="Basis">
</return>
<description>
</description>
</method>
<method name="get_space_state">
<return type="PhysicsDirectSpaceState">
</return>
<description>
</description>
</method>
<method name="get_step" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_total_angular_damp" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_total_gravity" qualifiers="const">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="get_total_linear_damp" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform">
</return>
<description>
</description>
</method>
<method name="integrate_forces">
<return type="void">
</return>
<description>
</description>
</method>
<method name="is_sleeping" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_angular_velocity">
<return type="void">
</return>
<argument index="0" name="velocity" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="set_linear_velocity">
<return type="void">
</return>
<argument index="0" name="velocity" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="set_sleep_state">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_transform">
<return type="void">
</return>
<argument index="0" name="transform" type="Transform">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity">
The angular velocity of the body.
</member>
<member name="center_of_mass" type="Vector3" setter="" getter="get_center_of_mass">
</member>
<member name="inverse_inertia" type="Vector3" setter="" getter="get_inverse_inertia">
The inverse of the inertia of the body.
</member>
<member name="inverse_mass" type="float" setter="" getter="get_inverse_mass">
The inverse of the mass of the body.
</member>
<member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity">
The linear velocity of the body.
</member>
<member name="principal_inertia_axes" type="Basis" setter="" getter="get_principal_inertia_axes">
</member>
<member name="sleeping" type="bool" setter="set_sleep_state" getter="is_sleeping">
[code]true[/code] if this body is currently sleeping (not active).
</member>
<member name="step" type="float" setter="" getter="get_step">
The timestep (delta) used for the simulation.
</member>
<member name="total_angular_damp" type="float" setter="" getter="get_total_angular_damp">
The rate at which the body stops rotating, if there are not any other forces moving it.
</member>
<member name="total_gravity" type="Vector3" setter="" getter="get_total_gravity">
The total gravity vector being currently applied to this body.
</member>
<member name="total_linear_damp" type="float" setter="" getter="get_total_linear_damp">
The rate at which the body stops moving, if there are not any other forces moving it.
</member>
<member name="transform" type="Transform" setter="set_transform" getter="get_transform">
The transformation matrix of the body.
</member>
</members>
<constants>
</constants>
</class>

82
doc/classes/PhysicsShapeQueryParameters.xml
View File

@ -9,60 +9,6 @@
<demos>
</demos>
<methods>
<method name="get_collision_mask" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_exclude" qualifiers="const">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_margin" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_shape_rid" qualifiers="const">
<return type="RID">
</return>
<description>
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform">
</return>
<description>
</description>
</method>
<method name="set_collision_mask">
<return type="void">
</return>
<argument index="0" name="collision_mask" type="int">
</argument>
<description>
</description>
</method>
<method name="set_exclude">
<return type="void">
</return>
<argument index="0" name="exclude" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="float">
</argument>
<description>
</description>
</method>
<method name="set_shape">
<return type="void">
</return>
@ -71,23 +17,19 @@
<description>
</description>
</method>
<method name="set_shape_rid">
<return type="void">
</return>
<argument index="0" name="shape" type="RID">
</argument>
<description>
</description>
</method>
<method name="set_transform">
<return type="void">
</return>
<argument index="0" name="transform" type="Transform">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
</member>
<member name="exclude" type="Array" setter="set_exclude" getter="get_exclude">
</member>
<member name="margin" type="float" setter="set_margin" getter="get_margin">
</member>
<member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid">
</member>
<member name="transform" type="Transform" setter="set_transform" getter="get_transform">
</member>
</members>
<constants>
</constants>
</class>

19
doc/classes/Polygon2D.xml
View File

@ -11,22 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_texture_rotation" qualifiers="const">
<return type="float">
</return>
<description>
Return the rotation in radians of the texture polygon.
</description>
</method>
<method name="set_texture_rotation">
<return type="void">
</return>
<argument index="0" name="texture_rotation" type="float">
</argument>
<description>
Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation.
</description>
</method>
</methods>
<members>
<member name="antialiased" type="bool" setter="set_antialiased" getter="get_antialiased">
@ -54,6 +38,9 @@
Amount to offset the polygon's [code]texture[/code]. If [code](0, 0)[/code] the texture's origin (its top-left corner) will be placed at the polygon's [code]position[/code].
</member>
<member name="texture_rotation" type="float" setter="set_texture_rotation_degrees" getter="get_texture_rotation_degrees">
The texture's rotation in radians.
</member>
<member name="texture_rotation_degrees" type="float" setter="set_texture_rotation_degrees" getter="get_texture_rotation_degrees">
The texture's rotation in degrees.
</member>
<member name="texture_scale" type="Vector2" setter="set_texture_scale" getter="get_texture_scale">

16
doc/classes/PopupMenu.xml
View File

@ -233,12 +233,6 @@
<description>
</description>
</method>
<method name="is_hide_on_state_item_selection" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_item_checkable" qualifiers="const">
<return type="bool">
</return>
@ -284,14 +278,6 @@
Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one.
</description>
</method>
<method name="set_hide_on_state_item_selection">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_item_accelerator">
<return type="void">
</return>
@ -455,6 +441,8 @@
</member>
<member name="hide_on_item_selection" type="bool" setter="set_hide_on_item_selection" getter="is_hide_on_item_selection">
</member>
<member name="hide_on_state_item_selection" type="bool" setter="set_hide_on_state_item_selection" getter="is_hide_on_state_item_selection">
</member>
</members>
<signals>
<signal name="id_pressed">

24
doc/classes/ProximityGroup.xml
View File

@ -21,26 +21,14 @@
<description>
</description>
</method>
<method name="set_dispatch_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int">
</argument>
<description>
</description>
</method>
<method name="set_group_name">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="dispatch_mode" type="int" setter="set_dispatch_mode" getter="get_dispatch_mode" enum="ProximityGroup.DispatchMode">
</member>
<member name="grid_radius" type="Vector3" setter="set_grid_radius" getter="get_grid_radius">
</member>
<member name="group_name" type="String" setter="set_group_name" getter="get_group_name">
</member>
</members>
<signals>
<signal name="broadcast">
@ -53,5 +41,9 @@
</signal>
</signals>
<constants>
<constant name="MODE_PROXY" value="0" enum="DispatchMode">
</constant>
<constant name="MODE_SIGNAL" value="1" enum="DispatchMode">
</constant>
</constants>
</class>

19
doc/classes/Range.xml
View File

@ -11,22 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_as_ratio" qualifiers="const">
<return type="float">
</return>
<description>
Return value mapped to 0 to 1 range.
</description>
</method>
<method name="set_as_ratio">
<return type="void">
</return>
<argument index="0" name="value" type="float">
</argument>
<description>
Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max.
</description>
</method>
<method name="share">
<return type="void">
</return>
@ -57,6 +41,9 @@
<member name="page" type="float" setter="set_page" getter="get_page">
Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code].
</member>
<member name="ratio" type="float" setter="set_as_ratio" getter="get_as_ratio">
The value mapped between 0 and 1.
</member>
<member name="rounded" type="bool" setter="set_use_rounded_values" getter="is_using_rounded_values">
If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer.
</member>

115
doc/classes/RichTextLabel.xml
View File

@ -53,20 +53,6 @@
Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line.
</description>
</method>
<method name="get_tab_size" qualifiers="const">
<return type="int">
</return>
<description>
Returns the number of spaces associated with a single tab length. Does not affect "\t" in text tags, only indent tags.
</description>
</method>
<method name="get_text">
<return type="String">
</return>
<description>
Returns the raw content of [member bbcode_text].
</description>
</method>
<method name="get_total_character_count" qualifiers="const">
<return type="int">
</return>
@ -88,34 +74,6 @@
Returns the number of visible lines.
</description>
</method>
<method name="is_meta_underlined" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the label underlines meta tags such as [url]{text}[/url].
</description>
</method>
<method name="is_scroll_active" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the scrollbar is visible. Does not block scrolling completely. See [method scroll_to_line].
</description>
</method>
<method name="is_scroll_following" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the window scrolls down to display new content automatically.
</description>
</method>
<method name="is_selection_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the label allows text selection.
</description>
</method>
<method name="newline">
<return type="void">
</return>
@ -234,51 +192,6 @@
Scrolls the window's top line to match [code]line[/code].
</description>
</method>
<method name="set_meta_underline">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
If [code]true[/code] will underline meta tags such as the [url] bbcode. Default value: [code]true[/code].
</description>
</method>
<method name="set_scroll_active">
<return type="void">
</return>
<argument index="0" name="active" type="bool">
</argument>
<description>
If [code]false[/code] the vertical scrollbar is hidden. Default value: [code]true[/code].
</description>
</method>
<method name="set_scroll_follow">
<return type="void">
</return>
<argument index="0" name="follow" type="bool">
</argument>
<description>
If [code]true[/code] the window scrolls to reveal new content. Default value: [code]false[/code].
</description>
</method>
<method name="set_selection_enabled">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
If [code]true[/code] text can be selected.
</description>
</method>
<method name="set_tab_size">
<return type="void">
</return>
<argument index="0" name="spaces" type="int">
</argument>
<description>
Sets the current tab length in spaces. Use with [method push_indent] to redefine indent length.
</description>
</method>
<method name="set_table_column_expand">
<return type="void">
</return>
@ -294,15 +207,6 @@
Columns with a [code]false[/code] expand will not contribute to the total ratio.
</description>
</method>
<method name="set_text">
<return type="void">
</return>
<argument index="0" name="text" type="String">
</argument>
<description>
Clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify [member bbcode_text].
</description>
</method>
</methods>
<members>
<member name="bbcode_enabled" type="bool" setter="set_use_bbcode" getter="is_using_bbcode">
@ -311,12 +215,31 @@
<member name="bbcode_text" type="String" setter="set_bbcode" getter="get_bbcode">
The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited.
</member>
<member name="meta_underlined" type="bool" setter="set_meta_underline" getter="is_meta_underlined">
If [code]true[/code], the label underlines meta tags such as [url]{text}[/url]. Default value: [code]true[/code].
</member>
<member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color">
If [code]true[/code] the label uses the custom font color. Default value: [code]false[/code].
</member>
<member name="percent_visible" type="float" setter="set_percent_visible" getter="get_percent_visible">
The text's visibility, as a [float] between 0.0 and 1.0.
</member>
<member name="scroll_active" type="bool" setter="set_scroll_active" getter="is_scroll_active">
If [code]true[/code], the scrollbar is visible. Does not block scrolling completely. See [method scroll_to_line]. Default value: [code]true[/code].
</member>
<member name="scroll_following" type="bool" setter="set_scroll_follow" getter="is_scroll_following">
If [code]true[/code], the window scrolls down to display new content automatically. Default value: [code]false[/code].
</member>
<member name="selection_enabled" type="bool" setter="set_selection_enabled" getter="is_selection_enabled">
If [code]true[/code], the label allows text selection.
</member>
<member name="tab_size" type="int" setter="set_tab_size" getter="get_tab_size">
The number of spaces associated with a single tab length. Does not affect "\t" in text tags, only indent tags.
</member>
<member name="text" type="String" setter="set_text" getter="get_text">
The raw text of the label.
When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify [member bbcode_text].
</member>
<member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters">
The restricted number of characters to display in the label.
</member>

57
doc/classes/RigidBody2D.xml
View File

@ -49,20 +49,6 @@
Applies a positioned impulse to the body (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied instantaneously. Both the impulse and the offset from the body origin are in global coordinates.
</description>
</method>
<method name="get_applied_force" qualifiers="const">
<return type="Vector2">
</return>
<description>
Returns the body's total applied force.
</description>
</method>
<method name="get_applied_torque" qualifiers="const">
<return type="float">
</return>
<description>
Returns the body's total applied torque.
</description>
</method>
<method name="get_colliding_bodies" qualifiers="const">
<return type="Array">
</return>
@ -70,31 +56,6 @@
Returns a list of the bodies colliding with this one. Use [member contacts_reported] to set the maximum number reported. You must also set [member contact_monitor] to [code]true[/code]. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead.
</description>
</method>
<method name="get_inertia" qualifiers="const">
<return type="float">
</return>
<description>
Returns the body's moment of inertia, which is computed automatically from the body's mass and assigned [Shape2D]s during the physics frame. Note that it will not yet have a value in the [code]_ready()[/code] function.
</description>
</method>
<method name="set_applied_force">
<return type="void">
</return>
<argument index="0" name="force" type="Vector2">
</argument>
<description>
Sets the applied force vector. This is the equivalent of firing a rocket: the force is applied constantly.
</description>
</method>
<method name="set_applied_torque">
<return type="void">
</return>
<argument index="0" name="torque" type="float">
</argument>
<description>
Sets the applied torque.
</description>
</method>
<method name="set_axis_velocity">
<return type="void">
</return>
@ -104,15 +65,6 @@
Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
</description>
</method>
<method name="set_inertia">
<return type="void">
</return>
<argument index="0" name="inertia" type="float">
</argument>
<description>
Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it.
</description>
</method>
<method name="test_motion">
<return type="bool">
</return>
@ -134,6 +86,12 @@
<member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity">
The body's rotational velocity.
</member>
<member name="applied_force" type="Vector2" setter="set_applied_force" getter="get_applied_force">
The body's total applied force.
</member>
<member name="applied_torque" type="float" setter="set_applied_torque" getter="get_applied_torque">
The body's total applied torque.
</member>
<member name="bounce" type="float" setter="set_bounce" getter="get_bounce">
The body's bounciness. Default value: [code]0[/code].
</member>
@ -159,6 +117,9 @@
<member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale">
Multiplies the gravity applied to the body. The body's gravity is calculated from the "Default Gravity" value in "Project &gt; Project Settings &gt; Physics &gt; 2d" and/or any additional gravity vector applied by [Area2D]s. Default value: [code]1[/code].
</member>
<member name="inertia" type="float" setter="set_inertia" getter="get_inertia">
The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it.
</member>
<member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp">
Damps the body's [member linear_velocity]. If [code]-1[/code] the body will use the "Default Linear Damp" in "Project &gt; Project Settings &gt; Physics &gt; 2d". Default value: [code]-1[/code].
</member>

136
doc/classes/SceneTree.xml
View File

@ -1,4 +1,4 @@
<?xml version="1.0" encoding="UTF-8" ?>
xml version="1.0" encoding="UTF-8" ?>
<class name="SceneTree" inherits="MainLoop" category="Core" version="3.0-beta">
<brief_description>
</brief_description>
@ -57,18 +57,6 @@
<description>
</description>
</method>
<method name="get_current_scene" qualifiers="const">
<return type="Node">
</return>
<description>
</description>
</method>
<method name="get_edited_scene_root" qualifiers="const">
<return type="Node">
</return>
<description>
</description>
</method>
<method name="get_frame" qualifiers="const">
<return type="int">
</return>
@ -101,12 +89,6 @@
<description>
</description>
</method>
<method name="get_root" qualifiers="const">
<return type="Viewport">
</return>
<description>
</description>
</method>
<method name="get_rpc_sender_id" qualifiers="const">
<return type="int">
</return>
@ -128,18 +110,6 @@
Returns true if there is a [NetworkedMultiplayerPeer] set (with [method SceneTree.set_network_peer]).
</description>
</method>
<method name="is_debugging_collisions_hint" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_debugging_navigation_hint" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_input_handled">
<return type="bool">
</return>
@ -153,24 +123,6 @@
Returns true if this SceneTree's [NetworkedMultiplayerPeer] is in server mode (listening for connections).
</description>
</method>
<method name="is_paused" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_refusing_new_network_connections" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_using_font_oversampling" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="notify_group">
<return type="void">
</return>
@ -221,38 +173,6 @@
<description>
</description>
</method>
<method name="set_current_scene">
<return type="void">
</return>
<argument index="0" name="child_node" type="Node">
</argument>
<description>
</description>
</method>
<method name="set_debug_collisions_hint">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_debug_navigation_hint">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_edited_scene_root">
<return type="void">
</return>
<argument index="0" name="scene" type="Node">
</argument>
<description>
</description>
</method>
<method name="set_group">
<return type="void">
</return>
@ -285,23 +205,6 @@
<description>
</description>
</method>
<method name="set_network_peer">
<return type="void">
</return>
<argument index="0" name="peer" type="NetworkedMultiplayerPeer">
</argument>
<description>
Set the peer object to handle the RPC system (effectively enabling networking). Depending on the peer itself, the SceneTree will become a network server (check with [method is_network_server()]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals.
</description>
</method>
<method name="set_pause">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_quit_on_go_back">
<return type="void">
</return>
@ -310,14 +213,6 @@
<description>
</description>
</method>
<method name="set_refuse_new_network_connections">
<return type="void">
</return>
<argument index="0" name="refuse" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_screen_stretch">
<return type="void">
</return>
@ -332,15 +227,28 @@
<description>
</description>
</method>
<method name="set_use_font_oversampling">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="current_scene" type="Node" setter="set_current_scene" getter="get_current_scene">
</member>
<member name="debug_collisions_hint" type="bool" setter="set_debug_collisions_hint" getter="is_debugging_collisions_hint">
</member>
<member name="debug_navigation_hint" type="bool" setter="set_debug_navigation_hint" getter="is_debugging_navigation_hint">
</member>
<member name="edited_scene_root" type="Node" setter="set_edited_scene_root" getter="get_edited_scene_root">
</member>
<member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer">
The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with [method is_network_server()]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals.
</member>
<member name="paused" type="bool" setter="set_pause" getter="is_paused">
</member>
<member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections">
</member>
<member name="root" type="Viewport" setter="" getter="get_root">
</member>
<member name="use_font_oversampling" type="bool" setter="set_use_font_oversampling" getter="is_using_font_oversampling">
</member>
</members>
<signals>
<signal name="connected_to_server">
<description>

18
doc/classes/SceneTreeTimer.xml
View File

@ -9,21 +9,11 @@
<demos>
</demos>
<methods>
<method name="get_time_left" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_time_left">
<return type="void">
</return>
<argument index="0" name="time" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="time_left" type="float" setter="set_time_left" getter="get_time_left">
</member>
</members>
<signals>
<signal name="timeout">
<description>

21
doc/classes/Script.xml
View File

@ -31,13 +31,6 @@
<description>
</description>
</method>
<method name="get_source_code" qualifiers="const">
<return type="String">
</return>
<description>
Returns the script source code, or an empty string if source code is not available.
</description>
</method>
<method name="has_script_signal" qualifiers="const">
<return type="bool">
</return>
@ -79,16 +72,12 @@
Reloads the script's class implementation. Returns an error code.
</description>
</method>
<method name="set_source_code">
<return type="void">
</return>
<argument index="0" name="source" type="String">
</argument>
<description>
Sets the script source code. Does not reload the class implementation.
</description>
</method>
</methods>
<members>
<member name="source_code" type="String" setter="set_source_code" getter="get_source_code">
The script source code, or an empty string if source code is not available. When set, does not reload the class implementation automatically.
</member>
</members>
<constants>
</constants>
</class>

44
doc/classes/ScrollContainer.xml
View File

@ -11,43 +11,19 @@
<demos>
</demos>
<methods>
<method name="get_h_scroll" qualifiers="const">
<return type="int">
</return>
<description>
Return current horizontal scroll value.
</description>
</method>
<method name="get_v_scroll" qualifiers="const">
<return type="int">
</return>
<description>
Return current vertical scroll value.
</description>
</method>
<method name="set_h_scroll">
<return type="void">
</return>
<argument index="0" name="val" type="int">
</argument>
<description>
Set horizontal scroll value.
</description>
</method>
<method name="set_v_scroll">
<return type="void">
</return>
<argument index="0" name="val" type="int">
</argument>
<description>
Set vertical scroll value.
</description>
</method>
</methods>
<members>
<member name="scroll_horizontal" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled">
<member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll">
The current horizontal scroll value.
</member>
<member name="scroll_vertical" type="bool" setter="set_enable_v_scroll" getter="is_v_scroll_enabled">
<member name="scroll_horizontal_enabled" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled">
If [code]true[/code], enables horizontal scrolling.
</member>
<member name="scroll_vertical" type="int" setter="set_v_scroll" getter="get_v_scroll">
The current horizontal scroll value.
</member>
<member name="scroll_vertical_enabled" type="bool" setter="set_enable_v_scroll" getter="is_v_scroll_enabled">
If [code]true[/code], enables vertical scrolling.
</member>
</members>
<constants>

18
doc/classes/Shader.xml
View File

@ -11,12 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_code" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_default_texture_param" qualifiers="const">
<return type="Texture">
</return>
@ -39,14 +33,6 @@
<description>
</description>
</method>
<method name="set_code">
<return type="void">
</return>
<argument index="0" name="code" type="String">
</argument>
<description>
</description>
</method>
<method name="set_default_texture_param">
<return type="void">
</return>
@ -58,6 +44,10 @@
</description>
</method>
</methods>
<members>
<member name="code" type="String" setter="set_code" getter="get_code">
</member>
</members>
<constants>
<constant name="MODE_SPATIAL" value="0" enum="Mode">
</constant>

18
doc/classes/ShaderMaterial.xml
View File

@ -9,12 +9,6 @@
<demos>
</demos>
<methods>
<method name="get_shader" qualifiers="const">
<return type="Shader">
</return>
<description>
</description>
</method>
<method name="get_shader_param" qualifiers="const">
<return type="Variant">
</return>
@ -23,14 +17,6 @@
<description>
</description>
</method>
<method name="set_shader">
<return type="void">
</return>
<argument index="0" name="shader" type="Shader">
</argument>
<description>
</description>
</method>
<method name="set_shader_param">
<return type="void">
</return>
@ -42,6 +28,10 @@
</description>
</method>
</methods>
<members>
<member name="shader" type="Shader" setter="set_shader" getter="get_shader">
</member>
</members>
<constants>
</constants>
</class>

19
doc/classes/Spatial.xml
View File

@ -13,13 +13,6 @@
<demos>
</demos>
<methods>
<method name="get_gizmo" qualifiers="const">
<return type="SpatialGizmo">
</return>
<description>
Returns the SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor.
</description>
</method>
<method name="get_parent_spatial" qualifiers="const">
<return type="Spatial">
</return>
@ -195,15 +188,6 @@
Makes the node ignore its parents transformations. Node transformations are only in global space.
</description>
</method>
<method name="set_gizmo">
<return type="void">
</return>
<argument index="0" name="gizmo" type="SpatialGizmo">
</argument>
<description>
Set [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor.
</description>
</method>
<method name="set_identity">
<return type="void">
</return>
@ -289,6 +273,9 @@
</method>
</methods>
<members>
<member name="gizmo" type="SpatialGizmo" setter="set_gizmo" getter="get_gizmo">
The SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor.
</member>
<member name="global_transform" type="Transform" setter="set_global_transform" getter="get_global_transform">
World space (global) [Transform] of this node.
</member>

18
doc/classes/SpatialVelocityTracker.xml
View File

@ -15,12 +15,6 @@
<description>
</description>
</method>
<method name="is_tracking_physics_step" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="reset">
<return type="void">
</return>
@ -29,14 +23,6 @@
<description>
</description>
</method>
<method name="set_track_physics_step">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="update_position">
<return type="void">
</return>
@ -46,6 +32,10 @@
</description>
</method>
</methods>
<members>
<member name="track_physics_step" type="bool" setter="set_track_physics_step" getter="is_tracking_physics_step">
</member>
</members>
<constants>
</constants>
</class>

21
doc/classes/StreamPeer.xml
View File

@ -131,13 +131,6 @@
Get a Variant from the stream.
</description>
</method>
<method name="is_big_endian_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether this [code]StreamPeer[/code] is using big-endian format.
</description>
</method>
<method name="put_16">
<return type="void">
</return>
@ -264,16 +257,12 @@
Put a Variant into the stream.
</description>
</method>
<method name="set_big_endian">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set this [code]StreamPeer[/code] to use big-endian format. Default is false.
</description>
</method>
</methods>
<members>
<member name="big_endian" type="bool" setter="set_big_endian" getter="is_big_endian_enabled">
If [code]true[/code], this [code]StreamPeer[/code] will using big-endian format for encoding and decoding.
</member>
</members>
<constants>
</constants>
</class>

18
doc/classes/StreamPeerBuffer.xml
View File

@ -21,12 +21,6 @@
<description>
</description>
</method>
<method name="get_data_array" qualifiers="const">
<return type="PoolByteArray">
</return>
<description>
</description>
</method>
<method name="get_position" qualifiers="const">
<return type="int">
</return>
@ -55,15 +49,11 @@
<description>
</description>
</method>
<method name="set_data_array">
<return type="void">
</return>
<argument index="0" name="data" type="PoolByteArray">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="data_array" type="PoolByteArray" setter="set_data_array" getter="get_data_array">
</member>
</members>
<constants>
</constants>
</class>

16
doc/classes/StyleBoxLine.xml
View File

@ -9,24 +9,12 @@
<demos>
</demos>
<methods>
<method name="get_grow" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_grow">
<return type="void">
</return>
<argument index="0" name="grow" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="color" type="Color" setter="set_color" getter="get_color">
</member>
<member name="grow" type="float" setter="set_grow" getter="get_grow">
</member>
<member name="thickness" type="int" setter="set_thickness" getter="get_thickness">
</member>
<member name="vertical" type="bool" setter="set_vertical" getter="is_vertical">

16
doc/classes/Tabs.xml
View File

@ -35,12 +35,6 @@
<description>
</description>
</method>
<method name="get_tab_align" qualifiers="const">
<return type="int" enum="Tabs.TabAlign">
</return>
<description>
</description>
</method>
<method name="get_tab_count" qualifiers="const">
<return type="int">
</return>
@ -105,14 +99,6 @@
<description>
</description>
</method>
<method name="set_tab_align">
<return type="void">
</return>
<argument index="0" name="align" type="int" enum="Tabs.TabAlign">
</argument>
<description>
</description>
</method>
<method name="set_tab_disabled">
<return type="void">
</return>
@ -149,6 +135,8 @@
</member>
<member name="scrolling_enabled" type="bool" setter="set_scrolling_enabled" getter="get_scrolling_enabled">
</member>
<member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="Tabs.TabAlign">
</member>
<member name="tab_close_display_policy" type="int" setter="set_tab_close_display_policy" getter="get_tab_close_display_policy" enum="Tabs.CloseButtonDisplayPolicy">
</member>
</members>

21
doc/classes/TextEdit.xml
View File

@ -294,24 +294,6 @@
<description>
</description>
</method>
<method name="set_max_chars">
<return type="void">
</return>
<argument index="0" name="amount" type="int">
</argument>
<description>
Set the maximum amount of characters editable.
</description>
</method>
<method name="set_wrap">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Enable text wrapping when it goes beyond he edge of what is visible.
</description>
</method>
<method name="toggle_fold_line">
<return type="void">
</return>
@ -384,6 +366,9 @@
String value of the [TextEdit].
</member>
<member name="v_scroll_speed" type="float" setter="set_v_scroll_speed" getter="get_v_scroll_speed">
If [code]true[/code], enables text wrapping when it goes beyond he edge of what is visible.
</member>
<member name="wrap_lines" type="bool" setter="set_wrap" getter="is_wrapping">
</member>
</members>
<signals>

27
doc/classes/Texture.xml
View File

@ -71,13 +71,6 @@
<description>
</description>
</method>
<method name="get_flags" qualifiers="const">
<return type="int">
</return>
<description>
Return the current texture flags.
</description>
</method>
<method name="get_height" qualifiers="const">
<return type="int">
</return>
@ -105,17 +98,16 @@
<description>
</description>
</method>
<method name="set_flags">
<return type="void">
</return>
<argument index="0" name="flags" type="int">
</argument>
<description>
Change the texture flags.
</description>
</method>
</methods>
<members>
<member name="flags" type="int" setter="set_flags" getter="get_flags">
The texture's flags.
</member>
</members>
<constants>
<constant name="FLAGS_DEFAULT" value="7" enum="Flags">
Default flags. Generate mipmaps, repeat, and filter are enabled.
</constant>
<constant name="FLAG_MIPMAPS" value="1" enum="Flags">
Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
</constant>
@ -125,9 +117,6 @@
<constant name="FLAG_FILTER" value="4" enum="Flags">
Magnifying filter, to enable smooth zooming in of the texture.
</constant>
<constant name="FLAGS_DEFAULT" value="7" enum="Flags">
Default flags. Generate mipmaps, repeat, and filter are enabled.
</constant>
<constant name="FLAG_ANISOTROPIC_FILTER" value="8" enum="Flags">
Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios.
More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases.

29
doc/classes/Timer.xml
View File

@ -11,20 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_time_left" qualifiers="const">
<return type="float">
</return>
<description>
Returns the timer's remaining time in seconds. Returns 0 if the timer is inactive.
</description>
</method>
<method name="is_paused" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the timer is paused.
</description>
</method>
<method name="is_stopped" qualifiers="const">
<return type="bool">
</return>
@ -32,15 +18,6 @@
Returns [code]true[/code] if the timer is stopped.
</description>
</method>
<method name="set_paused">
<return type="void">
</return>
<argument index="0" name="paused" type="bool">
</argument>
<description>
Pauses the timer. If [code]paused[/code] is [code]true[/code], the timer will not process until it is started or unpaused again, even if [method start] is called.
</description>
</method>
<method name="start">
<return type="void">
</return>
@ -64,9 +41,15 @@
<member name="one_shot" type="bool" setter="set_one_shot" getter="is_one_shot">
If [code]true[/code], Timer will stop when reaching 0. If [code]false[/code], it will restart. Default value: [code]false[/code].
</member>
<member name="paused" type="bool" setter="set_paused" getter="is_paused">
If [code]true[/code], the timer is paused and will not process until it is unpaused again, even if [method start] is called.
</member>
<member name="process_mode" type="int" setter="set_timer_process_mode" getter="get_timer_process_mode" enum="Timer.TimerProcessMode">
Processing mode. Uses TIMER_PROCESS_* constants as value.
</member>
<member name="time_left" type="float" setter="" getter="get_time_left">
The timer's remaining time in seconds. Returns 0 if the timer is inactive.
</member>
<member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time">
Wait time in seconds.
</member>

122
doc/classes/Tree.xml
View File

@ -54,20 +54,6 @@
Makes the currently selected item visible. This will scroll the tree to make sure the selected item is visible.
</description>
</method>
<method name="get_allow_reselect" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if a cell that is currently already selected may be selected again.
</description>
</method>
<method name="get_allow_rmb_select" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if a right click can select items.
</description>
</method>
<method name="get_column_at_position" qualifiers="const">
<return type="int">
</return>
@ -95,13 +81,6 @@
Returns the column's width in pixels.
</description>
</method>
<method name="get_columns" qualifiers="const">
<return type="int">
</return>
<description>
Returns the amount of columns.
</description>
</method>
<method name="get_custom_popup_rect" qualifiers="const">
<return type="Rect2">
</return>
@ -109,13 +88,6 @@
Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See [method TreeItem.set_cell_mode].
</description>
</method>
<method name="get_drop_mode_flags" qualifiers="const">
<return type="int">
</return>
<description>
Returns the current drop mode's flags.
</description>
</method>
<method name="get_drop_section_at_position" qualifiers="const">
<return type="int">
</return>
@ -202,31 +174,6 @@
Returns the current selection's column.
</description>
</method>
<method name="is_folding_hidden" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the folding arrow is hidden.
</description>
</method>
<method name="set_allow_reselect">
<return type="void">
</return>
<argument index="0" name="allow" type="bool">
</argument>
<description>
If [code]true[/code] the currently selected cell may be selected again.
</description>
</method>
<method name="set_allow_rmb_select">
<return type="void">
</return>
<argument index="0" name="allow" type="bool">
</argument>
<description>
If [code]true[/code] a right mouse button click can select items.
</description>
</method>
<method name="set_column_expand">
<return type="void">
</return>
@ -269,52 +216,31 @@
If [code]true[/code] column titles are visible.
</description>
</method>
<method name="set_columns">
<return type="void">
</return>
<argument index="0" name="amount" type="int">
</argument>
<description>
Set the amount of columns.
</description>
</method>
<method name="set_drop_mode_flags">
<return type="void">
</return>
<argument index="0" name="flags" type="int">
</argument>
<description>
Set the drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants.
</description>
</method>
<method name="set_hide_folding">
<return type="void">
</return>
<argument index="0" name="hide" type="bool">
</argument>
<description>
If [code]true[/code] the folding arrow is hidden.
</description>
</method>
<method name="set_hide_root">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
If [code]true[/code] the tree's root is hidden.
</description>
</method>
<method name="set_select_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="Tree.SelectMode">
</argument>
<description>
Allow single or multiple selection. See the [code]SELECT_*[/code] constants.
</description>
</method>
</methods>
<members>
<member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect">
If [code]true[/code] the currently selected cell may be selected again.
</member>
<member name="allow_rmb_select" type="bool" setter="set_allow_rmb_select" getter="get_allow_rmb_select">
If [code]true[/code] a right mouse button click can select items.
</member>
<member name="columns" type="int" setter="set_columns" getter="get_columns">
The amount of columns.
</member>
<member name="drop_mode_flags" type="int" setter="set_drop_mode_flags" getter="get_drop_mode_flags">
The drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants.
</member>
<member name="hide_folding" type="bool" setter="set_hide_folding" getter="is_folding_hidden">
If [code]true[/code] the folding arrow is hidden.
</member>
<member name="hide_root" type="bool" setter="set_hide_root" getter="is_root_hidden">
If [code]true[/code] the tree's root is hidden.
</member>
<member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="Tree.SelectMode">
Allow single or multiple selection. See the [code]SELECT_*[/code] constants.
</member>
</members>
<signals>
<signal name="button_pressed">
<argument index="0" name="item" type="Object">

59
doc/classes/TreeItem.xml
View File

@ -111,13 +111,6 @@
Returns the custom background color of column [code]column[/code].
</description>
</method>
<method name="get_custom_minimum_height" qualifiers="const">
<return type="int">
</return>
<description>
Returns the custom minimum height.
</description>
</method>
<method name="get_expand_right" qualifiers="const">
<return type="bool">
</return>
@ -260,13 +253,6 @@
Returns [code]true[/code] if the given column is checked.
</description>
</method>
<method name="is_collapsed">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if this TreeItem is collapsed.
</description>
</method>
<method name="is_custom_set_as_button" qualifiers="const">
<return type="bool">
</return>
@ -284,13 +270,6 @@
Returns [code]true[/code] if column [code]column[/code] is editable.
</description>
</method>
<method name="is_folding_disabled" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if folding is disabled for this TreeItem.
</description>
</method>
<method name="is_selectable" qualifiers="const">
<return type="bool">
</return>
@ -376,15 +355,6 @@
If [code]true[/code] the column [code]column[/code] is checked.
</description>
</method>
<method name="set_collapsed">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
If [code]true[/code] the TreeItem is collapsed.
</description>
</method>
<method name="set_custom_as_button">
<return type="void">
</return>
@ -432,24 +402,6 @@
Sets the given column's custom draw callback to [code]callback[/code] method on [code]object[/code].
</description>
</method>
<method name="set_custom_minimum_height">
<return type="void">
</return>
<argument index="0" name="height" type="int">
</argument>
<description>
Sets the custom minimum height of this TreeItem.
</description>
</method>
<method name="set_disable_folding">
<return type="void">
</return>
<argument index="0" name="disable" type="bool">
</argument>
<description>
If [code]true[/code] folding is disabled for this TreeItem.
</description>
</method>
<method name="set_editable">
<return type="void">
</return>
@ -585,6 +537,17 @@
</description>
</method>
</methods>
<members>
<member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed">
If [code]true[/code] the TreeItem is collapsed.
</member>
<member name="custom_minimum_height" type="int" setter="set_custom_minimum_height" getter="get_custom_minimum_height">
The custom minimum height.
</member>
<member name="disable_folding" type="bool" setter="set_disable_folding" getter="is_folding_disabled">
If [code]true[/code] folding is disabled for this TreeItem.
</member>
</members>
<constants>
<constant name="CELL_MODE_STRING" value="0" enum="TreeCellMode">
Cell contains a string.

38
doc/classes/Tween.xml
View File

@ -78,13 +78,6 @@
Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished.
</description>
</method>
<method name="get_speed_scale" qualifiers="const">
<return type="float">
</return>
<description>
Returns the speed that has been set from editor GUI or [method set_repeat].
</description>
</method>
<method name="interpolate_callback">
<return type="bool">
</return>
@ -186,13 +179,6 @@
Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended.
</description>
</method>
<method name="is_repeat" qualifiers="const">
<return type="bool">
</return>
<description>
Returns true if repeat has been set from editor GUI or [method set_repeat].
</description>
</method>
<method name="remove">
<return type="bool">
</return>
@ -265,24 +251,6 @@
Activate/deactivate the tween. You can use this for pausing animations, though [method stop_all] and [method resume_all] might be more fit for this.
</description>
</method>
<method name="set_repeat">
<return type="void">
</return>
<argument index="0" name="repeat" type="bool">
</argument>
<description>
Make the tween repeat after all tweens have finished.
</description>
</method>
<method name="set_speed_scale">
<return type="void">
</return>
<argument index="0" name="speed" type="float">
</argument>
<description>
Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using [method set_active] or [method stop_all] and [method resume_all] for this.
</description>
</method>
<method name="start">
<return type="bool">
</return>
@ -371,6 +339,12 @@
<members>
<member name="playback_process_mode" type="int" setter="set_tween_process_mode" getter="get_tween_process_mode" enum="Tween.TweenProcessMode">
</member>
<member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale">
The speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using [method set_active] or [method stop_all] and [method resume_all] for this.
</member>
<member name="repeat" type="bool" setter="set_repeat" getter="is_repeat">
If [code]true[/code], the tween will repeat.
</member>
</members>
<signals>
<signal name="tween_completed">

57
doc/classes/VideoPlayer.xml
View File

@ -11,13 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_buffering_msec" qualifiers="const">
<return type="int">
</return>
<description>
Get the amount of milliseconds to store in buffer while playing.
</description>
</method>
<method name="get_stream_name" qualifiers="const">
<return type="String">
</return>
@ -25,13 +18,6 @@
Get the name of the video stream.
</description>
</method>
<method name="get_stream_position" qualifiers="const">
<return type="float">
</return>
<description>
Get the current position of the stream, in seconds.
</description>
</method>
<method name="get_video_texture">
<return type="Texture">
</return>
@ -39,13 +25,6 @@
Get the current frame of the video as a [Texture].
</description>
</method>
<method name="get_volume" qualifiers="const">
<return type="float">
</return>
<description>
Get the volume of the audio track as a linear value.
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
@ -60,33 +39,6 @@
Start the video playback.
</description>
</method>
<method name="set_buffering_msec">
<return type="void">
</return>
<argument index="0" name="msec" type="int">
</argument>
<description>
Set the amount of milliseconds to buffer during playback.
</description>
</method>
<method name="set_stream_position">
<return type="void">
</return>
<argument index="0" name="position" type="float">
</argument>
<description>
Set the current position of the stream, in seconds.
</description>
</method>
<method name="set_volume">
<return type="void">
</return>
<argument index="0" name="volume" type="float">
</argument>
<description>
Set the audio volume as a linear value.
</description>
</method>
<method name="stop">
<return type="void">
</return>
@ -100,6 +52,9 @@
</member>
<member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay">
</member>
<member name="buffering_msec" type="int" setter="set_buffering_msec" getter="get_buffering_msec">
The amount of milliseconds to store in buffer while playing.
</member>
<member name="bus" type="String" setter="set_bus" getter="get_bus">
</member>
<member name="expand" type="bool" setter="set_expand" getter="has_expand">
@ -108,6 +63,12 @@
</member>
<member name="stream" type="VideoStream" setter="set_stream" getter="get_stream">
</member>
<member name="stream_position" type="float" setter="set_stream_position" getter="get_stream_position">
The current position of the stream, in seconds.
</member>
<member name="volume" type="float" setter="set_volume" getter="get_volume">
The volume of the audio track as a linear value.
</member>
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db">
</member>
</members>

55
doc/classes/Viewport.xml
View File

@ -37,13 +37,6 @@
Return the active 3D camera.
</description>
</method>
<method name="get_canvas_transform" qualifiers="const">
<return type="Transform2D">
</return>
<description>
Get the canvas transform of the viewport.
</description>
</method>
<method name="get_final_transform" qualifiers="const">
<return type="Transform2D">
</return>
@ -51,13 +44,6 @@
Get the total transform of the viewport.
</description>
</method>
<method name="get_global_canvas_transform" qualifiers="const">
<return type="Transform2D">
</return>
<description>
Get the global canvas transform of the viewport.
</description>
</method>
<method name="get_mouse_position" qualifiers="const">
<return type="Vector2">
</return>
@ -101,13 +87,6 @@
Return the final, visible rect in global screen coordinates.
</description>
</method>
<method name="get_world_2d" qualifiers="const">
<return type="World2D">
</return>
<description>
Return the 2D world of the viewport.
</description>
</method>
<method name="gui_get_drag_data" qualifiers="const">
<return type="Variant">
</return>
@ -152,24 +131,6 @@
<description>
</description>
</method>
<method name="set_canvas_transform">
<return type="void">
</return>
<argument index="0" name="xform" type="Transform2D">
</argument>
<description>
Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport.
</description>
</method>
<method name="set_global_canvas_transform">
<return type="void">
</return>
<argument index="0" name="xform" type="Transform2D">
</argument>
<description>
Set the global canvas transform of the viewport. The canvas transform is relative to this.
</description>
</method>
<method name="set_size_override">
<return type="void">
</return>
@ -192,14 +153,6 @@
Set whether the size override affects stretch as well.
</description>
</method>
<method name="set_world_2d">
<return type="void">
</return>
<argument index="0" name="world_2d" type="World2D">
</argument>
<description>
</description>
</method>
<method name="unhandled_input">
<return type="void">
</return>
@ -232,10 +185,16 @@
</member>
<member name="audio_listener_enable_3d" type="bool" setter="set_as_audio_listener" getter="is_audio_listener">
</member>
<member name="canvas_transform" type="Transform2D" setter="set_canvas_transform" getter="get_canvas_transform">
The canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport.
</member>
<member name="debug_draw" type="int" setter="set_debug_draw" getter="get_debug_draw" enum="Viewport.DebugDraw">
</member>
<member name="disable_3d" type="bool" setter="set_disable_3d" getter="is_3d_disabled">
</member>
<member name="global_canvas_transform" type="Transform2D" setter="set_global_canvas_transform" getter="get_global_canvas_transform">
The global canvas transform of the viewport. The canvas transform is relative to this.
</member>
<member name="gui_disable_input" type="bool" setter="set_disable_input" getter="is_input_disabled">
</member>
<member name="gui_snap_controls_to_pixels" type="bool" setter="set_snap_controls_to_pixels" getter="is_snap_controls_to_pixels_enabled">
@ -272,6 +231,8 @@
</member>
<member name="world" type="World" setter="set_world" getter="get_world">
</member>
<member name="world_2d" type="World2D" setter="set_world_2d" getter="get_world_2d">
</member>
</members>
<signals>
<signal name="size_changed">

31
doc/classes/World.xml
View File

@ -11,35 +11,24 @@
<demos>
</demos>
<methods>
<method name="get_direct_space_state">
<return type="PhysicsDirectSpaceState">
</return>
<description>
Returns the World's physics space.
</description>
</method>
<method name="get_scenario" qualifiers="const">
<return type="RID">
</return>
<description>
Returns the World's visual scenario.
</description>
</method>
<method name="get_space" qualifiers="const">
<return type="RID">
</return>
<description>
Returns the World's sound space.
</description>
</method>
</methods>
<members>
<member name="direct_space_state" type="PhysicsDirectSpaceState" setter="" getter="get_direct_space_state">
The World's physics direct space state, used for making various queries. Might be used only during [code]_physics_process[/code].
</member>
<member name="environment" type="Environment" setter="set_environment" getter="get_environment">
The World's [Environment].
</member>
<member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_environment">
The World's fallback_environment will be used if the World's [Environment] fails or is missing.
</member>
<member name="scenario" type="RID" setter="" getter="get_scenario">
The World's visual scenario.
</member>
<member name="space" type="RID" setter="" getter="get_space">
The World's physics space.
</member>
</members>
<constants>
</constants>

32
doc/classes/World2D.xml
View File

@ -11,28 +11,18 @@
<demos>
</demos>
<methods>
<method name="get_canvas">
<return type="RID">
</return>
<description>
Retrieve the [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing.
</description>
</method>
<method name="get_direct_space_state">
<return type="Physics2DDirectSpaceState">
</return>
<description>
Retrieve the state of this world's physics space. This allows arbitrary querying for collision.
</description>
</method>
<method name="get_space">
<return type="RID">
</return>
<description>
Retrieve the [RID] of this world's physics space resource. Used by the [Physics2DServer] for 2D physics, treating it as both a space and an area.
</description>
</method>
</methods>
<members>
<member name="canvas" type="RID" setter="" getter="get_canvas">
The [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing.
</member>
<member name="direct_space_state" type="Physics2DDirectSpaceState" setter="" getter="get_direct_space_state">
The state of this world's physics space. This allows arbitrary querying for collision.
</member>
<member name="space" type="RID" setter="" getter="get_space">
The [RID] of this world's physics space resource. Used by the [Physics2DServer] for 2D physics, treating it as both a space and an area.
</member>
</members>
<constants>
</constants>
</class>

18
modules/enet/doc_classes/NetworkedMultiplayerENet.xml
View File

@ -47,12 +47,6 @@
Create server that listens to connections via [code]port[/code].
</description>
</method>
<method name="get_compression_mode" qualifiers="const">
<return type="int" enum="NetworkedMultiplayerENet.CompressionMode">
</return>
<description>
</description>
</method>
<method name="set_bind_ip">
<return type="void">
</return>
@ -61,15 +55,11 @@
<description>
</description>
</method>
<method name="set_compression_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="NetworkedMultiplayerENet.CompressionMode">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="compression_mode" type="int" setter="set_compression_mode" getter="get_compression_mode" enum="NetworkedMultiplayerENet.CompressionMode">
</member>
</members>
<constants>
<constant name="COMPRESS_NONE" value="0" enum="CompressionMode">
</constant>

116
modules/gridmap/doc_classes/GridMap.xml
View File

@ -67,34 +67,6 @@
The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is retuned if the cell is empty.
</description>
</method>
<method name="get_cell_size" qualifiers="const">
<return type="Vector3">
</return>
<description>
The dimensions of the grid's cells.
</description>
</method>
<method name="get_center_x" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether or not grid items are centered on the X axis.
</description>
</method>
<method name="get_center_y" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether or not grid items are centered on the Y axis.
</description>
</method>
<method name="get_center_z" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether or not grid items are centered on the Z axis.
</description>
</method>
<method name="get_collision_layer_bit" qualifiers="const">
<return type="bool">
</return>
@ -118,20 +90,6 @@
Array of [Transform] and [Mesh] references corresponding to the non empty cells in the grid. The transforms are specified in world space.
</description>
</method>
<method name="get_octant_size" qualifiers="const">
<return type="int">
</return>
<description>
The size of each octant measured in number of cells. This applies to all three axis.
</description>
</method>
<method name="get_theme" qualifiers="const">
<return type="MeshLibrary">
</return>
<description>
The assigned [MeshLibrary].
</description>
</method>
<method name="get_used_cells" qualifiers="const">
<return type="Array">
</return>
@ -188,42 +146,6 @@
Optionally, the item's orientation can be passed.
</description>
</method>
<method name="set_cell_size">
<return type="void">
</return>
<argument index="0" name="size" type="Vector3">
</argument>
<description>
Sets the height, width and depth of the grid's cells.
</description>
</method>
<method name="set_center_x">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set grid items to be centered on the X axis. By default it is enabled.
</description>
</method>
<method name="set_center_y">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set grid items to be centered on the Y axis. By default it is enabled.
</description>
</method>
<method name="set_center_z">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set grid items to be centered on the Z axis. By default it is enabled.
</description>
</method>
<method name="set_clip">
<return type="void">
</return>
@ -258,24 +180,6 @@
<description>
</description>
</method>
<method name="set_octant_size">
<return type="void">
</return>
<argument index="0" name="size" type="int">
</argument>
<description>
Sets the size for each octant measured in number of cells. This applies to all three axis.
</description>
</method>
<method name="set_theme">
<return type="void">
</return>
<argument index="0" name="theme" type="MeshLibrary">
</argument>
<description>
Sets the collection of meshes for the map.
</description>
</method>
<method name="world_to_map" qualifiers="const">
<return type="Vector3">
</return>
@ -286,10 +190,30 @@
</method>
</methods>
<members>
<member name="cell_center_x" type="bool" setter="set_center_x" getter="get_center_x">
If [code]true[/code] grid items are centered on the X axis.
</member>
<member name="cell_center_y" type="bool" setter="set_center_y" getter="get_center_y">
If [code]true[/code] grid items are centered on the Y axis.
</member>
<member name="cell_center_z" type="bool" setter="set_center_z" getter="get_center_z">
If [code]true[/code] grid items are centered on the Z axis.
</member>
<member name="cell_octant_size" type="int" setter="set_octant_size" getter="get_octant_size">
The size of each octant measured in number of cells. This applies to all three axis.
</member>
<member name="cell_scale" type="float" setter="set_cell_scale" getter="get_cell_scale">
</member>
<member name="cell_size" type="Vector3" setter="set_cell_size" getter="get_cell_size">
The dimensions of the grid's cells.
</member>
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer">
</member>
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
</member>
<member name="theme" type="MeshLibrary" setter="set_theme" getter="get_theme">
The assigned [MeshLibrary].
</member>
</members>
<constants>
<constant name="INVALID_CELL_ITEM" value="-1">

32
modules/regex/doc_classes/RegExMatch.xml
View File

@ -28,13 +28,6 @@
Returns the number of capturing groups.
</description>
</method>
<method name="get_names" qualifiers="const">
<return type="Dictionary">
</return>
<description>
Returns a dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one.
</description>
</method>
<method name="get_start" qualifiers="const">
<return type="int">
</return>
@ -55,21 +48,18 @@
Returns an empty string if the group did not match or doesn't exist.
</description>
</method>
<method name="get_strings" qualifiers="const">
<return type="Array">
</return>
<description>
Returns an [Array] of the match and its capturing groups.
</description>
</method>
<method name="get_subject" qualifiers="const">
<return type="String">
</return>
<description>
Returns the source string used with the search pattern to find this matching result.
</description>
</method>
</methods>
<members>
<member name="names" type="Dictionary" setter="" getter="get_names">
A dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one.
</member>
<member name="strings" type="Array" setter="" getter="get_strings">
An [Array] of the match and its capturing groups.
</member>
<member name="subject" type="String" setter="" getter="get_subject">
The source string used with the search pattern to find this matching result.
</member>
</members>
<constants>
</constants>
</class>

48
modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml
View File

@ -11,49 +11,13 @@
<demos>
</demos>
<methods>
<method name="get_data" qualifiers="const">
<return type="PoolByteArray">
</return>
<description>
</description>
</method>
<method name="get_loop_offset" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="has_loop" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_data">
<return type="void">
</return>
<argument index="0" name="data" type="PoolByteArray">
</argument>
<description>
</description>
</method>
<method name="set_loop">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_loop_offset">
<return type="void">
</return>
<argument index="0" name="seconds" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="loop" type="bool" setter="set_loop" getter="has_loop">
</member>
<member name="loop_offset" type="float" setter="set_loop_offset" getter="get_loop_offset">
</member>
</members>
<constants>
</constants>
</class>

16
modules/visual_script/doc_classes/VisualScriptYield.xml
View File

@ -9,22 +9,10 @@
<demos>
</demos>
<methods>
<method name="get_yield_mode">
<return type="int" enum="VisualScriptYield.YieldMode">
</return>
<description>
</description>
</method>
<method name="set_yield_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="VisualScriptYield.YieldMode">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="mode" type="int" setter="set_yield_mode" getter="get_yield_mode" enum="VisualScriptYield.YieldMode">
</member>
<member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time">
</member>
</members>