diff options
Diffstat (limited to 'doc/base/classes.xml')
| -rw-r--r-- | doc/base/classes.xml | 1725 |
1 files changed, 1432 insertions, 293 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 157d49fbc8..1b95899729 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -525,13 +525,13 @@ Converts the value of a variable to a String. </description> </method> - <method name="str2var:var"> + <method name="str2var:Variant"> <return type="Nil"> </return> <argument index="0" name="string" type="String"> </argument> <description> - Converts the value of a String to a variable. + Converts the value of a String to a Variant. </description> </method> <method name="range"> @@ -573,7 +573,7 @@ <method name="hash"> <return type="int"> </return> - <argument index="0" name="var:var" type="var"> + <argument index="0" name="var:Variant" type="var"> </argument> <description> Hashes the variable passed and returns an integer. @@ -1603,7 +1603,7 @@ Axis-Aligned Bounding Box. </brief_description> <description> - AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position and a size, and several utility functions. It is typically used for simple (fast) overlap tests. + AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests. </description> <methods> <method name="encloses"> @@ -1628,7 +1628,7 @@ <return type="float"> </return> <description> - Get the area inside the [AABB]. + Get the area of the [AABB]. </description> </method> <method name="get_endpoint"> @@ -1697,7 +1697,7 @@ <argument index="0" name="by" type="float"> </argument> <description> - Return a copy of the AABB grown a given a mount of units towards all the sides. + Return a copy of the [AABB] grown a given amount of units towards all the sides. </description> </method> <method name="has_no_area"> @@ -1747,7 +1747,7 @@ <argument index="0" name="plane" type="Plane"> </argument> <description> - Return true if the AABB is at both sides of a plane. + Return true if the [AABB] is at both sides of a plane. </description> </method> <method name="intersects_segment"> @@ -1766,7 +1766,7 @@ <argument index="0" name="with" type="AABB"> </argument> <description> - Combine this [AABB] with another one, a larger one is returned that contains both. + Combine this [AABB] with another, a larger one is returned that contains both. </description> </method> <method name="AABB"> @@ -1849,6 +1849,8 @@ </description> </method> <method name="register_text_enter"> + <return type="LineEdit"> + </return> <argument index="0" name="line_edit" type="Object"> </argument> <description> @@ -2412,7 +2414,7 @@ </class> <class name="AnimationPlayer" inherits="Node" category="Core"> <brief_description> - Container and player of [Animaton] resources. + Container and player of [Animation] resources. </brief_description> <description> An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in diferent channels. @@ -3197,6 +3199,24 @@ <description> </description> </method> + <method name="set_animation_process_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_animation_process_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="advance"> + <argument index="0" name="delta" type="float"> + </argument> + <description> + </description> + </method> <method name="reset"> <description> </description> @@ -3239,6 +3259,12 @@ <argument index="0" name="enable" type="int"> </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="get_space_override_mode" qualifiers="const"> @@ -3463,133 +3489,162 @@ </class> <class name="Area2D" inherits="CollisionObject2D" category="Core"> <brief_description> - General purpose area detection and influence for 2D Phisics. + General purpose area detection and influence for 2D physics. </brief_description> <description> - General purpose area detection for 2D Phisics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). An Area2D can be set as a children to a RigidBody2D to generate a custom gravity field. For this, use SPACE_OVERRIDE_COMBINE and point gravity at the center of mass. + General purpose area detection for 2D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass. </description> <methods> <method name="set_space_override_mode"> <argument index="0" name="enable" type="int"> </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="get_space_override_mode" qualifiers="const"> <return type="int"> </return> <description> + Return the space override mode. </description> </method> <method name="set_gravity_is_point"> <argument index="0" name="enable" type="bool"> </argument> <description> - When overriding space parameters, areas can have a center of gravity as a point. + 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="is_gravity_a_point" qualifiers="const"> <return type="bool"> </return> <description> - Return if gravity is a point. When overriding space parameters, areas can have a center of gravity as a point. + 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="set_gravity_distance_scale"> <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="get_gravity_distance_scale" qualifiers="const"> <return type="float"> </return> <description> + Return the falloff factor for point gravity. </description> </method> <method name="set_gravity_vector"> <argument index="0" name="vector" type="Vector2"> </argument> <description> - Set gravity vector. If gravity is a point, this will be the attraction center. + 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="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="set_gravity"> <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="get_gravity" qualifiers="const"> <return type="float"> </return> <description> + Return the gravity intensity. </description> </method> <method name="set_linear_damp"> <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="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> + Return the linear damp rate. </description> </method> <method name="set_angular_damp"> <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="get_angular_damp" qualifiers="const"> <return type="float"> </return> <description> + Return the angular damp rate. </description> </method> <method name="set_priority"> <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 an 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="get_priority" qualifiers="const"> <return type="float"> </return> <description> + Return the processing order of this area. </description> </method> <method name="set_collision_mask"> <argument index="0" name="collision_mask" type="int"> </argument> <description> + Set the physics layers this area can scan for collisions. </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="set_layer_mask"> <argument index="0" name="layer_mask" 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="get_layer_mask" qualifiers="const"> <return type="int"> </return> <description> + Return the physics layer this area is in. </description> </method> <method name="set_collision_mask_bit"> @@ -3598,6 +3653,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -3606,6 +3662,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Return an individual bit on the collision mask. </description> </method> <method name="set_layer_mask_bit"> @@ -3614,6 +3671,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. </description> </method> <method name="get_layer_mask_bit" qualifiers="const"> @@ -3622,42 +3680,49 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Return an individual bit on the layer mask. </description> </method> <method name="set_enable_monitoring"> <argument index="0" name="enable" type="bool"> </argument> <description> + Set whether this area can detect bodies/areas entering/exiting it. </description> </method> <method name="is_monitoring_enabled" qualifiers="const"> <return type="bool"> </return> <description> + Return whether this area detects bodies/areas entering/exiting it. </description> </method> <method name="set_monitorable"> <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="is_monitorable" qualifiers="const"> <return type="bool"> </return> <description> + Set whether this area can be detected by other, monitoring, areas. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Array"> </return> <description> + Return a list of the bodies ([PhysicsBody2D]) that are totally or partially inside this area. </description> </method> <method name="get_overlapping_areas" qualifiers="const"> <return type="Array"> </return> <description> + Return a list of the areas that are totally or partially inside this area. </description> </method> <method name="overlaps_body" qualifiers="const"> @@ -3666,6 +3731,7 @@ <argument index="0" name="body" type="Object"> </argument> <description> + Return whether the body passed is totally or partially inside this area. </description> </method> <method name="overlaps_area" qualifiers="const"> @@ -3674,6 +3740,7 @@ <argument index="0" name="area" type="Object"> </argument> <description> + Return whether the area passed is totally or partially inside this area. </description> </method> </methods> @@ -3682,6 +3749,7 @@ <argument index="0" name="body" type="Object"> </argument> <description> + This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. </description> </signal> <signal name="body_enter_shape"> @@ -3694,12 +3762,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> + This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that repored the entering. </description> </signal> <signal name="area_enter"> <argument index="0" name="area" type="Object"> </argument> <description> + This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. </description> </signal> <signal name="area_enter_shape"> @@ -3712,12 +3782,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> + This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. </description> </signal> <signal name="body_exit"> <argument index="0" name="body" type="Object"> </argument> <description> + This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. </description> </signal> <signal name="body_exit_shape"> @@ -3730,12 +3802,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> + This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit. </description> </signal> <signal name="area_exit"> <argument index="0" name="area" type="Object"> </argument> <description> + This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. </description> </signal> <signal name="area_exit_shape"> @@ -3748,6 +3822,7 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> + This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. </description> </signal> </signals> @@ -3766,6 +3841,7 @@ <argument index="0" name="value" type="var"> </argument> <description> + Append an element at the end of the array (alias of [method push_back]). </description> </method> <method name="clear"> @@ -3784,6 +3860,7 @@ <argument index="0" name="value" type="var"> </argument> <description> + Remove the first occurence of a value from the array. </description> </method> <method name="find"> @@ -3792,6 +3869,7 @@ <argument index="0" name="value" type="var"> </argument> <description> + Searches the array for a value and returns its index or -1 if not found. </description> </method> <method name="hash"> @@ -3812,12 +3890,22 @@ </method> <method name="invert"> <description> + Reverse the order of the elements in the array (so first element will now be the last). </description> </method> <method name="is_shared"> <return type="bool"> </return> <description> + Get whether this is a shared array instance. + </description> + </method> + <method name="pop_back"> + <description> + </description> + </method> + <method name="pop_front"> + <description> </description> </method> <method name="push_back"> @@ -3827,6 +3915,12 @@ Append an element at the end of the array. </description> </method> + <method name="push_front"> + <argument index="0" name="value" type="var"> + </argument> + <description> + </description> + </method> <method name="remove"> <argument index="0" name="pos" type="int"> </argument> @@ -3850,6 +3944,7 @@ </method> <method name="sort"> <description> + Sort the array using natural order. </description> </method> <method name="sort_custom"> @@ -3858,6 +3953,7 @@ <argument index="1" name="func" type="String"> </argument> <description> + Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. </description> </method> <method name="Array"> @@ -4008,8 +4104,6 @@ </return> <argument index="0" name="sample" type="RID"> </argument> - <argument index="1" name="arg1" type="String"> - </argument> <description> Return the description of an audio sample. Mainly used for organization. </description> @@ -4053,7 +4147,7 @@ <method name="sample_set_data"> <argument index="0" name="sample" type="RID"> </argument> - <argument index="1" name="arg1" type="RawArray"> + <argument index="1" name="data" type="RawArray"> </argument> <description> Set the sample data for a given sample as an array of bytes. The length must be equal to the sample lenght expected in bytes or an error will be produced. @@ -4346,7 +4440,7 @@ Stop a given voice. </description> </method> - <method name="free"> + <method name="free_rid"> <argument index="0" name="rid" type="RID"> </argument> <description> @@ -5470,7 +5564,7 @@ </constant> </constants> </class> -<class name="ButtonGroup" inherits="Control" category="Core"> +<class name="ButtonGroup" inherits="BoxContainer" category="Core"> <brief_description> Group of Buttons. </brief_description> @@ -5516,6 +5610,10 @@ </methods> <constants> </constants> + <theme_items> + <theme_item name="panel" type="StyleBox"> + </theme_item> + </theme_items> </class> <class name="Camera" inherits="Spatial" category="Core"> <brief_description> @@ -5862,7 +5960,7 @@ </description> </method> <method name="set_zoom"> - <argument index="0" name="arg0" type="Vector2"> + <argument index="0" name="zoom" type="Vector2"> </argument> <description> </description> @@ -5885,6 +5983,18 @@ <description> </description> </method> + <method name="set_enable_follow_smoothing"> + <argument index="0" name="follow_smoothing" type="bool"> + </argument> + <description> + </description> + </method> + <method name="is_follow_smoothing_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="force_update_scroll"> <description> Force the camera to update scroll immediately. @@ -5977,6 +6087,12 @@ Hide the CanvasItem currently visible. </description> </method> + <method name="set_hidden"> + <argument index="0" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> <method name="update"> <description> Queue the CanvasItem for update. NOTIFICATION_DRAW will be called on idle time to request redraw. @@ -6102,6 +6218,8 @@ </argument> <argument index="1" name="pos" type="Vector2"> </argument> + <argument index="2" name="modulate" type="Color" default="Color(1,1,1,1)"> + </argument> <description> Draw a texture at a given position. </description> @@ -6621,7 +6739,7 @@ <argument index="0" name="radius" type="float"> </argument> <description> - Radius of the [CapsuleShape2D]. + Set the radius of the [CapsuleShape2D]. </description> </method> <method name="get_radius" qualifiers="const"> @@ -6635,7 +6753,7 @@ <argument index="0" name="height" type="float"> </argument> <description> - Height of the [CapsuleShape2D]. + Set the height of the [CapsuleShape2D]. </description> </method> <method name="get_height" qualifiers="const"> @@ -6940,7 +7058,7 @@ Base node for 2D collisionables. </brief_description> <description> - CollisionObject2D is the base class for 2D physics collisionables. They can hold any number of 2D collision shapes. Usually, they are edited by placing CollisionBody2D and CollisionPolygon2D nodes as children. Such nodes are for reference ant not present outside the editor, so code should use the regular shape API. + CollisionObject2D is the base class for 2D physics collisionables. They can hold any number of 2D collision shapes. Usually, they are edited by placing [CollisionShape2D] and/or [CollisionPolygon2D] nodes as children. Such nodes are for reference and not present outside the editor, so code should use the regular shape API. </description> <methods> <method name="_input_event" qualifiers="virtual"> @@ -6951,6 +7069,7 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> + This method can be used to override normal input processing. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. </description> </method> <method name="add_shape"> @@ -6966,7 +7085,7 @@ <return type="int"> </return> <description> - Return the amount of shapes in the collision body. + Return the amount of shapes in the collision body. Because a [CollisionPolygon2D] can generate more than one [Shape2D], the amount returned does not have to match the sum of [CollisionShape2D] and [CollisionPolygon2D]. </description> </method> <method name="set_shape"> @@ -6993,6 +7112,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> + Set whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). </description> </method> <method name="get_shape" qualifiers="const"> @@ -7019,6 +7139,7 @@ <argument index="0" name="shape_idx" type="int"> </argument> <description> + Return whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). </description> </method> <method name="remove_shape"> @@ -7037,25 +7158,28 @@ <return type="RID"> </return> <description> - Return the RID of the object. + Return the RID of this object. </description> </method> <method name="set_pickable"> <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="is_pickable" qualifiers="const"> <return type="bool"> </return> <description> + Return whether this object is pickable. </description> </method> </methods> <signals> <signal name="mouse_enter"> <description> + This event fires only once when the mouse pointer enters any shape of this object. </description> </signal> <signal name="input_event"> @@ -7066,10 +7190,12 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> + This signal triggers when an input event fires over a shape. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. </description> </signal> <signal name="mouse_exit"> <description> + This event fires only once when the mouse pointer exits all shapes of this object. </description> </signal> </signals> @@ -7083,7 +7209,7 @@ </description> <methods> <method name="set_build_mode"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="build_mode" type="int"> </argument> <description> </description> @@ -7136,58 +7262,69 @@ </class> <class name="CollisionPolygon2D" inherits="Node2D" category="Core"> <brief_description> - Editor-Only class. + Editor-only class for easy editing of collision polygons. </brief_description> <description> - Editor-Only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. This class is for editing custom shape polygons. + Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. This class is for editing custom shape polygons. </description> <methods> <method name="set_polygon"> <argument index="0" name="polygon" type="Vector2Array"> </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[/code]=0), or a list of lines (for [code]build_mode[/code]=1). 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> <method name="get_polygon" qualifiers="const"> <return type="Vector2Array"> </return> <description> + Return the list of points that define the polygon. </description> </method> <method name="set_build_mode"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="build_mode" type="int"> </argument> <description> + Set whether the polygon is to be a [ConvexPolygon2D] ([code]build_mode[/code]=0), or a [ConcavePolygon2D] ([code]build_mode[/code]=1). </description> </method> <method name="get_build_mode" qualifiers="const"> <return type="int"> </return> <description> + Return whether the polygon is a [ConvexPolygon2D] ([code]build_mode[/code]=0), or a [ConcavePolygon2D] ([code]build_mode[/code]=1). </description> </method> <method name="set_trigger"> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="trigger" type="bool"> </argument> <description> + Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). </description> </method> <method name="is_trigger" qualifiers="const"> <return type="bool"> </return> <description> + Return whether this polygon is a trigger. </description> </method> <method name="get_collision_object_first_shape" qualifiers="const"> <return type="int"> </return> <description> + Return the index of the first shape generated by the editor. + When [code]build_mode[/code] is set to generate convex polygons, the shape shown in the editor may be decomopsed into many convex polygons. In that case, a range of indexes is needed to directly access the [Shape2D]s. + When [code]build_mode[/code] is set to generate concave polygons, there is only one [Shape2D] generated, so the start index and the end index are the same. </description> </method> <method name="get_collision_object_last_shape" qualifiers="const"> <return type="int"> </return> <description> + Return the index of the last shape generated by the editor. </description> </method> </methods> @@ -7201,7 +7338,7 @@ </description> <methods> <method name="resource_changed"> - <argument index="0" name="arg0" type="Object"> + <argument index="0" name="resource" type="Object"> </argument> <description> </description> @@ -7246,40 +7383,45 @@ </class> <class name="CollisionShape2D" inherits="Node2D" category="Core"> <brief_description> - Editor-Only class. + Editor-only class for easy editing of shapes. </brief_description> <description> - Editor-Only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. + Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. </description> <methods> <method name="set_shape"> <argument index="0" name="shape" type="Object"> </argument> <description> + Set this shape's [Shape2D]. This will not appear as a node, but can be directly edited as a property. </description> </method> <method name="get_shape" qualifiers="const"> <return type="Object"> </return> <description> + Return this shape's [Shape2D]. </description> </method> <method name="set_trigger"> <argument index="0" name="enable" type="bool"> </argument> <description> + Set whether this shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. will not block movement of colliding objects). </description> </method> <method name="is_trigger" qualifiers="const"> <return type="bool"> </return> <description> + Return whether this shape is a trigger. </description> </method> <method name="get_collision_object_shape_index" qualifiers="const"> <return type="int"> </return> <description> + Return the index of this shape inside its container [CollisionObject2D]. This can be used to directly access the underlying [Shape2D]. </description> </method> </methods> @@ -7291,7 +7433,7 @@ Color in RGBA format. </brief_description> <description> - A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point, ranging from 0 to 1. + A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate() ) may accept values > 1. </description> <methods> <method name="blend"> @@ -7626,6 +7768,66 @@ <description> </description> <methods> + <method name="add_point"> + <argument index="0" name="offset" type="float"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="remove_point"> + <argument index="0" name="offset" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_offset"> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="offset" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_color"> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + </description> + </method> + <method name="interpolate"> + <return type="Color"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="set_offsets"> <argument index="0" name="offsets" type="RealArray"> </argument> @@ -7659,7 +7861,7 @@ Concave polygon shape. </brief_description> <description> - Concave polygon shape resource, which can be set into a [PhysicsBody] or area. This shape is created by feeding a list of triangles. + Concave polygon shape resource, which can be set into a [PhysicsBody] or area. This shape is created by feeding a list of triangles. </description> <methods> <method name="set_faces"> @@ -7686,6 +7888,7 @@ </brief_description> <description> Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for RigidBody nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions. + The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. </description> <methods> <method name="set_segments"> @@ -7795,7 +7998,7 @@ <method name="get_section_keys" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="section" type="String"> </argument> <description> </description> @@ -8041,6 +8244,18 @@ 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_rotation"> + <argument index="0" name="rotation" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_scale"> + <argument index="0" name="scale" type="Vector2"> + </argument> + <description> + </description> + </method> <method name="get_margin" qualifiers="const"> <return type="float"> </return> @@ -8077,6 +8292,18 @@ 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 [method get_minimum_size][/b]. 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_rotation" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_scale" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> <method name="get_custom_minimum_size" qualifiers="const"> <return type="Vector2"> </return> @@ -8576,14 +8803,15 @@ Convex Polygon Shape for 2D physics. </brief_description> <description> - Convex Polygon Shape for 2D physics. + Convex Polygon Shape for 2D physics. A convex polygon, whatever its shape, is internally decomposed into as many convex polygons as needed to ensure all collision checks against it are always done on convex polygons (which are faster to check). + The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. </description> <methods> <method name="set_point_cloud"> <argument index="0" name="point_cloud" type="Vector2Array"> </argument> <description> - Create the point set from a point cloud. The resulting convex hull will be set as the shape. + Currently, this method does nothing. </description> </method> <method name="set_points"> @@ -8712,14 +8940,18 @@ </class> <class name="Curve2D" inherits="Resource" category="Core"> <brief_description> + Describes a Bezier curve in 2D space. </brief_description> <description> + This class describes a Bezier curve in 2D space. It is mainly used to give a shape to a [Path2D], but can be manually sampled for other purposes. +It keeps a cache of precalculated points along the curve, to speed further calculations up. </description> <methods> <method name="get_point_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of points describing the curve. </description> </method> <method name="add_point"> @@ -8732,6 +8964,8 @@ <argument index="3" name="atpos" type="int" default="-1"> </argument> <description> + Adds a point to a curve, at position "pos", with control points "in" and "out". +If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= [method get_point_count]), the point will be appended at the end of the point list. </description> </method> <method name="set_point_pos"> @@ -8740,6 +8974,7 @@ <argument index="1" name="pos" type="Vector2"> </argument> <description> + Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="get_point_pos" qualifiers="const"> @@ -8748,6 +8983,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). </description> </method> <method name="set_point_in"> @@ -8756,6 +8992,7 @@ <argument index="1" name="pos" type="Vector2"> </argument> <description> + Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="get_point_in" qualifiers="const"> @@ -8764,6 +9001,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). </description> </method> <method name="set_point_out"> @@ -8772,6 +9010,7 @@ <argument index="1" name="pos" type="Vector2"> </argument> <description> + Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="get_point_out" qualifiers="const"> @@ -8780,12 +9019,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). </description> </method> <method name="remove_point"> <argument index="0" name="idx" type="int"> </argument> <description> + Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. </description> </method> <method name="interpolate" qualifiers="const"> @@ -8796,6 +9037,8 @@ <argument index="1" name="t" type="float"> </argument> <description> + Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. +If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0). </description> </method> <method name="interpolatef" qualifiers="const"> @@ -8804,24 +9047,28 @@ <argument index="0" name="fofs" type="float"> </argument> <description> + Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t". </description> </method> <method name="set_bake_interval"> <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="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> <description> + Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough. </description> </method> <method name="interpolate_baked" qualifiers="const"> @@ -8832,12 +9079,16 @@ <argument index="1" name="cubic" type="bool" default="false"> </argument> <description> + Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. +To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. +Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). </description> </method> <method name="get_baked_points" qualifiers="const"> <return type="Vector2Array"> </return> <description> + Returns the cache of points as a [Vector2Array]. </description> </method> <method name="tesselate" qualifiers="const"> @@ -8848,6 +9099,10 @@ <argument index="1" name="tolerance_degrees" type="float" default="4"> </argument> <description> + Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. +This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. +"max_stages" controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! +"tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. </description> </method> </methods> @@ -8856,14 +9111,18 @@ </class> <class name="Curve3D" inherits="Resource" category="Core"> <brief_description> + Describes a Bezier curve in 3D space. </brief_description> <description> + This class describes a Bezier curve in 3D space. It is mainly used to give a shape to a [Path], but can be manually sampled for other purposes. +It keeps a cache of precalculated points along the curve, to speed further calculations up. </description> <methods> <method name="get_point_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of points describing the curve. </description> </method> <method name="add_point"> @@ -8876,6 +9135,8 @@ <argument index="3" name="atpos" type="int" default="-1"> </argument> <description> + Adds a point to a curve, at position "pos", with control points "in" and "out". +If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= [method get_point_count]), the point will be appended at the end of the point list. </description> </method> <method name="set_point_pos"> @@ -8884,6 +9145,7 @@ <argument index="1" name="pos" type="Vector3"> </argument> <description> + Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="get_point_pos" qualifiers="const"> @@ -8892,6 +9154,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). </description> </method> <method name="set_point_tilt"> @@ -8900,6 +9163,8 @@ <argument index="1" name="tilt" type="float"> </argument> <description> + Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console. +The tilt controls the rotation along the look-at axis an object travelling the path would have. In the case of a curve controlling a [PathFollow], this tilt is an offset over the natural tilt the PathFollow calculates. </description> </method> <method name="get_point_tilt" qualifiers="const"> @@ -8908,6 +9173,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console, and returns 0. </description> </method> <method name="set_point_in"> @@ -8916,6 +9182,7 @@ <argument index="1" name="pos" type="Vector3"> </argument> <description> + Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="get_point_in" qualifiers="const"> @@ -8924,6 +9191,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). </description> </method> <method name="set_point_out"> @@ -8932,6 +9200,7 @@ <argument index="1" name="pos" type="Vector3"> </argument> <description> + Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="get_point_out" qualifiers="const"> @@ -8940,12 +9209,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). </description> </method> <method name="remove_point"> <argument index="0" name="idx" type="int"> </argument> <description> + Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. </description> </method> <method name="interpolate" qualifiers="const"> @@ -8956,6 +9227,8 @@ <argument index="1" name="t" type="float"> </argument> <description> + Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. +If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0, 0). </description> </method> <method name="interpolatef" qualifiers="const"> @@ -8964,24 +9237,28 @@ <argument index="0" name="fofs" type="float"> </argument> <description> + Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t". </description> </method> <method name="set_bake_interval"> <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="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> <description> + Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough. </description> </method> <method name="interpolate_baked" qualifiers="const"> @@ -8992,18 +9269,23 @@ <argument index="1" name="cubic" type="bool" default="false"> </argument> <description> + Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. +To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. +Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). </description> </method> <method name="get_baked_points" qualifiers="const"> <return type="Vector3Array"> </return> <description> + Returns the cache of points as a [Vector3Array]. </description> </method> <method name="get_baked_tilts" qualifiers="const"> <return type="RealArray"> </return> <description> + Returns the cache of tilts as a [RealArray]. </description> </method> <method name="tesselate" qualifiers="const"> @@ -9014,6 +9296,10 @@ <argument index="1" name="tolerance_degrees" type="float" default="4"> </argument> <description> + Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. +This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. +"max_stages" controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! +"tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. </description> </method> </methods> @@ -9434,7 +9720,7 @@ </description> </method> <method name="set_show_hidden_files"> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="show" type="bool"> </argument> <description> </description> @@ -10027,6 +10313,12 @@ <description> </description> </method> + <method name="get_length" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="set_autoplay"> <argument index="0" name="enabled" type="bool"> </argument> @@ -10047,24 +10339,18 @@ <description> </description> </method> - <method name="get_channel_volumeidx" qualifiers="const"> + <method name="get_channel_volume" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_channel_last_note_time" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> @@ -10451,7 +10737,7 @@ </description> </method> <method name="set_show_hidden_files"> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="show" type="bool"> </argument> <description> </description> @@ -10513,6 +10799,8 @@ </theme_item> <theme_item name="folder" type="Texture"> </theme_item> + <theme_item name="reload" type="Texture"> + </theme_item> </theme_items> </class> <class name="FixedMaterial" inherits="Material" category="Core"> @@ -10676,6 +10964,14 @@ </constant> <constant name="FLAG_DISCARD_ALPHA" value="3"> </constant> + <constant name="LIGHT_SHADER_LAMBERT" value="0"> + </constant> + <constant name="LIGHT_SHADER_WRAP" value="1"> + </constant> + <constant name="LIGHT_SHADER_VELVET" value="2"> + </constant> + <constant name="LIGHT_SHADER_TOON" value="3"> + </constant> </constants> </class> <class name="Font" inherits="Resource" category="Core"> @@ -10743,9 +11039,9 @@ <method name="get_kerning_pair" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="char_a" type="int"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="char_b" type="int"> </argument> <description> Return a kerning pair as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. @@ -10856,6 +11152,18 @@ Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is apassed. clipping the width. "pos" specifies te baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. </description> </method> + <method name="set_fallback"> + <argument index="0" name="fallback" type="Object"> + </argument> + <description> + </description> + </method> + <method name="get_fallback" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -10867,27 +11175,25 @@ </description> <methods> <method name="call_func"> - <argument index="0" name="method" type="String"> + <argument index="0" name="arg0" type="var" default="NULL"> </argument> - <argument index="1" name="arg0" type="var" default="NULL"> + <argument index="1" name="arg1" type="var" default="NULL"> </argument> - <argument index="2" name="arg1" type="var" default="NULL"> + <argument index="2" name="arg2" type="var" default="NULL"> </argument> - <argument index="3" name="arg2" type="var" default="NULL"> + <argument index="3" name="arg3" type="var" default="NULL"> </argument> - <argument index="4" name="arg3" type="var" default="NULL"> + <argument index="4" name="arg4" type="var" default="NULL"> </argument> - <argument index="5" name="arg4" type="var" default="NULL"> + <argument index="5" name="arg5" type="var" default="NULL"> </argument> - <argument index="6" name="arg5" type="var" default="NULL"> + <argument index="6" name="arg6" type="var" default="NULL"> </argument> - <argument index="7" name="arg6" type="var" default="NULL"> + <argument index="7" name="arg7" type="var" default="NULL"> </argument> - <argument index="8" name="arg7" type="var" default="NULL"> + <argument index="8" name="arg8" type="var" default="NULL"> </argument> - <argument index="9" name="arg8" type="var" default="NULL"> - </argument> - <argument index="10" name="arg9" type="var" default="NULL"> + <argument index="9" name="arg9" type="var" default="NULL"> </argument> <description> </description> @@ -10915,6 +11221,8 @@ </description> <methods> <method name="resume"> + <return type="Variant"> + </return> <argument index="0" name="arg" type="var" default="NULL"> </argument> <description> @@ -11521,7 +11829,7 @@ <method name="has_singleton" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> @@ -11529,7 +11837,7 @@ <method name="get_singleton" qualifiers="const"> <return type="Object"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> @@ -11537,7 +11845,7 @@ <method name="load_resource_pack"> <return type="bool"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="pack" type="String"> </argument> <description> </description> @@ -11545,7 +11853,7 @@ <method name="save_custom"> <return type="int"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="file" type="String"> </argument> <description> </description> @@ -11556,10 +11864,10 @@ </class> <class name="GraphEdit" inherits="Control" category="Core"> <brief_description> - GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. + GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. </brief_description> <description> - GraphEdit manages the showing of GraphNodes it contains, as well as connections an disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. + GraphEdit manages the showing of GraphNodes it contains, as well as connections an disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. It is greatly advised to enable low processor usage mode [OS.set_low_processor_usage_mode()] when using GraphEdits. </description> <methods> @@ -11575,7 +11883,7 @@ <argument index="3" name="to_port" type="int"> </argument> <description> - Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created. + Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created. </description> </method> <method name="is_node_connected"> @@ -11590,7 +11898,7 @@ <argument index="3" name="to_port" type="int"> </argument> <description> - Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. + Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. </description> </method> <method name="disconnect_node"> @@ -11603,32 +11911,50 @@ <argument index="3" name="to_port" type="int"> </argument> <description> - Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists. + Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists. </description> </method> <method name="get_connection_list" qualifiers="const"> <return type="Array"> </return> <description> - Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } + Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } </description> </method> <method name="set_right_disconnects"> <argument index="0" name="enable" type="bool"> </argument> <description> - Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. + Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. </description> </method> <method name="is_right_disconnects_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise. + Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise. </description> </method> </methods> <signals> + <signal name="delete_nodes_request"> + <description> + </description> + </signal> + <signal name="duplicate_nodes_request"> + <description> + </description> + </signal> + <signal name="popup_request"> + <argument index="0" name="p_position" type="Vector2"> + </argument> + <description> + </description> + </signal> + <signal name="_begin_node_move"> + <description> + </description> + </signal> <signal name="disconnection_request"> <argument index="0" name="from" type="String"> </argument> @@ -11639,7 +11965,7 @@ <argument index="3" name="to_slot" type="int"> </argument> <description> - Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. + Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. </description> </signal> <signal name="connection_request"> @@ -11652,7 +11978,11 @@ <argument index="3" name="to_slot" type="int"> </argument> <description> - Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. + Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. + </description> + </signal> + <signal name="_end_node_move"> + <description> </description> </signal> </signals> @@ -11661,24 +11991,24 @@ </class> <class name="GraphNode" inherits="Container" category="Core"> <brief_description> - A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. + A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. </brief_description> <description> - A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. + A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. </description> <methods> <method name="set_title"> <argument index="0" name="title" type="String"> </argument> <description> - Set the title of the GraphNode. + Set the title of the GraphNode. </description> </method> <method name="get_title" qualifiers="const"> <return type="String"> </return> <description> - Return the title of the GraphNode. + Return the title of the GraphNode. </description> </method> <method name="set_slot"> @@ -11697,19 +12027,19 @@ <argument index="6" name="color_right" type="Color"> </argument> <description> - Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input, 'right' are output. 'type' is an integer defining the type of the slot. Refer to description for the compatibility between slot types. + Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input, 'right' are output. 'type' is an integer defining the type of the slot. Refer to description for the compatibility between slot types. </description> </method> <method name="clear_slot"> <argument index="0" name="idx" type="int"> </argument> <description> - Disable input and ouput slot whose index is 'idx'. + Disable input and ouput slot whose index is 'idx'. </description> </method> <method name="clear_all_slots"> <description> - Disable all input and output slots of the GraphNode. + Disable all input and output slots of the GraphNode. </description> </method> <method name="is_slot_enabled_left" qualifiers="const"> @@ -11718,7 +12048,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return true if left (input) slot 'idx' is enabled. False otherwise. + Return true if left (input) slot 'idx' is enabled. False otherwise. </description> </method> <method name="get_slot_type_left" qualifiers="const"> @@ -11727,7 +12057,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the (integer) type of left (input) 'idx' slot. + Return the (integer) type of left (input) 'idx' slot. </description> </method> <method name="get_slot_color_left" qualifiers="const"> @@ -11736,7 +12066,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the color set to 'idx' left (input) slot. + Return the color set to 'idx' left (input) slot. </description> </method> <method name="is_slot_enabled_right" qualifiers="const"> @@ -11745,7 +12075,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return true if right (output) slot 'idx' is enabled. False otherwise. + Return true if right (output) slot 'idx' is enabled. False otherwise. </description> </method> <method name="get_slot_type_right" qualifiers="const"> @@ -11754,7 +12084,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the (integer) type of right (output) 'idx' slot. + Return the (integer) type of right (output) 'idx' slot. </description> </method> <method name="get_slot_color_right" qualifiers="const"> @@ -11763,35 +12093,35 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the color set to 'idx' right (output) slot. + Return the color set to 'idx' right (output) slot. </description> </method> <method name="set_offset"> <argument index="0" name="offset" type="Vector2"> </argument> <description> - Set the offset of the GraphNode. + Set the offset of the GraphNode. </description> </method> <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the offset of the GraphNode. + Return the offset of the GraphNode. </description> </method> <method name="get_connection_output_count"> <return type="int"> </return> <description> - Return the number of enabled output slots (connections) of the GraphNode. + Return the number of enabled output slots (connections) of the GraphNode. </description> </method> <method name="get_connection_input_count"> <return type="int"> </return> <description> - Return the number of enabled input slots (connections) to the GraphNode. + Return the number of enabled input slots (connections) to the GraphNode. </description> </method> <method name="get_connection_output_pos"> @@ -11800,7 +12130,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the position of the output connection 'idx'. + Return the position of the output connection 'idx'. </description> </method> <method name="get_connection_output_type"> @@ -11809,7 +12139,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the type of the output connection 'idx'. + Return the type of the output connection 'idx'. </description> </method> <method name="get_connection_output_color"> @@ -11818,7 +12148,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the color of the output connection 'idx'. + Return the color of the output connection 'idx'. </description> </method> <method name="get_connection_input_pos"> @@ -11827,7 +12157,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the position of the input connection 'idx'. + Return the position of the input connection 'idx'. </description> </method> <method name="get_connection_input_type"> @@ -11836,7 +12166,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the type of the input connection 'idx'. + Return the type of the input connection 'idx'. </description> </method> <method name="get_connection_input_color"> @@ -11845,33 +12175,33 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the color of the input connection 'idx'. + Return the color of the input connection 'idx'. </description> </method> <method name="set_show_close_button"> <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. + 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="is_close_button_visible" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if the close button is shown. False otherwise. + Returns true if the close button is shown. False otherwise. </description> </method> </methods> <signals> <signal name="raise_request"> <description> - Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. + Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. </description> </signal> <signal name="close_request"> <description> - Signal sent on closing the GraphNode. + Signal sent on closing the GraphNode. </description> </signal> <signal name="dragged"> @@ -11880,12 +12210,12 @@ <argument index="1" name="to" type="Vector2"> </argument> <description> - Signal sent when the GraphNode is dragged. + Signal sent when the GraphNode is dragged. </description> </signal> <signal name="offset_changed"> <description> - Signal sent when the GraphNode is moved. + Signal sent when the GraphNode is moved. </description> </signal> </signals> @@ -11910,6 +12240,12 @@ </theme_item> <theme_item name="frame" type="StyleBox"> </theme_item> + <theme_item name="selectedframe" type="StyleBox"> + </theme_item> + <theme_item name="defaultfocus" type="StyleBox"> + </theme_item> + <theme_item name="defaultframe" type="StyleBox"> + </theme_item> </theme_items> </class> <class name="GridContainer" inherits="Container" category="Core"> @@ -12033,7 +12369,7 @@ </description> </method> <method name="resource_changed"> - <argument index="0" name="arg0" type="Object"> + <argument index="0" name="resource" type="Object"> </argument> <description> </description> @@ -12407,9 +12743,13 @@ </argument> <argument index="2" name="use_ssl" type="bool" default="false"> </argument> - <argument index="3" name="arg3" type="bool" default="true"> + <argument index="3" name="verify_host" type="bool" default="true"> </argument> <description> + Connect to a host. This needs to be done before any requests are sent. +The host should not have http:// prepended but will strip the protocol identifier if provided. + +verify_host will check the SSL identity of the host if set to true. </description> </method> <method name="set_connection"> @@ -12430,6 +12770,19 @@ <argument index="3" name="body" type="String" default=""""> </argument> <description> + Sends a request to the connected host. The url is the what is normally behind the hostname, i.e: +http://somehost.com/index.php +url would be "index.php" + +Headers are HTTP request headers + +To create a POST request with query strings to push to the server, do: +var fields = {"username" : "user", + "password" : "pass"} +var queryString = httpClient.query_string_from_dict(fields) +var headers = ["Content-Type: application/x-www-form-urlencoded", + "Content-Length: " + str(queryString.length())] +var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString) </description> </method> <method name="send_body_text"> @@ -12438,6 +12791,7 @@ <argument index="0" name="body" type="String"> </argument> <description> + Stub function </description> </method> <method name="send_body_data"> @@ -12446,6 +12800,7 @@ <argument index="0" name="body" type="RawArray"> </argument> <description> + Stub function </description> </method> <method name="close"> @@ -12498,12 +12853,14 @@ <argument index="0" name="bytes" type="int"> </argument> <description> + Sets the size of the buffer used and maximum bytes to read per iteration </description> </method> <method name="set_blocking_mode"> <argument index="0" name="enabled" type="bool"> </argument> <description> + If set to true, execute will wait until all data is read from the response. </description> </method> <method name="is_blocking_mode_enabled" qualifiers="const"> @@ -12516,12 +12873,28 @@ <return type="int"> </return> <description> + Returns a status string like STATUS_REQUESTING. Need to call [method poll] in order to get status updates. </description> </method> <method name="poll"> <return type="Error"> </return> <description> + This needs to be called in order to have any request processed. Check results with [method get_status] + </description> + </method> + <method name="query_string_from_dict"> + <return type="String"> + </return> + <argument index="0" name="fields" type="Dictionary"> + </argument> + <description> + Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary. + +var fields = {"username": "user", "password": "pass"} +String queryString = httpClient.query_string_from_dict(fields) + +returns:= "username=user&password=pass" </description> </method> </methods> @@ -12971,6 +13344,21 @@ <description> </description> </method> + <method name="Image"> + <return type="Image"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="mipmaps" type="bool"> + </argument> + <argument index="3" name="format" type="int"> + </argument> + <description> + Create an empty image of a specific size and format. + </description> + </method> </methods> <constants> <constant name="COMPRESS_BC" value="0"> @@ -13115,6 +13503,10 @@ <description> </description> </method> + <method name="shrink_x2_and_keep_size"> + <description> + </description> + </method> <method name="set_size_override"> <argument index="0" name="size" type="Vector2"> </argument> @@ -13298,13 +13690,13 @@ </description> </method> <method name="action_press"> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="action" type="String"> </argument> <description> </description> </method> <method name="action_release"> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="action" type="String"> </argument> <description> </description> @@ -14292,6 +14684,28 @@ <constants> </constants> </class> +<class name="InstancePlaceholder" inherits="Node" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="replace_by_instance"> + <argument index="0" name="custom_scene" type="PackedScene" default="NULL"> + </argument> + <description> + </description> + </method> + <method name="get_instance_path" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> <class name="IntArray" category="Built-In Types"> <brief_description> Integer Array. @@ -14762,6 +15176,18 @@ <description> </description> </method> + <method name="set_exclude_nodes_from_collision"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="get_exclude_nodes_from_collision" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -14778,7 +15204,7 @@ <argument index="0" name="node" type="NodePath"> </argument> <description> - Set the path to the A node for the joint. Must be of type PhysicsBody2D. + Set the path to the A node for the joint. Must be of type [PhysicsBody2D]. </description> </method> <method name="get_node_a" qualifiers="const"> @@ -14792,7 +15218,7 @@ <argument index="0" name="node" type="NodePath"> </argument> <description> - Set the path to the B node for the joint. Must be of type PhysicsBody2D. + Set the path to the B node for the joint. Must be of type [PhysicsBody2D]. </description> </method> <method name="get_node_b" qualifiers="const"> @@ -14814,6 +15240,18 @@ <description> </description> </method> + <method name="set_exclude_nodes_from_collision"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="get_exclude_nodes_from_collision" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -14840,14 +15278,13 @@ <description> </description> </method> - <method name="can_move_to"> + <method name="can_teleport_to"> <return type="bool"> </return> <argument index="0" name="position" type="Vector3"> </argument> - <argument index="1" name="arg1" type="bool"> - </argument> <description> + Returns whether the KinematicBody can be teleported to the destination given as an argument, checking all collision shapes of the body against potential colliders at the destination. </description> </method> <method name="is_colliding" qualifiers="const"> @@ -14875,6 +15312,8 @@ </description> </method> <method name="get_collider" qualifiers="const"> + <return type="Object"> + </return> <description> </description> </method> @@ -14950,8 +15389,12 @@ </class> <class name="KinematicBody2D" inherits="PhysicsBody2D" category="Core"> <brief_description> + Kinematic body 2D node. </brief_description> <description> + Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: + Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). + Kinematic Characters: KinematicBody2D also has an api for moving objects (the [method move] method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. </description> <methods> <method name="move"> @@ -14960,6 +15403,7 @@ <argument index="0" name="rel_vec" type="Vector2"> </argument> <description> + Move the body in the given direction, stopping if there is an obstacle. </description> </method> <method name="move_to"> @@ -14968,6 +15412,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> + Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. </description> </method> <method name="test_move"> @@ -14976,66 +15421,82 @@ <argument index="0" name="rel_vec" type="Vector2"> </argument> <description> + Return true if there would be a collision if the body moved in the given direction. </description> </method> <method name="get_travel" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the last movement done by the body. </description> </method> <method name="revert_motion"> <description> + Undo the last movement done by the body. </description> </method> <method name="is_colliding" qualifiers="const"> <return type="bool"> </return> <description> + Return whether the body is colliding with another. </description> </method> <method name="get_collision_pos" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with [method is_colliding]. </description> </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the normal of the surface the body collided with. This is useful to implement sliding along a surface. </description> </method> <method name="get_collider_velocity" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the velocity of the body that collided with this one. </description> </method> <method name="get_collider" qualifiers="const"> + <return type="Object"> + </return> <description> + Return the body that collided with this one. </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="int"> </return> <description> + Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding]. </description> </method> <method name="get_collider_metadata" qualifiers="const"> + <return type="var"> + </return> <description> + Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with [method is_colliding]. Aditionally, this metadata can not be set with [method Object.set_meta], it must be set with [method Physics2DServer.body_set_shape_metadata]. </description> </method> <method name="set_collision_margin"> <argument index="0" name="pixels" type="float"> </argument> <description> + Set the collision margin for this object. A collision margin is an amount (in pixels) that all shapes will grow when computing collisions, to account for numerical imprecision. </description> </method> <method name="get_collision_margin" qualifiers="const"> <return type="float"> </return> <description> + Return the collision margin for this object. </description> </method> </methods> @@ -15340,7 +15801,7 @@ <method name="get_parameter" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="variable" type="int"> </argument> <description> </description> @@ -15356,7 +15817,7 @@ <method name="get_color" qualifiers="const"> <return type="Color"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="color" type="int"> </argument> <description> </description> @@ -15693,6 +16154,8 @@ </constant> <constant name="MODE_MIX" value="2"> </constant> + <constant name="MODE_MASK" value="3"> + </constant> </constants> </class> <class name="LightOccluder2D" inherits="Node2D" category="Core"> @@ -15737,6 +16200,18 @@ LineEdit provides a single line string editor, used for text fields. </description> <methods> + <method name="set_align"> + <argument index="0" name="align" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_align" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="clear"> <description> Clear the [LineEdit] text. @@ -15850,6 +16325,14 @@ </signal> </signals> <constants> + <constant name="ALIGN_LEFT" value="0"> + </constant> + <constant name="ALIGN_CENTER" value="1"> + </constant> + <constant name="ALIGN_RIGHT" value="2"> + </constant> + <constant name="ALIGN_FILL" value="3"> + </constant> </constants> <theme_items> <theme_item name="minimum_spaces" type="int"> @@ -16037,6 +16520,8 @@ </description> </method> <method name="base64_to_variant"> + <return type="Variant"> + </return> <argument index="0" name="base64_str" type="String"> </argument> <description> @@ -16517,11 +17002,11 @@ </method> </methods> <members> - <member name="x" type="float"> + <member name="x" type="Vector2"> </member> - <member name="y" type="float"> + <member name="y" type="Vector2"> </member> - <member name="o" type="float"> + <member name="o" type="Vector2"> </member> </members> <constants> @@ -16568,6 +17053,8 @@ </theme_item> <theme_item name="pressed" type="StyleBox"> </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> <theme_item name="disabled" type="StyleBox"> </theme_item> <theme_item name="normal" type="StyleBox"> @@ -16623,9 +17110,9 @@ </argument> <argument index="1" name="arrays" type="Array"> </argument> - <argument index="2" name="morph_arrays" type="Array"> + <argument index="2" name="morph_arrays" type="Array" default="Array()"> </argument> - <argument index="3" name="arg3" type="bool" default="Array()"> + <argument index="3" name="alphasort" type="bool" default="false"> </argument> <description> Create a new surface ([method get_surface_count] that will become surf_idx for this. @@ -17298,7 +17785,7 @@ </description> </method> <method name="set_instance_count"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="count" type="int"> </argument> <description> Set the amount of instnces that is going to be drawn. Changing this number will erase all the existing instance transform and color data. @@ -17312,9 +17799,9 @@ </description> </method> <method name="set_instance_transform"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="instance" type="int"> </argument> - <argument index="1" name="arg1" type="Transform"> + <argument index="1" name="transform" type="Transform"> </argument> <description> Set the transform for a specific instance. @@ -17323,16 +17810,16 @@ <method name="get_instance_transform" qualifiers="const"> <return type="Transform"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="instance" type="int"> </argument> <description> Return the transform of a specific instance. </description> </method> <method name="set_instance_color"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="instance" type="int"> </argument> - <argument index="1" name="arg1" type="Color"> + <argument index="1" name="color" type="Color"> </argument> <description> Set the color of a specific instance. @@ -17341,14 +17828,14 @@ <method name="get_instance_color" qualifiers="const"> <return type="Color"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="instance" type="int"> </argument> <description> Get the color of a specific instance. </description> </method> <method name="set_aabb"> - <argument index="0" name="arg0" type="AABB"> + <argument index="0" name="visibility_aabb" type="AABB"> </argument> <description> Set the visibility AABB. If not provided, MultiMesh will not be visible. @@ -18049,8 +18536,11 @@ <method name="add_child"> <argument index="0" name="node" type="Node"> </argument> + <argument index="1" name="legible_unique_name" type="bool" default="false"> + </argument> <description> Add a child [Node]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. + The optional boolean argument enforces creating child node with human-readable names, based on the name of node being instanced instead of its type only. </description> </method> <method name="remove_child"> @@ -18124,7 +18614,11 @@ <method name="find_node" qualifiers="const"> <return type="Node"> </return> - <argument index="0" name="mask" type="NodePath" default="true"> + <argument index="0" name="mask" type="String"> + </argument> + <argument index="1" name="recursive" type="bool" default="true"> + </argument> + <argument index="2" name="owned" type="bool" default="true"> </argument> <description> </description> @@ -18188,7 +18682,7 @@ <method name="add_to_group"> <argument index="0" name="group" type="String"> </argument> - <argument index="1" name="arg1" type="bool" default="false"> + <argument index="1" name="persistent" type="bool" default="false"> </argument> <description> Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies", "Collectables", etc. A [Node] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_scene]). @@ -18415,6 +18909,18 @@ Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. </description> </method> + <method name="set_scene_instance_load_placeholder"> + <argument index="0" name="load_placeholder" type="bool"> + </argument> + <description> + </description> + </method> + <method name="get_scene_instance_load_placeholder" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="get_viewport" qualifiers="const"> <return type="Object"> </return> @@ -18627,7 +19133,7 @@ </description> </method> <method name="edit_set_pivot"> - <argument index="0" name="arg0" type="Vector2"> + <argument index="0" name="pivot" type="Vector2"> </argument> <description> </description> @@ -18635,7 +19141,7 @@ <method name="get_relative_transform" qualifiers="const"> <return type="Matrix32"> </return> - <argument index="0" name="arg0" type="Object"> + <argument index="0" name="parent" type="Object"> </argument> <description> </description> @@ -19104,7 +19610,7 @@ </description> </method> <method name="set_icon"> - <argument index="0" name="arg0" type="Image"> + <argument index="0" name="icon" type="Image"> </argument> <description> </description> @@ -19269,7 +19775,7 @@ </description> </method> <method name="print_resources_by_type"> - <argument index="0" name="arg0" type="StringArray"> + <argument index="0" name="types" type="StringArray"> </argument> <description> </description> @@ -19277,13 +19783,13 @@ <method name="native_video_play"> <return type="int"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="path" type="String"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="volume" type="float"> </argument> - <argument index="2" name="arg2" type="String"> + <argument index="2" name="audio_track" type="String"> </argument> - <argument index="3" name="arg3" type="String"> + <argument index="3" name="subtitle_track" type="String"> </argument> <description> </description> @@ -19510,7 +20016,7 @@ <method name="notification"> <argument index="0" name="what" type="int"> </argument> - <argument index="1" name="arg1" type="bool" default="false"> + <argument index="1" name="reversed" type="bool" default="false"> </argument> <description> Notify the object of something. @@ -19648,6 +20154,8 @@ </description> </method> <method name="callv"> + <return type="Variant"> + </return> <argument index="0" name="method" type="String"> </argument> <argument index="1" name="arg_array" type="Array"> @@ -19658,7 +20166,7 @@ <method name="has_method" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="method" type="String"> </argument> <description> </description> @@ -19986,7 +20494,7 @@ </description> </method> <method name="select"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="idx" type="int"> </argument> <description> Select an item by index and make it the current item. @@ -20085,7 +20593,7 @@ <method name="flush"> <return type="int"> </return> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="verbose" type="bool"> </argument> <description> </description> @@ -20171,7 +20679,7 @@ <method name="instance" qualifiers="const"> <return type="Node"> </return> - <argument index="0" name="arg0" type="bool" default="false"> + <argument index="0" name="gen_edit_state" type="bool" default="false"> </argument> <description> </description> @@ -20201,7 +20709,7 @@ <method name="put_var"> <return type="int"> </return> - <argument index="0" name="var" type="var"> + <argument index="0" name="var" type="Variant"> </argument> <description> </description> @@ -20421,6 +20929,18 @@ <description> </description> </method> + <method name="set_ignore_camera_zoom"> + <argument index="0" name="ignore" type="bool"> + </argument> + <description> + </description> + </method> + <method name="is_ignore_camera_zoom"> + <return type="bool"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -20673,7 +21193,7 @@ <method name="get_randomness" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="variable" type="int"> </argument> <description> Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. @@ -20730,7 +21250,7 @@ </description> </method> <method name="set_emit_timeout"> - <argument index="0" name="arg0" type="float"> + <argument index="0" name="timeout" type="float"> </argument> <description> </description> @@ -20920,6 +21440,8 @@ </description> </method> <method name="set_texture"> + <return type="Texture"> + </return> <argument index="0" name="texture" type="Object"> </argument> <description> @@ -20944,6 +21466,8 @@ </description> </method> <method name="set_color_ramp"> + <return type="ColorRamp"> + </return> <argument index="0" name="color_ramp" type="Object"> </argument> <description> @@ -21229,20 +21753,24 @@ </class> <class name="Path" inherits="Spatial" category="Core"> <brief_description> + Container for a [Curve3D]. </brief_description> <description> + This class is a container/Node-ification of a [Curve3D], so it can have [Spatial] properties and [Node] info. </description> <methods> <method name="set_curve"> <argument index="0" name="curve" type="Curve3D"> </argument> <description> + Sets the [Curve3D]. </description> </method> <method name="get_curve" qualifiers="const"> <return type="Curve3D"> </return> <description> + Returns the [Curve3D] contained. </description> </method> </methods> @@ -21251,20 +21779,24 @@ </class> <class name="Path2D" inherits="Node2D" category="Core"> <brief_description> + Container for a [Curve2D]. </brief_description> <description> + This class is a container/Node-ification of a [Curve2D], so it can have [Node2D] properties and [Node] info. </description> <methods> <method name="set_curve"> <argument index="0" name="curve" type="Curve2D"> </argument> <description> + Sets the [Curve2D]. </description> </method> <method name="get_curve" qualifiers="const"> <return type="Curve2D"> </return> <description> + Returns the [Curve2D] contained. </description> </method> </methods> @@ -21273,194 +21805,238 @@ </class> <class name="PathFollow" inherits="Spatial" category="Core"> <brief_description> + Point sampler for a [Path]. </brief_description> <description> + This node takes its parent [Path], and returns the coordinates of a point within it, given a distance from the first vertex. +It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. </description> <methods> <method name="set_offset"> <argument index="0" name="offset" type="float"> </argument> <description> + Sets the distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. </description> </method> <method name="get_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the distance along the path in 3D units. </description> </method> <method name="set_h_offset"> <argument index="0" name="h_offset" type="float"> </argument> <description> + Moves this node in the X axis. As this node's position will be set every time its offset is set, this allows many PathFollow to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. +A similar effect may be achieved moving the this node's descendants. </description> </method> <method name="get_h_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the X displacement this node has from its parent [Path]. </description> </method> <method name="set_v_offset"> <argument index="0" name="v_offset" type="float"> </argument> <description> + Moves this node in the Y axis, for the same reasons of [method set_h_offset]. </description> </method> <method name="get_v_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the Y displacement this node has from its parent [Path]. </description> </method> <method name="set_unit_offset"> <argument index="0" name="unit_offset" type="float"> </argument> <description> + Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. </description> </method> <method name="get_unit_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). </description> </method> <method name="set_rotation_mode"> <argument index="0" name="rotation_mode" type="int"> </argument> <description> + Allows or forbids rotation on one or more axes, per the constants below. </description> </method> <method name="get_rotation_mode" qualifiers="const"> <return type="int"> </return> <description> + Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode. </description> </method> <method name="set_cubic_interpolation"> <argument index="0" name="enable" type="bool"> </argument> <description> + The points along the [Curve3D] of the [Path] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. +There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. +This method controls whether the position between two cached points is interpolated linearly, or cubicly. </description> </method> <method name="get_cubic_interpolation" qualifiers="const"> <return type="bool"> </return> <description> + This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. </description> </method> <method name="set_loop"> <argument index="0" name="loop" type="bool"> </argument> <description> + If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths. </description> </method> <method name="has_loop" qualifiers="const"> <return type="bool"> </return> <description> + Returns whether this node wraps its offsets around, or truncates them to the path ends. </description> </method> </methods> <constants> <constant name="ROTATION_NONE" value="0"> + Forbids the PathFollow to rotate. </constant> <constant name="ROTATION_Y" value="1"> + Allows the PathFollow to rotate in the Y axis only. </constant> <constant name="ROTATION_XY" value="2"> + Allows the PathFollow to rotate in both the X, and Y axes. </constant> <constant name="ROTATION_XYZ" value="3"> + Allows the PathFollow to rotate in any axis. </constant> </constants> </class> <class name="PathFollow2D" inherits="Node2D" category="Core"> <brief_description> + Point sampler for a [Path2D]. </brief_description> <description> + This node takes its parent [Path2D], and returns the coordinates of a point within it, given a distance from the first vertex. +It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. </description> <methods> <method name="set_offset"> <argument index="0" name="offset" type="float"> </argument> <description> + Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path. </description> </method> <method name="get_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the distance along the path in pixels. </description> </method> <method name="set_h_offset"> <argument index="0" name="h_offset" type="float"> </argument> <description> + Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. +A similar effect may be achieved moving this node's descendants. </description> </method> <method name="get_h_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the horizontal displacement this node has from its parent [Path2D]. </description> </method> <method name="set_v_offset"> <argument index="0" name="v_offset" type="float"> </argument> <description> + Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset]. </description> </method> <method name="get_v_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the vertical displacement this node has from its parent [Path2D]. </description> </method> <method name="set_unit_offset"> <argument index="0" name="unit_offset" type="float"> </argument> <description> + Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. </description> </method> <method name="get_unit_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). </description> </method> <method name="set_rotate"> <argument index="0" name="enable" type="bool"> </argument> <description> + If set, this node rotates to follow the path, making its descendants rotate. </description> </method> <method name="is_rotating" qualifiers="const"> <return type="bool"> </return> <description> + Returns whether this node rotates to follow the path. </description> </method> <method name="set_cubic_interpolation"> <argument index="0" name="enable" type="bool"> </argument> <description> + The points along the [Curve2D] of the [Path2D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. +There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. +This method controls whether the position between two cached points is interpolated linearly, or cubicly. </description> </method> <method name="get_cubic_interpolation" qualifiers="const"> <return type="bool"> </return> <description> + This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. </description> </method> <method name="set_loop"> <argument index="0" name="loop" type="bool"> </argument> <description> + If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths. </description> </method> <method name="has_loop" qualifiers="const"> <return type="bool"> </return> <description> + Returns whether this node wraps its offsets around, or truncates them to the path ends. </description> </method> </methods> @@ -21770,6 +22346,8 @@ </description> </method> <method name="get_contact_collider_shape_metadata" qualifiers="const"> + <return type="Variant"> + </return> <argument index="0" name="contact_idx" type="int"> </argument> <description> @@ -22184,11 +22762,11 @@ </description> </method> <method name="area_set_monitor_callback"> - <argument index="0" name="receiver" type="RID"> + <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="method" type="Object"> + <argument index="1" name="receiver" type="Object"> </argument> - <argument index="2" name="arg2" type="String"> + <argument index="2" name="method" type="String"> </argument> <description> </description> @@ -22498,9 +23076,9 @@ </description> </method> <method name="body_set_one_way_collision_direction"> - <argument index="0" name="normal" type="RID"> + <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="arg1" type="Vector2"> + <argument index="1" name="normal" type="Vector2"> </argument> <description> </description> @@ -22508,15 +23086,15 @@ <method name="body_get_one_way_collision_direction" qualifiers="const"> <return type="Vector2"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="body" type="RID"> </argument> <description> </description> </method> <method name="body_set_one_way_collision_max_depth"> - <argument index="0" name="normal" type="RID"> + <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="depth" type="float"> </argument> <description> </description> @@ -22524,7 +23102,7 @@ <method name="body_get_one_way_collision_max_depth" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="body" type="RID"> </argument> <description> </description> @@ -22552,7 +23130,7 @@ </argument> <argument index="2" name="method" type="String"> </argument> - <argument index="3" name="arg3" type="var"> + <argument index="3" name="userdata" type="var" default="NULL"> </argument> <description> </description> @@ -22676,7 +23254,7 @@ <method name="get_process_info"> <return type="int"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="process_info" type="int"> </argument> <description> </description> @@ -22715,11 +23293,20 @@ </constant> <constant name="AREA_PARAM_PRIORITY" value="7"> </constant> + <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + </constant> <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1"> + 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. </constant> - <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> + 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. + </constant> + <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> + This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. </constant> - <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="2"> + <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. </constant> <constant name="BODY_MODE_STATIC" value="0"> </constant> @@ -23007,7 +23594,7 @@ </class> <class name="PhysicsBody" inherits="CollisionObject" category="Core"> <brief_description> - Base class for differnt types of Physics bodies. + Base class for different types of Physics bodies. </brief_description> <description> PhysicsBody is an abstract base class for implementing a physics body. All PhysicsBody types inherit from it. @@ -23043,32 +23630,40 @@ </class> <class name="PhysicsBody2D" inherits="CollisionObject2D" category="Core"> <brief_description> + Base class for all objects affected by physics. </brief_description> <description> + PhysicsBody2D is an abstract base class for implementing a physics body. All [i]x[/i]Body2D types inherit from it. </description> <methods> <method name="set_layer_mask"> <argument index="0" name="mask" 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="get_layer_mask" qualifiers="const"> <return type="int"> </return> <description> + Return the physics layer this area is in. </description> </method> <method name="set_collision_mask"> <argument index="0" name="mask" type="int"> </argument> <description> + Set the physics layers this area can scan for collisions. </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="set_collision_mask_bit"> @@ -23077,6 +23672,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -23085,6 +23681,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Return an individual bit on the collision mask. </description> </method> <method name="set_layer_mask_bit"> @@ -23093,6 +23690,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> + Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. </description> </method> <method name="get_layer_mask_bit" qualifiers="const"> @@ -23101,42 +23699,49 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Return an individual bit on the collision mask. </description> </method> <method name="set_one_way_collision_direction"> <argument index="0" name="dir" type="Vector2"> </argument> <description> + Set a direction in which bodies can go through this one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions. </description> </method> <method name="get_one_way_collision_direction" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the direction used for one-way collision detection. </description> </method> <method name="set_one_way_collision_max_depth"> <argument index="0" name="depth" type="float"> </argument> <description> + Set how far a body can go through this one, when it allows one-way collisions (see [method set_one_way_collision_detection]). </description> </method> <method name="get_one_way_collision_max_depth" qualifiers="const"> <return type="float"> </return> <description> + Return how far a body can go through this one, when it allows one-way collisions. </description> </method> <method name="add_collision_exception_with"> <argument index="0" name="body" type="PhysicsBody2D"> </argument> <description> + Adds a body to the collision exception list. This list contains bodies that this body will not collide with. </description> </method> <method name="remove_collision_exception_with"> <argument index="0" name="body" type="PhysicsBody2D"> </argument> <description> + Removes a body from the collision exception list. </description> </method> </methods> @@ -23674,11 +24279,11 @@ </description> </method> <method name="area_set_monitor_callback"> - <argument index="0" name="receiver" type="RID"> + <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="method" type="Object"> + <argument index="1" name="receiver" type="Object"> </argument> - <argument index="2" name="arg2" type="String"> + <argument index="2" name="method" type="String"> </argument> <description> </description> @@ -23738,8 +24343,6 @@ </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> <description> </description> </method> @@ -24284,7 +24887,7 @@ <method name="get_process_info"> <return type="int"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="process_info" type="int"> </argument> <description> </description> @@ -24451,11 +25054,20 @@ </constant> <constant name="AREA_PARAM_PRIORITY" value="7"> </constant> + <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + </constant> <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1"> + 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. </constant> - <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> + 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. + </constant> + <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> + This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. </constant> - <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="2"> + <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. </constant> <constant name="BODY_MODE_STATIC" value="0"> </constant> @@ -24688,6 +25300,18 @@ Pin Joint for 2D Rigid Bodies. It pins 2 bodies (rigid or static) together, or a single body to a fixed position in space. </description> <methods> + <method name="set_softness"> + <argument index="0" name="softness" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_softness" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -25254,7 +25878,7 @@ <method name="set_item_checked"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="checked" type="bool"> </argument> <description> Set the checkstate status of the item at index "idx". @@ -25808,6 +26432,14 @@ <description> </description> </method> + <method name="xform"> + <return type="Vector3"> + </return> + <argument index="0" name="v" type="Vector3"> + </argument> + <description> + </description> + </method> <method name="Quat"> <return type="Quat"> </return> @@ -25934,12 +26566,6 @@ Return value mapped to 0 to 1 (unit) range. </description> </method> - <method name="get_rounded_values" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="set_val"> <argument index="0" name="value" type="float"> </argument> @@ -25987,11 +26613,17 @@ </description> </method> <method name="set_rounded_values"> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="enabled" type="bool"> </argument> <description> </description> </method> + <method name="is_rounded_values" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="set_exp_unit_value"> <argument index="0" name="enabled" type="bool"> </argument> @@ -26052,12 +26684,14 @@ <return type="String"> </return> <description> + Returns a copy of the array's contents formatted as String. Fast alternative to get_string_from_utf8(), assuming the content is ASCII-only (unlike the UTF-8 function, this function maps every byte to a character in the string, so any multibyte sequence will be torn apart). </description> </method> <method name="get_string_from_utf8"> <return type="String"> </return> <description> + Returns a copy of the array's contents formatted as String, assuming the array is formatted as UTF-8. Slower than get_string_from_ascii(), but works for UTF-8. Usually you should prefer this function over get_string_from_ascii() to support international input. </description> </method> <method name="push_back"> @@ -26292,6 +26926,18 @@ <description> </description> </method> + <method name="set_type_mask"> + <argument index="0" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_type_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -26323,19 +26969,21 @@ Ray 2D shape resource for physics. </brief_description> <description> - Ray 2D shape resource for physics. A ray is not really a collision body, isntead it tries to separate itself from whatever is touching its far endpoint. It's often useful for ccharacters. + Ray 2D shape resource for physics. A ray is not really a collision body, isntead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. </description> <methods> <method name="set_length"> <argument index="0" name="length" type="float"> </argument> <description> + Set the length of the ray. </description> </method> <method name="get_length" qualifiers="const"> <return type="float"> </return> <description> + Return the length of the ray. </description> </method> </methods> @@ -26398,8 +27046,10 @@ </class> <class name="Rect2" category="Built-In Types"> <brief_description> + 2D Axis-aligned bounding box. </brief_description> <description> + Rect2 provides an 2D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. </description> <methods> <method name="clip"> @@ -26408,6 +27058,7 @@ <argument index="0" name="b" type="Rect2"> </argument> <description> + Returns the intersection of this [Rect2] and b. </description> </method> <method name="encloses"> @@ -26416,6 +27067,7 @@ <argument index="0" name="b" type="Rect2"> </argument> <description> + Returns true if this [Rect2] completely encloses another one. </description> </method> <method name="expand"> @@ -26424,12 +27076,14 @@ <argument index="0" name="to" type="Vector2"> </argument> <description> + Return this [Rect2] expanded to include a given point. </description> </method> <method name="get_area"> <return type="float"> </return> <description> + Get the area of the [Rect2]. </description> </method> <method name="grow"> @@ -26438,12 +27092,14 @@ <argument index="0" name="by" type="float"> </argument> <description> + Return a copy of the [Rect2] grown a given amount of units towards all the sides. </description> </method> <method name="has_no_area"> <return type="bool"> </return> <description> + Return true if the [Rect2] is flat or empty. </description> </method> <method name="has_point"> @@ -26452,6 +27108,7 @@ <argument index="0" name="point" type="Vector2"> </argument> <description> + Return true if the [Rect2] contains a point. </description> </method> <method name="intersects"> @@ -26460,6 +27117,7 @@ <argument index="0" name="b" type="Rect2"> </argument> <description> + Return true if the [Rect2] overlaps with another. </description> </method> <method name="merge"> @@ -26468,6 +27126,7 @@ <argument index="0" name="b" type="Rect2"> </argument> <description> + Combine this [Rect2] with another, a larger one is returned that contains both. </description> </method> <method name="Rect2"> @@ -26478,6 +27137,7 @@ <argument index="1" name="size" type="Vector2"> </argument> <description> + Construct a [Rect2] by position and size. </description> </method> <method name="Rect2"> @@ -26492,6 +27152,7 @@ <argument index="3" name="height" type="float"> </argument> <description> + Construct a [Rect2] by x, y, width and height. </description> </method> </methods> @@ -26567,7 +27228,7 @@ Reference frame for GUI. </brief_description> <description> - Reference frame for GUI. It's just like an empty control, except a red box is displayed while editing around it's size at all times. + Reference frame for GUI. It's just like an empty control, except a red box is displayed while editing around its size at all times. </description> <methods> </methods> @@ -26580,8 +27241,27 @@ </class> <class name="RegEx" inherits="Reference" category="Core"> <brief_description> - </brief_description> - <description> + Simple regular expression matcher. + </brief_description> + <description> + Class for finding text patterns in a string using regular expressions. Regular expressions are a way to define patterns of text to be searched. + This class only finds patterns in a string. It can not perform replacements. + Usage of regular expressions is too long to be explained here, but Internet is full of tutorials and detailed explanations. + Currently supported features: + Capturing [code]()[/code] and non-capturing [code](?:)[/code] groups + Any character [code].[/code] + Shorthand caracter classes [code]\w \W \s \S \d \D[/code] + User-defined character classes such as [code][A-Za-z][/code] + Simple quantifiers [code]?[/code], [code]*[/code] and [code]+[/code] + Range quantifiers [code]{x,y}[/code] + Lazy (non-greedy) quantifiers [code]*?[/code] + Begining [code]^[/code] and end [code]$[/code] anchors + Alternation [code]|[/code] + Backreferences [code]\1[/code] and [code]\g{1}[/code] + POSIX character classes [code][[:alnum:]][/code] + Lookahead [code](?=)[/code], [code](?!)[/code] and lookbehind [code](?<=)[/code], [code](?<!)[/code] + ASCII [code]\xFF[/code] and Unicode [code]\uFFFF[/code] code points (in a style similar to Python) + Word boundaries [code]\b[/code], [code]\B[/code] </description> <methods> <method name="compile"> @@ -26589,7 +27269,10 @@ </return> <argument index="0" name="pattern" type="String"> </argument> + <argument index="1" name="capture" type="int" default="9"> + </argument> <description> + Compiles and assign the regular expression pattern to use. The limit on the number of capturing groups can be specified or made unlimited if negative. </description> </method> <method name="find" qualifiers="const"> @@ -26602,22 +27285,26 @@ <argument index="2" name="end" type="int" default="-1"> </argument> <description> + This method tries to find the pattern within the string, and returns the position where it was found. It also stores any capturing group (see [method get_capture]) for further retrieval. </description> </method> <method name="clear"> <description> + This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object, and forgets all captures made by the last [method find]. </description> </method> <method name="is_valid" qualifiers="const"> <return type="bool"> </return> <description> + Returns whether this object has a valid regular expression assigned. </description> </method> <method name="get_capture_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of capturing groups. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]). </description> </method> <method name="get_capture" qualifiers="const"> @@ -26626,12 +27313,14 @@ <argument index="0" name="capture" type="int"> </argument> <description> + Returns a captured group. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]). </description> </method> <method name="get_captures" qualifiers="const"> <return type="StringArray"> </return> <description> + Return a list of all the captures made by the regular expression. </description> </method> </methods> @@ -26734,7 +27423,7 @@ <method name="duplicate"> <return type="Object"> </return> - <argument index="0" name="arg0" type="bool" default="false"> + <argument index="0" name="subresources" type="bool" default="false"> </argument> <description> </description> @@ -26923,7 +27612,7 @@ <method name="get_dependencies"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="path" type="String"> </argument> <description> </description> @@ -26931,7 +27620,7 @@ <method name="has"> <return type="bool"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="path" type="String"> </argument> <description> </description> @@ -27017,7 +27706,7 @@ </argument> <argument index="1" name="resource" type="Resource"> </argument> - <argument index="2" name="arg2" type="int" default="0"> + <argument index="2" name="flags" type="int" default="0"> </argument> <description> Save a resource to disk, to a given path. @@ -27112,6 +27801,26 @@ <description> </description> </method> + <method name="push_table"> + <argument index="0" name="columns" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_table_column_expand"> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="expand" type="bool"> + </argument> + <argument index="2" name="ratio" type="int"> + </argument> + <description> + </description> + </method> + <method name="push_cell"> + <description> + </description> + </method> <method name="pop"> <description> </description> @@ -27162,6 +27871,12 @@ <description> </description> </method> + <method name="scroll_to_line"> + <argument index="0" name="line" type="int"> + </argument> + <description> + </description> + </method> <method name="set_tab_size"> <argument index="0" name="spaces" type="int"> </argument> @@ -27270,7 +27985,7 @@ </constant> <constant name="LIST_DOTS" value="2"> </constant> - <constant name="ITEM_MAIN" value="0"> + <constant name="ITEM_FRAME" value="0"> </constant> <constant name="ITEM_TEXT" value="1"> </constant> @@ -27290,10 +28005,14 @@ </constant> <constant name="ITEM_LIST" value="9"> </constant> - <constant name="ITEM_META" value="10"> + <constant name="ITEM_META" value="11"> </constant> </constants> <theme_items> + <theme_item name="table_vseparation" type="int"> + </theme_item> + <theme_item name="table_hseparation" type="int"> + </theme_item> <theme_item name="line_separation" type="int"> </theme_item> <theme_item name="default_color" type="Color"> @@ -27607,7 +28326,7 @@ Rigid body 2D node. </brief_description> <description> - Rigid body 2D node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift state between regular Rigid Body to Character or even Static. + Rigid body 2D node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift state between regular Rigid body, Kinematic, Character or Static. Character mode forbids the node from being rotated. This node can have a custom force integrator function, for writing complex physics motion behavior per node. As a warning, don't change this node position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. </description> @@ -27630,7 +28349,7 @@ <return type="int"> </return> <description> - Return the current body mode, see [set_mode]. + Return the current body mode, see [method set_mode]. </description> </method> <method name="set_mass"> @@ -27651,14 +28370,14 @@ <argument index="0" name="weight" type="float"> </argument> <description> - Set the body mass given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels. + Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels. </description> </method> <method name="get_weight" qualifiers="const"> <return type="float"> </return> <description> - Return the body mass given standard earth-weight (gravity 9.8). + Return the body weight given standard earth-weight (gravity 9.8). </description> </method> <method name="set_friction"> @@ -27679,7 +28398,7 @@ <argument index="0" name="bounce" type="float"> </argument> <description> - Set the body bounciness, from 0 (no bounce) to 1 (bounce). + Set the body bounciness, from 0 (no bounce) to 1 (full bounce). </description> </method> <method name="get_bounce" qualifiers="const"> @@ -27693,36 +28412,42 @@ <argument index="0" name="gravity_scale" type="float"> </argument> <description> + Set The gravity factor. This factor multiplies gravity intensity just for this body. </description> </method> <method name="get_gravity_scale" qualifiers="const"> <return type="float"> </return> <description> + Return the gravity factor. </description> </method> <method name="set_linear_damp"> <argument index="0" name="linear_damp" type="float"> </argument> <description> + Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overriden. </description> </method> <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> + Return the linear damp for this body. </description> </method> <method name="set_angular_damp"> <argument index="0" name="angular_damp" type="float"> </argument> <description> + Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overriden. </description> </method> <method name="get_angular_damp" qualifiers="const"> <return type="float"> </return> <description> + Return the angular damp for this body. </description> </method> <method name="set_linear_velocity"> @@ -27736,7 +28461,7 @@ <return type="Vector2"> </return> <description> - Return the body linear velocity. This changes by physics granularity. See [set_linear_velocity]. + Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity]. </description> </method> <method name="set_angular_velocity"> @@ -27750,7 +28475,7 @@ <return type="float"> </return> <description> - Return the body angular velocity. This changes by physics granularity. See [set_angular_velocity]. + Return the body angular velocity. This changes by physics granularity. See [method set_angular_velocity]. </description> </method> <method name="set_max_contacts_reported"> @@ -27764,14 +28489,14 @@ <return type="int"> </return> <description> - Return the maximum contacts that can be reported. See [set_max_contacts_reported]. + Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. </description> </method> <method name="set_use_custom_integrator"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set to true if the body shall not do any internal force integration at all (like gravity or air friction). Only the [_integrate_forces] will be able to integrate them if overrided. + Set to true if the body shall not do any internal force integration at all (like gravity or air friction). Only the [method _integrate_forces] will be able to integrate them if overrided. </description> </method> <method name="is_using_custom_integrator"> @@ -27785,7 +28510,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Enable contact monitoring. (the signals to notify when a body entered/exited collision). + Enable contact monitoring. This allows the body to emit signals when it collides with another. </description> </method> <method name="is_contact_monitor_enabled" qualifiers="const"> @@ -27799,19 +28524,22 @@ <argument index="0" name="mode" type="int"> </argument> <description> + Set the continuous collision detection mode from the enum CCD_MODE_*. + Coninuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fat-moving objects. </description> </method> <method name="get_continuous_collision_detection_mode" qualifiers="const"> <return type="int"> </return> <description> + Return whether this body is using continuous collision detection. </description> </method> <method name="set_axis_velocity"> <argument index="0" name="axis_velocity" type="Vector2"> </argument> <description> - Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. (This is useful for jumping behavior). + Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> <method name="apply_impulse"> @@ -27820,31 +28548,35 @@ <argument index="1" name="impulse" type="Vector2"> </argument> <description> - Apply a positioned impulse (which will be affected by the body mass and shape). + Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. </description> </method> <method name="set_applied_force"> <argument index="0" name="force" type="Vector2"> </argument> <description> + Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly. </description> </method> <method name="get_applied_force" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the applied force vector. </description> </method> <method name="set_sleeping"> <argument index="0" name="sleeping" type="bool"> </argument> <description> + Set whether a body is isleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse]/[method set_applied_force] wakes them up. Until then, they behave like a static body. </description> </method> <method name="is_sleeping" qualifiers="const"> <return type="bool"> </return> <description> + Return whether the body is sleeping. </description> </method> <method name="set_can_sleep"> @@ -27852,13 +28584,14 @@ </argument> <description> Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. + Sleeping bodies are not affected by forces until a collision or an [method apply_impulse]/[method set_applied_force] wakes them up. Until then, they behave like a static body. </description> </method> <method name="is_able_to_sleep" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the body has the ability to fall asleep when not moving. See [set_can_sleep]. + Return true if the body has the ability to fall asleep when not moving. See [method set_can_sleep]. </description> </method> <method name="test_motion"> @@ -27871,12 +28604,14 @@ <argument index="2" name="result" type="Physics2DTestMotionResult" default="NULL"> </argument> <description> + Return whether the body would collide, if it tried to move in the given vector. This method allows two extra parameters: A margin, which increases slightly the size of the shapes involved in the collision detection, and an object of type [Physics2DTestMotionResult], which will store additional information about the collision (should there be one). </description> </method> <method name="get_colliding_bodies" qualifiers="const"> <return type="Array"> </return> <description> + Return a list of the bodies colliding with this one. </description> </method> </methods> @@ -27885,7 +28620,7 @@ <argument index="0" name="body" type="Object"> </argument> <description> - Emitted when a new body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. </description> </signal> <signal name="body_enter_shape"> @@ -27898,7 +28633,8 @@ <argument index="3" name="local_shape" type="int"> </argument> <description> - Emitted when a new body sub-shape enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. </description> </signal> <signal name="body_exit"> @@ -27919,26 +28655,31 @@ </argument> <description> Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. </description> </signal> </signals> <constants> <constant name="MODE_STATIC" value="1"> - Static mode (does not move, can't be moved). + Static mode. The body behaves like a [StaticBody2D], and can only move by user code. </constant> <constant name="MODE_KINEMATIC" value="3"> + Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code. </constant> <constant name="MODE_RIGID" value="0"> - Rigid body, can move and rotate. + Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. </constant> <constant name="MODE_CHARACTER" value="2"> - Character body, can move but not rotate. + Character body. This behaves like a rigid body, but can not rotate. </constant> <constant name="CCD_MODE_DISABLED" value="0"> + Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. </constant> <constant name="CCD_MODE_CAST_RAY" value="1"> + Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. </constant> <constant name="CCD_MODE_CAST_SHAPE" value="2"> + Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. </constant> </constants> </class> @@ -28879,7 +29620,7 @@ <method name="get_nodes_in_group"> <return type="Array"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="group" type="String"> </argument> <description> </description> @@ -29178,8 +29919,10 @@ </class> <class name="ScrollContainer" inherits="Container" category="Core"> <brief_description> + A helper node for displaying scollable elements (e.g. lists). </brief_description> <description> + A ScrollContainer node with a [Control] child and scrollbar child ([HScrollbar], [VScrollBar], or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a [Panel] control. </description> <methods> <method name="set_enable_h_scroll"> @@ -29246,24 +29989,28 @@ <argument index="0" name="a" type="Vector2"> </argument> <description> + Set the first point's position. </description> </method> <method name="get_a" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the first point's position. </description> </method> <method name="set_b"> <argument index="0" name="b" type="Vector2"> </argument> <description> + Set the second point's position. </description> </method> <method name="get_b" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the second point's position. </description> </method> </methods> @@ -29446,6 +30193,28 @@ <description> </description> </method> + <method name="default_set_value"> + <argument index="0" name="shader_type" type="int"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <argument index="2" name="param_id" type="int"> + </argument> + <argument index="3" name="value" type="var"> + </argument> + <description> + </description> + </method> + <method name="default_get_value"> + <argument index="0" name="shader_type" type="int"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <argument index="2" name="param_id" type="int"> + </argument> + <description> + </description> + </method> <method name="scalar_const_node_set_value"> <argument index="0" name="shader_type" type="int"> </argument> @@ -29456,13 +30225,13 @@ <description> </description> </method> - <method name="scalar_const_node_get_value"> + <method name="scalar_const_node_get_value" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="arg2" type="float"> - </argument> <description> </description> </method> @@ -29476,13 +30245,13 @@ <description> </description> </method> - <method name="vec_const_node_get_value"> + <method name="vec_const_node_get_value" qualifiers="const"> + <return type="Vector3"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="arg2" type="Vector3"> - </argument> <description> </description> </method> @@ -29496,13 +30265,13 @@ <description> </description> </method> - <method name="rgb_const_node_get_value"> + <method name="rgb_const_node_get_value" qualifiers="const"> + <return type="Color"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="arg2" type="Color"> - </argument> <description> </description> </method> @@ -29516,13 +30285,13 @@ <description> </description> </method> - <method name="xform_const_node_get_value"> + <method name="xform_const_node_get_value" qualifiers="const"> + <return type="Transform"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="arg2" type="Transform"> - </argument> <description> </description> </method> @@ -29536,13 +30305,13 @@ <description> </description> </method> - <method name="texture_node_get_filter_size"> + <method name="texture_node_get_filter_size" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="arg2" type="int"> - </argument> <description> </description> </method> @@ -29556,13 +30325,13 @@ <description> </description> </method> - <method name="texture_node_get_filter_strength"> + <method name="texture_node_get_filter_strength" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="float"> </argument> - <argument index="2" name="arg2" type="float"> - </argument> <description> </description> </method> @@ -29989,6 +30758,8 @@ </description> </method> <method name="node_get_state" qualifiers="const"> + <return type="Variant"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> @@ -30251,12 +31022,14 @@ <method name="set_shader_param"> <argument index="0" name="param" type="String"> </argument> - <argument index="1" name="value" type="var"> + <argument index="1" name="value" type="Variant"> </argument> <description> </description> </method> <method name="get_shader_param" qualifiers="const"> + <return type="Variant"> + </return> <argument index="0" name="param" type="String"> </argument> <description> @@ -30289,13 +31062,14 @@ </argument> <description> Use a custom solver bias. No need to change this unless you really know what you are doing. + The solver bias is a factor controlling how much two objects "rebound" off each other, when colliding, to avoid them getting into each other because of numerical imprecision. </description> </method> <method name="get_custom_solver_bias" qualifiers="const"> <return type="float"> </return> <description> - Return the custom solver bias. No need to change this unless you really know what you are doing. + Return the custom solver bias. </description> </method> <method name="collide"> @@ -30308,6 +31082,8 @@ <argument index="2" name="shape_xform" type="Matrix32"> </argument> <description> + Return whether this shape is colliding with another. + This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). </description> </method> <method name="collide_with_motion"> @@ -30324,9 +31100,13 @@ <argument index="4" name="shape_motion" type="Vector2"> </argument> <description> + Return whether this shape would collide with another, if a given movemen was applied. + This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test ont the other object ([code]shape_motion[/code]). </description> </method> <method name="collide_and_get_contacts"> + <return type="Variant"> + </return> <argument index="0" name="local_xform" type="Matrix32"> </argument> <argument index="1" name="with_shape" type="Shape2D"> @@ -30334,9 +31114,13 @@ <argument index="2" name="shape_xform" type="Matrix32"> </argument> <description> + Return a list of the points where this shape touches another. If there are no collisions, the list is empty. + This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). </description> </method> <method name="collide_with_motion_and_get_contacts"> + <return type="Variant"> + </return> <argument index="0" name="local_xform" type="Matrix32"> </argument> <argument index="1" name="local_motion" type="Vector2"> @@ -30348,6 +31132,8 @@ <argument index="4" name="shape_motion" type="Vector2"> </argument> <description> + Return a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions, the list is empty. + This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test ont the other object ([code]shape_motion[/code]). </description> </method> </methods> @@ -30889,6 +31675,12 @@ <description> </description> </method> + <method name="set_hidden"> + <argument index="0" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_notify_local_transform"> <argument index="0" name="enable" type="bool"> </argument> @@ -31177,7 +31969,7 @@ </description> </method> <method name="play"> - <argument index="0" name="arg0" type="float" default="0"> + <argument index="0" name="offset" type="float" default="0"> </argument> <description> </description> @@ -31619,7 +32411,7 @@ <argument index="0" name="modulate" type="Color"> </argument> <description> - Set color modulation for the sprite. All sprite pixels are multiplied by this color. + Set color modulation for the sprite. All sprite pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect. </description> </method> <method name="get_modulate" qualifiers="const"> @@ -32010,7 +32802,7 @@ <argument index="0" name="vel" type="Vector2"> </argument> <description> - Set a constant linear velocity for the body. + Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. </description> </method> <method name="set_constant_angular_velocity"> @@ -32024,7 +32816,7 @@ <return type="Vector2"> </return> <description> - Return the constant linear velocity for the body. + Return the constant linear velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. </description> </method> <method name="get_constant_angular_velocity" qualifiers="const"> @@ -32038,24 +32830,28 @@ <argument index="0" name="friction" type="float"> </argument> <description> + Set the body friction, from 0 (frictionless) to 1 (full friction). </description> </method> <method name="get_friction" qualifiers="const"> <return type="float"> </return> <description> + Return the body friction. </description> </method> <method name="set_bounce"> <argument index="0" name="bounce" type="float"> </argument> <description> + Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). </description> </method> <method name="get_bounce" qualifiers="const"> <return type="float"> </return> <description> + Return the body bounciness. </description> </method> </methods> @@ -32106,6 +32902,178 @@ Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [Error] code, and a data array. </description> </method> + <method name="get_available_bytes" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_big_endian"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="is_big_endian_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="put_8"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_u8"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_16"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_u16"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_32"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_u32"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_64"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_u64"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_float"> + <argument index="0" name="val" type="float"> + </argument> + <description> + </description> + </method> + <method name="put_double"> + <argument index="0" name="val" type="float"> + </argument> + <description> + </description> + </method> + <method name="put_utf8_string"> + <argument index="0" name="val" type="String"> + </argument> + <description> + </description> + </method> + <method name="put_var"> + <argument index="0" name="val" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="get_8"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_u8"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_16"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_u16"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_32"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_u32"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_64"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_u64"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_float"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_double"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_string"> + <return type="String"> + </return> + <argument index="0" name="bytes" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_utf8_string"> + <return type="String"> + </return> + <argument index="0" name="bytes" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_var"> + <return type="Variant"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -32237,7 +33205,7 @@ </description> </method> <method name="play"> - <argument index="0" name="arg0" type="float" default="0"> + <argument index="0" name="offset" type="float" default="0"> </argument> <description> </description> @@ -32736,9 +33704,10 @@ </description> </method> <method name="to_ascii"> - <return type="String"> + <return type="RawArray"> </return> <description> + Convert the String (which is a character array) to RawArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. </description> </method> <method name="to_float"> @@ -32770,9 +33739,10 @@ </description> </method> <method name="to_utf8"> - <return type="String"> + <return type="RawArray"> </return> <description> + Convert the String (which is an array of characters) to RawArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). </description> </method> <method name="xml_escape"> @@ -32914,9 +33884,9 @@ </description> </method> <method name="draw" qualifiers="const"> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="canvas_item" type="RID"> </argument> - <argument index="1" name="arg1" type="Rect2"> + <argument index="1" name="rect" type="Rect2"> </argument> <description> </description> @@ -33069,7 +34039,7 @@ <method name="get_expand_margin_size" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="margin" type="int"> </argument> <description> Return the expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. @@ -33110,7 +34080,7 @@ <method name="get_margin_size" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="margin" type="int"> </argument> <description> </description> @@ -33126,7 +34096,7 @@ <method name="get_expand_margin_size" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="margin" type="int"> </argument> <description> </description> @@ -33549,6 +34519,12 @@ </method> </methods> <signals> + <signal name="tab_close"> + <argument index="0" name="tab" type="int"> + </argument> + <description> + </description> + </signal> <signal name="right_button_pressed"> <argument index="0" name="tab" type="int"> </argument> @@ -33569,6 +34545,14 @@ </constant> <constant name="ALIGN_RIGHT" value="2"> </constant> + <constant name="SHOW_ACTIVE_ONLY" value="1"> + </constant> + <constant name="SHOW_ALWAYS" value="0"> + </constant> + <constant name="SHOW_HOVER" value="2"> + </constant> + <constant name="SHOW_NEVER" value="3"> + </constant> </constants> <theme_items> <theme_item name="label_valign_fg" type="int"> @@ -33583,6 +34567,14 @@ </theme_item> <theme_item name="font_color_fg" type="Color"> </theme_item> + <theme_item name="increment_hilite" type="Texture"> + </theme_item> + <theme_item name="decrement_hilite" type="Texture"> + </theme_item> + <theme_item name="increment" type="Texture"> + </theme_item> + <theme_item name="decrement" type="Texture"> + </theme_item> <theme_item name="font" type="Font"> </theme_item> <theme_item name="tab_fg" type="StyleBox"> @@ -33646,7 +34638,7 @@ <method name="get_line" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="line" type="int"> </argument> <description> Return the text of a specific line. @@ -33655,15 +34647,17 @@ <method name="cursor_set_column"> <argument index="0" name="column" type="int"> </argument> + <argument index="1" name="adjust_viewport" type="bool" default="false"> + </argument> <description> - Set the current column of the text editor. </description> </method> <method name="cursor_set_line"> <argument index="0" name="line" type="int"> </argument> + <argument index="1" name="adjust_viewport" type="bool" default="false"> + </argument> <description> - Set the current line of the text editor. </description> </method> <method name="cursor_get_column" qualifiers="const"> @@ -34003,7 +34997,7 @@ </argument> <argument index="2" name="modulate" type="Color" default="Color(1,1,1,1)"> </argument> - <argument index="3" name="arg3" type="bool" default="false"> + <argument index="3" name="transpose" type="bool" default="false"> </argument> <description> </description> @@ -34017,7 +35011,7 @@ </argument> <argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)"> </argument> - <argument index="4" name="arg4" type="bool" default="false"> + <argument index="4" name="transpose" type="bool" default="false"> </argument> <description> </description> @@ -34031,7 +35025,7 @@ </argument> <argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)"> </argument> - <argument index="4" name="arg4" type="bool" default="false"> + <argument index="4" name="transpose" type="bool" default="false"> </argument> <description> </description> @@ -34106,7 +35100,7 @@ <description> </description> </method> - <method name="set_scale"> + <method name="set_texture_scale"> <argument index="0" name="scale" type="Vector2"> </argument> <description> @@ -34154,7 +35148,7 @@ <description> </description> </method> - <method name="get_scale" qualifiers="const"> + <method name="get_texture_scale" qualifiers="const"> <return type="Vector2"> </return> <description> @@ -34262,8 +35256,68 @@ <description> </description> </method> + <method name="set_fill_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_fill_mode"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_radial_initial_angle"> + <argument index="0" name="mode" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_radial_initial_angle"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_radial_center_offset"> + <argument index="0" name="mode" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_radial_center_offset"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="set_fill_degrees"> + <argument index="0" name="mode" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_fill_degrees"> + <return type="float"> + </return> + <description> + </description> + </method> </methods> <constants> + <constant name="FILL_LEFT_TO_RIGHT" value="0"> + </constant> + <constant name="FILL_RIGHT_TO_LEFT" value="1"> + </constant> + <constant name="FILL_TOP_TO_BOTTOM" value="2"> + </constant> + <constant name="FILL_BOTTOM_TO_TOP" value="3"> + </constant> + <constant name="FILL_CLOCKWISE" value="4"> + </constant> + <constant name="FILL_COUNTER_CLOCKWISE" value="5"> + </constant> </constants> </class> <class name="Theme" inherits="Resource" category="Core"> @@ -34316,7 +35370,7 @@ <method name="get_icon_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -34362,7 +35416,7 @@ <method name="get_stylebox_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -34408,7 +35462,7 @@ <method name="get_font_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -34454,7 +35508,7 @@ <method name="get_color_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -34500,7 +35554,7 @@ <method name="get_constant_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -34520,7 +35574,7 @@ <method name="get_type_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -34566,6 +35620,16 @@ </description> </method> <method name="wait_to_finish"> + <return type="Variant"> + </return> + <description> + </description> + </method> + <method name="set_name"> + <return type="Error"> + </return> + <argument index="0" name="name" type="String"> + </argument> <description> </description> </method> @@ -34805,6 +35869,18 @@ Return the collision bounce parameter. </description> </method> + <method name="set_occluder_light_mask"> + <argument index="0" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_occluder_light_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="set_cell"> <argument index="0" name="x" type="int"> </argument> @@ -35670,19 +36746,19 @@ <method name="translate" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="message" type="String"> </argument> <description> </description> </method> <method name="add_translation"> - <argument index="0" name="arg0" type="Object"> + <argument index="0" name="translation" type="Translation"> </argument> <description> </description> </method> <method name="remove_translation"> - <argument index="0" name="arg0" type="Object"> + <argument index="0" name="translation" type="Translation"> </argument> <description> </description> @@ -35720,17 +36796,17 @@ </description> </method> <method name="set_column_min_width"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="min_width" type="int"> </argument> <description> </description> </method> <method name="set_column_expand"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="expand" type="bool"> </argument> <description> </description> @@ -35738,13 +36814,13 @@ <method name="get_column_width" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="column" type="int"> </argument> <description> </description> </method> <method name="set_hide_root"> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> @@ -35859,6 +36935,18 @@ <description> </description> </method> + <method name="set_hide_folding"> + <argument index="0" name="hide" type="bool"> + </argument> + <description> + </description> + </method> + <method name="is_folding_hidden" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> </methods> <signals> <signal name="item_activated"> @@ -36192,6 +37280,8 @@ </description> </method> <method name="remove_child"> + <return type="TreeItem"> + </return> <argument index="0" name="child" type="Object"> </argument> <description> @@ -36290,7 +37380,7 @@ </argument> <argument index="1" name="button" type="Texture"> </argument> - <argument index="2" name="arg2" type="int"> + <argument index="2" name="button_idx" type="int"> </argument> <description> </description> @@ -36814,7 +37904,7 @@ </argument> <argument index="1" name="property" type="String"> </argument> - <argument index="2" name="value" type="var"> + <argument index="2" name="value" type="Variant"> </argument> <description> </description> @@ -36824,7 +37914,7 @@ </argument> <argument index="1" name="property" type="String"> </argument> - <argument index="2" name="value" type="var"> + <argument index="2" name="value" type="Variant"> </argument> <description> </description> @@ -37011,6 +38101,14 @@ <description> </description> <methods> + <method name="angle"> + <return type="float"> + </return> + <description> + Returns the result of atan2 when called with the Vector's x and y as parameters (Math::atan2(x,y)). + Be aware that it therefore returns an angle oriented clockwise with regard to the (0, 1) unit vector, and not an angle oriented counter-clockwise with regard to the (1, 0) unit vector (which would be the typical trigonometric representation of the angle when calling Math::atan2(y,x)). + </description> + </method> <method name="angle_to"> <return type="float"> </return> @@ -37029,13 +38127,6 @@ Returns the angle in radians between the line connecting the two points and the x coordinate. </description> </method> - <method name="atan2"> - <return type="float"> - </return> - <description> - Returns the result of atan2 when called with the Vector's x and y as parameters. - </description> - </method> <method name="cubic_interpolate"> <return type="Vector2"> </return> @@ -37136,7 +38227,7 @@ <argument index="0" name="vec" type="Vector2"> </argument> <description> - Reflects/mirrors the vector around another vector. + Like "slide", but reflects the Vector instead of continuing along the wall. </description> </method> <method name="rotated"> @@ -37200,10 +38291,10 @@ </class> <class name="Vector2Array" category="Built-In Types"> <brief_description> - An Array of Vector2's. + An Array of Vector2. </brief_description> <description> - An Array specifically designed to hold Vector2's. + An Array specifically designed to hold Vector2. </description> <methods> <method name="get"> @@ -37212,21 +38303,21 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the Vector2 at the given index. + Returns the Vector2 at the given index. </description> </method> <method name="push_back"> <argument index="0" name="vector2" type="Vector2"> </argument> <description> - Insert a new Vector2. + Inserts a Vector2 at the end. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + Sets the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. </description> </method> <method name="set"> @@ -37235,7 +38326,7 @@ <argument index="1" name="vector2" type="Vector2"> </argument> <description> - Set the Vector2 at the given index. + Changes the Vector2 at the given index. </description> </method> <method name="size"> @@ -37263,13 +38354,21 @@ Vector class, which performs basic 3D vector math operations. </brief_description> <description> - Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vecor math operations. + Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations. </description> <methods> <method name="abs"> <return type="Vector3"> </return> <description> + Returns a new vector with all components in absolute values (e.g. positive). + </description> + </method> + <method name="ceil"> + <return type="Vector3"> + </return> + <description> + Returns a new vector with all components rounded up. </description> </method> <method name="cross"> @@ -37293,7 +38392,7 @@ <argument index="3" name="t" type="float"> </argument> <description> - Perform a cubic interpolation between vectors a,b,c,d (b is current), by the given amount (i). + Perform a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount (t). </description> </method> <method name="distance_squared_to"> @@ -37302,7 +38401,7 @@ <argument index="0" name="b" type="Vector3"> </argument> <description> - Return the squared distance (distance minus the last square root) to b. + Return the squared distance (distance minus the last square root) to b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula. </description> </method> <method name="distance_to"> @@ -37323,11 +38422,18 @@ Return the dot product with b. </description> </method> + <method name="floor"> + <return type="Vector3"> + </return> + <description> + Returns a new vector with all components rounded down. + </description> + </method> <method name="inverse"> <return type="Vector3"> </return> <description> - Returns the inverse of the vector. this is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) + Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) </description> </method> <method name="length"> @@ -37341,7 +38447,7 @@ <return type="float"> </return> <description> - Return the length of the vector, squared. + Return the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. </description> </method> <method name="linear_interpolate"> @@ -37352,26 +38458,28 @@ <argument index="1" name="t" type="float"> </argument> <description> - Linearly interpolates the vector to a given one (b), by the given amount (i). + Linearly interpolates the vector to a given one (b), by the given amount (t). </description> </method> <method name="max_axis"> <return type="int"> </return> <description> + Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest. </description> </method> <method name="min_axis"> <return type="int"> </return> <description> + Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest. </description> </method> <method name="normalized"> <return type="Vector3"> </return> <description> - Return a copy of the normalized vector to unit length. This is the same as v / v.length() + Return a copy of the normalized vector to unit length. This is the same as v / v.length(). </description> </method> <method name="reflect"> @@ -37380,6 +38488,7 @@ <argument index="0" name="by" type="Vector3"> </argument> <description> + Like "slide", but reflects the Vector instead of continuing along the wall. </description> </method> <method name="rotated"> @@ -37390,6 +38499,7 @@ <argument index="1" name="phi" type="float"> </argument> <description> + Rotates the vector around some axis by phi radians. </description> </method> <method name="slide"> @@ -37398,6 +38508,7 @@ <argument index="0" name="by" type="Vector3"> </argument> <description> + Slides the vector along a wall. </description> </method> <method name="snapped"> @@ -37419,6 +38530,7 @@ <argument index="2" name="z" type="float"> </argument> <description> + Returns a Vector3 with the given components. </description> </method> </methods> @@ -37432,17 +38544,22 @@ </members> <constants> <constant name="AXIS_X" value="0"> + Enumerated value for the X axis. Returned by functions like max_axis or min_axis. </constant> <constant name="AXIS_Y" value="1"> + Enumerated value for the Y axis. </constant> <constant name="AXIS_Z" value="2"> + Enumerated value for the Z axis. </constant> </constants> </class> <class name="Vector3Array" category="Built-In Types"> <brief_description> + An Array of Vector3. </brief_description> <description> + An Array specifically designed to hold Vector3. </description> <methods> <method name="get"> @@ -37451,18 +38568,21 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the Vector3 at the given index. </description> </method> <method name="push_back"> <argument index="0" name="vector3" type="Vector3"> </argument> <description> + Inserts a Vector3 at the end. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> + Sets the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. </description> </method> <method name="set"> @@ -37471,12 +38591,14 @@ <argument index="1" name="vector3" type="Vector3"> </argument> <description> + Changes the Vector3 at the given index. </description> </method> <method name="size"> <return type="int"> </return> <description> + Returns the size of the array. </description> </method> <method name="Vector3Array"> @@ -37485,6 +38607,7 @@ <argument index="0" name="from" type="Array"> </argument> <description> + Constructs a new Vector3Array. Optionally, you can pass in an Array that will be converted. </description> </method> </methods> @@ -37819,6 +38942,12 @@ <description> </description> </method> + <method name="get_video_texutre"> + <return type="Texture"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -38149,7 +39278,7 @@ </description> </method> <method name="set_render_target_to_screen_rect"> - <argument index="0" name="arg0" type="Rect2"> + <argument index="0" name="rect" type="Rect2"> </argument> <description> </description> @@ -39621,6 +40750,14 @@ <description> </description> </method> + <method name="canvas_item_set_z"> + <argument index="0" name="arg0" type="RID"> + </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <description> + </description> + </method> <method name="canvas_item_add_line"> <argument index="0" name="arg0" type="RID"> </argument> @@ -40066,6 +41203,8 @@ </description> <methods> <method name="get_ref" qualifiers="const"> + <return type="Object"> + </return> <description> </description> </method> @@ -40277,7 +41416,7 @@ <method name="get_attribute_name" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> @@ -40285,7 +41424,7 @@ <method name="get_attribute_value" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> @@ -40293,7 +41432,7 @@ <method name="has_attribute" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> @@ -40301,7 +41440,7 @@ <method name="get_named_attribute_value" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> @@ -40309,7 +41448,7 @@ <method name="get_named_attribute_value_safe" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> @@ -40333,7 +41472,7 @@ <method name="seek"> <return type="int"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="pos" type="int"> </argument> <description> </description> |