diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 6abbeee4f..5523cabc7 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -19,6 +19,8 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`acos` **(** :ref:`float` s **)** | @@ -173,6 +175,10 @@ Member Function Description Make a color from red, green, blue and alpha. Arguments can range from 0 to 255. +.. _class_@GDScript_ColorN: + +- :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha **)** + .. _class_@GDScript_abs: - :ref:`float` **abs** **(** :ref:`float` s **)** diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index adde3b432..821629c5e 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -61,6 +61,7 @@ Member Functions Signals ------- +- **finished** **(** **)** - **frame_changed** **(** **)** Description diff --git a/classes/class_array.rst b/classes/class_array.rst index b36c95302..3c86d06c1 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -33,6 +33,8 @@ Member Functions +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`append` **(** var value **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`back` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`count` **(** var value **)** | @@ -45,6 +47,8 @@ Member Functions +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_last` **(** var value **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`front` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has` **(** var value **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hash` **(** **)** | @@ -132,6 +136,12 @@ Construct an array from a :ref:`RawArray`. Append an element at the end of the array (alias of :ref:`push_back`). +.. _class_Array_back: + +- void **back** **(** **)** + +Returns the last element of the array if the array is not empty (size>0). + .. _class_Array_clear: - void **clear** **(** **)** @@ -168,6 +178,12 @@ Searches the array for a value and returns its index or -1 if not found. Optiona Searches the array in reverse order for a value and returns its index or -1 if not found. +.. _class_Array_front: + +- void **front** **(** **)** + +Returns the first element of the array if the array is not empty (size>0). + .. _class_Array_has: - :ref:`bool` **has** **(** var value **)** diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index b8432743e..1682cb18d 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -15,8 +15,29 @@ Brief Description A node that will attach to a bone. +Member Functions +---------------- + ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bone_name` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_name` **(** :ref:`String` bone_name **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ + Description ----------- This node must be the child of a :ref:`Skeleton` node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone. +Member Function Description +--------------------------- + +.. _class_BoneAttachment_get_bone_name: + +- :ref:`String` **get_bone_name** **(** **)** const + +.. _class_BoneAttachment_set_bone_name: + +- void **set_bone_name** **(** :ref:`String` bone_name **)** + + diff --git a/classes/class_buttonarray.rst b/classes/class_buttonarray.rst index 3ad1fa45f..763b29278 100644 --- a/classes/class_buttonarray.rst +++ b/classes/class_buttonarray.rst @@ -41,12 +41,16 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selected` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flat` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_button_icon` **(** :ref:`int` button_idx, :ref:`Texture` icon **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_button_text` **(** :ref:`int` button_idx, :ref:`String` text **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_button_tooltip` **(** :ref:`int` button_idx, :ref:`String` text **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flat` **(** :ref:`bool` enabled **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_selected` **(** :ref:`int` button_idx **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -132,6 +136,10 @@ Return the index of the currently hovered button in the array. Return the index of the currently selected button in the array. +.. _class_ButtonArray_is_flat: + +- :ref:`bool` **is_flat** **(** **)** const + .. _class_ButtonArray_set_button_icon: - void **set_button_icon** **(** :ref:`int` button_idx, :ref:`Texture` icon **)** @@ -148,6 +156,10 @@ Define the text of the specified button. - void **set_button_tooltip** **(** :ref:`int` button_idx, :ref:`String` text **)** +.. _class_ButtonArray_set_flat: + +- void **set_flat** **(** :ref:`bool` enabled **)** + .. _class_ButtonArray_set_selected: - void **set_selected** **(** :ref:`int` button_idx **)** diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 4c4f31c80..966d15715 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -18,71 +18,75 @@ Camera node for 2D scenes. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`align` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_current` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_update_scroll` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_anchor_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_pos` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_drag_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_follow_smoothing` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_h_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_limit` **(** :ref:`int` margin **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_v_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_zoom` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_current` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_follow_smoothing_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_h_drag_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_rotating` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_v_drag_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_current` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset_smoothing` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_mode` **(** :ref:`int` anchor_mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_margin` **(** :ref:`int` margin, :ref:`float` drag_margin **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_follow_smoothing` **(** :ref:`bool` follow_smoothing **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_follow_smoothing` **(** :ref:`float` follow_smoothing **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_drag_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit` **(** :ref:`int` margin, :ref:`int` limit **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotating` **(** :ref:`bool` rotating **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_drag_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_zoom` **(** :ref:`Vector2` zoom **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`align` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_current` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_update_scroll` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_anchor_mode` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_pos` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_custom_viewport` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_drag_margin` **(** :ref:`int` margin **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_follow_smoothing` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_h_offset` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_limit` **(** :ref:`int` margin **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_v_offset` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_zoom` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_current` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_follow_smoothing_enabled` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_h_drag_enabled` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_rotating` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_v_drag_enabled` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_current` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset_smoothing` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor_mode` **(** :ref:`int` anchor_mode **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_viewport` **(** :ref:`Viewport` viewport **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_margin` **(** :ref:`int` margin, :ref:`float` drag_margin **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_follow_smoothing` **(** :ref:`bool` follow_smoothing **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_follow_smoothing` **(** :ref:`float` follow_smoothing **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_drag_enabled` **(** :ref:`bool` enabled **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit` **(** :ref:`int` margin, :ref:`int` limit **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotating` **(** :ref:`bool` rotating **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_drag_enabled` **(** :ref:`bool` enabled **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_zoom` **(** :ref:`Vector2` zoom **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -130,6 +134,12 @@ Return the camera position. - :ref:`Vector2` **get_camera_screen_center** **(** **)** const +.. _class_Camera2D_get_custom_viewport: + +- :ref:`Viewport` **get_custom_viewport** **(** **)** const + +Return the viewport RID for this layer. + .. _class_Camera2D_get_drag_margin: - :ref:`float` **get_drag_margin** **(** :ref:`int` margin **)** const @@ -204,6 +214,10 @@ This has no effect if smoothing is disabled. - void **set_anchor_mode** **(** :ref:`int` anchor_mode **)** +.. _class_Camera2D_set_custom_viewport: + +- void **set_custom_viewport** **(** :ref:`Viewport` viewport **)** + .. _class_Camera2D_set_drag_margin: - void **set_drag_margin** **(** :ref:`int` margin, :ref:`float` drag_margin **)** diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index ce5ef1df4..859304eee 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -20,35 +20,37 @@ Canvas Item layer. Member Functions ---------------- -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotationd` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_transform` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_viewport` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer` **(** :ref:`int` layer **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotationd` **(** :ref:`float` degrees **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Matrix32` transform **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_custom_viewport` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotationd` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Matrix32` | :ref:`get_transform` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_viewport` **(** :ref:`Viewport` viewport **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer` **(** :ref:`int` layer **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotationd` **(** :ref:`float` degrees **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Matrix32` transform **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -58,6 +60,12 @@ Canvas Item layer. :ref:`CanvasItem` nodes that are direct or Member Function Description --------------------------- +.. _class_CanvasLayer_get_custom_viewport: + +- :ref:`Viewport` **get_custom_viewport** **(** **)** const + +Return the viewport RID for this layer. + .. _class_CanvasLayer_get_layer: - :ref:`int` **get_layer** **(** **)** const @@ -94,18 +102,16 @@ Return the base scale for this layer (helper). Return the base transform for this layer. -.. _class_CanvasLayer_get_viewport: - -- :ref:`RID` **get_viewport** **(** **)** const - -Return the viewport RID for this layer. - .. _class_CanvasLayer_get_world_2d: - :ref:`World2D` **get_world_2d** **(** **)** const Return the :ref:`World2D` used by this layer. +.. _class_CanvasLayer_set_custom_viewport: + +- void **set_custom_viewport** **(** :ref:`Viewport` viewport **)** + .. _class_CanvasLayer_set_layer: - void **set_layer** **(** :ref:`int` layer **)** diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 6b75db7ab..843f1722d 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -21,6 +21,8 @@ Member Functions +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2(0, 0), :ref:`Vector2` out=Vector2(0, 0), :ref:`int` atpos=-1 **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_bake_interval` **(** **)** const | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_baked_length` **(** **)** const | @@ -72,6 +74,10 @@ 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 >= :ref:`get_point_count`), the point will be appended at the end of the point list. +.. _class_Curve2D_clear_points: + +- void **clear_points** **(** **)** + .. _class_Curve2D_get_bake_interval: - :ref:`float` **get_bake_interval** **(** **)** const diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index c137e89ec..63deddbf8 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -21,6 +21,8 @@ Member Functions +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_point` **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3(0, 0, 0), :ref:`Vector3` out=Vector3(0, 0, 0), :ref:`int` atpos=-1 **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_bake_interval` **(** **)** const | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_baked_length` **(** **)** const | @@ -78,6 +80,10 @@ 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 >= :ref:`get_point_count`), the point will be appended at the end of the point list. +.. _class_Curve3D_clear_points: + +- void **clear_points** **(** **)** + .. _class_Curve3D_get_bake_interval: - :ref:`float` **get_bake_interval** **(** **)** const diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 5bd9218ce..3c0aa7bee 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -39,6 +39,8 @@ Member Functions +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`edit` **(** :ref:`Object` object **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_resource` **(** :ref:`Object` arg0 **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`forward_input_event` **(** :ref:`InputEvent` event **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`forward_spatial_input_event` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | @@ -192,6 +194,12 @@ This is used for plugins that create gizmos used by the spatial editor. Just che This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. +.. _class_EditorPlugin_edit_resource: + +- void **edit_resource** **(** :ref:`Object` arg0 **)** + +Tells the editor to handle the edit of the given resource. For example, if you pass a script as argument, the editor will open the script editor. + .. _class_EditorPlugin_forward_input_event: - :ref:`bool` **forward_input_event** **(** :ref:`InputEvent` event **)** virtual diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 4b3037770..6f42ec8d4 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -200,7 +200,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) - :ref:`int` **get_status** **(** **)** const -Returns a status string like STATUS_REQUESTING. Need to call :ref:`poll` in order to get status updates. +Returns a STATUS\_\* enum constant. Need to call :ref:`poll` in order to get status updates. .. _class_HTTPClient_has_response: diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 18481aaf8..9a6317b57 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -29,7 +29,7 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_teleport_to` **(** :ref:`Vector3` position **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | +| :ref:`Variant` | :ref:`get_collider` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_shape` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ @@ -102,7 +102,7 @@ Returns whether the KinematicBody can be teleported to the destination given as .. _class_KinematicBody_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Variant` **get_collider** **(** **)** const Return the body that collided with this one. diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 1eead77f7..34b507fb8 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | +| :ref:`Variant` | :ref:`get_collider` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------+ @@ -62,7 +62,7 @@ Member Function Description .. _class_KinematicBody2D_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Variant` **get_collider** **(** **)** const Return the body that collided with this one. diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 5a56d59ba..48088c741 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -27,6 +27,12 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_global_pos` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_global_rot` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_global_rotd` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_scale` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_pos` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Matrix32` | :ref:`get_relative_transform_to_parent` **(** :ref:`Object` parent **)** const | @@ -55,6 +61,12 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_pos` **(** :ref:`Vector2` pos **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_rot` **(** :ref:`float` radians **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_rotd` **(** :ref:`float` degrees **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_transform` **(** :ref:`Matrix32` xform **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pos` **(** :ref:`Vector2` pos **)** | @@ -100,6 +112,24 @@ Return the rotation angle in radians needed for the 2d node to point at 'point' Return the global position of the 2D node. +.. _class_Node2D_get_global_rot: + +- :ref:`float` **get_global_rot** **(** **)** const + +Return the global rotation in radians of the 2D node. + +.. _class_Node2D_get_global_rotd: + +- :ref:`float` **get_global_rotd** **(** **)** const + +Return the global rotation in degrees of the 2D node. + +.. _class_Node2D_get_global_scale: + +- :ref:`Vector2` **get_global_scale** **(** **)** const + +Return the global scale of the 2D node. + .. _class_Node2D_get_pos: - :ref:`Vector2` **get_pos** **(** **)** const @@ -182,6 +212,24 @@ Apply the 'ratio' scale to the 2D node, according to its current scale value. Set the global position of the 2D node to 'pos'. +.. _class_Node2D_set_global_rot: + +- void **set_global_rot** **(** :ref:`float` radians **)** + +Set the global rotation in radians of the 2D node. + +.. _class_Node2D_set_global_rotd: + +- void **set_global_rotd** **(** :ref:`float` degrees **)** + +Set the global rotation in degrees of the 2D node. + +.. _class_Node2D_set_global_scale: + +- void **set_global_scale** **(** :ref:`Vector2` scale **)** + +Set the global scale of the 2D node. + .. _class_Node2D_set_global_transform: - void **set_global_transform** **(** :ref:`Matrix32` xform **)** diff --git a/classes/class_os.rst b/classes/class_os.rst index 0468798d6..70b4d2abe 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -63,6 +63,8 @@ Member Functions +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_executable_path` **(** **)** const | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_exit_code` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frames_drawn` **(** **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_frames_per_second` **(** **)** const | @@ -191,6 +193,8 @@ Member Functions +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_current_screen` **(** :ref:`int` screen **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exit_code` **(** :ref:`int` code **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_icon` **(** :ref:`Image` icon **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_iterations_per_second` **(** :ref:`int` iterations_per_second **)** | @@ -432,6 +436,10 @@ Return an environment variable. Return the path to the current engine executable. +.. _class_OS_get_exit_code: + +- :ref:`int` **get_exit_code** **(** **)** const + .. _class_OS_get_frames_drawn: - :ref:`int` **get_frames_drawn** **(** **)** @@ -788,6 +796,10 @@ Set clipboard to the OS. - void **set_current_screen** **(** :ref:`int` screen **)** +.. _class_OS_set_exit_code: + +- void **set_exit_code** **(** :ref:`int` code **)** + .. _class_OS_set_icon: - void **set_icon** **(** :ref:`Image` icon **)** diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 9b6ef208a..905140d8f 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -61,6 +61,8 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hide_on_item_selection` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | @@ -71,6 +73,8 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` idx **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_item_selection` **(** :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_ID` **(** :ref:`int` idx, :ref:`int` id **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | @@ -225,6 +229,12 @@ Return the text of the item at index "idx". - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const +.. _class_PopupMenu_is_hide_on_item_selection: + +- :ref:`bool` **is_hide_on_item_selection** **(** **)** + +Returns a boolean that indicates whether or not the PopupMenu will hide on item selection. + .. _class_PopupMenu_is_item_checkable: - :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const @@ -255,6 +265,12 @@ Return whether the item is a seperator. If it is, it would be displayed as a lin Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. +.. _class_PopupMenu_set_hide_on_item_selection: + +- void **set_hide_on_item_selection** **(** :ref:`bool` enable **)** + +Sets whether or not the PopupMenu will hide on item selection. + .. _class_PopupMenu_set_item_ID: - void **set_item_ID** **(** :ref:`int` idx, :ref:`int` id **)** diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 8577da406..3fac31066 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -161,7 +161,7 @@ Return the current body bounciness. - :ref:`Array` **get_colliding_bodies** **(** **)** const -Return a list of the bodies colliding with this one. +Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see :ref:`set_max_contacts_reported` to increase it. .. _class_RigidBody_get_friction: diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 4451bb3af..c8da501c5 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -192,7 +192,7 @@ Return the body bounciness. - :ref:`Array` **get_colliding_bodies** **(** **)** const -Return a list of the bodies colliding with this one. +Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see :ref:`set_max_contacts_reported` to increase it. You must also enable contact monitor, see :ref:`set_contact_monitor` .. _class_RigidBody2D_get_continuous_collision_detection_mode: diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index d1d0b7e4b..66482409a 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -59,6 +59,8 @@ Member Functions +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`World` | :ref:`get_world` **(** **)** const | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | @@ -123,6 +125,8 @@ Member Functions +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_world` **(** :ref:`World` world **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_worlds` **(** **)** | @@ -281,6 +285,10 @@ Return the final, visible rect in global screen coordinates. Return the 3D world of the viewport. +.. _class_Viewport_get_world_2d: + +- :ref:`World2D` **get_world_2d** **(** **)** const + .. _class_Viewport_gui_get_drag_data: - :ref:`Variant` **gui_get_drag_data** **(** **)** const @@ -471,6 +479,10 @@ Make the viewport use a world separate from the parent viewport's world. Change the 3D world of the viewport. +.. _class_Viewport_set_world_2d: + +- void **set_world_2d** **(** :ref:`World2D` world_2d **)** + .. _class_Viewport_unhandled_input: - void **unhandled_input** **(** :ref:`InputEvent` local_event **)**