diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 51ce9564b..2941fac48 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -44,7 +44,11 @@ Signals ------- - **confirmed** **(** **)** +Emitted when accepted. + - **custom_action** **(** :ref:`String` action **)** +Emitted with a custom button is added. + Description ----------- diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 821629c5e..1667d6d8f 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -62,7 +62,11 @@ Signals ------- - **finished** **(** **)** +Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted everytime the last frame is drawn, before looping. + - **frame_changed** **(** **)** +Emitted when frame is changed. + Description ----------- diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 7e4106da1..034e89ab6 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -42,6 +42,8 @@ Signals ------- - **frame_changed** **(** **)** +Emitted when frame is changed. + Member Function Description --------------------------- diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 8ef211cf0..bb721a277 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -100,8 +100,14 @@ Signals ------- - **animation_changed** **(** :ref:`String` old_name, :ref:`String` new_name **)** +If the currently being played animation changes, this signal will notify of such change. + - **animation_started** **(** :ref:`String` name **)** +Notifies when an animation starts playing. + - **finished** **(** **)** +Notifies when an animation finished playing. + Numeric Constants ----------------- diff --git a/classes/class_area.rst b/classes/class_area.rst index 2a2b7b895..f8e38c975 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -88,13 +88,29 @@ Signals ------- - **area_enter** **(** :ref:`Object` area **)** +This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. + - **area_enter_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +This signal triggers only once when an area enters this area. The first parameter is the area's :ref:`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. + - **area_exit** **(** :ref:`Object` area **)** +This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. + - **area_exit_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +This signal triggers only once when an area exits this area. The first parameter is the area's :ref:`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. + - **body_enter** **(** :ref:`Object` body **)** +This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. + - **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +This signal triggers only once when a body enters this area. The first parameter is the body's :ref:`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. + - **body_exit** **(** :ref:`Object` body **)** +This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. + - **body_exit_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +This signal triggers only once when a body exits this area. The first parameter is the body's :ref:`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 ----------- diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index f99aaff05..3121c831b 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -88,13 +88,29 @@ Signals ------- - **area_enter** **(** :ref:`Object` area **)** +This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. + - **area_enter_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +This signal triggers only once when an area enters this area. The first parameter is the area's :ref:`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. + - **area_exit** **(** :ref:`Object` area **)** +This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. + - **area_exit_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +This signal triggers only once when an area exits this area. The first parameter is the area's :ref:`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. + - **body_enter** **(** :ref:`Object` body **)** +This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. + - **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +This signal triggers only once when a body enters this area. The first parameter is the body's :ref:`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. + - **body_exit** **(** :ref:`Object` body **)** +This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. + - **body_exit_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +This signal triggers only once when a body exits this area. The first parameter is the body's :ref:`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 ----------- diff --git a/classes/class_astar.rst b/classes/class_astar.rst index be0100597..7c97275d1 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -18,37 +18,37 @@ Brief Description Member Functions ---------------- -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_pos **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_pos_in_segment` **(** :ref:`Vector3` to_pos **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`IntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` id **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_pos **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_pos_in_segment` **(** :ref:`Vector3` to_pos **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`IntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` id **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -65,6 +65,8 @@ Member Function Description - void **add_point** **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** +Add a new point at the given position. The ``weight_scale`` has to be 1 or larger. + .. _class_AStar_are_points_connected: - :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** const @@ -75,7 +77,7 @@ Member Function Description .. _class_AStar_connect_points: -- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id **)** +- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** .. _class_AStar_disconnect_points: diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index fda01376a..e32c57c4a 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -58,10 +58,20 @@ Signals ------- - **button_down** **(** **)** +Emitted when the button starts being held down. + - **button_up** **(** **)** +Emitted when the button stops being held down. + - **pressed** **(** **)** +This signal is emitted every time the button is toggled or pressed (i.e. activated, so on ``button_down`` if "Click on press" is active and on ``button_up`` otherwise). + - **released** **(** **)** +Emitted when the button was released. This is only emitted by non-toggle buttons and if "Click on press" is active. + - **toggled** **(** :ref:`bool` pressed **)** +This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the *pressed* argument. + Numeric Constants ----------------- diff --git a/classes/class_buttonarray.rst b/classes/class_buttonarray.rst index 763b29278..7aaa326dc 100644 --- a/classes/class_buttonarray.rst +++ b/classes/class_buttonarray.rst @@ -58,6 +58,8 @@ Signals ------- - **button_selected** **(** :ref:`int` button_idx **)** +A button has been selected, its index is given as the argument. + Numeric Constants ----------------- diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 26d151c40..af8070552 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -138,9 +138,17 @@ Signals ------- - **draw** **(** **)** +Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing. + - **hide** **(** **)** +Emitted when becoming hidden. + - **item_rect_changed** **(** **)** +Emitted when the item rect has changed. + - **visibility_changed** **(** **)** +Emitted when the visibility (hidden/visible) changes. + Numeric Constants ----------------- diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 378176523..96a9e3f22 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -54,8 +54,14 @@ Signals ------- - **input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** +This signal triggers when an input event fires over a shape. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. + - **mouse_enter** **(** **)** +This event fires only once when the mouse pointer enters any shape of this object. + - **mouse_exit** **(** **)** +This event fires only once when the mouse pointer exits all shapes of this object. + Description ----------- diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 701812f5b..bf7fac89c 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -38,6 +38,8 @@ Signals ------- - **color_changed** **(** :ref:`Color` color **)** +Emitted when the color is changed. + Description ----------- diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 4cfbe10ea..ae78483be 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -34,6 +34,8 @@ Signals ------- - **color_changed** **(** :ref:`Color` color **)** +Emitted when the color is changed. + Description ----------- diff --git a/classes/class_container.rst b/classes/class_container.rst index 08ff8f14f..a52d1a2c5 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -30,6 +30,8 @@ Signals ------- - **sort_children** **(** **)** +Emitted when sorting the children is needed. + Numeric Constants ----------------- diff --git a/classes/class_control.rst b/classes/class_control.rst index 306a6fe7d..c3e8f089c 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -206,14 +206,30 @@ Signals ------- - **focus_enter** **(** **)** +Emitted when keyboard focus is gained. + - **focus_exit** **(** **)** +Emitted when the keyboard focus is lost. + - **input_event** **(** :ref:`InputEvent` ev **)** +Emitted when an input event is received. Connecting in realtime is recommended for accepting the events. + - **minimum_size_changed** **(** **)** +Emitted when the minimum size of the control changed. + - **modal_close** **(** **)** - **mouse_enter** **(** **)** +Emitted when the mouse enters the control area. + - **mouse_exit** **(** **)** +Emitted when the mouse left the control area. + - **resized** **(** **)** +Emitted when the control changed size. + - **size_flags_changed** **(** **)** +Emitted when the size flags changed. + Numeric Constants ----------------- diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index ea177c393..d90a06cfe 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -32,6 +32,8 @@ Signals ------- - **selection_changed** **(** **)** +Emitted when the selection changes. + Description ----------- diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index ad330bbfd..522ce1a90 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -60,8 +60,14 @@ Signals ------- - **dir_selected** **(** :ref:`String` dir **)** +Event emitted when the user selects a directory. + - **file_selected** **(** :ref:`String` path **)** +Event emitted when the user selects a file (double clicks it or presses the OK button). + - **files_selected** **(** :ref:`StringArray` paths **)** +Event emitted when the user selects multiple files. + Numeric Constants ----------------- diff --git a/classes/class_gdfunctionstate.rst b/classes/class_gdfunctionstate.rst index 6eee7fb0e..7a006aec2 100644 --- a/classes/class_gdfunctionstate.rst +++ b/classes/class_gdfunctionstate.rst @@ -18,11 +18,11 @@ State of a function call after yielding. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=NULL **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** :ref:`bool` extended_check=false **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=NULL **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -34,10 +34,12 @@ Member Function Description .. _class_GDFunctionState_is_valid: -- :ref:`bool` **is_valid** **(** **)** const +- :ref:`bool` **is_valid** **(** :ref:`bool` extended_check=false **)** const Check whether the function call may be resumed. This is not the case if the function state was already resumed. +If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`GDFunctionState.resume`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. + .. _class_GDFunctionState_resume: - :ref:`Variant` **resume** **(** :ref:`Variant` arg=NULL **)** diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 00cf4b993..300bc0171 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -42,12 +42,26 @@ Signals ------- - **_begin_node_move** **(** **)** +Signal sent at the beginning of a GraphNode movement. + - **_end_node_move** **(** **)** +Signal sent at the end of a GraphNode movement. + - **connection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** +Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. + - **delete_nodes_request** **(** **)** +Signal sent when a GraphNode is attempted to be removed from the GraphEdit. + - **disconnection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** +Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. + - **duplicate_nodes_request** **(** **)** +Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. + - **popup_request** **(** :ref:`Vector2` p_position **)** +Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent. + Description ----------- diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index d3155ec83..4854b2633 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -70,9 +70,17 @@ Signals ------- - **close_request** **(** **)** +Signal sent on closing the GraphNode. + - **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** +Signal sent when the GraphNode is dragged. + - **offset_changed** **(** **)** +Signal sent when the GraphNode is moved. + - **raise_request** **(** **)** +Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. + Description ----------- diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 1ee364e19..2ef0e47c1 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -50,6 +50,8 @@ Signals ------- - **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`StringArray` headers, :ref:`RawArray` body **)** +This signal is emitted upon request completion. + Numeric Constants ----------------- diff --git a/classes/class_image.rst b/classes/class_image.rst index 5e8452455..aa779fa4d 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -19,6 +19,8 @@ Member Functions +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`Image` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` mipmaps, :ref:`int` format **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dest=0 **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dest=0 **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`brush_transfer` **(** :ref:`Image` src, :ref:`Image` brush, :ref:`Vector2` pos=0 **)** | @@ -106,6 +108,12 @@ Member Function Description Create an empty image of a specific size and format. +.. _class_Image_blend_rect: + +- void **blend_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dest=0 **)** + +Alpha-blends a "src_rect" :ref:`Rect2` from "src" :ref:`Image` to this :ref:`Image` on coordinates "dest". + .. _class_Image_blit_rect: - void **blit_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dest=0 **)** diff --git a/classes/class_input.rst b/classes/class_input.rst index 70d1cda9f..126d2fa68 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -90,6 +90,8 @@ Signals ------- - **joy_connection_changed** **(** :ref:`int` index, :ref:`bool` connected **)** +Emitted when a joystick device has been connected or disconnected + Numeric Constants ----------------- diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 49455aaba..1f4d4f958 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -122,9 +122,21 @@ Signals ------- - **item_activated** **(** :ref:`int` index **)** +Fired when specified list item is activated via double click or Enter. + - **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` atpos **)** +Fired when specified list item has been selected via right mouse clicking. + +The click position is also provided to allow appropriate popup of context menus + +at the correct location. + - **item_selected** **(** :ref:`int` index **)** +Fired when specified item has been selected. + - **multi_selected** **(** :ref:`int` index, :ref:`bool` selected **)** +Fired when a multiple selection is altered on a list allowing mutliple selection. + Numeric Constants ----------------- diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 1efb9029f..753f2ad2a 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -76,7 +76,11 @@ Signals ------- - **text_changed** **(** :ref:`String` text **)** +When the text changes, this signal is emitted. + - **text_entered** **(** :ref:`String` text **)** +This signal is emitted when the user presses KEY_ENTER on the :ref:`LineEdit`. This signal is often used as an alternate confirmation mechanism in dialogs. + Numeric Constants ----------------- diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 68d78de0e..1b07507b7 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -18,49 +18,59 @@ A :ref:`Resource` that contains vertex-array based geometry. Member Functions ---------------- -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_morph_target` **(** :ref:`String` name **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` morph_arrays=Array(), :ref:`bool` alphasort=false **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_geometry` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_morph_targets` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_custom_aabb` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_morph_target_count` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_morph_target_mode` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_morph_target_name` **(** :ref:`int` index **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_count` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`regen_normalmaps` **(** **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_aabb` **(** :ref:`AABB` aabb **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_morph_target_mode` **(** :ref:`int` mode **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_morph_target` **(** :ref:`String` name **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_surface` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` morph_arrays=Array(), :ref:`bool` alphasort=false **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_geometry` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_morph_targets` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`create_convex_shape` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| TriangleMesh | :ref:`generate_triangle_mesh` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_custom_aabb` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3Array` | :ref:`get_faces` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_morph_target_count` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_morph_target_mode` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_morph_target_name` **(** :ref:`int` index **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_count` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`regen_normalmaps` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_aabb` **(** :ref:`AABB` aabb **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_morph_target_mode` **(** :ref:`int` mode **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -123,10 +133,30 @@ The format of a surface determines which arrays it will allocate and hold, so "f - void **clear_morph_targets** **(** **)** +.. _class_Mesh_create_convex_shape: + +- :ref:`Shape` **create_convex_shape** **(** **)** const + +.. _class_Mesh_create_outline: + +- :ref:`Mesh` **create_outline** **(** :ref:`float` margin **)** const + +.. _class_Mesh_create_trimesh_shape: + +- :ref:`Shape` **create_trimesh_shape** **(** **)** const + +.. _class_Mesh_generate_triangle_mesh: + +- TriangleMesh **generate_triangle_mesh** **(** **)** const + .. _class_Mesh_get_custom_aabb: - :ref:`AABB` **get_custom_aabb** **(** **)** const +.. _class_Mesh_get_faces: + +- :ref:`Vector3Array` **get_faces** **(** **)** const + .. _class_Mesh_get_morph_target_count: - :ref:`int` **get_morph_target_count** **(** **)** const diff --git a/classes/class_node.rst b/classes/class_node.rst index 95473e849..c1a7333f4 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -160,6 +160,8 @@ Signals - **enter_tree** **(** **)** - **exit_tree** **(** **)** - **renamed** **(** **)** +Emitted when the node is renamed. + Numeric Constants ----------------- diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index eecce8445..1919f87cb 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -64,6 +64,8 @@ Signals ------- - **item_selected** **(** :ref:`int` ID **)** +This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). + Description ----------- diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 56ffe25ce..0fd0b52e2 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -38,7 +38,11 @@ Signals ------- - **about_to_show** **(** **)** +This signal is emitted when a popup is about to be shown. (often used in :ref:`PopupMenu` for clearing the list of options and creating a new one according to the current context). + - **popup_hide** **(** **)** +This signal is emitted when a popup is hidden. + Numeric Constants ----------------- diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 905140d8f..190e38256 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -106,6 +106,8 @@ Signals ------- - **item_pressed** **(** :ref:`int` ID **)** +This even is emitted when an item is pressed or its accelerator is activated. The id of the item is returned if it exists, else the index. + Description ----------- diff --git a/classes/class_range.rst b/classes/class_range.rst index c60d3171e..609300e02 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -66,7 +66,11 @@ Signals ------- - **changed** **(** **)** +This signal is emitted when min, max, range or step change. + - **value_changed** **(** :ref:`float` value **)** +This signal is emitted when value changes. + Description ----------- diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index 621a8eb60..53a15ee45 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -60,7 +60,7 @@ Return the total amount of stages (calls to :ref:`poll` **poll** **(** **)** -Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling :ref:`get_resource`. +Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling :ref:`get_resource`. .. _class_ResourceInteractiveLoader_wait: diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 3fac31066..46adaab7f 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -100,10 +100,24 @@ Signals ------- - **body_enter** **(** :ref:`Object` body **)** +Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + - **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +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 :ref:`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. + - **body_exit** **(** :ref:`Object` body **)** +Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + - **body_exit_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +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 :ref:`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. + - **sleeping_state_changed** **(** **)** +Emitted when the body changes its sleeping state. Either by sleeping or waking up. + Numeric Constants ----------------- diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index c8da501c5..856190ff6 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -112,10 +112,24 @@ Signals ------- - **body_enter** **(** :ref:`Object` body **)** +Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + - **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +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 :ref:`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. + - **body_exit** **(** :ref:`Object` body **)** +Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + - **body_exit_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +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 :ref:`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. + - **sleeping_state_changed** **(** **)** +Emitted when the body changes its sleeping state. Either by sleeping or waking up. + Numeric Constants ----------------- diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 0d8d1a8a6..f6477814b 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -38,6 +38,8 @@ Signals ------- - **dragged** **(** :ref:`int` offset **)** +Emmited when the dragger is gragged by user. + Numeric Constants ----------------- diff --git a/classes/class_streamplayer.rst b/classes/class_streamplayer.rst index d71d16adb..ae5ddb9f9 100644 --- a/classes/class_streamplayer.rst +++ b/classes/class_streamplayer.rst @@ -72,6 +72,8 @@ Signals ------- - **finished** **(** **)** +This signal triggers when the player stops playing. It will not trigger on each loop. + Description ----------- diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index fc45a8397..9ffb5d08a 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -59,7 +59,19 @@ Member Functions Description ----------- -Helper tool to create geometry. +The :ref:`SurfaceTool` is used to construct a :ref:`Mesh` by specifying vertex attributes individually. It can be used to construct a :ref:`Mesh` from script. All properties except index need to be added before a call to :ref:`add_vertex`. For example adding vertex colors and UVs looks like + +:: + + var st = SurfaceTool.new() + st.begin(Mesh.PRIMITIVE_TRIANGLES) + st.add_color(Color(1, 0, 0)) + st.add_uv(Vector2(0, 0)) + st.add_vertex(Vector3(0, 0, 0)) + +The :ref:`SurfaceTool` now contains one vertex of a triangle which has a UV coordinate and a specified :ref:`Color`. If another vertex were added without calls to :ref:`add_uv` or :ref:`add_color` then the last values would be used. + +It is very important that vertex attributes are passed **before** the call to :ref:`add_vertex`, failure to do this will result in an error when committing the vertex information to a mesh. Member Function Description --------------------------- @@ -68,72 +80,108 @@ Member Function Description - void **add_bones** **(** :ref:`IntArray` bones **)** +Add an array of bones for the next Vertex to use. + .. _class_SurfaceTool_add_color: - void **add_color** **(** :ref:`Color` color **)** +Specify a :ref:`Color` for the next Vertex to use. + .. _class_SurfaceTool_add_index: - void **add_index** **(** :ref:`int` index **)** +Adds an index to index array if you are using indexed Vertices. Does not need to be called before adding Vertex. + .. _class_SurfaceTool_add_normal: - void **add_normal** **(** :ref:`Vector3` normal **)** +Specify a normal for the next Vertex to use. + .. _class_SurfaceTool_add_smooth_group: - void **add_smooth_group** **(** :ref:`bool` smooth **)** +Specify whether current Vertex (if using only Vertex arrays) or current index (if also using index arrays) should utilize smooth normals for normal calculation. + .. _class_SurfaceTool_add_tangent: - void **add_tangent** **(** :ref:`Plane` tangent **)** +Specify a Tangent for the next Vertex to use. + .. _class_SurfaceTool_add_triangle_fan: - void **add_triangle_fan** **(** :ref:`Vector3Array` vertexes, :ref:`Vector2Array` uvs=Vector2Array([]), :ref:`ColorArray` colors=ColorArray([ColorArray]), :ref:`Vector2Array` uv2s=Vector2Array([]), :ref:`Vector3Array` normals=Vector3Array([]), :ref:`Array` tangents=Array() **)** +Insert a triangle fan made of array data into :ref:`Mesh` being constructed. + .. _class_SurfaceTool_add_uv: - void **add_uv** **(** :ref:`Vector2` uv **)** +Specify UV Coordinate for next Vertex to use. + .. _class_SurfaceTool_add_uv2: - void **add_uv2** **(** :ref:`Vector2` uv2 **)** +Specify an optional second set of UV coordinates for next Vertex to use. + .. _class_SurfaceTool_add_vertex: - void **add_vertex** **(** :ref:`Vector3` vertex **)** +Specify position of current Vertex. Should be called after specifying other vertex properties (e.g. Color, UV). + .. _class_SurfaceTool_add_weights: - void **add_weights** **(** :ref:`RealArray` weights **)** +Specify weight value for next Vertex to use. + .. _class_SurfaceTool_begin: - void **begin** **(** :ref:`int` primitive **)** +Called before adding any Vertices. Takes the primitive type as an argument (e.g. Mesh.PRIMITIVE_TRIANGLES). + .. _class_SurfaceTool_clear: - void **clear** **(** **)** +Clear all information passed into the surface tool so far. + .. _class_SurfaceTool_commit: - :ref:`Mesh` **commit** **(** :ref:`Mesh` existing=NULL **)** +Returns a constructed :ref:`Mesh` from current information passed in. If an existing :ref:`Mesh` is passed in as an argument, will add an extra surface to the existing :ref:`Mesh`. + .. _class_SurfaceTool_deindex: - void **deindex** **(** **)** +Removes index array by expanding Vertex array. + .. _class_SurfaceTool_generate_normals: - void **generate_normals** **(** **)** +Generates normals from Vertices so you do not have to do it manually. + .. _class_SurfaceTool_index: - void **index** **(** **)** +Shrinks Vertex array by creating an index array. Avoids reusing Vertices. + .. _class_SurfaceTool_set_material: - void **set_material** **(** :ref:`Material` material **)** +Sets :ref:`Material` to be used by the :ref:`Mesh` you are constructing. + diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 3d85222e4..f9fa1eb9f 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -57,7 +57,11 @@ Signals - **pre_popup_pressed** **(** **)** - **tab_changed** **(** :ref:`int` tab **)** +Emitted when a tab gets selected. Same behavior as :ref:`tab_selected` signal for backward compatibility. Note: In Godot v3.0+ this will change to be only emitted when tab gets changed. + - **tab_selected** **(** :ref:`int` tab **)** +Emitted when a tab is being selected, even if it is the same tab. + Description ----------- diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 6e802eb63..8bd6c201f 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -118,9 +118,15 @@ Signals ------- - **breakpoint_toggled** **(** :ref:`int` row **)** +Emitted when a breakpoint is placed via the breakpoint gutter. + - **cursor_changed** **(** **)** +Emitted when the cursor changes. + - **request_completion** **(** **)** - **text_changed** **(** **)** +Emitted when the text changes. + Numeric Constants ----------------- diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index 21c593380..09a5525a7 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -63,6 +63,8 @@ Member Functions Numeric Constants ----------------- +- **RESIZE_SCALE** = **0** +- **RESIZE_STRETCH** = **1** - **STRETCH_SCALE_ON_EXPAND** = **0** - **STRETCH_SCALE** = **1** - **STRETCH_TILE** = **2** diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 4791fb2ea..37d993c2a 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -37,8 +37,12 @@ Member Functions +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_layer` **(** **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_mask` **(** **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_use_kinematic` **(** **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Matrix32` | :ref:`get_custom_transform` **(** **)** const | @@ -83,10 +87,14 @@ Member Functions +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_friction` **(** :ref:`float` value **)** | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` mask **)** | +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_use_kinematic` **(** :ref:`bool` use_kinematic **)** | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_transform` **(** :ref:`Matrix32` custom_transform **)** | @@ -112,6 +120,8 @@ Signals ------- - **settings_changed** **(** **)** +Signal indicating that a tilemap setting has changed. + Numeric Constants ----------------- @@ -191,12 +201,20 @@ Return the collision friction parameter. Return the collision layer. +.. _class_TileMap_get_collision_layer_bit: + +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const + .. _class_TileMap_get_collision_mask: - :ref:`int` **get_collision_mask** **(** **)** const Return the collision mask. +.. _class_TileMap_get_collision_mask_bit: + +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const + .. _class_TileMap_get_collision_use_kinematic: - :ref:`bool` **get_collision_use_kinematic** **(** **)** const @@ -337,12 +355,16 @@ Set the collision friction parameter. Allowable values range from 0 to 1. .. _class_TileMap_set_collision_layer: -- void **set_collision_layer** **(** :ref:`int` mask **)** +- void **set_collision_layer** **(** :ref:`int` layer **)** Set the collision layer. Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1. +.. _class_TileMap_set_collision_layer_bit: + +- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + .. _class_TileMap_set_collision_mask: - void **set_collision_mask** **(** :ref:`int` mask **)** @@ -351,6 +373,10 @@ Set the collision masks. Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1. +.. _class_TileMap_set_collision_mask_bit: + +- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + .. _class_TileMap_set_collision_use_kinematic: - void **set_collision_use_kinematic** **(** :ref:`bool` use_kinematic **)** diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 4bd507b9f..439984fd2 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -50,6 +50,8 @@ Signals ------- - **timeout** **(** **)** +Emitted when the time runs out. + Numeric Constants ----------------- diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 9137d1908..25b66d59e 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -92,14 +92,33 @@ Signals ------- - **button_pressed** **(** :ref:`Object` item, :ref:`int` column, :ref:`int` id **)** +Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button`). + - **cell_selected** **(** **)** +Emitted when a cell is selected. + +- **column_title_pressed** **(** :ref:`int` column **)** - **custom_popup_edited** **(** :ref:`bool` arrow_clicked **)** +Emitted when a cell with the ``CELL_MODE_CUSTOM`` is clicked to be edited. + - **empty_tree_rmb_selected** **(** :ref:`Vector2` pos **)** +Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty. + - **item_activated** **(** **)** +Emitted when an item is activated (double-clicked). + - **item_collapsed** **(** :ref:`Object` item **)** +Emitted when an item is collapsed by a click on the folding arrow. + - **item_edited** **(** **)** +Emitted when an item is editted. + - **item_rmb_selected** **(** :ref:`Vector2` pos **)** +Emitted when an item is selected with right mouse button. + - **item_selected** **(** **)** +Emitted when an item is selected with right mouse button. + - **multi_selected** **(** :ref:`Object` item, :ref:`int` column, :ref:`bool` selected **)** Numeric Constants diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index e35a57ecc..2d9be3500 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -18,107 +18,107 @@ Brief Description Member Functions ---------------- -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deselect` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_children` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_metadata` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_collapsed` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_bottom` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_top` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`remove_child` **(** :ref:`Object` child **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`int` mode **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collapsed` **(** :ref:`bool` enable **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_children` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_metadata` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_collapsed` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_bottom` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_top` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`remove_child` **(** :ref:`Object` child **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`int` mode **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collapsed` **(** :ref:`bool` enable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -135,7 +135,7 @@ Member Function Description .. _class_TreeItem_add_button: -- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false **)** +- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** .. _class_TreeItem_clear_custom_bg_color: diff --git a/classes/class_tween.rst b/classes/class_tween.rst index e35e27c3a..e94f32d8a 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -80,8 +80,14 @@ Signals ------- - **tween_complete** **(** :ref:`Object` object, :ref:`String` key **)** +This signal is emitted when a tween ends. + - **tween_start** **(** :ref:`Object` object, :ref:`String` key **)** +This signal is emitted when a tween starts. + - **tween_step** **(** :ref:`Object` object, :ref:`String` key, :ref:`float` elapsed, :ref:`Object` value **)** +This signal is emitted each step of the tweening. + Numeric Constants ----------------- diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 93ea847b8..91f82f88a 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -27,6 +27,8 @@ Member Functions +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_radius` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_roll_influence` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_suspension_max_force` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_suspension_rest_length` **(** **)** const | @@ -35,6 +37,8 @@ Member Functions +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_suspension_travel` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_contact` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_used_as_steering` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_used_as_traction` **(** **)** const | @@ -47,6 +51,8 @@ Member Functions +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_radius` **(** :ref:`float` length **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_roll_influence` **(** :ref:`float` roll_influence **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_suspension_max_force` **(** :ref:`float` length **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_suspension_rest_length` **(** :ref:`float` length **)** | @@ -79,6 +85,10 @@ Member Function Description - :ref:`float` **get_radius** **(** **)** const +.. _class_VehicleWheel_get_roll_influence: + +- :ref:`float` **get_roll_influence** **(** **)** const + .. _class_VehicleWheel_get_suspension_max_force: - :ref:`float` **get_suspension_max_force** **(** **)** const @@ -95,6 +105,10 @@ Member Function Description - :ref:`float` **get_suspension_travel** **(** **)** const +.. _class_VehicleWheel_is_in_contact: + +- :ref:`bool` **is_in_contact** **(** **)** const + .. _class_VehicleWheel_is_used_as_steering: - :ref:`bool` **is_used_as_steering** **(** **)** const @@ -119,6 +133,10 @@ Member Function Description - void **set_radius** **(** :ref:`float` length **)** +.. _class_VehicleWheel_set_roll_influence: + +- void **set_roll_influence** **(** :ref:`float` roll_influence **)** + .. _class_VehicleWheel_set_suspension_max_force: - void **set_suspension_max_force** **(** :ref:`float` length **)** diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 66482409a..09359168e 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -138,6 +138,8 @@ Signals ------- - **size_changed** **(** **)** +Emitted when the size of the viewport is changed, whether by :ref:`set_size_override`, resize of window, or some other means. + Numeric Constants ----------------- diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index ba82c735c..8f78a5aa4 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -32,9 +32,17 @@ Signals ------- - **enter_camera** **(** :ref:`Object` camera **)** +Emitted when the VisibilityNotifier enters a :ref:`Camera`'s view. + - **enter_screen** **(** **)** +Emitted when the VisibilityNotifier enters the screen. + - **exit_camera** **(** :ref:`Object` camera **)** +Emitted when the VisibilityNotifier exits a :ref:`Camera`'s view. + - **exit_screen** **(** **)** +Emitted when the VisibilityNotifier exits the screen. + Description ----------- diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index d6d2a6e00..da7ce3199 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -32,9 +32,17 @@ Signals ------- - **enter_screen** **(** **)** +Emitted when the VisibilityNotifier2D enters the screen. + - **enter_viewport** **(** :ref:`Object` viewport **)** +Emitted when the VisibilityNotifier2D enters a :ref:`Viewport`. + - **exit_screen** **(** **)** +Emitted when the VisibilityNotifier2D exits the screen. + - **exit_viewport** **(** :ref:`Object` viewport **)** +Emitted when the VisibilityNotifier2D exits a :ref:`Viewport`. + Description ----------- diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index d9e9a7fd8..5e85a6c97 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -13,7 +13,7 @@ WorldEnvironment Brief Description ----------------- - +Sets environment properties for the entire scene Member Functions ---------------- @@ -24,6 +24,11 @@ Member Functions | void | :ref:`set_environment` **(** :ref:`Environment` env **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +Description +----------- + +The :ref:`WorldEnvironment` node can be added to a scene in order to set default :ref:`Environment` variables for the scene. The :ref:`WorldEnvironment` can be overridden by an :ref:`Environment` node set on the current :ref:`Camera`. Additionally, only one :ref:`WorldEnvironment` may be instanced in a given scene at a time. The :ref:`WorldEnvironment` allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). + Member Function Description --------------------------- @@ -31,8 +36,12 @@ Member Function Description - :ref:`Environment` **get_environment** **(** **)** const +Return the :ref:`Environment` currently bound. + .. _class_WorldEnvironment_set_environment: - void **set_environment** **(** :ref:`Environment` env **)** +Set the currently bound :ref:`Environment` to the one specified. +