diff options
Diffstat (limited to 'doc/base/classes.xml')
| -rw-r--r-- | doc/base/classes.xml | 579 |
1 files changed, 515 insertions, 64 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 074c14443c..c531482950 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -205,22 +205,20 @@ Exponential logarithm. </description> </method> - <method name="isnan"> + <method name="is_nan"> <return type="float"> </return> <argument index="0" name="s" type="float"> </argument> <description> - Return true if the float is not a number. </description> </method> - <method name="isinf"> + <method name="is_inf"> <return type="float"> </return> <argument index="0" name="s" type="float"> </argument> <description> - Return true if the float is infinite. </description> </method> <method name="ease"> @@ -2100,13 +2098,13 @@ </methods> <members> <member name="pos" type="Vector3"> - Position (starting corner). + Position (starting corner). </member> <member name="size" type="Vector3"> - Size from position to end. + Size from position to end. </member> <member name="end" type="Vector3"> - Ending corner. + Ending corner. </member> </members> <constants> @@ -2234,6 +2232,34 @@ Get the [SpriteFrames] resource, which contains all frames. </description> </method> + <method name="set_animation"> + <argument index="0" name="animation" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_animation" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="play"> + <argument index="0" name="anim" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="stop"> + <description> + </description> + </method> + <method name="is_playing" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="set_centered"> <argument index="0" name="centered" type="bool"> </argument> @@ -3612,8 +3638,10 @@ </class> <class name="Area" inherits="CollisionObject" category="Core"> <brief_description> + General purpose area detection and influence for 3D physics. </brief_description> <description> + General purpose area detection for 3D 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"> @@ -3632,114 +3660,140 @@ <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, 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 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="Vector3"> </argument> <description> + Set the gravity vector. This vector does not have to be normalized. + If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> <method name="get_gravity_vector" qualifiers="const"> <return type="Vector3"> </return> <description> + Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> <method name="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_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_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_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"> @@ -3748,6 +3802,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"> @@ -3756,6 +3811,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"> @@ -3764,6 +3820,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"> @@ -3772,58 +3829,67 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Return an individual bit on the layer mask. </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> + Return whether this area can be detected by other, monitoring, areas. </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="get_overlapping_bodies" qualifiers="const"> <return type="Array"> </return> <description> + Return a list of the bodies ([PhysicsBody]) 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"> - <return type="PhysicsBody"> + <return type="bool"> </return> <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"> - <return type="Area"> + <return type="bool"> </return> <argument index="0" name="area" type="Object"> </argument> <description> + Return whether the area passed is totally or partially inside this area. </description> </method> </methods> @@ -3832,6 +3898,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"> @@ -3844,12 +3911,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 reported 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"> @@ -3862,12 +3931,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"> @@ -3880,12 +3951,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"> @@ -3898,6 +3971,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> @@ -4125,7 +4199,7 @@ <return type="bool"> </return> <description> - Set whether this area can be detected by other, monitoring, areas. + Return whether this area can be detected by other, monitoring, areas. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> @@ -5160,13 +5234,13 @@ </methods> <constants> <constant name="COPY_MODE_DISABLED" value="0"> - Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers. + Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers. </constant> <constant name="COPY_MODE_RECT" value="1"> - Sets the copy mode to a region. + Sets the copy mode to a region. </constant> <constant name="COPY_MODE_VIEWPORT" value="2"> - Sets the copy mode to the entire screen. + Sets the copy mode to the entire screen. </constant> </constants> </class> @@ -8211,37 +8285,37 @@ </methods> <members> <member name="r" type="float"> - Red (0 to 1) + Red (0 to 1) </member> <member name="g" type="float"> - Green (0 to 1) + Green (0 to 1) </member> <member name="b" type="float"> - Blue (0 to 1) + Blue (0 to 1) </member> <member name="a" type="float"> - Alpha (0 to 1) + Alpha (0 to 1) </member> <member name="h" type="float"> - Hue (0 to 1) + Hue (0 to 1) </member> <member name="s" type="float"> - Saturation (0 to 1) + Saturation (0 to 1) </member> <member name="v" type="float"> - Value (0 to 1) + Value (0 to 1) </member> <member name="r8" type="int"> - Red (0 to 255) + Red (0 to 255) </member> <member name="g8" type="int"> - Green (0 to 255) + Green (0 to 255) </member> <member name="b8" type="int"> - Blue (0 to 255) + Blue (0 to 255) </member> <member name="a8" type="int"> - Alpha (0 to 255) + Alpha (0 to 255) </member> </members> <constants> @@ -10695,6 +10769,12 @@ This approximation makes straight segments between each point, then subdivides t to read the documentation, tutorials and examples. </description> <methods> + <method name="can_reimport_multiple_files" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="custom_export" qualifiers="virtual"> <return type="RawArray"> </return> @@ -10786,6 +10866,20 @@ This approximation makes straight segments between each point, then subdivides t this information. </description> </method> + <method name="import_from_drop" qualifiers="virtual"> + <argument index="0" name="files" type="StringArray"> + </argument> + <argument index="1" name="dest_path" type="String"> + </argument> + <description> + </description> + </method> + <method name="reimport_multiple_files" qualifiers="virtual"> + <argument index="0" name="files" type="StringArray"> + </argument> + <description> + </description> + </method> <method name="validate_source_path"> <return type="String"> </return> @@ -11151,6 +11245,8 @@ This approximation makes straight segments between each point, then subdivides t </constant> <constant name="CONTAINER_CANVAS_EDITOR_SIDE" value="5"> </constant> + <constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="7"> + </constant> <constant name="DOCK_SLOT_LEFT_UL" value="0"> </constant> <constant name="DOCK_SLOT_LEFT_BL" value="1"> @@ -16830,6 +16926,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> + <method name="set_same_column_width"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="is_same_column_width" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="set_max_text_lines"> <argument index="0" name="lines" type="int"> </argument> @@ -16890,11 +16998,49 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> + <method name="set_max_icon_size"> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_max_icon_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="set_icon_scale"> + <argument index="0" name="scale" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_icon_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_allow_rmb_select"> + <argument index="0" name="allow" type="bool"> + </argument> + <description> + </description> + </method> + <method name="get_allow_rmb_select" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="get_item_at_pos" qualifiers="const"> <return type="int"> </return> <argument index="0" name="pos" type="Vector2"> </argument> + <argument index="1" name="exact" type="bool" default="false"> + </argument> <description> </description> </method> @@ -16918,6 +17064,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </signal> + <signal name="item_rmb_selected"> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="atpos" type="Vector2"> + </argument> + <description> + </description> + </signal> <signal name="item_selected"> <argument index="0" name="index" type="int"> </argument> @@ -17534,6 +17688,8 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <theme_items> <theme_item name="shadow_offset_x" type="int"> </theme_item> + <theme_item name="line_spacing" type="int"> + </theme_item> <theme_item name="shadow_offset_y" type="int"> </theme_item> <theme_item name="shadow_as_outline" type="int"> @@ -17999,7 +18155,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="float"> </return> <description> - Return the Exponential Shadow Multiplier (ESM) value of the Light2D. + Return the Exponential Shadow Multiplier (ESM) value of the Light2D. </description> </method> <method name="set_shadow_color"> @@ -18019,16 +18175,16 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </methods> <constants> <constant name="MODE_ADD" value="0"> - Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. + Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. </constant> <constant name="MODE_SUB" value="1"> - Substract the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. + Substract the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. </constant> <constant name="MODE_MIX" value="2"> - Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. + Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. </constant> <constant name="MODE_MASK" value="3"> - The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. + The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. </constant> </constants> </class> @@ -18187,6 +18343,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> + <method name="menu_option"> + <argument index="0" name="option" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_menu" qualifiers="const"> + <return type="PopupMenu"> + </return> + <description> + </description> + </method> </methods> <signals> <signal name="text_entered"> @@ -18213,6 +18381,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="ALIGN_FILL" value="3"> </constant> + <constant name="MENU_CUT" value="0"> + </constant> + <constant name="MENU_COPY" value="1"> + </constant> + <constant name="MENU_PASTE" value="2"> + </constant> + <constant name="MENU_CLEAR" value="3"> + </constant> + <constant name="MENU_SELECT_ALL" value="4"> + </constant> + <constant name="MENU_UNDO" value="5"> + </constant> + <constant name="MENU_MAX" value="6"> + </constant> </constants> <theme_items> <theme_item name="minimum_spaces" type="int"> @@ -18341,6 +18523,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a [MainLoop] has to be provided to OS, else the application will exit. This happens automatically (and a [SceneTree] is created), unless a main [Script] is supplied, which may or not create and return a [MainLoop]. </description> <methods> + <method name="_drop_files" qualifiers="virtual"> + <argument index="0" name="files" type="StringArray"> + </argument> + <argument index="1" name="screen" type="int"> + </argument> + <description> + </description> + </method> <method name="_finalize" qualifiers="virtual"> <description> </description> @@ -18439,7 +18629,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <constants> </constants> <theme_items> - <theme_item name="margin" type="int"> + <theme_item name="margin_right" type="int"> + </theme_item> + <theme_item name="margin_top" type="int"> + </theme_item> + <theme_item name="margin_left" type="int"> + </theme_item> + <theme_item name="margin_bottom" type="int"> </theme_item> </theme_items> </class> @@ -21335,6 +21531,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the dimensions in pixels of the specified screen. </description> </method> + <method name="get_screen_dpi" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="screen" type="int" default="0"> + </argument> + <description> + </description> + </method> <method name="get_window_position" qualifiers="const"> <return type="Vector2"> </return> @@ -27795,6 +27999,18 @@ This method controls whether the position between two cached points is interpola Returns the polygon fill color </description> </method> + <method name="set_vertex_colors"> + <argument index="0" name="vertex_colors" type="ColorArray"> + </argument> + <description> + </description> + </method> + <method name="get_vertex_colors" qualifiers="const"> + <return type="ColorArray"> + </return> + <description> + </description> + </method> <method name="set_texture"> <argument index="0" name="texture" type="Object"> </argument> @@ -29469,13 +29685,13 @@ This method controls whether the position between two cached points is interpola </methods> <members> <member name="pos" type="Vector2"> - Position (starting corner). + Position (starting corner). </member> <member name="size" type="Vector2"> - Size from position to end. + Size from position to end. </member> <member name="end" type="Vector2"> - Ending corner. + Ending corner. </member> </members> <constants> @@ -29693,13 +29909,14 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="path" type="String"> </argument> <description> - Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. + Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another [Resource] already has path "path". </description> </method> <method name="take_over_path"> <argument index="0" name="path" type="String"> </argument> <description> + Set the path of the resource. Differs from set_path(), if another [Resource] exists with "path" it over-takes it, instead of failing. </description> </method> <method name="get_path" qualifiers="const"> @@ -30367,188 +30584,221 @@ This method controls whether the position between two cached points is interpola </class> <class name="RigidBody" inherits="PhysicsBody" category="Core"> <brief_description> + Rigid body node. </brief_description> <description> + Rigid body node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift mode between regular Rigid body, Kinematic, Character or Static. </description> <methods> <method name="_integrate_forces" qualifiers="virtual"> <argument index="0" name="state" type="PhysicsDirectBodyState"> </argument> <description> + Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body. </description> </method> <method name="set_mode"> <argument index="0" name="mode" type="int"> </argument> <description> + Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. </description> </method> <method name="get_mode" qualifiers="const"> <return type="int"> </return> <description> + Return the current body mode, see [method set_mode]. </description> </method> <method name="set_mass"> <argument index="0" name="mass" type="float"> </argument> <description> + Set the body mass. </description> </method> <method name="get_mass" qualifiers="const"> <return type="float"> </return> <description> + Return the current body mass. </description> </method> <method name="set_weight"> <argument index="0" name="weight" type="float"> </argument> <description> + Set the body weight given standard earth-weight (gravity 9.8). </description> </method> <method name="get_weight" qualifiers="const"> <return type="float"> </return> <description> + Return the current body weight, given standard earth-weight (gravity 9.8). </description> </method> <method name="set_friction"> <argument index="0" name="friction" type="float"> </argument> <description> + Set the body friction, from 0 (frictionless) to 1 (max friction). </description> </method> <method name="get_friction" qualifiers="const"> <return type="float"> </return> <description> + Return the current body friction, from 0 (frictionless) to 1 (max friction). </description> </method> <method name="set_bounce"> <argument index="0" name="bounce" type="float"> </argument> <description> + Set the body bounciness, from 0 (no bounciness) to 1 (max bounciness). </description> </method> <method name="get_bounce" qualifiers="const"> <return type="float"> </return> <description> + Return the current body bounciness. </description> </method> <method name="set_linear_velocity"> <argument index="0" name="linear_velocity" type="Vector3"> </argument> <description> + Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. </description> </method> <method name="get_linear_velocity" qualifiers="const"> <return type="Vector3"> </return> <description> + Return the current body linear velocity. </description> </method> <method name="set_angular_velocity"> <argument index="0" name="angular_velocity" type="Vector3"> </argument> <description> + Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. </description> </method> <method name="get_angular_velocity" qualifiers="const"> <return type="Vector3"> </return> <description> + Return the current body angular velocity. </description> </method> <method name="set_gravity_scale"> <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 current body gravity scale. </description> </method> <method name="set_linear_damp"> <argument index="0" name="linear_damp" type="float"> </argument> <description> + Set the linear damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. </description> </method> <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> + Return the current body linear damp. Default is -1. </description> </method> <method name="set_angular_damp"> <argument index="0" name="angular_damp" type="float"> </argument> <description> + Set the angular damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any angular damp derived from the world or areas will be overridden. </description> </method> <method name="get_angular_damp" qualifiers="const"> <return type="float"> </return> <description> + Return the current body angular damp. Default is -1. </description> </method> <method name="set_max_contacts_reported"> <argument index="0" name="amount" type="int"> </argument> <description> + Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. </description> </method> <method name="get_max_contacts_reported" qualifiers="const"> <return type="int"> </return> <description> + 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> + Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. </description> </method> <method name="is_using_custom_integrator"> <return type="bool"> </return> <description> + Return whether the body is using a custom integrator. </description> </method> <method name="set_contact_monitor"> <argument index="0" name="enabled" type="bool"> </argument> <description> + 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"> <return type="bool"> </return> <description> + Return whether contact monitoring is enabled. </description> </method> <method name="set_use_continuous_collision_detection"> <argument index="0" name="enable" type="bool"> </argument> <description> + Set the continuous collision detection mode from the enum CCD_MODE_*. + Continuous 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, fast-moving objects. </description> </method> <method name="is_using_continuous_collision_detection" qualifiers="const"> <return type="bool"> </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="Vector3"> </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. </description> </method> <method name="apply_impulse"> @@ -30557,48 +30807,57 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="impulse" type="Vector3"> </argument> <description> + 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. Both the impulse and the offset from the body origin are in global coordinates. </description> </method> <method name="set_sleeping"> <argument index="0" name="sleeping" type="bool"> </argument> <description> + Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] 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"> <argument index="0" name="able_to_sleep" type="bool"> </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 whether the body has the ability to fall asleep when not moving. See [method set_can_sleep]. </description> </method> <method name="set_axis_lock"> <argument index="0" name="axis_lock" type="int"> </argument> <description> + Set the axis lock of the body, from the AXIS_LOCK_* enum. Axis lock stops the body from moving along the specified axis(X/Y/Z) and rotating along the other two axes. </description> </method> <method name="get_axis_lock" qualifiers="const"> <return type="int"> </return> <description> + Return the current axis lock of the body. One of AXIS_LOCK_* enum. </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> @@ -30607,6 +30866,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="body" type="Object"> </argument> <description> + 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"> @@ -30619,12 +30879,15 @@ This method controls whether the position between two cached points is interpola <argument index="3" name="local_shape" type="int"> </argument> <description> + 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"> <argument index="0" name="body" type="Object"> </argument> <description> + Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. </description> </signal> <signal name="body_exit_shape"> @@ -30637,19 +30900,25 @@ This method controls whether the position between two cached points is interpola <argument index="3" name="local_shape" type="int"> </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> <signal name="sleeping_state_changed"> <description> + Emitted when the body changes it's sleeping state. Either by sleeping or waking up. </description> </signal> </signals> <constants> <constant name="MODE_STATIC" value="1"> + Static mode. The body behaves like a [StaticBody], and can only move by user code. </constant> <constant name="MODE_KINEMATIC" value="3"> + Kinematic body. The body behaves like a [KinematicBody], and can only move by user code. </constant> <constant name="MODE_RIGID" value="0"> + 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"> </constant> @@ -30760,7 +31029,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="gravity_scale" type="float"> </argument> <description> - Set The gravity factor. This factor multiplies gravity intensity just for this body. + Set the gravity factor. This factor multiplies gravity intensity just for this body. </description> </method> <method name="get_gravity_scale" qualifiers="const"> @@ -30873,7 +31142,7 @@ This method controls whether the position between two cached points is interpola </argument> <description> Set the continuous collision detection mode from the enum CCD_MODE_*. - Continuous 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. + Continuous 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, fast-moving objects. </description> </method> <method name="get_continuous_collision_detection_mode" qualifiers="const"> @@ -31031,6 +31300,7 @@ This method controls whether the position between two cached points is interpola </signal> <signal name="sleeping_state_changed"> <description> + Emitted when the body changes it's sleeping state. Either by sleeping or waking up. </description> </signal> </signals> @@ -32337,6 +32607,12 @@ This method controls whether the position between two cached points is interpola </method> </methods> <signals> + <signal name="node_configuration_warning_changed"> + <argument index="0" name="node" type="Object"> + </argument> + <description> + </description> + </signal> <signal name="screen_resized"> <description> </description> @@ -32347,6 +32623,14 @@ This method controls whether the position between two cached points is interpola <description> </description> </signal> + <signal name="files_dropped"> + <argument index="0" name="files" type="StringArray"> + </argument> + <argument index="1" name="screen" type="int"> + </argument> + <description> + </description> + </signal> <signal name="idle_frame"> <description> </description> @@ -35269,49 +35553,120 @@ This method controls whether the position between two cached points is interpola Sprite frame library for [AnimatedSprite]. </description> <methods> + <method name="add_animation"> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_animation" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_animation"> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="rename_animation"> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="newname" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_animation_speed"> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="speed" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_animation_speed" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_animation_loop"> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="loop" type="bool"> + </argument> + <description> + </description> + </method> + <method name="get_animation_loop" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> <method name="add_frame"> - <argument index="0" name="frame" type="Object"> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="frame" type="Object"> </argument> - <argument index="1" name="atpos" type="int" default="-1"> + <argument index="2" name="atpos" type="int" default="-1"> </argument> <description> - Add a frame (texture). </description> </method> <method name="get_frame_count" qualifiers="const"> <return type="int"> </return> + <argument index="0" name="anim" type="String"> + </argument> <description> - Return the amount of frames. </description> </method> <method name="get_frame" qualifiers="const"> <return type="Object"> </return> - <argument index="0" name="idx" type="int"> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="idx" type="int"> </argument> <description> - Return a texture (frame). </description> </method> <method name="set_frame"> - <argument index="0" name="idx" type="int"> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="idx" type="int"> </argument> - <argument index="1" name="txt" type="Object"> + <argument index="2" name="txt" type="Object"> </argument> <description> </description> </method> <method name="remove_frame"> - <argument index="0" name="idx" type="int"> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="idx" type="int"> </argument> <description> - Remove a frame </description> </method> <method name="clear"> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="clear_all"> <description> - Clear the frames. </description> </method> </methods> @@ -35320,58 +35675,68 @@ This method controls whether the position between two cached points is interpola </class> <class name="StaticBody" inherits="PhysicsBody" category="Core"> <brief_description> - PhysicsBody for static collision objects. + Static body for 3D Physics. </brief_description> <description> - StaticBody implements a static collision [Node], by utilizing a rigid body in the [PhysicsServer]. Static bodies are used for static collision. For more information on physics body nodes, see [PhysicsBody]. + Static body for 3D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody3D] so they are great for scenario collision. + A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies. + Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels). </description> <methods> <method name="set_constant_linear_velocity"> <argument index="0" name="vel" type="Vector3"> </argument> <description> + 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"> <argument index="0" name="vel" type="Vector3"> </argument> <description> + Set a constant angular 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_linear_velocity" qualifiers="const"> <return type="Vector3"> </return> <description> + Return the constant linear velocity for the body. </description> </method> <method name="get_constant_angular_velocity" qualifiers="const"> <return type="Vector3"> </return> <description> + Return the constant angular velocity for the body. </description> </method> <method name="set_friction"> <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> @@ -35399,14 +35764,14 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="vel" type="float"> </argument> <description> - Set a constant angular velocity for the body. + Set a constant angular 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_linear_velocity" qualifiers="const"> <return type="Vector2"> </return> <description> - 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. + Return the constant linear velocity for the body. </description> </method> <method name="get_constant_angular_velocity" qualifiers="const"> @@ -37558,6 +37923,18 @@ This method controls whether the position between two cached points is interpola Clear all the syntax coloring information. </description> </method> + <method name="menu_option"> + <argument index="0" name="arg0" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_menu" qualifiers="const"> + <return type="PopupMenu"> + </return> + <description> + </description> + </method> </methods> <signals> <signal name="text_changed"> @@ -37585,6 +37962,20 @@ This method controls whether the position between two cached points is interpola <constant name="SEARCH_BACKWARDS" value="4"> Search from end to beginning. </constant> + <constant name="MENU_CUT" value="0"> + </constant> + <constant name="MENU_COPY" value="1"> + </constant> + <constant name="MENU_PASTE" value="2"> + </constant> + <constant name="MENU_CLEAR" value="3"> + </constant> + <constant name="MENU_SELECT_ALL" value="4"> + </constant> + <constant name="MENU_UNDO" value="5"> + </constant> + <constant name="MENU_MAX" value="6"> + </constant> </constants> <theme_items> <theme_item name="line_spacing" type="int"> @@ -37597,12 +37988,12 @@ This method controls whether the position between two cached points is interpola </theme_item> <theme_item name="symbol_color" type="Color"> </theme_item> - <theme_item name="cursor_color" type="Color"> - </theme_item> <theme_item name="selection_color" type="Color"> </theme_item> <theme_item name="completion_existing" type="Color"> </theme_item> + <theme_item name="caret_color" type="Color"> + </theme_item> <theme_item name="breakpoint_color" type="Color"> </theme_item> <theme_item name="font_color_selected" type="Color"> @@ -37905,8 +38296,30 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="set_stretch_mode"> + <argument index="0" name="stretch_mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_stretch_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> </methods> <constants> + <constant name="STRETCH_SCALE_ON_EXPAND" value="0"> + </constant> + <constant name="STRETCH_SCALE" value="1"> + </constant> + <constant name="STRETCH_TILE" value="2"> + </constant> + <constant name="STRETCH_KEEP" value="3"> + </constant> + <constant name="STRETCH_KEEP_CENTERED" value="4"> + </constant> </constants> </class> <class name="TextureProgress" inherits="Range" category="Core"> @@ -39394,10 +39807,10 @@ This method controls whether the position between two cached points is interpola </methods> <members> <member name="basis" type="Matrix3"> - The basis contains 3 [Vector3]. X axis, Y axis, and Z axis. + The basis contains 3 [Vector3]. X axis, Y axis, and Z axis. </member> <member name="origin" type="Vector3"> - The origin of the transform. Which is the translation offset. + The origin of the transform. Which is the translation offset. </member> </members> <constants> @@ -39718,6 +40131,30 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="set_allow_rmb_select"> + <argument index="0" name="allow" type="bool"> + </argument> + <description> + </description> + </method> + <method name="get_allow_rmb_select" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_single_select_cell_editing_only_when_already_selected"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="get_single_select_cell_editing_only_when_already_selected" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> </methods> <signals> <signal name="item_activated"> @@ -39750,6 +40187,18 @@ This method controls whether the position between two cached points is interpola <description> </description> </signal> + <signal name="empty_tree_rmb_selected"> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + </description> + </signal> + <signal name="item_rmb_selected"> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + </description> + </signal> <signal name="item_selected"> <description> </description> @@ -41174,16 +41623,16 @@ This method controls whether the position between two cached points is interpola </methods> <members> <member name="x" type="float"> - X component of the vector. + X component of the vector. </member> <member name="y" type="float"> - Y component of the vector. + Y component of the vector. </member> <member name="width" type="float"> - Width of the vector (Same as X). + Width of the vector (Same as X). </member> <member name="height" type="float"> - Height of the vector (Same as Y). + Height of the vector (Same as Y). </member> </members> <constants> @@ -41427,13 +41876,13 @@ This method controls whether the position between two cached points is interpola </methods> <members> <member name="x" type="float"> - X component of the vector. + X component of the vector. </member> <member name="y" type="float"> - Y component of the vector. + Y component of the vector. </member> <member name="z" type="float"> - Z component of the vector. + Z component of the vector. </member> </members> <constants> @@ -41565,7 +42014,7 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_linear_velocity" qualifiers="const"> + <method name="get_linear_velocity"> <return type="Vector3"> </return> <description> @@ -42366,13 +42815,15 @@ This method controls whether the position between two cached points is interpola <constant name="ENABLER_PAUSE_PARTICLES" value="2"> This enabler will stop [Particles2D] nodes. </constant> + <constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5"> + </constant> <constant name="ENABLER_PARENT_PROCESS" value="3"> This enabler will stop the parent's _process function. </constant> <constant name="ENABLER_PARENT_FIXED_PROCESS" value="4"> This enabler will stop the parent's _fixed_process function. </constant> - <constant name="ENABLER_MAX" value="5"> + <constant name="ENABLER_MAX" value="6"> </constant> </constants> </class> |