Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-22 04:06:14 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

doc: Remove setters and getters now exposed via properties/members

Browse Source
This commit is contained in:
Rémi Verschelde 2017-11-24 18:10:32 +01:00
parent 31f62f53c5
commit 92f07fefcd
251 changed files with 0 additions and 17248 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/classes/ARVRAnchor.xml
View File

@ -13,13 +13,6 @@
<demos>
</demos>
<methods>
<method name="get_anchor_id" qualifiers="const">
<return type="int">
</return>
<description>
Returns the anchor id for this anchor.
</description>
</method>
<method name="get_anchor_name" qualifiers="const">
<return type="String">
</return>
@ -48,15 +41,6 @@
Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table.
</description>
</method>
<method name="set_anchor_id">
<return type="void">
</return>
<argument index="0" name="anchor_id" type="int">
</argument>
<description>
Binds this anchor node to an anchor with this id. You can set this before the anchor itself exists. The first anchor that is identified gets id 1, the second id 2, etc. When anchors get removed that slot remains free and can be assigned to the next anchor that is identified. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merge them.
</description>
</method>
</methods>
<members>
<member name="anchor_id" type="int" setter="set_anchor_id" getter="get_anchor_id">

30
doc/classes/ARVRController.xml
View File

@ -13,13 +13,6 @@
<demos>
</demos>
<methods>
<method name="get_controller_id" qualifiers="const">
<return type="int">
</return>
<description>
Returns the controller id currently assigned to this node.
</description>
</method>
<method name="get_controller_name" qualifiers="const">
<return type="String">
</return>
@ -57,12 +50,6 @@
Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry.
</description>
</method>
<method name="get_rumble" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="is_button_pressed" qualifiers="const">
<return type="int">
</return>
@ -72,23 +59,6 @@
Is the given button currently pressed?
</description>
</method>
<method name="set_controller_id">
<return type="void">
</return>
<argument index="0" name="controller_id" type="int">
</argument>
<description>
Changes the id that identifies the controller bound to this node. The first controller that the ARVR Server detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off that slot is freed ensuring that controllers will keep the same id while it is turned on even when controllers with lower ids are turned off.
</description>
</method>
<method name="set_rumble">
<return type="void">
</return>
<argument index="0" name="rumble" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="controller_id" type="int" setter="set_controller_id" getter="get_controller_id">

48
doc/classes/ARVRInterface.xml
View File

@ -12,13 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_anchor_detection_is_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Returns true if achor detection is enabled (AR only).
</description>
</method>
<method name="get_capabilities" qualifiers="const">
<return type="int">
</return>
@ -58,20 +51,6 @@
While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD.
</description>
</method>
<method name="is_initialized">
<return type="bool">
</return>
<description>
Returns true if this interface is active.
</description>
</method>
<method name="is_primary">
<return type="bool">
</return>
<description>
Returns true if this interface is currently the primary interface (the interface responsible for showing the output).
</description>
</method>
<method name="is_stereo">
<return type="bool">
</return>
@ -79,33 +58,6 @@
Returns true if the current output of this interface is in stereo.
</description>
</method>
<method name="set_anchor_detection_is_enabled">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Enables anchor detection, this is used on AR interfaces and enables the extra logic that will detect planes, features, objects, etc. and adds/modifies anchor points.
</description>
</method>
<method name="set_is_initialized">
<return type="void">
</return>
<argument index="0" name="initialized" type="bool">
</argument>
<description>
Initialize/uninitialize this interface (same effect as calling initialize/uninitialize).
</description>
</method>
<method name="set_is_primary">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set this interface to the primary interface (unset the old one).
</description>
</method>
<method name="uninitialize">
<return type="void">
</return>

18
doc/classes/ARVROrigin.xml
View File

@ -14,24 +14,6 @@
<demos>
</demos>
<methods>
<method name="get_world_scale" qualifiers="const">
<return type="float">
</return>
<description>
Get the world scale applied to our positioning.
</description>
</method>
<method name="set_world_scale">
<return type="void">
</return>
<argument index="0" name="world_scale" type="float">
</argument>
<description>
Changes the world scaling factor.
Most AR/VR platforms will assume a unit size of 1 unit in your game world = 1 meter in the real world. This scale allows you to adjust this to the unit system you use in your game.
Note that this method is a passthrough to the ARVRServer itself.
</description>
</method>
</methods>
<members>
<member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale">

14
doc/classes/ARVRPositionalTracker.xml
View File

@ -48,12 +48,6 @@
Returns the position of the controller adjusted by world scale.
</description>
</method>
<method name="get_rumble" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_tracks_orientation" qualifiers="const">
<return type="bool">
</return>
@ -84,14 +78,6 @@
Type of tracker.
</description>
</method>
<method name="set_rumble">
<return type="void">
</return>
<argument index="0" name="rumble" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="rumble" type="float" setter="set_rumble" getter="get_rumble">

16
doc/classes/ARVRServer.xml
View File

@ -82,13 +82,6 @@
Get the number of trackers currently registered.
</description>
</method>
<method name="get_world_scale" qualifiers="const">
<return type="float">
</return>
<description>
Returns our world scale (see ARVROrigin for more information).
</description>
</method>
<method name="set_primary_interface">
<return type="void">
</return>
@ -98,15 +91,6 @@
Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces.
</description>
</method>
<method name="set_world_scale">
<return type="void">
</return>
<argument index="0" name="arg0" type="float">
</argument>
<description>
Changing the world scale, see the ARVROrigin documentation for more information.
</description>
</method>
</methods>
<members>
<member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale">

32
doc/classes/AcceptDialog.xml
View File

@ -34,13 +34,6 @@
Adds a button with label [i]name[/i] and a cancel action to the dialog and returns the created button.
</description>
</method>
<method name="get_hide_on_ok" qualifiers="const">
<return type="bool">
</return>
<description>
Return true if the dialog will be hidden when accepted (default true).
</description>
</method>
<method name="get_label">
<return type="Label">
</return>
@ -55,13 +48,6 @@
Return the OK Button.
</description>
</method>
<method name="get_text" qualifiers="const">
<return type="String">
</return>
<description>
Return the built-in label text.
</description>
</method>
<method name="register_text_enter">
<return type="void">
</return>
@ -71,24 +57,6 @@
Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted.
</description>
</method>
<method name="set_hide_on_ok">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set whether the dialog is hidden when accepted (default true).
</description>
</method>
<method name="set_text">
<return type="void">
</return>
<argument index="0" name="text" type="String">
</argument>
<description>
Set the built-in label text.
</description>
</method>
</methods>
<members>
<member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok">

112
doc/classes/AnimatedSprite.xml
View File

@ -11,55 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_animation" qualifiers="const">
<return type="String">
</return>
<description>
Return the name of the current animation set to the node.
</description>
</method>
<method name="get_frame" qualifiers="const">
<return type="int">
</return>
<description>
Return the visible frame index.
</description>
</method>
<method name="get_offset" qualifiers="const">
<return type="Vector2">
</return>
<description>
Return the offset of the sprite in the node origin.
</description>
</method>
<method name="get_sprite_frames" qualifiers="const">
<return type="SpriteFrames">
</return>
<description>
Get the [SpriteFrames] resource, which contains all frames.
</description>
</method>
<method name="is_centered" qualifiers="const">
<return type="bool">
</return>
<description>
Return true when centered. See [method set_centered].
</description>
</method>
<method name="is_flipped_h" qualifiers="const">
<return type="bool">
</return>
<description>
Return true if sprite is flipped horizontally.
</description>
</method>
<method name="is_flipped_v" qualifiers="const">
<return type="bool">
</return>
<description>
Return true if sprite is flipped vertically.
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
@ -76,69 +27,6 @@
Play the animation set in parameter. If no parameter is provided, the current animation is played.
</description>
</method>
<method name="set_animation">
<return type="void">
</return>
<argument index="0" name="animation" type="String">
</argument>
<description>
Set the current animation of the node and reinits the frame counter of the animation.
</description>
</method>
<method name="set_centered">
<return type="void">
</return>
<argument index="0" name="centered" type="bool">
</argument>
<description>
When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is.
</description>
</method>
<method name="set_flip_h">
<return type="void">
</return>
<argument index="0" name="flip_h" type="bool">
</argument>
<description>
If true, sprite is flipped horizontally.
</description>
</method>
<method name="set_flip_v">
<return type="void">
</return>
<argument index="0" name="flip_v" type="bool">
</argument>
<description>
If true, sprite is flipped vertically.
</description>
</method>
<method name="set_frame">
<return type="void">
</return>
<argument index="0" name="frame" type="int">
</argument>
<description>
Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource).
</description>
</method>
<method name="set_offset">
<return type="void">
</return>
<argument index="0" name="offset" type="Vector2">
</argument>
<description>
Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not.
</description>
</method>
<method name="set_sprite_frames">
<return type="void">
</return>
<argument index="0" name="sprite_frames" type="SpriteFrames">
</argument>
<description>
Set the [SpriteFrames] resource, which contains all frames.
</description>
</method>
<method name="stop">
<return type="void">
</return>

48
doc/classes/AnimatedSprite3D.xml
View File

@ -11,27 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_animation" qualifiers="const">
<return type="String">
</return>
<description>
Return the name of the current animation set to the node.
</description>
</method>
<method name="get_frame" qualifiers="const">
<return type="int">
</return>
<description>
Return the visible frame index.
</description>
</method>
<method name="get_sprite_frames" qualifiers="const">
<return type="SpriteFrames">
</return>
<description>
Get the [SpriteFrames] resource, which contains all frames.
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
@ -48,33 +27,6 @@
Play the animation set in parameter. If no parameter is provided, the current animation is played.
</description>
</method>
<method name="set_animation">
<return type="void">
</return>
<argument index="0" name="animation" type="String">
</argument>
<description>
Set the current animation of the node and reinits the frame counter of the animation.
</description>
</method>
<method name="set_frame">
<return type="void">
</return>
<argument index="0" name="frame" type="int">
</argument>
<description>
Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource).
</description>
</method>
<method name="set_sprite_frames">
<return type="void">
</return>
<argument index="0" name="sprite_frames" type="SpriteFrames">
</argument>
<description>
Set the [SpriteFrames] resource, which contains all frames.
</description>
</method>
<method name="stop">
<return type="void">
</return>

48
doc/classes/AnimationPlayer.xml
View File

@ -90,13 +90,6 @@
Get the list of names of the animations stored in the player.
</description>
</method>
<method name="get_animation_process_mode" qualifiers="const">
<return type="int" enum="AnimationPlayer.AnimationProcessMode">
</return>
<description>
Return the mode in which the animation player processes. See [method set_animation_process_mode].
</description>
</method>
<method name="get_autoplay" qualifiers="const">
<return type="String">
</return>
@ -136,13 +129,6 @@
Get the position (in seconds) of the currently being played animation.
</description>
</method>
<method name="get_default_blend_time" qualifiers="const">
<return type="float">
</return>
<description>
Return the default blend time between animations.
</description>
</method>
<method name="get_position" qualifiers="const">
<return type="float">
</return>
@ -150,13 +136,6 @@
Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided).
</description>
</method>
<method name="get_root" qualifiers="const">
<return type="NodePath">
</return>
<description>
Return path to root node (see [method set_root]).
</description>
</method>
<method name="get_speed_scale" qualifiers="const">
<return type="float">
</return>
@ -262,15 +241,6 @@
Set the player as active (playing). If false, it will do nothing.
</description>
</method>
<method name="set_animation_process_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="AnimationPlayer.AnimationProcessMode">
</argument>
<description>
Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS_*.
</description>
</method>
<method name="set_autoplay">
<return type="void">
</return>
@ -302,24 +272,6 @@
Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
</description>
</method>
<method name="set_default_blend_time">
<return type="void">
</return>
<argument index="0" name="sec" type="float">
</argument>
<description>
Set the default blend time between animations.
</description>
</method>
<method name="set_root">
<return type="void">
</return>
<argument index="0" name="path" type="NodePath">
</argument>
<description>
AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed.
</description>
</method>
<method name="set_speed_scale">
<return type="void">
</return>

16
doc/classes/AnimationTreePlayer.xml
View File

@ -189,13 +189,6 @@
Disconnects nodes connected to [code]id[/code] at the specified input slot.
</description>
</method>
<method name="get_animation_process_mode" qualifiers="const">
<return type="int" enum="AnimationTreePlayer.AnimationProcessMode">
</return>
<description>
Returns playback process mode of this AnimationTreePlayer.
</description>
</method>
<method name="get_base_path" qualifiers="const">
<return type="NodePath">
</return>
@ -480,15 +473,6 @@
Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active.
</description>
</method>
<method name="set_animation_process_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="AnimationTreePlayer.AnimationProcessMode">
</argument>
<description>
Sets process mode (ANIMATION_PROCESS_*) of this AnimationTreePlayer.
</description>
</method>
<method name="set_base_path">
<return type="void">
</return>

288
doc/classes/Area.xml
View File

@ -11,26 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_angular_damp" qualifiers="const">
<return type="float">
</return>
<description>
Return the angular damp rate.
</description>
</method>
<method name="get_audio_bus" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_collision_layer" qualifiers="const">
<return type="int">
</return>
<description>
Return the physics layer this area is in.
</description>
</method>
<method name="get_collision_layer_bit" qualifiers="const">
<return type="bool">
</return>
@ -40,13 +20,6 @@
Return an individual bit on the layer mask.
</description>
</method>
<method name="get_collision_mask" qualifiers="const">
<return type="int">
</return>
<description>
Return the physics layers this area can scan for collisions.
</description>
</method>
<method name="get_collision_mask_bit" qualifiers="const">
<return type="bool">
</return>
@ -56,34 +29,6 @@
Return an individual bit on the collision mask.
</description>
</method>
<method name="get_gravity" qualifiers="const">
<return type="float">
</return>
<description>
Return the gravity intensity.
</description>
</method>
<method name="get_gravity_distance_scale" qualifiers="const">
<return type="float">
</return>
<description>
Return the falloff factor for point gravity.
</description>
</method>
<method name="get_gravity_vector" qualifiers="const">
<return type="Vector3">
</return>
<description>
Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
</description>
</method>
<method name="get_linear_damp" qualifiers="const">
<return type="float">
</return>
<description>
Return the linear damp rate.
</description>
</method>
<method name="get_overlapping_areas" qualifiers="const">
<return type="Array">
</return>
@ -98,71 +43,6 @@
Returns a list of intersecting [PhysicsBody]s.
</description>
</method>
<method name="get_priority" qualifiers="const">
<return type="float">
</return>
<description>
Return the processing order of this area.
</description>
</method>
<method name="get_reverb_amount" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_reverb_bus" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_reverb_uniformity" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_space_override_mode" qualifiers="const">
<return type="int" enum="Area.SpaceOverride">
</return>
<description>
Return the space override mode.
</description>
</method>
<method name="is_gravity_a_point" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
</description>
</method>
<method name="is_monitorable" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether this area can be detected by other, monitoring, areas.
</description>
</method>
<method name="is_monitoring" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether this area detects bodies/areas entering/exiting it.
</description>
</method>
<method name="is_overriding_audio_bus" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_using_reverb_bus" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="overlaps_area" qualifiers="const">
<return type="bool">
</return>
@ -181,43 +61,6 @@
If [code]true[/code] the given body overlaps the Area.
</description>
</method>
<method name="set_angular_damp">
<return type="void">
</return>
<argument index="0" name="angular_damp" type="float">
</argument>
<description>
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
</description>
</method>
<method name="set_audio_bus">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="set_audio_bus_override">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_collision_layer">
<return type="void">
</return>
<argument index="0" name="collision_layer" type="int">
</argument>
<description>
Set the physics layers this area is in.
Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask].
A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
</description>
</method>
<method name="set_collision_layer_bit">
<return type="void">
</return>
@ -229,15 +72,6 @@
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
</description>
</method>
<method name="set_collision_mask">
<return type="void">
</return>
<argument index="0" name="collision_mask" type="int">
</argument>
<description>
Set the physics layers this area can scan for collisions.
</description>
</method>
<method name="set_collision_mask_bit">
<return type="void">
</return>
@ -249,128 +83,6 @@
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
</description>
</method>
<method name="set_gravity">
<return type="void">
</return>
<argument index="0" name="gravity" type="float">
</argument>
<description>
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity).
</description>
</method>
<method name="set_gravity_distance_scale">
<return type="void">
</return>
<argument index="0" name="distance_scale" type="float">
</argument>
<description>
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
</description>
</method>
<method name="set_gravity_is_point">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector].
</description>
</method>
<method name="set_gravity_vector">
<return type="void">
</return>
<argument index="0" name="vector" type="Vector3">
</argument>
<description>
Set the gravity vector. This vector does not have to be normalized.
If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
</description>
</method>
<method name="set_linear_damp">
<return type="void">
</return>
<argument index="0" name="linear_damp" type="float">
</argument>
<description>
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
</description>
</method>
<method name="set_monitorable">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
</description>
</method>
<method name="set_monitoring">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set whether this area can detect bodies/areas entering/exiting it.
</description>
</method>
<method name="set_priority">
<return type="void">
</return>
<argument index="0" name="priority" type="float">
</argument>
<description>
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
</description>
</method>
<method name="set_reverb_amount">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_reverb_bus">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="set_reverb_uniformity">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_space_override_mode">
<return type="void">
</return>
<argument index="0" name="enable" type="int" enum="Area.SpaceOverride">
</argument>
<description>
Set the space override mode. This mode controls how an area affects gravity and damp.
AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
</description>
</method>
<method name="set_use_reverb_bus">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp">

232
doc/classes/Area2D.xml
View File

@ -11,26 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_angular_damp" qualifiers="const">
<return type="float">
</return>
<description>
Return the angular damp rate.
</description>
</method>
<method name="get_audio_bus_name" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_collision_layer" qualifiers="const">
<return type="int">
</return>
<description>
Return the physics layer this area is in.
</description>
</method>
<method name="get_collision_layer_bit" qualifiers="const">
<return type="bool">
</return>
@ -40,13 +20,6 @@
Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer.
</description>
</method>
<method name="get_collision_mask" qualifiers="const">
<return type="int">
</return>
<description>
Return the physics layers this area will scan to determine collisions.
</description>
</method>
<method name="get_collision_mask_bit" qualifiers="const">
<return type="bool">
</return>
@ -56,34 +29,6 @@
Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer.
</description>
</method>
<method name="get_gravity" qualifiers="const">
<return type="float">
</return>
<description>
Return the gravity intensity.
</description>
</method>
<method name="get_gravity_distance_scale" qualifiers="const">
<return type="float">
</return>
<description>
Return the falloff factor for point gravity.
</description>
</method>
<method name="get_gravity_vector" qualifiers="const">
<return type="Vector2">
</return>
<description>
Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
</description>
</method>
<method name="get_linear_damp" qualifiers="const">
<return type="float">
</return>
<description>
Return the linear damp rate.
</description>
</method>
<method name="get_overlapping_areas" qualifiers="const">
<return type="Array">
</return>
@ -98,47 +43,6 @@
Returns a list of intersecting [PhysicsBody2D]s.
</description>
</method>
<method name="get_priority" qualifiers="const">
<return type="float">
</return>
<description>
Return the processing order of this area.
</description>
</method>
<method name="get_space_override_mode" qualifiers="const">
<return type="int" enum="Area2D.SpaceOverride">
</return>
<description>
Return the space override mode.
</description>
</method>
<method name="is_gravity_a_point" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
</description>
</method>
<method name="is_monitorable" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether this area can be detected by other, monitoring, areas.
</description>
</method>
<method name="is_monitoring" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether this area detects bodies/areas entering/exiting it.
</description>
</method>
<method name="is_overriding_audio_bus" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="overlaps_area" qualifiers="const">
<return type="bool">
</return>
@ -157,43 +61,6 @@
If [code]true[/code] the given body overlaps the Area2D.
</description>
</method>
<method name="set_angular_damp">
<return type="void">
</return>
<argument index="0" name="angular_damp" type="float">
</argument>
<description>
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
</description>
</method>
<method name="set_audio_bus_name">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="set_audio_bus_override">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_collision_layer">
<return type="void">
</return>
<argument index="0" name="collision_layer" type="int">
</argument>
<description>
Set the physics layers this area is in.
Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask].
A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
</description>
</method>
<method name="set_collision_layer_bit">
<return type="void">
</return>
@ -205,15 +72,6 @@
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
</description>
</method>
<method name="set_collision_mask">
<return type="void">
</return>
<argument index="0" name="collision_mask" type="int">
</argument>
<description>
Set the physics layers this area can scan for collisions.
</description>
</method>
<method name="set_collision_mask_bit">
<return type="void">
</return>
@ -225,96 +83,6 @@
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
</description>
</method>
<method name="set_gravity">
<return type="void">
</return>
<argument index="0" name="gravity" type="float">
</argument>
<description>
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity).
</description>
</method>
<method name="set_gravity_distance_scale">
<return type="void">
</return>
<argument index="0" name="distance_scale" type="float">
</argument>
<description>
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
</description>
</method>
<method name="set_gravity_is_point">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector].
</description>
</method>
<method name="set_gravity_vector">
<return type="void">
</return>
<argument index="0" name="vector" type="Vector2">
</argument>
<description>
Set the gravity vector. This vector does not have to be normalized.
If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center.
</description>
</method>
<method name="set_linear_damp">
<return type="void">
</return>
<argument index="0" name="linear_damp" type="float">
</argument>
<description>
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
</description>
</method>
<method name="set_monitorable">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
</description>
</method>
<method name="set_monitoring">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set whether this area can detect bodies/areas entering/exiting it.
</description>
</method>
<method name="set_priority">
<return type="void">
</return>
<argument index="0" name="priority" type="float">
</argument>
<description>
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
</description>
</method>
<method name="set_space_override_mode">
<return type="void">
</return>
<argument index="0" name="space_override_mode" type="int" enum="Area2D.SpaceOverride">
</argument>
<description>
Set the space override mode. This mode controls how an area affects gravity and damp.
AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
</description>
</method>
</methods>
<members>
<member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp">

56
doc/classes/AtlasTexture.xml
View File

@ -12,62 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_atlas" qualifiers="const">
<return type="Texture">
</return>
<description>
</description>
</method>
<method name="get_margin" qualifiers="const">
<return type="Rect2">
</return>
<description>
</description>
</method>
<method name="get_region" qualifiers="const">
<return type="Rect2">
</return>
<description>
</description>
</method>
<method name="has_filter_clip" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_atlas">
<return type="void">
</return>
<argument index="0" name="atlas" type="Texture">
</argument>
<description>
</description>
</method>
<method name="set_filter_clip">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="Rect2">
</argument>
<description>
</description>
</method>
<method name="set_region">
<return type="void">
</return>
<argument index="0" name="region" type="Rect2">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="atlas" type="Texture" setter="set_atlas" getter="get_atlas">

14
doc/classes/AudioEffectAmplify.xml
View File

@ -12,20 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_volume_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_volume_db">
<return type="void">
</return>
<argument index="0" name="volume" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db">

168
doc/classes/AudioEffectChorus.xml
View File

@ -11,174 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_dry" qualifiers="const">
<return type="float">
</return>
<description>
Returns the set dry ratio.
</description>
</method>
<method name="get_voice_count" qualifiers="const">
<return type="int">
</return>
<description>
Returns the set voice count.
</description>
</method>
<method name="get_voice_cutoff_hz" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the voice's set cutoff frequency.
</description>
</method>
<method name="get_voice_delay_ms" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the voice's set delay.
</description>
</method>
<method name="get_voice_depth_ms" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the voice's set filter depth.
</description>
</method>
<method name="get_voice_level_db" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the voice's set maximum volume.
</description>
</method>
<method name="get_voice_pan" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the voice's set pan.
</description>
</method>
<method name="get_voice_rate_hz" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<description>
Returns the voice filter's set rate in cycles.
</description>
</method>
<method name="get_wet" qualifiers="const">
<return type="float">
</return>
<description>
Returns the set applied wetness of the effect.
</description>
</method>
<method name="set_dry">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
Returns the set applied dryness of the effect.
</description>
</method>
<method name="set_voice_count">
<return type="void">
</return>
<argument index="0" name="voices" type="int">
</argument>
<description>
Set the number of voices in the effect's filter.
</description>
</method>
<method name="set_voice_cutoff_hz">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="cutoff_hz" type="float">
</argument>
<description>
Set the cutoff frequency of the voice. The maximum frequency the voice may affect.
</description>
</method>
<method name="set_voice_delay_ms">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="delay_ms" type="float">
</argument>
<description>
Set the delay of the voice's signal.
</description>
</method>
<method name="set_voice_depth_ms">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="depth_ms" type="float">
</argument>
<description>
Set the filter depth of the voice's signal.
</description>
</method>
<method name="set_voice_level_db">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="level_db" type="float">
</argument>
<description>
Set the volume level of the voice.
</description>
</method>
<method name="set_voice_pan">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="pan" type="float">
</argument>
<description>
Set the pan level of the voice.
</description>
</method>
<method name="set_voice_rate_hz">
<return type="void">
</return>
<argument index="0" name="voice_idx" type="int">
</argument>
<argument index="1" name="rate_hz" type="float">
</argument>
<description>
Set the voice filter's rate.
</description>
</method>
<method name="set_wet">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
Set the amount of effect.
</description>
</method>
</methods>
<members>
<member name="dry" type="float" setter="set_dry" getter="get_dry">

98
doc/classes/AudioEffectCompressor.xml
View File

@ -17,104 +17,6 @@
<demos>
</demos>
<methods>
<method name="get_attack_us" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_gain" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_mix" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_ratio" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_release_ms" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_sidechain" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_threshold" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_attack_us">
<return type="void">
</return>
<argument index="0" name="attack_us" type="float">
</argument>
<description>
</description>
</method>
<method name="set_gain">
<return type="void">
</return>
<argument index="0" name="gain" type="float">
</argument>
<description>
</description>
</method>
<method name="set_mix">
<return type="void">
</return>
<argument index="0" name="mix" type="float">
</argument>
<description>
</description>
</method>
<method name="set_ratio">
<return type="void">
</return>
<argument index="0" name="ratio" type="float">
</argument>
<description>
</description>
</method>
<method name="set_release_ms">
<return type="void">
</return>
<argument index="0" name="release_ms" type="float">
</argument>
<description>
</description>
</method>
<method name="set_sidechain">
<return type="void">
</return>
<argument index="0" name="sidechain" type="String">
</argument>
<description>
</description>
</method>
<method name="set_threshold">
<return type="void">
</return>
<argument index="0" name="threshold" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="attack_us" type="float" setter="set_attack_us" getter="get_attack_us">

182
doc/classes/AudioEffectDelay.xml
View File

@ -12,188 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_dry">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_feedback_delay_ms" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_feedback_level_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_feedback_lowpass" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_tap1_delay_ms" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_tap1_level_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_tap1_pan" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_tap2_delay_ms" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_tap2_level_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_tap2_pan" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="is_feedback_active" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_tap1_active" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_tap2_active" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_dry">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_feedback_active">
<return type="void">
</return>
<argument index="0" name="amount" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_feedback_delay_ms">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_feedback_level_db">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_feedback_lowpass">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_tap1_active">
<return type="void">
</return>
<argument index="0" name="amount" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_tap1_delay_ms">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_tap1_level_db">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_tap1_pan">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_tap2_active">
<return type="void">
</return>
<argument index="0" name="amount" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_tap2_delay_ms">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_tap2_level_db">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_tap2_pan">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="dry" type="float" setter="set_dry" getter="get_dry">

70
doc/classes/AudioEffectDistortion.xml
View File

@ -13,76 +13,6 @@
<demos>
</demos>
<methods>
<method name="get_drive" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_keep_hf_hz" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_mode" qualifiers="const">
<return type="int" enum="AudioEffectDistortion.Mode">
</return>
<description>
</description>
</method>
<method name="get_post_gain" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_pre_gain" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_drive">
<return type="void">
</return>
<argument index="0" name="drive" type="float">
</argument>
<description>
</description>
</method>
<method name="set_keep_hf_hz">
<return type="void">
</return>
<argument index="0" name="keep_hf_hz" type="float">
</argument>
<description>
</description>
</method>
<method name="set_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="AudioEffectDistortion.Mode">
</argument>
<description>
</description>
</method>
<method name="set_post_gain">
<return type="void">
</return>
<argument index="0" name="post_gain" type="float">
</argument>
<description>
</description>
</method>
<method name="set_pre_gain">
<return type="void">
</return>
<argument index="0" name="pre_gain" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="drive" type="float" setter="set_drive" getter="get_drive">

56
doc/classes/AudioEffectFilter.xml
View File

@ -11,62 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_cutoff" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_db" qualifiers="const">
<return type="int" enum="AudioEffectFilter.FilterDB">
</return>
<description>
</description>
</method>
<method name="get_gain" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_resonance" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_cutoff">
<return type="void">
</return>
<argument index="0" name="freq" type="float">
</argument>
<description>
</description>
</method>
<method name="set_db">
<return type="void">
</return>
<argument index="0" name="amount" type="int" enum="AudioEffectFilter.FilterDB">
</argument>
<description>
</description>
</method>
<method name="set_gain">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_resonance">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff">

56
doc/classes/AudioEffectLimiter.xml
View File

@ -12,62 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_ceiling_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_soft_clip_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_soft_clip_ratio" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_threshold_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_ceiling_db">
<return type="void">
</return>
<argument index="0" name="ceiling" type="float">
</argument>
<description>
</description>
</method>
<method name="set_soft_clip_db">
<return type="void">
</return>
<argument index="0" name="soft_clip" type="float">
</argument>
<description>
</description>
</method>
<method name="set_soft_clip_ratio">
<return type="void">
</return>
<argument index="0" name="soft_clip" type="float">
</argument>
<description>
</description>
</method>
<method name="set_threshold_db">
<return type="void">
</return>
<argument index="0" name="threshold" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="ceiling_db" type="float" setter="set_ceiling_db" getter="get_ceiling_db">

14
doc/classes/AudioEffectPanner.xml
View File

@ -11,20 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_pan" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_pan">
<return type="void">
</return>
<argument index="0" name="cpanume" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="pan" type="float" setter="set_pan" getter="get_pan">

70
doc/classes/AudioEffectPhaser.xml
View File

@ -12,76 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_depth" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_feedback" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_range_max_hz" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_range_min_hz" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_rate_hz" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_depth">
<return type="void">
</return>
<argument index="0" name="depth" type="float">
</argument>
<description>
</description>
</method>
<method name="set_feedback">
<return type="void">
</return>
<argument index="0" name="fbk" type="float">
</argument>
<description>
</description>
</method>
<method name="set_range_max_hz">
<return type="void">
</return>
<argument index="0" name="hz" type="float">
</argument>
<description>
</description>
</method>
<method name="set_range_min_hz">
<return type="void">
</return>
<argument index="0" name="hz" type="float">
</argument>
<description>
</description>
</method>
<method name="set_rate_hz">
<return type="void">
</return>
<argument index="0" name="hz" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="depth" type="float" setter="set_depth" getter="get_depth">

14
doc/classes/AudioEffectPitchShift.xml
View File

@ -12,20 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_pitch_scale" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_pitch_scale">
<return type="void">
</return>
<argument index="0" name="rate" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale">

98
doc/classes/AudioEffectReverb.xml
View File

@ -12,78 +12,12 @@
<demos>
</demos>
<methods>
<method name="get_damping" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_dry" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_hpf" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_predelay_feedback" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_predelay_msec" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_room_size" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_spread" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_wet" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_damping">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_dry">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_hpf">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_predelay_feedback">
<return type="void">
</return>
@ -92,38 +26,6 @@
<description>
</description>
</method>
<method name="set_predelay_msec">
<return type="void">
</return>
<argument index="0" name="msec" type="float">
</argument>
<description>
</description>
</method>
<method name="set_room_size">
<return type="void">
</return>
<argument index="0" name="size" type="float">
</argument>
<description>
</description>
</method>
<method name="set_spread">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_wet">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="damping" type="float" setter="set_damping" getter="get_damping">

42
doc/classes/AudioEffectStereoEnhance.xml
View File

@ -9,48 +9,6 @@
<demos>
</demos>
<methods>
<method name="get_pan_pullout" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_surround" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_time_pullout" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_pan_pullout">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_surround">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_time_pullout">
<return type="void">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="pan_pullout" type="float" setter="set_pan_pullout" getter="get_pan_pullout">

76
doc/classes/AudioStreamPlayer.xml
View File

@ -12,18 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_bus" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_mix_target" qualifiers="const">
<return type="int" enum="AudioStreamPlayer.MixTarget">
</return>
<description>
</description>
</method>
<method name="get_playback_position">
<return type="float">
</return>
@ -31,30 +19,6 @@
Returns the position in the [AudioStream].
</description>
</method>
<method name="get_stream" qualifiers="const">
<return type="AudioStream">
</return>
<description>
</description>
</method>
<method name="get_volume_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="is_autoplay_enabled">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="play">
<return type="void">
</return>
@ -73,46 +37,6 @@
Sets the position from which audio will be played, in seconds.
</description>
</method>
<method name="set_autoplay">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_bus">
<return type="void">
</return>
<argument index="0" name="bus" type="String">
</argument>
<description>
</description>
</method>
<method name="set_mix_target">
<return type="void">
</return>
<argument index="0" name="mix_target" type="int" enum="AudioStreamPlayer.MixTarget">
</argument>
<description>
</description>
</method>
<method name="set_stream">
<return type="void">
</return>
<argument index="0" name="stream" type="AudioStream">
</argument>
<description>
</description>
</method>
<method name="set_volume_db">
<return type="void">
</return>
<argument index="0" name="volume_db" type="float">
</argument>
<description>
</description>
</method>
<method name="stop">
<return type="void">
</return>

104
doc/classes/AudioStreamPlayer2D.xml
View File

@ -12,30 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_area_mask" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_attenuation" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_bus" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_max_distance" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_playback_position">
<return type="float">
</return>
@ -43,30 +19,6 @@
Returns the position in the [AudioStream].
</description>
</method>
<method name="get_stream" qualifiers="const">
<return type="AudioStream">
</return>
<description>
</description>
</method>
<method name="get_volume_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="is_autoplay_enabled">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="play">
<return type="void">
</return>
@ -85,62 +37,6 @@
Sets the position from which audio will be played, in seconds.
</description>
</method>
<method name="set_area_mask">
<return type="void">
</return>
<argument index="0" name="mask" type="int">
</argument>
<description>
</description>
</method>
<method name="set_attenuation">
<return type="void">
</return>
<argument index="0" name="curve" type="float">
</argument>
<description>
</description>
</method>
<method name="set_autoplay">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_bus">
<return type="void">
</return>
<argument index="0" name="bus" type="String">
</argument>
<description>
</description>
</method>
<method name="set_max_distance">
<return type="void">
</return>
<argument index="0" name="pixels" type="float">
</argument>
<description>
</description>
</method>
<method name="set_stream">
<return type="void">
</return>
<argument index="0" name="stream" type="AudioStream">
</argument>
<description>
</description>
</method>
<method name="set_volume_db">
<return type="void">
</return>
<argument index="0" name="volume_db" type="float">
</argument>
<description>
</description>
</method>
<method name="stop">
<return type="void">
</return>

230
doc/classes/AudioStreamPlayer3D.xml
View File

@ -12,72 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_area_mask" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_attenuation_filter_cutoff_hz" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_attenuation_filter_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_attenuation_model" qualifiers="const">
<return type="int" enum="AudioStreamPlayer3D.AttenuationModel">
</return>
<description>
</description>
</method>
<method name="get_bus" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_doppler_tracking" qualifiers="const">
<return type="int" enum="AudioStreamPlayer3D.DopplerTracking">
</return>
<description>
</description>
</method>
<method name="get_emission_angle" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_emission_angle_filter_attenuation_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_max_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_max_distance" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_out_of_range_mode" qualifiers="const">
<return type="int" enum="AudioStreamPlayer3D.OutOfRangeMode">
</return>
<description>
</description>
</method>
<method name="get_playback_position">
<return type="float">
</return>
@ -85,42 +19,6 @@
Returns the position in the [AudioStream].
</description>
</method>
<method name="get_stream" qualifiers="const">
<return type="AudioStream">
</return>
<description>
</description>
</method>
<method name="get_unit_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_unit_size" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="is_autoplay_enabled">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_emission_angle_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="play">
<return type="void">
</return>
@ -139,134 +37,6 @@
Sets the position from which audio will be played, in seconds.
</description>
</method>
<method name="set_area_mask">
<return type="void">
</return>
<argument index="0" name="mask" type="int">
</argument>
<description>
</description>
</method>
<method name="set_attenuation_filter_cutoff_hz">
<return type="void">
</return>
<argument index="0" name="degrees" type="float">
</argument>
<description>
</description>
</method>
<method name="set_attenuation_filter_db">
<return type="void">
</return>
<argument index="0" name="db" type="float">
</argument>
<description>
</description>
</method>
<method name="set_attenuation_model">
<return type="void">
</return>
<argument index="0" name="model" type="int" enum="AudioStreamPlayer3D.AttenuationModel">
</argument>
<description>
</description>
</method>
<method name="set_autoplay">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_bus">
<return type="void">
</return>
<argument index="0" name="bus" type="String">
</argument>
<description>
</description>
</method>
<method name="set_doppler_tracking">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="AudioStreamPlayer3D.DopplerTracking">
</argument>
<description>
</description>
</method>
<method name="set_emission_angle">
<return type="void">
</return>
<argument index="0" name="degrees" type="float">
</argument>
<description>
</description>
</method>
<method name="set_emission_angle_enabled">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_emission_angle_filter_attenuation_db">
<return type="void">
</return>
<argument index="0" name="db" type="float">
</argument>
<description>
</description>
</method>
<method name="set_max_db">
<return type="void">
</return>
<argument index="0" name="max_db" type="float">
</argument>
<description>
</description>
</method>
<method name="set_max_distance">
<return type="void">
</return>
<argument index="0" name="metres" type="float">
</argument>
<description>
</description>
</method>
<method name="set_out_of_range_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="AudioStreamPlayer3D.OutOfRangeMode">
</argument>
<description>
</description>
</method>
<method name="set_stream">
<return type="void">
</return>
<argument index="0" name="stream" type="AudioStream">
</argument>
<description>
</description>
</method>
<method name="set_unit_db">
<return type="void">
</return>
<argument index="0" name="unit_db" type="float">
</argument>
<description>
</description>
</method>
<method name="set_unit_size">
<return type="void">
</return>
<argument index="0" name="unit_size" type="float">
</argument>
<description>
</description>
</method>
<method name="stop">
<return type="void">
</return>

28
doc/classes/AudioStreamRandomPitch.xml
View File

@ -11,34 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_audio_stream" qualifiers="const">
<return type="AudioStream">
</return>
<description>
</description>
</method>
<method name="get_random_pitch" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_audio_stream">
<return type="void">
</return>
<argument index="0" name="stream" type="AudioStream">
</argument>
<description>
</description>
</method>
<method name="set_random_pitch">
<return type="void">
</return>
<argument index="0" name="scale" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="audio_stream" type="AudioStream" setter="set_audio_stream" getter="get_audio_stream">

98
doc/classes/AudioStreamSample.xml
View File

@ -11,104 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_data" qualifiers="const">
<return type="PoolByteArray">
</return>
<description>
</description>
</method>
<method name="get_format" qualifiers="const">
<return type="int" enum="AudioStreamSample.Format">
</return>
<description>
</description>
</method>
<method name="get_loop_begin" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_loop_end" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_loop_mode" qualifiers="const">
<return type="int" enum="AudioStreamSample.LoopMode">
</return>
<description>
</description>
</method>
<method name="get_mix_rate" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="is_stereo" 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_format">
<return type="void">
</return>
<argument index="0" name="format" type="int" enum="AudioStreamSample.Format">
</argument>
<description>
</description>
</method>
<method name="set_loop_begin">
<return type="void">
</return>
<argument index="0" name="loop_begin" type="int">
</argument>
<description>
</description>
</method>
<method name="set_loop_end">
<return type="void">
</return>
<argument index="0" name="loop_end" type="int">
</argument>
<description>
</description>
</method>
<method name="set_loop_mode">
<return type="void">
</return>
<argument index="0" name="loop_mode" type="int" enum="AudioStreamSample.LoopMode">
</argument>
<description>
</description>
</method>
<method name="set_mix_rate">
<return type="void">
</return>
<argument index="0" name="mix_rate" type="int">
</argument>
<description>
</description>
</method>
<method name="set_stereo">
<return type="void">
</return>
<argument index="0" name="stereo" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="data" type="PoolByteArray" setter="set_data" getter="get_data">

32
doc/classes/BackBufferCopy.xml
View File

@ -11,38 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_copy_mode" qualifiers="const">
<return type="int" enum="BackBufferCopy.CopyMode">
</return>
<description>
Return the copy mode currently applied to the BackBufferCopy. See [code]COPY_MODE_*[/code] constants.
</description>
</method>
<method name="get_rect" qualifiers="const">
<return type="Rect2">
</return>
<description>
Return the area covered by the BackBufferCopy.
</description>
</method>
<method name="set_copy_mode">
<return type="void">
</return>
<argument index="0" name="copy_mode" type="int" enum="BackBufferCopy.CopyMode">
</argument>
<description>
Set the copy mode of the BackBufferCopy. See [code]COPY_MODE_*[/code] constants.
</description>
</method>
<method name="set_rect">
<return type="void">
</return>
<argument index="0" name="rect" type="Rect2">
</argument>
<description>
Defines the area covered by the BackBufferCopy.
</description>
</method>
</methods>
<members>
<member name="copy_mode" type="int" setter="set_copy_mode" getter="get_copy_mode" enum="BackBufferCopy.CopyMode">

108
doc/classes/BaseButton.xml
View File

@ -27,19 +27,6 @@
Called when button is toggled (only if toggle_mode is active).
</description>
</method>
<method name="get_action_mode" qualifiers="const">
<return type="int" enum="BaseButton.ActionMode">
</return>
<description>
Return the current mode of action (see [method set_action_mode]) (one of the ACTION_MODE_* constants).
</description>
</method>
<method name="get_button_group" qualifiers="const">
<return type="ButtonGroup">
</return>
<description>
</description>
</method>
<method name="get_draw_mode" qualifiers="const">
<return type="int" enum="BaseButton.DrawMode">
</return>
@ -47,26 +34,6 @@
Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum.
</description>
</method>
<method name="get_enabled_focus_mode" qualifiers="const">
<return type="int" enum="Control.FocusMode">
</return>
<description>
Returns focus access mode used when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]).
</description>
</method>
<method name="get_shortcut" qualifiers="const">
<return type="ShortCut">
</return>
<description>
</description>
</method>
<method name="is_disabled" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether the button is in disabled state (see [method set_disabled]).
</description>
</method>
<method name="is_hovered" qualifiers="const">
<return type="bool">
</return>
@ -74,81 +41,6 @@
Return true if mouse entered the button before it exit.
</description>
</method>
<method name="is_pressed" qualifiers="const">
<return type="bool">
</return>
<description>
If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down.
</description>
</method>
<method name="is_toggle_mode" qualifiers="const">
<return type="bool">
</return>
<description>
Return the toggle_mode property (see [method set_toggle_mode]).
</description>
</method>
<method name="set_action_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="BaseButton.ActionMode">
</argument>
<description>
Set the current mode of action, determining when the button is considered clicked (see the ACTION_MODE_* constants).
</description>
</method>
<method name="set_button_group">
<return type="void">
</return>
<argument index="0" name="button_group" type="ButtonGroup">
</argument>
<description>
</description>
</method>
<method name="set_disabled">
<return type="void">
</return>
<argument index="0" name="disabled" type="bool">
</argument>
<description>
Set the button into disabled state. When a button is disabled, it can't be clicked or toggled.
</description>
</method>
<method name="set_enabled_focus_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="Control.FocusMode">
</argument>
<description>
Sets the focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]).
</description>
</method>
<method name="set_pressed">
<return type="void">
</return>
<argument index="0" name="pressed" type="bool">
</argument>
<description>
Set the button to pressed state (only if toggle_mode is active).
</description>
</method>
<method name="set_shortcut">
<return type="void">
</return>
<argument index="0" name="shortcut" type="ShortCut">
</argument>
<description>
</description>
</method>
<method name="set_toggle_mode">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked.
</description>
</method>
</methods>
<members>
<member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode">

43
doc/classes/BitmapFont.xml
View File

@ -77,13 +77,6 @@
Returns the size of a character, optionally taking kerning into account if the next character is provided.
</description>
</method>
<method name="get_fallback" qualifiers="const">
<return type="BitmapFont">
</return>
<description>
Returns the fallback BitmapFont.
</description>
</method>
<method name="get_kerning_pair" qualifiers="const">
<return type="int">
</return>
@ -111,42 +104,6 @@
Returns the number of textures in the BitmapFont atlas.
</description>
</method>
<method name="set_ascent">
<return type="void">
</return>
<argument index="0" name="px" type="float">
</argument>
<description>
Sets the font ascent (number of pixels above the baseline).
</description>
</method>
<method name="set_distance_field_hint">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
If [code]true[/code] distance field hint is enabled.
</description>
</method>
<method name="set_fallback">
<return type="void">
</return>
<argument index="0" name="fallback" type="BitmapFont">
</argument>
<description>
Sets the fallback BitmapFont.
</description>
</method>
<method name="set_height">
<return type="void">
</return>
<argument index="0" name="px" type="float">
</argument>
<description>
Sets the total font height (ascent plus descent) in pixels.
</description>
</method>
</methods>
<members>
<member name="ascent" type="float" setter="set_ascent" getter="get_ascent">

16
doc/classes/BoxContainer.xml
View File

@ -20,22 +20,6 @@
Adds a control to the box as a spacer. If [code]true[/code], [i]begin[/i] will insert the spacer control in front of other children.
</description>
</method>
<method name="get_alignment" qualifiers="const">
<return type="int" enum="BoxContainer.AlignMode">
</return>
<description>
Return the alignment of children in the container.
</description>
</method>
<method name="set_alignment">
<return type="void">
</return>
<argument index="0" name="alignment" type="int" enum="BoxContainer.AlignMode">
</argument>
<description>
Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END).
</description>
</method>
</methods>
<members>
<member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignMode">

16
doc/classes/BoxShape.xml
View File

@ -11,22 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_extents" qualifiers="const">
<return type="Vector3">
</return>
<description>
Return the half extents of the shape.
</description>
</method>
<method name="set_extents">
<return type="void">
</return>
<argument index="0" name="extents" type="Vector3">
</argument>
<description>
Set the half extents for the shape.
</description>
</method>
</methods>
<members>
<member name="extents" type="Vector3" setter="set_extents" getter="get_extents">

70
doc/classes/Button.xml
View File

@ -11,76 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_button_icon" qualifiers="const">
<return type="Texture">
</return>
<description>
</description>
</method>
<method name="get_clip_text" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_text" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_text_align" qualifiers="const">
<return type="int" enum="Button.TextAlign">
</return>
<description>
</description>
</method>
<method name="is_flat" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_button_icon">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
<description>
</description>
</method>
<method name="set_clip_text">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_flat">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_text">
<return type="void">
</return>
<argument index="0" name="text" type="String">
</argument>
<description>
</description>
</method>
<method name="set_text_align">
<return type="void">
</return>
<argument index="0" name="align" type="int" enum="Button.TextAlign">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="align" type="int" setter="set_text_align" getter="get_text_align" enum="Button.TextAlign">

219
doc/classes/Camera2D.xml
View File

@ -32,12 +32,6 @@
Force the camera to update scroll immediately.
</description>
</method>
<method name="get_anchor_mode" qualifiers="const">
<return type="int" enum="Camera2D.AnchorMode">
</return>
<description>
</description>
</method>
<method name="get_camera_position" qualifiers="const">
<return type="Vector2">
</return>
@ -57,110 +51,18 @@
<description>
</description>
</method>
<method name="get_drag_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
Return the margins needed to drag the camera (see [method set_drag_margin]).
</description>
</method>
<method name="get_follow_smoothing" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_h_offset" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_limit" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
Return the scrolling limit in pixels.
</description>
</method>
<method name="get_offset" qualifiers="const">
<return type="Vector2">
</return>
<description>
Return the scroll offset.
</description>
</method>
<method name="get_v_offset" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_zoom" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="is_current" qualifiers="const">
<return type="bool">
</return>
<description>
Return true of this is the current camera (see [method make_current]).
</description>
</method>
<method name="is_follow_smoothing_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_h_drag_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_limit_drawing_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_limit_smoothing_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_margin_drawing_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_rotating" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_screen_drawing_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_v_drag_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="make_current">
<return type="void">
</return>
@ -176,14 +78,6 @@
This has no effect if smoothing is disabled.
</description>
</method>
<method name="set_anchor_mode">
<return type="void">
</return>
<argument index="0" name="anchor_mode" type="int" enum="Camera2D.AnchorMode">
</argument>
<description>
</description>
</method>
<method name="set_custom_viewport">
<return type="void">
</return>
@ -192,41 +86,6 @@
<description>
</description>
</method>
<method name="set_drag_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="drag_margin" type="float">
</argument>
<description>
Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN_* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges.
</description>
</method>
<method name="set_enable_follow_smoothing">
<return type="void">
</return>
<argument index="0" name="follow_smoothing" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_follow_smoothing">
<return type="void">
</return>
<argument index="0" name="follow_smoothing" type="float">
</argument>
<description>
</description>
</method>
<method name="set_h_drag_enabled">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_h_offset">
<return type="void">
</return>
@ -235,76 +94,6 @@
<description>
</description>
</method>
<method name="set_limit">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="limit" type="int">
</argument>
<description>
Set the scrolling limit in pixels.
</description>
</method>
<method name="set_limit_drawing_enabled">
<return type="void">
</return>
<argument index="0" name="limit_drawing_enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_limit_smoothing_enabled">
<return type="void">
</return>
<argument index="0" name="limit_smoothing_enabled" type="bool">
</argument>
<description>
Smooth camera when reaching camera limits.
This requires camera smoothing being enabled to have a noticeable effect.
</description>
</method>
<method name="set_margin_drawing_enabled">
<return type="void">
</return>
<argument index="0" name="margin_drawing_enabled" 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 scroll offset. Useful for looking around or camera shake animations.
</description>
</method>
<method name="set_rotating">
<return type="void">
</return>
<argument index="0" name="rotating" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_screen_drawing_enabled">
<return type="void">
</return>
<argument index="0" name="screen_drawing_enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_v_drag_enabled">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_v_offset">
<return type="void">
</return>
@ -313,14 +102,6 @@
<description>
</description>
</method>
<method name="set_zoom">
<return type="void">
</return>
<argument index="0" name="zoom" type="Vector2">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="anchor_mode" type="int" setter="set_anchor_mode" getter="get_anchor_mode" enum="Camera2D.AnchorMode">

113
doc/classes/CanvasItem.xml
View File

@ -313,13 +313,6 @@
Get the global transform matrix of this item in relation to the canvas.
</description>
</method>
<method name="get_light_mask" qualifiers="const">
<return type="int">
</return>
<description>
Get this item's light mask number.
</description>
</method>
<method name="get_local_mouse_position" qualifiers="const">
<return type="Vector2">
</return>
@ -327,27 +320,6 @@
Get the mouse position relative to this item's position.
</description>
</method>
<method name="get_material" qualifiers="const">
<return type="Material">
</return>
<description>
Get the material of this item.
</description>
</method>
<method name="get_modulate" qualifiers="const">
<return type="Color">
</return>
<description>
Get the modulate of the CanvasItem, which affects children items too.
</description>
</method>
<method name="get_self_modulate" qualifiers="const">
<return type="Color">
</return>
<description>
Get the self-modulate of the CanvasItem.
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform2D">
</return>
@ -355,13 +327,6 @@
Get the transform matrix of this item.
</description>
</method>
<method name="get_use_parent_material" qualifiers="const">
<return type="bool">
</return>
<description>
Get whether this item uses its parent's material.
</description>
</method>
<method name="get_viewport_rect" qualifiers="const">
<return type="Rect2">
</return>
@ -390,13 +355,6 @@
Hide the CanvasItem currently visible.
</description>
</method>
<method name="is_draw_behind_parent_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether the item is drawn behind its parent.
</description>
</method>
<method name="is_local_transform_notification_enabled" qualifiers="const">
<return type="bool">
</return>
@ -416,13 +374,6 @@
<description>
</description>
</method>
<method name="is_visible" qualifiers="const">
<return type="bool">
</return>
<description>
Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden.
</description>
</method>
<method name="is_visible_in_tree" qualifiers="const">
<return type="bool">
</return>
@ -454,42 +405,6 @@
Set as top level. This means that it will not inherit transform from parent canvas items.
</description>
</method>
<method name="set_draw_behind_parent">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set whether the canvas item is drawn behind its parent.
</description>
</method>
<method name="set_light_mask">
<return type="void">
</return>
<argument index="0" name="light_mask" type="int">
</argument>
<description>
Set the ligtht mask number of this item.
</description>
</method>
<method name="set_material">
<return type="void">
</return>
<argument index="0" name="material" type="Material">
</argument>
<description>
Set the material of this item.
</description>
</method>
<method name="set_modulate">
<return type="void">
</return>
<argument index="0" name="modulate" type="Color">
</argument>
<description>
Set the modulate of the CanvasItem. This [i]affects[/i] the modulation of children items.
</description>
</method>
<method name="set_notify_local_transform">
<return type="void">
</return>
@ -506,34 +421,6 @@
<description>
</description>
</method>
<method name="set_self_modulate">
<return type="void">
</return>
<argument index="0" name="self_modulate" type="Color">
</argument>
<description>
Set the self-modulate of the CanvasItem. This does not affect the modulation of children items.
</description>
</method>
<method name="set_use_parent_material">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set whether or not this item should use its parent's material.
</description>
</method>
<method name="set_visible">
<return type="void">
</return>
<argument index="0" name="visible" type="bool">
</argument>
<description>
Set whether this item should be visible or not.
Note that a hidden CanvasItem will make all children hidden too, so no matter what is set here this item won't be shown if its parent or grandparents nodes are hidden.
</description>
</method>
<method name="show">
<return type="void">
</return>

28
doc/classes/CanvasItemMaterial.xml
View File

@ -9,34 +9,6 @@
<demos>
</demos>
<methods>
<method name="get_blend_mode" qualifiers="const">
<return type="int" enum="CanvasItemMaterial.BlendMode">
</return>
<description>
</description>
</method>
<method name="get_light_mode" qualifiers="const">
<return type="int" enum="CanvasItemMaterial.LightMode">
</return>
<description>
</description>
</method>
<method name="set_blend_mode">
<return type="void">
</return>
<argument index="0" name="blend_mode" type="int" enum="CanvasItemMaterial.BlendMode">
</argument>
<description>
</description>
</method>
<method name="set_light_mode">
<return type="void">
</return>
<argument index="0" name="light_mode" type="int" enum="CanvasItemMaterial.LightMode">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="CanvasItemMaterial.BlendMode">

64
doc/classes/CanvasLayer.xml
View File

@ -17,20 +17,6 @@
<description>
</description>
</method>
<method name="get_layer" qualifiers="const">
<return type="int">
</return>
<description>
Return the layer index, determines the draw order, a lower value will be below a higher one.
</description>
</method>
<method name="get_offset" qualifiers="const">
<return type="Vector2">
</return>
<description>
Return the base offset for this layer (helper).
</description>
</method>
<method name="get_rotation" qualifiers="const">
<return type="float">
</return>
@ -38,20 +24,6 @@
Return the base rotation for this layer in radians (helper).
</description>
</method>
<method name="get_rotation_degrees" qualifiers="const">
<return type="float">
</return>
<description>
Return the base rotation for this layer in degrees.
</description>
</method>
<method name="get_scale" qualifiers="const">
<return type="Vector2">
</return>
<description>
Return the base scale for this layer (helper).
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform2D">
</return>
@ -74,24 +46,6 @@
<description>
</description>
</method>
<method name="set_layer">
<return type="void">
</return>
<argument index="0" name="layer" type="int">
</argument>
<description>
Set the layer index, determines the draw order, a lower value will be below a higher one.
</description>
</method>
<method name="set_offset">
<return type="void">
</return>
<argument index="0" name="offset" type="Vector2">
</argument>
<description>
Set the base offset for this layer (helper).
</description>
</method>
<method name="set_rotation">
<return type="void">
</return>
@ -101,24 +55,6 @@
Set the base rotation for this layer in radians (helper).
</description>
</method>
<method name="set_rotation_degrees">
<return type="void">
</return>
<argument index="0" name="degrees" type="float">
</argument>
<description>
Set the base rotation for this layer in degrees (helper).
</description>
</method>
<method name="set_scale">
<return type="void">
</return>
<argument index="0" name="scale" type="Vector2">
</argument>
<description>
Set the base scale for this layer (helper).
</description>
</method>
<method name="set_transform">
<return type="void">
</return>

16
doc/classes/CanvasModulate.xml
View File

@ -11,22 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_color" qualifiers="const">
<return type="Color">
</return>
<description>
Gets the canvas tint color
</description>
</method>
<method name="set_color">
<return type="void">
</return>
<argument index="0" name="color" type="Color">
</argument>
<description>
Sets the canvas tint color
</description>
</method>
</methods>
<members>
<member name="color" type="Color" setter="set_color" getter="get_color">

56
doc/classes/CapsuleMesh.xml
View File

@ -11,62 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_mid_height" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_radial_segments" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_radius" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_rings" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="set_mid_height">
<return type="void">
</return>
<argument index="0" name="mid_height" type="float">
</argument>
<description>
</description>
</method>
<method name="set_radial_segments">
<return type="void">
</return>
<argument index="0" name="segments" type="int">
</argument>
<description>
</description>
</method>
<method name="set_radius">
<return type="void">
</return>
<argument index="0" name="radius" type="float">
</argument>
<description>
</description>
</method>
<method name="set_rings">
<return type="void">
</return>
<argument index="0" name="rings" type="int">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="mid_height" type="float" setter="set_mid_height" getter="get_mid_height">

32
doc/classes/CapsuleShape.xml
View File

@ -11,38 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_height" qualifiers="const">
<return type="float">
</return>
<description>
Return the capsule height.
</description>
</method>
<method name="get_radius" qualifiers="const">
<return type="float">
</return>
<description>
Return the capsule radius.
</description>
</method>
<method name="set_height">
<return type="void">
</return>
<argument index="0" name="height" type="float">
</argument>
<description>
Set the capsule height.
</description>
</method>
<method name="set_radius">
<return type="void">
</return>
<argument index="0" name="radius" type="float">
</argument>
<description>
Set the capsule radius.
</description>
</method>
</methods>
<members>
<member name="height" type="float" setter="set_height" getter="get_height">

32
doc/classes/CapsuleShape2D.xml
View File

@ -11,38 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_height" qualifiers="const">
<return type="float">
</return>
<description>
Return the height of the [code]CapsuleShape2D[/code].
</description>
</method>
<method name="get_radius" qualifiers="const">
<return type="float">
</return>
<description>
Return the radius of the [code]CapsuleShape2D[/code].
</description>
</method>
<method name="set_height">
<return type="void">
</return>
<argument index="0" name="height" type="float">
</argument>
<description>
Set the height of the [code]CapsuleShape2D[/code].
</description>
</method>
<method name="set_radius">
<return type="void">
</return>
<argument index="0" name="radius" type="float">
</argument>
<description>
Set the radius of the [code]CapsuleShape2D[/code].
</description>
</method>
</methods>
<members>
<member name="height" type="float" setter="set_height" getter="get_height">

16
doc/classes/CenterContainer.xml
View File

@ -11,22 +11,6 @@
<demos>
</demos>
<methods>
<method name="is_using_top_left" qualifiers="const">
<return type="bool">
</return>
<description>
Should put children to the top left corner instead of center of the container.
</description>
</method>
<method name="set_use_top_left">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container).
</description>
</method>
</methods>
<members>
<member name="use_top_left" type="bool" setter="set_use_top_left" getter="is_using_top_left">

16
doc/classes/CircleShape2D.xml
View File

@ -11,22 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_radius" qualifiers="const">
<return type="float">
</return>
<description>
Return the radius of the circle shape.
</description>
</method>
<method name="set_radius">
<return type="void">
</return>
<argument index="0" name="radius" type="float">
</argument>
<description>
Set the radius of the circle shape.
</description>
</method>
</methods>
<members>
<member name="radius" type="float" setter="set_radius" getter="get_radius">

28
doc/classes/CollisionObject.xml
View File

@ -36,12 +36,6 @@
Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference.
</description>
</method>
<method name="get_capture_input_on_drag" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_rid" qualifiers="const">
<return type="RID">
</return>
@ -56,12 +50,6 @@
Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument.
</description>
</method>
<method name="is_ray_pickable" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_shape_owner_disabled" qualifiers="const">
<return type="bool">
</return>
@ -80,22 +68,6 @@
Removes the given shape owner.
</description>
</method>
<method name="set_capture_input_on_drag">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_ray_pickable">
<return type="void">
</return>
<argument index="0" name="ray_pickable" type="bool">
</argument>
<description>
</description>
</method>
<method name="shape_find_owner" qualifiers="const">
<return type="int">
</return>

16
doc/classes/CollisionObject2D.xml
View File

@ -46,13 +46,6 @@
Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument.
</description>
</method>
<method name="is_pickable" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether this object is pickable.
</description>
</method>
<method name="is_shape_owner_disabled" qualifiers="const">
<return type="bool">
</return>
@ -79,15 +72,6 @@
Removes the given shape owner.
</description>
</method>
<method name="set_pickable">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events.
</description>
</method>
<method name="shape_find_owner" qualifiers="const">
<return type="int">
</return>

42
doc/classes/CollisionPolygon.xml
View File

@ -11,48 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_depth" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_polygon" qualifiers="const">
<return type="PoolVector2Array">
</return>
<description>
</description>
</method>
<method name="is_disabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_depth">
<return type="void">
</return>
<argument index="0" name="depth" type="float">
</argument>
<description>
</description>
</method>
<method name="set_disabled">
<return type="void">
</return>
<argument index="0" name="disabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_polygon">
<return type="void">
</return>
<argument index="0" name="polygon" type="PoolVector2Array">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="depth" type="float" setter="set_depth" getter="get_depth">

61
doc/classes/CollisionPolygon2D.xml
View File

@ -11,67 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_build_mode" qualifiers="const">
<return type="int" enum="CollisionPolygon2D.BuildMode">
</return>
<description>
Return whether the polygon is a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]).
</description>
</method>
<method name="get_polygon" qualifiers="const">
<return type="PoolVector2Array">
</return>
<description>
Return the list of points that define the polygon.
</description>
</method>
<method name="is_disabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_one_way_collision_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_build_mode">
<return type="void">
</return>
<argument index="0" name="build_mode" type="int" enum="CollisionPolygon2D.BuildMode">
</argument>
<description>
Set whether the polygon is to be a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]).
</description>
</method>
<method name="set_disabled">
<return type="void">
</return>
<argument index="0" name="disabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_one_way_collision">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_polygon">
<return type="void">
</return>
<argument index="0" name="polygon" type="PoolVector2Array">
</argument>
<description>
Set the array of points forming the polygon.
When editing the point list via the editor, depending on [method get_build_mode], it has to be a list of points (for [code]build_mode==0[/code]), or a list of lines (for [code]build_mode==1[/code]). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point.
</description>
</method>
</methods>
<members>
<member name="build_mode" type="int" setter="set_build_mode" getter="get_build_mode" enum="CollisionPolygon2D.BuildMode">

28
doc/classes/CollisionShape.xml
View File

@ -11,18 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_shape" qualifiers="const">
<return type="Shape">
</return>
<description>
</description>
</method>
<method name="is_disabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="make_convex_from_brothers">
<return type="void">
</return>
@ -39,22 +27,6 @@
If this method exists within a script it will be called whenever the shape resource has been modified.
</description>
</method>
<method name="set_disabled">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_shape">
<return type="void">
</return>
<argument index="0" name="shape" type="Shape">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">

42
doc/classes/CollisionShape2D.xml
View File

@ -11,48 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_shape" qualifiers="const">
<return type="Shape2D">
</return>
<description>
</description>
</method>
<method name="is_disabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_one_way_collision_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_disabled">
<return type="void">
</return>
<argument index="0" name="disabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_one_way_collision">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_shape">
<return type="void">
</return>
<argument index="0" name="shape" type="Shape2D">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">

36
doc/classes/ColorPickerButton.xml
View File

@ -11,48 +11,12 @@
<demos>
</demos>
<methods>
<method name="get_pick_color" qualifiers="const">
<return type="Color">
</return>
<description>
</description>
</method>
<method name="get_picker">
<return type="ColorPicker">
</return>
<description>
</description>
</method>
<method name="is_editing_alpha" qualifiers="const">
<return type="bool">
</return>
<description>
See [method ColorPicker.is_edit_alpha]
</description>
</method>
<method name="set_edit_alpha">
<return type="void">
</return>
<argument index="0" name="show" type="bool">
</argument>
<description>
See [method ColorPicker.set_edit_alpha]
</description>
</method>
<method name="set_pick_color">
<return type="void">
</return>
<argument index="0" name="color" type="Color">
</argument>
<description>
Set new color to ColorRect.
[codeblock]
var cr = get_node("colorrect_node")
cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red
[/codeblock]
</description>
</method>
</methods>
<members>
<member name="color" type="Color" setter="set_pick_color" getter="get_pick_color">

24
doc/classes/ColorRect.xml
View File

@ -11,30 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_frame_color" qualifiers="const">
<return type="Color">
</return>
<description>
Return the color in RGBA format.
[codeblock]
var cr = get_node("colorrect_node")
var c = cr.get_frame_color() # Default color is white
[/codeblock]
</description>
</method>
<method name="set_frame_color">
<return type="void">
</return>
<argument index="0" name="color" type="Color">
</argument>
<description>
Set new color to ColorRect.
[codeblock]
var cr = get_node("colorrect_node")
cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red
[/codeblock]
</description>
</method>
</methods>
<members>
<member name="color" type="Color" setter="set_frame_color" getter="get_frame_color">

16
doc/classes/ConcavePolygonShape2D.xml
View File

@ -12,22 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_segments" qualifiers="const">
<return type="PoolVector2Array">
</return>
<description>
Return the array of segments.
</description>
</method>
<method name="set_segments">
<return type="void">
</return>
<argument index="0" name="segments" type="PoolVector2Array">
</argument>
<description>
Set the array of segments.
</description>
</method>
</methods>
<members>
<member name="segments" type="PoolVector2Array" setter="set_segments" getter="get_segments">

18
doc/classes/ConeTwistJoint.xml
View File

@ -13,24 +13,6 @@
<demos>
</demos>
<methods>
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="ConeTwistJoint.Param">
</argument>
<description>
</description>
</method>
<method name="set_param">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="ConeTwistJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="bias" type="float" setter="set_param" getter="get_param">

302
doc/classes/Control.xml
View File

@ -137,15 +137,6 @@
<description>
</description>
</method>
<method name="get_anchor" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
</description>
</method>
<method name="get_begin" qualifiers="const">
<return type="Vector2">
</return>
@ -187,12 +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_custom_minimum_size" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_default_cursor_shape" qualifiers="const">
<return type="int" enum="Control.CursorShape">
</return>
@ -222,22 +207,6 @@
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_neighbour" qualifiers="const">
<return type="NodePath">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
Return the forced neighbour for moving the input focus to. When pressing directional/joypad directions, focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
</description>
</method>
<method name="get_focus_next" qualifiers="const">
<return type="NodePath">
</return>
<description>
Return the 'focus_next' for moving input focus to. When pressing TAB, focus is moved to the next control in the tree. However, the control to move to can be forced with this function.
</description>
</method>
<method name="get_focus_owner" qualifiers="const">
<return type="Control">
</return>
@ -245,13 +214,6 @@
Return which control is owning the keyboard focus, or null if no one.
</description>
</method>
<method name="get_focus_previous" qualifiers="const">
<return type="NodePath">
</return>
<description>
Return the 'focus_previous' for moving input focus to. When pressing Shift+TAB focus is moved to the previous control in the tree. However, the control to move to can be forced with this function.
</description>
</method>
<method name="get_font" qualifiers="const">
<return type="Font">
</return>
@ -276,19 +238,6 @@
Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_position], [method get_size]).
</description>
</method>
<method name="get_h_grow_direction" qualifiers="const">
<return type="int" enum="Control.GrowDirection">
</return>
<description>
</description>
</method>
<method name="get_h_size_flags" qualifiers="const">
<return type="int">
</return>
<description>
Hint for containers, return horizontal positioning flags.
</description>
</method>
<method name="get_icon" qualifiers="const">
<return type="Texture">
</return>
@ -299,15 +248,6 @@
<description>
</description>
</method>
<method name="get_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode.
</description>
</method>
<method name="get_minimum_size" qualifiers="const">
<return type="Vector2">
</return>
@ -315,13 +255,6 @@
Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
</description>
</method>
<method name="get_mouse_filter" qualifiers="const">
<return type="int" enum="Control.MouseFilter">
</return>
<description>
Return when the control is ignoring mouse events (even touchpad events send mouse events).
</description>
</method>
<method name="get_parent_area_size" qualifiers="const">
<return type="Vector2">
</return>
@ -334,19 +267,6 @@
<description>
</description>
</method>
<method name="get_pivot_offset" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_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_rect" qualifiers="const">
<return type="Rect2">
</return>
@ -361,33 +281,6 @@
Return the rotation (in radians)
</description>
</method>
<method name="get_rotation_degrees" qualifiers="const">
<return type="float">
</return>
<description>
Return the rotation (in degrees)
</description>
</method>
<method name="get_scale" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_size" qualifiers="const">
<return type="Vector2">
</return>
<description>
Returns the size of the Control, computed from all margins, however the size returned will [b]never be smaller than the minimum size reported by[/b] [method get_minimum_size]. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [method get_minimum_size], [method set_margin], [method set_anchor]).
</description>
</method>
<method name="get_stretch_ratio" qualifiers="const">
<return type="float">
</return>
<description>
Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
</description>
</method>
<method name="get_stylebox" qualifiers="const">
<return type="StyleBox">
</return>
@ -398,13 +291,6 @@
<description>
</description>
</method>
<method name="get_theme" qualifiers="const">
<return type="Theme">
</return>
<description>
Return a [Theme] override, if one exists (see [method set_theme]).
</description>
</method>
<method name="get_tooltip" qualifiers="const">
<return type="String">
</return>
@ -414,19 +300,6 @@
Return the tooltip, which will appear when the cursor is resting over this control.
</description>
</method>
<method name="get_v_grow_direction" qualifiers="const">
<return type="int" enum="Control.GrowDirection">
</return>
<description>
</description>
</method>
<method name="get_v_size_flags" qualifiers="const">
<return type="int">
</return>
<description>
Hint for containers, return vertical positioning flags.
</description>
</method>
<method name="grab_click_focus">
<return type="void">
</return>
@ -545,12 +418,6 @@
<description>
</description>
</method>
<method name="is_clipping_contents">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="minimum_size_changed">
<return type="void">
</return>
@ -623,22 +490,6 @@
Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
</description>
</method>
<method name="set_clip_contents">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_custom_minimum_size">
<return type="void">
</return>
<argument index="0" name="size" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_default_cursor_shape">
<return type="void">
</return>
@ -682,35 +533,6 @@
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_focus_neighbour">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="neighbour" type="NodePath">
</argument>
<description>
Force a neighbour for moving the input focus to. When pressing directional/joypad directions, focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
</description>
</method>
<method name="set_focus_next">
<return type="void">
</return>
<argument index="0" name="next" type="NodePath">
</argument>
<description>
Force the 'focus_next' for moving input focus to. When pressing TAB, focus is moved to the next control in the tree. However, the control to move to can be forced with this function.
</description>
</method>
<method name="set_focus_previous">
<return type="void">
</return>
<argument index="0" name="previous" type="NodePath">
</argument>
<description>
Force the 'focus_previous' for moving input focus to. When pressing Shift+TAB, focus is moved to the previous control in the tree. However, the control to move to can be forced with this function.
</description>
</method>
<method name="set_global_position">
<return type="void">
</return>
@ -720,34 +542,6 @@
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_h_grow_direction">
<return type="void">
</return>
<argument index="0" name="direction" type="int" enum="Control.GrowDirection">
</argument>
<description>
</description>
</method>
<method name="set_h_size_flags">
<return type="void">
</return>
<argument index="0" name="flags" type="int">
</argument>
<description>
Hint for containers, set horizontal positioning flags.
</description>
</method>
<method name="set_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<argument index="1" name="offset" type="float">
</argument>
<description>
Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode.
</description>
</method>
<method name="set_margins_preset">
<return type="void">
</return>
@ -760,32 +554,6 @@
<description>
</description>
</method>
<method name="set_mouse_filter">
<return type="void">
</return>
<argument index="0" name="filter" type="int" enum="Control.MouseFilter">
</argument>
<description>
Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER_* constants)
</description>
</method>
<method name="set_pivot_offset">
<return type="void">
</return>
<argument index="0" name="pivot_offset" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_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 parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see [method set_margin]).
</description>
</method>
<method name="set_rotation">
<return type="void">
</return>
@ -795,76 +563,6 @@
Set the rotation (in radians).
</description>
</method>
<method name="set_rotation_degrees">
<return type="void">
</return>
<argument index="0" name="degrees" type="float">
</argument>
<description>
Set the rotation (in degrees).
</description>
</method>
<method name="set_scale">
<return type="void">
</return>
<argument index="0" name="scale" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_size">
<return type="void">
</return>
<argument index="0" name="size" type="Vector2">
</argument>
<description>
Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]).
</description>
</method>
<method name="set_stretch_ratio">
<return type="void">
</return>
<argument index="0" name="ratio" type="float">
</argument>
<description>
Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
</description>
</method>
<method name="set_theme">
<return type="void">
</return>
<argument index="0" name="theme" type="Theme">
</argument>
<description>
Overrides the whole [Theme] for this node and all its [code]Control[/code] children.
</description>
</method>
<method name="set_tooltip">
<return type="void">
</return>
<argument index="0" name="tooltip" type="String">
</argument>
<description>
Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments.
</description>
</method>
<method name="set_v_grow_direction">
<return type="void">
</return>
<argument index="0" name="direction" type="int" enum="Control.GrowDirection">
</argument>
<description>
</description>
</method>
<method name="set_v_size_flags">
<return type="void">
</return>
<argument index="0" name="flags" type="int">
</argument>
<description>
Hint for containers, set vertical positioning flags.
</description>
</method>
<method name="show_modal">
<return type="void">
</return>

14
doc/classes/ConvexPolygonShape.xml
View File

@ -11,20 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_points" qualifiers="const">
<return type="PoolVector3Array">
</return>
<description>
</description>
</method>
<method name="set_points">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector3Array">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="points" type="PoolVector3Array" setter="set_points" getter="get_points">

16
doc/classes/ConvexPolygonShape2D.xml
View File

@ -12,13 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_points" qualifiers="const">
<return type="PoolVector2Array">
</return>
<description>
Returns a list of points in either clockwise or counter clockwise order, forming a convex polygon.
</description>
</method>
<method name="set_point_cloud">
<return type="void">
</return>
@ -28,15 +21,6 @@
Currently, this method does nothing.
</description>
</method>
<method name="set_points">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<description>
Sets a list of points in either clockwise or counter clockwise order, forming a convex polygon.
</description>
</method>
</methods>
<members>
<member name="points" type="PoolVector2Array" setter="set_points" getter="get_points">

28
doc/classes/CubeMap.xml
View File

@ -24,12 +24,6 @@
Returns the CubeMap's height.
</description>
</method>
<method name="get_lossy_storage_quality" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_side" qualifiers="const">
<return type="Image">
</return>
@ -39,12 +33,6 @@
Returns an [Image] for a side of the CubeMap using one of the [code]SIDE_*[/code] constants or an integer 0-5.
</description>
</method>
<method name="get_storage" qualifiers="const">
<return type="int" enum="CubeMap.Storage">
</return>
<description>
</description>
</method>
<method name="get_width" qualifiers="const">
<return type="int">
</return>
@ -60,14 +48,6 @@
<description>
</description>
</method>
<method name="set_lossy_storage_quality">
<return type="void">
</return>
<argument index="0" name="quality" type="float">
</argument>
<description>
</description>
</method>
<method name="set_side">
<return type="void">
</return>
@ -79,14 +59,6 @@
Sets an [Image] for a side of the CubeMap using one of the [code]SIDE_*[/code] constants or an integer 0-5.
</description>
</method>
<method name="set_storage">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="CubeMap.Storage">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="lossy_storage_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality">

56
doc/classes/CubeMesh.xml
View File

@ -11,62 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_size" qualifiers="const">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="get_subdivide_depth" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_subdivide_height" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_subdivide_width" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="set_size">
<return type="void">
</return>
<argument index="0" name="size" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="set_subdivide_depth">
<return type="void">
</return>
<argument index="0" name="divisions" type="int">
</argument>
<description>
</description>
</method>
<method name="set_subdivide_height">
<return type="void">
</return>
<argument index="0" name="divisions" type="int">
</argument>
<description>
</description>
</method>
<method name="set_subdivide_width">
<return type="void">
</return>
<argument index="0" name="subdivide" type="int">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="size" type="Vector3" setter="set_size" getter="get_size">

42
doc/classes/Curve.xml
View File

@ -43,24 +43,6 @@
<description>
</description>
</method>
<method name="get_bake_resolution" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_max_value" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_min_value" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_point_left_mode" qualifiers="const">
<return type="int" enum="Curve.TangentMode">
</return>
@ -125,30 +107,6 @@
<description>
</description>
</method>
<method name="set_bake_resolution">
<return type="void">
</return>
<argument index="0" name="resolution" type="int">
</argument>
<description>
</description>
</method>
<method name="set_max_value">
<return type="void">
</return>
<argument index="0" name="max" type="float">
</argument>
<description>
</description>
</method>
<method name="set_min_value">
<return type="void">
</return>
<argument index="0" name="min" type="float">
</argument>
<description>
</description>
</method>
<method name="set_point_left_mode">
<return type="void">
</return>

16
doc/classes/Curve2D.xml
View File

@ -35,13 +35,6 @@
Removes all points from the curve.
</description>
</method>
<method name="get_bake_interval" qualifiers="const">
<return type="float">
</return>
<description>
Returns the distance between two adjacent cached points.
</description>
</method>
<method name="get_baked_length" qualifiers="const">
<return type="float">
</return>
@ -133,15 +126,6 @@
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
</description>
</method>
<method name="set_bake_interval">
<return type="void">
</return>
<argument index="0" name="distance" type="float">
</argument>
<description>
Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
</description>
</method>
<method name="set_point_in">
<return type="void">
</return>

16
doc/classes/Curve3D.xml
View File

@ -34,13 +34,6 @@
<description>
</description>
</method>
<method name="get_bake_interval" qualifiers="const">
<return type="float">
</return>
<description>
Returns the distance between two adjacent cached points.
</description>
</method>
<method name="get_baked_length" qualifiers="const">
<return type="float">
</return>
@ -148,15 +141,6 @@
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
</description>
</method>
<method name="set_bake_interval">
<return type="void">
</return>
<argument index="0" name="distance" type="float">
</argument>
<description>
Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
</description>
</method>
<method name="set_point_in">
<return type="void">
</return>

22
doc/classes/CurveTexture.xml
View File

@ -9,28 +9,6 @@
<demos>
</demos>
<methods>
<method name="get_curve" qualifiers="const">
<return type="Curve">
</return>
<description>
</description>
</method>
<method name="set_curve">
<return type="void">
</return>
<argument index="0" name="curve" type="Curve">
</argument>
<description>
</description>
</method>
<method name="set_width">
<return type="void">
</return>
<argument index="0" name="width" type="int">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="curve" type="Curve" setter="set_curve" getter="get_curve">

70
doc/classes/CylinderMesh.xml
View File

@ -11,76 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_bottom_radius" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_height" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_radial_segments" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_rings" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_top_radius" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_bottom_radius">
<return type="void">
</return>
<argument index="0" name="radius" type="float">
</argument>
<description>
</description>
</method>
<method name="set_height">
<return type="void">
</return>
<argument index="0" name="height" type="float">
</argument>
<description>
</description>
</method>
<method name="set_radial_segments">
<return type="void">
</return>
<argument index="0" name="segments" type="int">
</argument>
<description>
</description>
</method>
<method name="set_rings">
<return type="void">
</return>
<argument index="0" name="rings" type="int">
</argument>
<description>
</description>
</method>
<method name="set_top_radius">
<return type="void">
</return>
<argument index="0" name="radius" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="bottom_radius" type="float" setter="set_bottom_radius" getter="get_bottom_radius">

64
doc/classes/DampedSpringJoint2D.xml
View File

@ -11,70 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_damping" qualifiers="const">
<return type="float">
</return>
<description>
Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
</description>
</method>
<method name="get_length" qualifiers="const">
<return type="float">
</return>
<description>
Return the maximum length of the spring joint.
</description>
</method>
<method name="get_rest_length" qualifiers="const">
<return type="float">
</return>
<description>
Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
</description>
</method>
<method name="get_stiffness" qualifiers="const">
<return type="float">
</return>
<description>
Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
</description>
</method>
<method name="set_damping">
<return type="void">
</return>
<argument index="0" name="damping" type="float">
</argument>
<description>
Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
</description>
</method>
<method name="set_length">
<return type="void">
</return>
<argument index="0" name="length" type="float">
</argument>
<description>
Set the maximum length of the spring joint.
</description>
</method>
<method name="set_rest_length">
<return type="void">
</return>
<argument index="0" name="rest_length" type="float">
</argument>
<description>
Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
</description>
</method>
<method name="set_stiffness">
<return type="void">
</return>
<argument index="0" name="stiffness" type="float">
</argument>
<description>
Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
</description>
</method>
</methods>
<members>
<member name="damping" type="float" setter="set_damping" getter="get_damping">

42
doc/classes/DirectionalLight.xml
View File

@ -11,48 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_shadow_depth_range" qualifiers="const">
<return type="int" enum="DirectionalLight.ShadowDepthRange">
</return>
<description>
</description>
</method>
<method name="get_shadow_mode" qualifiers="const">
<return type="int" enum="DirectionalLight.ShadowMode">
</return>
<description>
</description>
</method>
<method name="is_blend_splits_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_blend_splits">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_shadow_depth_range">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="DirectionalLight.ShadowDepthRange">
</argument>
<description>
</description>
</method>
<method name="set_shadow_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="DirectionalLight.ShadowMode">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="directional_shadow_bias_split_scale" type="float" setter="set_param" getter="get_param">

83
doc/classes/DynamicFont.xml
View File

@ -36,42 +36,6 @@
Returns the number of fallback fonts.
</description>
</method>
<method name="get_font_data" qualifiers="const">
<return type="DynamicFontData">
</return>
<description>
</description>
</method>
<method name="get_size" qualifiers="const">
<return type="int">
</return>
<description>
Returns the font size in pixels.
</description>
</method>
<method name="get_spacing" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="type" type="int">
</argument>
<description>
Returns the given type of spacing in pixels. See [code]SPACING_*[/code] constants.
</description>
</method>
<method name="get_use_filter" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if filtering is used.
</description>
</method>
<method name="get_use_mipmaps" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if mipmapping is used.
</description>
</method>
<method name="remove_fallback">
<return type="void">
</return>
@ -92,53 +56,6 @@
Sets the fallback font at index [code]idx[/code].
</description>
</method>
<method name="set_font_data">
<return type="void">
</return>
<argument index="0" name="data" type="DynamicFontData">
</argument>
<description>
Sets the [DynamicFontData].
</description>
</method>
<method name="set_size">
<return type="void">
</return>
<argument index="0" name="data" type="int">
</argument>
<description>
Sets the font size.
</description>
</method>
<method name="set_spacing">
<return type="void">
</return>
<argument index="0" name="type" type="int">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
Sets the spacing of the given type. See [code]SPACING_*[/code] constants.
</description>
</method>
<method name="set_use_filter">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set to [code]true[/code] to use filtering.
</description>
</method>
<method name="set_use_mipmaps">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Set to [code]true[/code] to use mipmapping.
</description>
</method>
</methods>
<members>
<member name="extra_spacing_bottom" type="int" setter="set_spacing" getter="get_spacing">

16
doc/classes/DynamicFontData.xml
View File

@ -11,22 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_font_path" qualifiers="const">
<return type="String">
</return>
<description>
Returns the font path.
</description>
</method>
<method name="set_font_path">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Sets the font path.
</description>
</method>
</methods>
<members>
<member name="font_path" type="String" setter="set_font_path" getter="get_font_path">

998
doc/classes/Environment.xml
View File

File diff suppressed because it is too large Load Diff

62
doc/classes/FileDialog.xml
View File

@ -27,13 +27,6 @@
Clear all the added filters in the dialog.
</description>
</method>
<method name="get_access" qualifiers="const">
<return type="int" enum="FileDialog.Access">
</return>
<description>
Return the file access permission of the dialog.
</description>
</method>
<method name="get_current_dir" qualifiers="const">
<return type="String">
</return>
@ -55,19 +48,6 @@
Get the current selected path (directory and file) of the file dialog (empty if none).
</description>
</method>
<method name="get_filters" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
</description>
</method>
<method name="get_mode" qualifiers="const">
<return type="int" enum="FileDialog.Mode">
</return>
<description>
Get the file dialog mode from the MODE_* enum.
</description>
</method>
<method name="get_vbox">
<return type="VBoxContainer">
</return>
@ -82,22 +62,6 @@
Invalidate and update the current dialog content list.
</description>
</method>
<method name="is_showing_hidden_files" qualifiers="const">
<return type="bool">
</return>
<description>
Return true if the dialog allows show hidden files.
</description>
</method>
<method name="set_access">
<return type="void">
</return>
<argument index="0" name="access" type="int" enum="FileDialog.Access">
</argument>
<description>
Set the file access permission of the dialog(Must be one of [ACCESS_RESOURCES], [ACCESS_USERDATA] or [ACCESS_FILESYSTEM]).
</description>
</method>
<method name="set_current_dir">
<return type="void">
</return>
@ -125,32 +89,6 @@
Set the current selected file path of the file dialog.
</description>
</method>
<method name="set_filters">
<return type="void">
</return>
<argument index="0" name="filters" type="PoolStringArray">
</argument>
<description>
</description>
</method>
<method name="set_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="FileDialog.Mode">
</argument>
<description>
Set the file dialog mode from the MODE_* enum.
</description>
</method>
<method name="set_show_hidden_files">
<return type="void">
</return>
<argument index="0" name="show" type="bool">
</argument>
<description>
Set the dialog should show hidden files.
</description>
</method>
</methods>
<members>
<member name="access" type="int" setter="set_access" getter="get_access" enum="FileDialog.Access">

140
doc/classes/GIProbe.xml
View File

@ -25,146 +25,6 @@
<description>
</description>
</method>
<method name="get_bias" qualifiers="const">
<return type="float">
</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_extents" qualifiers="const">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="get_normal_bias" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_probe_data" qualifiers="const">
<return type="GIProbeData">
</return>
<description>
</description>
</method>
<method name="get_propagation" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_subdiv" qualifiers="const">
<return type="int" enum="GIProbe.Subdiv">
</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="max" type="float">
</argument>
<description>
</description>
</method>
<method name="set_compress">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_dynamic_range">
<return type="void">
</return>
<argument index="0" name="max" type="int">
</argument>
<description>
</description>
</method>
<method name="set_energy">
<return type="void">
</return>
<argument index="0" name="max" type="float">
</argument>
<description>
</description>
</method>
<method name="set_extents">
<return type="void">
</return>
<argument index="0" name="extents" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="set_interior">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_normal_bias">
<return type="void">
</return>
<argument index="0" name="max" type="float">
</argument>
<description>
</description>
</method>
<method name="set_probe_data">
<return type="void">
</return>
<argument index="0" name="data" type="GIProbeData">
</argument>
<description>
</description>
</method>
<method name="set_propagation">
<return type="void">
</return>
<argument index="0" name="max" type="float">
</argument>
<description>
</description>
</method>
<method name="set_subdiv">
<return type="void">
</return>
<argument index="0" name="subdiv" type="int" enum="GIProbe.Subdiv">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="bias" type="float" setter="set_bias" getter="get_bias">

154
doc/classes/GIProbeData.xml
View File

@ -9,160 +9,6 @@
<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">

108
doc/classes/Generic6DOFJoint.xml
View File

@ -11,114 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_flag_x" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<description>
</description>
</method>
<method name="get_flag_y" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<description>
</description>
</method>
<method name="get_flag_z" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<description>
</description>
</method>
<method name="get_param_x" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<description>
</description>
</method>
<method name="get_param_y" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<description>
</description>
</method>
<method name="get_param_z" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<description>
</description>
</method>
<method name="set_flag_x">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_flag_y">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_flag_z">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_param_x">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
<method name="set_param_y">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
<method name="set_param_z">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="angular_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x">

118
doc/classes/GeometryInstance.xml
View File

@ -11,124 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_cast_shadows_setting" qualifiers="const">
<return type="int" enum="GeometryInstance.ShadowCastingSetting">
</return>
<description>
</description>
</method>
<method name="get_extra_cull_margin" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_flag" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="GeometryInstance.Flags">
</argument>
<description>
</description>
</method>
<method name="get_lod_max_distance" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_lod_max_hysteresis" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_lod_min_distance" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_lod_min_hysteresis" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_material_override" qualifiers="const">
<return type="Material">
</return>
<description>
Return the material override for the whole geometry.
</description>
</method>
<method name="set_cast_shadows_setting">
<return type="void">
</return>
<argument index="0" name="shadow_casting_setting" type="int" enum="GeometryInstance.ShadowCastingSetting">
</argument>
<description>
</description>
</method>
<method name="set_extra_cull_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="float">
</argument>
<description>
</description>
</method>
<method name="set_flag">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="GeometryInstance.Flags">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_lod_max_distance">
<return type="void">
</return>
<argument index="0" name="mode" type="float">
</argument>
<description>
</description>
</method>
<method name="set_lod_max_hysteresis">
<return type="void">
</return>
<argument index="0" name="mode" type="float">
</argument>
<description>
</description>
</method>
<method name="set_lod_min_distance">
<return type="void">
</return>
<argument index="0" name="mode" type="float">
</argument>
<description>
</description>
</method>
<method name="set_lod_min_hysteresis">
<return type="void">
</return>
<argument index="0" name="mode" type="float">
</argument>
<description>
</description>
</method>
<method name="set_material_override">
<return type="void">
</return>
<argument index="0" name="material" type="Material">
</argument>
<description>
Set the material override for the whole geometry.
</description>
</method>
</methods>
<members>
<member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance.ShadowCastingSetting">

32
doc/classes/Gradient.xml
View File

@ -31,13 +31,6 @@
Returns the color of the ramp color at index [i]point[/i]
</description>
</method>
<method name="get_colors" qualifiers="const">
<return type="PoolColorArray">
</return>
<description>
Returns the colors in the ramp
</description>
</method>
<method name="get_offset" qualifiers="const">
<return type="float">
</return>
@ -47,13 +40,6 @@
Returns the offset of the ramp color at index [i]point[/i]
</description>
</method>
<method name="get_offsets" qualifiers="const">
<return type="PoolRealArray">
</return>
<description>
Returns the offsets for the colors in this ramp
</description>
</method>
<method name="get_point_count" qualifiers="const">
<return type="int">
</return>
@ -90,15 +76,6 @@
Sets the color of the ramp color at index [i]point[/i]
</description>
</method>
<method name="set_colors">
<return type="void">
</return>
<argument index="0" name="colors" type="PoolColorArray">
</argument>
<description>
Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements.
</description>
</method>
<method name="set_offset">
<return type="void">
</return>
@ -110,15 +87,6 @@
Sets the offset for the ramp color at index [i]point[/i]
</description>
</method>
<method name="set_offsets">
<return type="void">
</return>
<argument index="0" name="offsets" type="PoolRealArray">
</argument>
<description>
Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements, all new colors will be black by default.
</description>
</method>
</methods>
<members>
<member name="colors" type="PoolColorArray" setter="set_colors" getter="get_colors">

22
doc/classes/GradientTexture.xml
View File

@ -11,28 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_gradient" qualifiers="const">
<return type="Gradient">
</return>
<description>
</description>
</method>
<method name="set_gradient">
<return type="void">
</return>
<argument index="0" name="gradient" type="Gradient">
</argument>
<description>
</description>
</method>
<method name="set_width">
<return type="void">
</return>
<argument index="0" name="width" type="int">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient">

46
doc/classes/GraphNode.xml
View File

@ -144,32 +144,12 @@
Return the (integer) type of right (output) 'idx' slot.
</description>
</method>
<method name="get_title" qualifiers="const">
<return type="String">
</return>
<description>
Return the title of the GraphNode.
</description>
</method>
<method name="is_close_button_visible" qualifiers="const">
<return type="bool">
</return>
<description>
Returns true if the close button is shown. False otherwise.
</description>
</method>
<method name="is_comment" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_resizable" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_selected">
<return type="bool">
</return>
@ -219,14 +199,6 @@
<description>
</description>
</method>
<method name="set_resizable">
<return type="void">
</return>
<argument index="0" name="resizable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_selected">
<return type="void">
</return>
@ -235,15 +207,6 @@
<description>
</description>
</method>
<method name="set_show_close_button">
<return type="void">
</return>
<argument index="0" name="show" type="bool">
</argument>
<description>
Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work.
</description>
</method>
<method name="set_slot">
<return type="void">
</return>
@ -268,15 +231,6 @@
<description>
</description>
</method>
<method name="set_title">
<return type="void">
</return>
<argument index="0" name="title" type="String">
</argument>
<description>
Set the title of the GraphNode.
</description>
</method>
</methods>
<members>
<member name="resizable" type="bool" setter="set_resizable" getter="is_resizable">

16
doc/classes/GridContainer.xml
View File

@ -11,22 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_columns" qualifiers="const">
<return type="int">
</return>
<description>
Returns the number of columns in this container
</description>
</method>
<method name="set_columns">
<return type="void">
</return>
<argument index="0" name="columns" type="int">
</argument>
<description>
Sets the numbers of columns in the container, then reorder its children to accommodate the new layout
</description>
</method>
</methods>
<members>
<member name="columns" type="int" setter="set_columns" getter="get_columns">

32
doc/classes/GrooveJoint2D.xml
View File

@ -11,38 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_initial_offset" qualifiers="const">
<return type="float">
</return>
<description>
Set the final offset of the groove on body A.
</description>
</method>
<method name="get_length" qualifiers="const">
<return type="float">
</return>
<description>
Return the length of the groove.
</description>
</method>
<method name="set_initial_offset">
<return type="void">
</return>
<argument index="0" name="offset" type="float">
</argument>
<description>
Set the initial offset of the groove on body A.
</description>
</method>
<method name="set_length">
<return type="void">
</return>
<argument index="0" name="length" type="float">
</argument>
<description>
Set the length of the groove.
</description>
</method>
</methods>
<members>
<member name="initial_offset" type="float" setter="set_initial_offset" getter="get_initial_offset">

48
doc/classes/HTTPRequest.xml
View File

@ -26,13 +26,6 @@
Return the response body length.
</description>
</method>
<method name="get_body_size_limit" qualifiers="const">
<return type="int">
</return>
<description>
Return current body size limit.
</description>
</method>
<method name="get_download_file" qualifiers="const">
<return type="String">
</return>
@ -54,20 +47,6 @@
Return the current status of the underlying [HTTPClient].
</description>
</method>
<method name="get_max_redirects" qualifiers="const">
<return type="int">
</return>
<description>
Return the maximum amount of redirects that will be followed.
</description>
</method>
<method name="is_using_threads" qualifiers="const">
<return type="bool">
</return>
<description>
Whether this request is using threads.
</description>
</method>
<method name="request">
<return type="int" enum="Error">
</return>
@ -84,15 +63,6 @@
<description>
</description>
</method>
<method name="set_body_size_limit">
<return type="void">
</return>
<argument index="0" name="bytes" type="int">
</argument>
<description>
Set the response body size limit.
</description>
</method>
<method name="set_download_file">
<return type="void">
</return>
@ -102,24 +72,6 @@
Set the file to download into. Outputs the response body into the file.
</description>
</method>
<method name="set_max_redirects">
<return type="void">
</return>
<argument index="0" name="amount" type="int">
</argument>
<description>
Set the maximum amount of redirects the request will follow.
</description>
</method>
<method name="set_use_threads">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Make this HTTPRequest use threads.
</description>
</method>
</methods>
<members>
<member name="body_size_limit" type="int" setter="set_body_size_limit" getter="get_body_size_limit">

36
doc/classes/HingeJoint.xml
View File

@ -11,42 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_flag" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="HingeJoint.Flag">
</argument>
<description>
</description>
</method>
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="HingeJoint.Param">
</argument>
<description>
</description>
</method>
<method name="set_flag">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="HingeJoint.Flag">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_param">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="HingeJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="angular_limit/bias" type="float" setter="set_param" getter="get_param">

15
doc/classes/InputEvent.xml
View File

@ -28,13 +28,6 @@
Returns a [String] representation of the event.
</description>
</method>
<method name="get_device" qualifiers="const">
<return type="int">
</return>
<description>
Returns the device's id that generated the event.
</description>
</method>
<method name="get_id" qualifiers="const">
<return type="int">
</return>
@ -90,14 +83,6 @@
Returns [code]true[/code] if this input event is pressed. Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code].
</description>
</method>
<method name="set_device">
<return type="void">
</return>
<argument index="0" name="device" type="int">
</argument>
<description>
</description>
</method>
<method name="set_id">
<return type="void">
</return>

22
doc/classes/InputEventAction.xml
View File

@ -12,28 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_action" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="set_action">
<return type="void">
</return>
<argument index="0" name="action" type="String">
</argument>
<description>
</description>
</method>
<method name="set_pressed">
<return type="void">
</return>
<argument index="0" name="pressed" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="action" type="String" setter="set_action" getter="get_action">

36
doc/classes/InputEventJoypadButton.xml
View File

@ -12,42 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_button_index" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_pressure" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_button_index">
<return type="void">
</return>
<argument index="0" name="button_index" type="int">
</argument>
<description>
</description>
</method>
<method name="set_pressed">
<return type="void">
</return>
<argument index="0" name="pressed" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_pressure">
<return type="void">
</return>
<argument index="0" name="pressure" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="button_index" type="int" setter="set_button_index" getter="get_button_index">

28
doc/classes/InputEventJoypadMotion.xml
View File

@ -12,34 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_axis" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_axis_value" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_axis">
<return type="void">
</return>
<argument index="0" name="axis" type="int">
</argument>
<description>
</description>
</method>
<method name="set_axis_value">
<return type="void">
</return>
<argument index="0" name="axis_value" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="axis" type="int" setter="set_axis" getter="get_axis">

44
doc/classes/InputEventKey.xml
View File

@ -12,56 +12,12 @@
<demos>
</demos>
<methods>
<method name="get_scancode" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_scancode_with_modifiers" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_unicode" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="set_echo">
<return type="void">
</return>
<argument index="0" name="echo" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_pressed">
<return type="void">
</return>
<argument index="0" name="pressed" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_scancode">
<return type="void">
</return>
<argument index="0" name="scancode" type="int">
</argument>
<description>
</description>
</method>
<method name="set_unicode">
<return type="void">
</return>
<argument index="0" name="unicode" type="int">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="echo" type="bool" setter="set_echo" getter="is_echo">

42
doc/classes/InputEventMouse.xml
View File

@ -12,48 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_button_mask" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_global_position" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_position" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="set_button_mask">
<return type="void">
</return>
<argument index="0" name="button_mask" type="int">
</argument>
<description>
</description>
</method>
<method name="set_global_position">
<return type="void">
</return>
<argument index="0" name="global_position" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_position">
<return type="void">
</return>
<argument index="0" name="position" type="Vector2">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask">

50
doc/classes/InputEventMouseButton.xml
View File

@ -12,56 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_button_index" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_factor">
<return type="float">
</return>
<description>
</description>
</method>
<method name="is_doubleclick" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_button_index">
<return type="void">
</return>
<argument index="0" name="button_index" type="int">
</argument>
<description>
</description>
</method>
<method name="set_doubleclick">
<return type="void">
</return>
<argument index="0" name="doubleclick" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_factor">
<return type="void">
</return>
<argument index="0" name="factor" type="float">
</argument>
<description>
</description>
</method>
<method name="set_pressed">
<return type="void">
</return>
<argument index="0" name="pressed" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="button_index" type="int" setter="set_button_index" getter="get_button_index">

28
doc/classes/InputEventMouseMotion.xml
View File

@ -12,34 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_relative" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_speed" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="set_relative">
<return type="void">
</return>
<argument index="0" name="relative" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_speed">
<return type="void">
</return>
<argument index="0" name="speed" type="Vector2">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="relative" type="Vector2" setter="set_relative" getter="get_relative">

56
doc/classes/InputEventScreenDrag.xml
View File

@ -13,62 +13,6 @@
<demos>
</demos>
<methods>
<method name="get_index" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_position" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_relative" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_speed" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="set_index">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="set_position">
<return type="void">
</return>
<argument index="0" name="position" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_relative">
<return type="void">
</return>
<argument index="0" name="relative" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_speed">
<return type="void">
</return>
<argument index="0" name="speed" type="Vector2">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="index" type="int" setter="set_index" getter="get_index">

36
doc/classes/InputEventScreenTouch.xml
View File

@ -13,42 +13,6 @@
<demos>
</demos>
<methods>
<method name="get_index" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_position" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="set_index">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="set_position">
<return type="void">
</return>
<argument index="0" name="position" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_pressed">
<return type="void">
</return>
<argument index="0" name="pressed" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="index" type="int" setter="set_index" getter="get_index">

70
doc/classes/InputEventWithModifiers.xml
View File

@ -12,76 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_alt" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_command" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_control" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_metakey" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_shift" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_alt">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_command">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_control">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_metakey">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_shift">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="alt" type="bool" setter="set_alt" getter="get_alt">

42
doc/classes/InterpolatedCamera.xml
View File

@ -9,40 +9,6 @@
<demos>
</demos>
<methods>
<method name="get_speed" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_target_path" qualifiers="const">
<return type="NodePath">
</return>
<description>
</description>
</method>
<method name="is_interpolation_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_interpolation_enabled">
<return type="void">
</return>
<argument index="0" name="target_path" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_speed">
<return type="void">
</return>
<argument index="0" name="speed" type="float">
</argument>
<description>
</description>
</method>
<method name="set_target">
<return type="void">
</return>
@ -51,14 +17,6 @@
<description>
</description>
</method>
<method name="set_target_path">
<return type="void">
</return>
<argument index="0" name="target_path" type="NodePath">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="enabled" type="bool" setter="set_interpolation_enabled" getter="is_interpolation_enabled">

136
doc/classes/ItemList.xml
View File

@ -53,38 +53,12 @@
Ensure selection is visible, adjusting the scroll position as necessary.
</description>
</method>
<method name="get_allow_rmb_select" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether or not items may be selected via right mouse clicking.
</description>
</method>
<method name="get_fixed_column_width" qualifiers="const">
<return type="int">
</return>
<description>
If column size has been fixed to a value, return that value.
</description>
</method>
<method name="get_fixed_icon_size" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_icon_mode" qualifiers="const">
<return type="int" enum="ItemList.IconMode">
</return>
<description>
</description>
</method>
<method name="get_icon_scale" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_item_at_position" qualifiers="const">
<return type="int">
</return>
@ -153,26 +127,6 @@
Return tooltip hint for specified item index.
</description>
</method>
<method name="get_max_columns" qualifiers="const">
<return type="int">
</return>
<description>
Return total number of columns in use by the list.
</description>
</method>
<method name="get_max_text_lines" qualifiers="const">
<return type="int">
</return>
<description>
Return total number of lines currently in use by the list.
</description>
</method>
<method name="get_select_mode" qualifiers="const">
<return type="int" enum="ItemList.SelectMode">
</return>
<description>
</description>
</method>
<method name="get_selected_items">
<return type="PoolIntArray">
</return>
@ -187,12 +141,6 @@
Returns the current vertical scroll bar for the List.
</description>
</method>
<method name="has_auto_height" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_item_disabled" qualifiers="const">
<return type="bool">
</return>
@ -220,13 +168,6 @@
Returns whether the tooltip is enabled for specified item index.
</description>
</method>
<method name="is_same_column_width" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether or not all columns of the list are of the same size.
</description>
</method>
<method name="is_selected" qualifiers="const">
<return type="bool">
</return>
@ -257,32 +198,6 @@
Note: This method does not trigger the item selection signal.
</description>
</method>
<method name="set_allow_rmb_select">
<return type="void">
</return>
<argument index="0" name="allow" type="bool">
</argument>
<description>
Allow (or disallow) selection of (selectable) items in the list using right mouse button.
</description>
</method>
<method name="set_auto_height">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_fixed_column_width">
<return type="void">
</return>
<argument index="0" name="width" type="int">
</argument>
<description>
Set the size (width) all columns in the list are to use.
</description>
</method>
<method name="set_fixed_icon_size">
<return type="void">
</return>
@ -291,22 +206,6 @@
<description>
</description>
</method>
<method name="set_icon_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="ItemList.IconMode">
</argument>
<description>
</description>
</method>
<method name="set_icon_scale">
<return type="void">
</return>
<argument index="0" name="scale" type="float">
</argument>
<description>
</description>
</method>
<method name="set_item_custom_bg_color">
<return type="void">
</return>
@ -405,41 +304,6 @@
Sets whether the tooltip is enabled for specified item index.
</description>
</method>
<method name="set_max_columns">
<return type="void">
</return>
<argument index="0" name="amount" type="int">
</argument>
<description>
Set maximum number of columns to use for the list.
</description>
</method>
<method name="set_max_text_lines">
<return type="void">
</return>
<argument index="0" name="lines" type="int">
</argument>
<description>
Set maximum number of lines to use for the list.
</description>
</method>
<method name="set_same_column_width">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Sets a fixed size (width) to use for all columns of the list.
</description>
</method>
<method name="set_select_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="ItemList.SelectMode">
</argument>
<description>
</description>
</method>
<method name="sort_items_by_text">
<return type="void">
</return>

56
doc/classes/JSONParseResult.xml
View File

@ -11,62 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_error" qualifiers="const">
<return type="int" enum="Error">
</return>
<description>
</description>
</method>
<method name="get_error_line" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_error_string" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_result" qualifiers="const">
<return type="Variant">
</return>
<description>
</description>
</method>
<method name="set_error">
<return type="void">
</return>
<argument index="0" name="error" type="int" enum="Error">
</argument>
<description>
</description>
</method>
<method name="set_error_line">
<return type="void">
</return>
<argument index="0" name="error_line" type="int">
</argument>
<description>
</description>
</method>
<method name="set_error_string">
<return type="void">
</return>
<argument index="0" name="error_string" type="String">
</argument>
<description>
</description>
</method>
<method name="set_result">
<return type="void">
</return>
<argument index="0" name="result" type="Variant">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="error" type="int" setter="set_error" getter="get_error" enum="Error">

56
doc/classes/Joint.xml
View File

@ -11,62 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_exclude_nodes_from_collision" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_node_a" qualifiers="const">
<return type="NodePath">
</return>
<description>
</description>
</method>
<method name="get_node_b" qualifiers="const">
<return type="NodePath">
</return>
<description>
</description>
</method>
<method name="get_solver_priority" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="set_exclude_nodes_from_collision">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_node_a">
<return type="void">
</return>
<argument index="0" name="node" type="NodePath">
</argument>
<description>
</description>
</method>
<method name="set_node_b">
<return type="void">
</return>
<argument index="0" name="node" type="NodePath">
</argument>
<description>
</description>
</method>
<method name="set_solver_priority">
<return type="void">
</return>
<argument index="0" name="priority" type="int">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="collision/exclude_nodes" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision">

60
doc/classes/Joint2D.xml
View File

@ -11,66 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_bias" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_exclude_nodes_from_collision" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_node_a" qualifiers="const">
<return type="NodePath">
</return>
<description>
Return the path to the A node for the joint.
</description>
</method>
<method name="get_node_b" qualifiers="const">
<return type="NodePath">
</return>
<description>
Return the path to the B node for the joint.
</description>
</method>
<method name="set_bias">
<return type="void">
</return>
<argument index="0" name="bias" type="float">
</argument>
<description>
</description>
</method>
<method name="set_exclude_nodes_from_collision">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_node_a">
<return type="void">
</return>
<argument index="0" name="node" type="NodePath">
</argument>
<description>
Set the path to the A node for the joint. Must be of type [PhysicsBody2D].
</description>
</method>
<method name="set_node_b">
<return type="void">
</return>
<argument index="0" name="node" type="NodePath">
</argument>
<description>
Set the path to the B node for the joint. Must be of type [PhysicsBody2D].
</description>
</method>
</methods>
<members>
<member name="bias" type="float" setter="set_bias" getter="get_bias">

Some files were not shown because too many files have changed in this diff Show More