diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index e433b847e..fda01376a 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -57,6 +57,8 @@ Member Functions Signals ------- +- **button_down** **(** **)** +- **button_up** **(** **)** - **pressed** **(** **)** - **released** **(** **)** - **toggled** **(** :ref:`bool` pressed **)** diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 54e1506f7..681c35778 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -18,42 +18,42 @@ Brief Description Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2((0, 0)), :ref:`float` advance=-1 **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_fallback` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_count` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ascent` **(** :ref:`float` px **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_distance_field_hint` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fallback` **(** :ref:`Object` fallback **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` px **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2(0, 0), :ref:`float` advance=-1 **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_fallback` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_texture_count` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ascent` **(** :ref:`float` px **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_distance_field_hint` **(** :ref:`bool` enable **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fallback` **(** :ref:`Object` fallback **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` px **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_BitmapFont_add_char: -- void **add_char** **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2((0, 0)), :ref:`float` advance=-1 **)** +- void **add_char** **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2(0, 0), :ref:`float` advance=-1 **)** Add a character to the font, where *character* is the unicode value, *texture* is the texture index, *rect* is the region in the texture (in pixels!), *align* is the (optional) alignment for the character and *advance* is the (optional) advance. diff --git a/classes/class_control.rst b/classes/class_control.rst index ccaa55f3e..1b4e0a2d1 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -53,7 +53,7 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cursor_shape` **(** :ref:`Vector2` pos=Vector2((0, 0)) **)** const | +| :ref:`int` | :ref:`get_cursor_shape` **(** :ref:`Vector2` pos=Vector2(0, 0) **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_custom_minimum_size` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -107,7 +107,7 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Theme` | :ref:`get_theme` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` atpos=Vector2((0, 0)) **)** const | +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` atpos=Vector2(0, 0) **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_v_size_flags` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -351,7 +351,7 @@ Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given marg .. _class_Control_get_cursor_shape: -- :ref:`int` **get_cursor_shape** **(** :ref:`Vector2` pos=Vector2((0, 0)) **)** const +- :ref:`int` **get_cursor_shape** **(** :ref:`Vector2` pos=Vector2(0, 0) **)** const Return the cursor shape at a certain position in the control. @@ -493,7 +493,7 @@ Return a :ref:`Theme` override, if one exists (see :ref:`set_theme< .. _class_Control_get_tooltip: -- :ref:`String` **get_tooltip** **(** :ref:`Vector2` atpos=Vector2((0, 0)) **)** const +- :ref:`String` **get_tooltip** **(** :ref:`Vector2` atpos=Vector2(0, 0) **)** const Return the tooltip, which will appear when the cursor is resting over this control. diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index e28dcf3bc..6b75db7ab 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -18,41 +18,41 @@ Describes a Bezier curve in 2D space. Member Functions ---------------- -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2((0, 0)), :ref:`Vector2` out=Vector2((0, 0)), :ref:`int` atpos=-1 **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`get_baked_points` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2Array` | :ref:`tesselate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2(0, 0), :ref:`Vector2` out=Vector2(0, 0), :ref:`int` atpos=-1 **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2Array` | :ref:`get_baked_points` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2Array` | :ref:`tesselate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -66,7 +66,7 @@ Member Function Description .. _class_Curve2D_add_point: -- void **add_point** **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2((0, 0)), :ref:`Vector2` out=Vector2((0, 0)), :ref:`int` atpos=-1 **)** +- void **add_point** **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2(0, 0), :ref:`Vector2` out=Vector2(0, 0), :ref:`int` atpos=-1 **)** Adds a point to a curve, at position "pos", with control points "in" and "out". diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index d17661117..c137e89ec 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -18,47 +18,47 @@ Describes a Bezier curve in 3D space. Member Functions ---------------- -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3((0, 0, 0)), :ref:`Vector3` out=Vector3((0, 0, 0)), :ref:`int` atpos=-1 **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`get_baked_points` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RealArray` | :ref:`get_baked_tilts` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3Array` | :ref:`tesselate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3(0, 0, 0), :ref:`Vector3` out=Vector3(0, 0, 0), :ref:`int` atpos=-1 **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3Array` | :ref:`get_baked_points` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RealArray` | :ref:`get_baked_tilts` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3Array` | :ref:`tesselate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -72,7 +72,7 @@ Member Function Description .. _class_Curve3D_add_point: -- void **add_point** **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3((0, 0, 0)), :ref:`Vector3` out=Vector3((0, 0, 0)), :ref:`int` atpos=-1 **)** +- void **add_point** **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3(0, 0, 0), :ref:`Vector3` out=Vector3(0, 0, 0), :ref:`int` atpos=-1 **)** Adds a point to a curve, at position "pos", with control points "in" and "out". diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 7e16dd1d7..177a4b978 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -57,12 +57,16 @@ Member Functions +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_main_screen` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_visible` **(** :ref:`bool` visible **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_save_layout` **(** **)** const | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | @@ -73,8 +77,12 @@ Member Functions +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` plugin **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`save_external_data` **(** **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -242,6 +250,12 @@ Get the state of your plugin editor. This is used when saving the scene (so stat Get the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. +.. _class_EditorPlugin_get_window_layout: + +- void **get_window_layout** **(** :ref:`ConfigFile` layout **)** virtual + +Get the GUI layout of the plugin. This is used to save the project's editor layout when the :ref:`EditorPlugin.queue_save_layout` is called or the editor layout was changed(For example changing the position of a dock). + .. _class_EditorPlugin_handles: - :ref:`bool` **handles** **(** :ref:`Object` object **)** virtual @@ -262,6 +276,12 @@ This function will be called when the editor is requested to become visible. It Remember that you have to manage the visibility of all your editor controls manually. +.. _class_EditorPlugin_queue_save_layout: + +- void **queue_save_layout** **(** **)** const + +Queue save the project's editor layout. + .. _class_EditorPlugin_remove_control_from_bottom_panel: - void **remove_control_from_bottom_panel** **(** :ref:`Control` control **)** @@ -292,10 +312,22 @@ Remove the export plugin, don't forget to call this on exit. Remove the import plugin, don't forget to call this on exit. +.. _class_EditorPlugin_save_external_data: + +- void **save_external_data** **(** **)** virtual + +This method is called after the editor save the project or when the it's closed. It asks the plugin to save edited external scenes/resources. + .. _class_EditorPlugin_set_state: - void **set_state** **(** :ref:`Dictionary` state **)** virtual Restore the state saved by :ref:`EditorPlugin.get_state`. +.. _class_EditorPlugin_set_window_layout: + +- void **set_window_layout** **(** :ref:`ConfigFile` layout **)** virtual + +Restore the plugin GUI layout saved by :ref:`EditorPlugin.get_window_layout`. + diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 8ac6aeaa8..a793b2b47 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -18,6 +18,8 @@ Object that holds the project-independent editor settings. Member Functions ---------------- ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase` **(** :ref:`String` property **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ @@ -55,6 +57,34 @@ Accessing the settings is done by using the regular :ref:`Object` Member Function Description --------------------------- +.. _class_EditorSettings_add_property_info: + +- void **add_property_info** **(** :ref:`Dictionary` info **)** + +Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@Global Scope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string::ref:`String`. + +Example: +:: + + +editor_settings.set("category/property_name", 0) + + + +var property_info = { + + "name": "category/property_name", + + "type": TYPE_INT, + + "hint": PROPERTY_HINT_ENUM, + + "hint_string": "one,two,three" + +} + + editor_settings.add_property_info(property_info) + .. _class_EditorSettings_erase: - void **erase** **(** :ref:`String` property **)** diff --git a/classes/class_globals.rst b/classes/class_globals.rst index aa2f65908..241e83e7d 100644 --- a/classes/class_globals.rst +++ b/classes/class_globals.rst @@ -18,6 +18,8 @@ Contains global variables accessible from everywhere. Member Functions ---------------- ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** :ref:`String` name **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ @@ -54,6 +56,27 @@ Contains global variables accessible from everywhere. Use the normal :ref:`Objec Member Function Description --------------------------- +.. _class_Globals_add_property_info: + +- void **add_property_info** **(** :ref:`Dictionary` hint **)** + +Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@Global Scope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string::ref:`String`. + +Example: + +:: + + Globals.set("category/property_name", 0) + + var property_info = { + "name": "category/property_name", + "type": TYPE_INT, + "hint": PROPERTY_HINT_ENUM, + "hint_string": "one,two,three" + } + + Globals.add_property_info(property_info) + .. _class_Globals_clear: - void **clear** **(** :ref:`String` name **)** diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index 518a2d182..6feeba05e 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -23,7 +23,7 @@ Member Functions +-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_vertex` **(** :ref:`Vector3` pos **)** | +-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`int` primitive, :ref:`Texture` texture=Object() **)** | +| void | :ref:`begin` **(** :ref:`int` primitive, :ref:`Texture` texture=NULL **)** | +-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -57,7 +57,7 @@ Add a vertex with the currently set color/uv/etc. .. _class_ImmediateGeometry_begin: -- void **begin** **(** :ref:`int` primitive, :ref:`Texture` texture=Object() **)** +- void **begin** **(** :ref:`int` primitive, :ref:`Texture` texture=NULL **)** Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references. diff --git a/classes/class_input.rst b/classes/class_input.rst index a23d67b4b..2c9b5c5ad 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -63,7 +63,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Texture` image, :ref:`Vector2` hotspot=Vector2((0, 0)) **)** | +| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Texture` image, :ref:`Vector2` hotspot=Vector2(0, 0) **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_mouse_mode` **(** :ref:`int` mode **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -222,7 +222,7 @@ Removes all mappings from the internal db that match the given uid. .. _class_Input_set_custom_mouse_cursor: -- void **set_custom_mouse_cursor** **(** :ref:`Texture` image, :ref:`Vector2` hotspot=Vector2((0, 0)) **)** +- void **set_custom_mouse_cursor** **(** :ref:`Texture` image, :ref:`Vector2` hotspot=Vector2(0, 0) **)** Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 41ef7e793..667ea3f2c 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -13,7 +13,7 @@ ItemList Brief Description ----------------- - +Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns. Member Functions ---------------- @@ -128,6 +128,17 @@ Numeric Constants - **SELECT_SINGLE** = **0** - **SELECT_MULTI** = **1** +Description +----------- + +This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, + +or both text and icon. Tooltips are supported and may be different for every item in the list. Selectable items in the list + +may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled + +to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key). + Member Function Description --------------------------- @@ -135,26 +146,40 @@ Member Function Description - void **add_icon_item** **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** +Adds an item to the item list with no text, only an icon. + .. _class_ItemList_add_item: - void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=NULL, :ref:`bool` selectable=true **)** +Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. + +If selectable is true the list item will be selectable. + .. _class_ItemList_clear: - void **clear** **(** **)** +Remove all items from the list. + .. _class_ItemList_ensure_current_is_visible: - void **ensure_current_is_visible** **(** **)** +Ensure selection is visible, adjusting the scroll position as necessary. + .. _class_ItemList_get_allow_rmb_select: - :ref:`bool` **get_allow_rmb_select** **(** **)** const +Return whether or not items may be selected via right mouse clicking. + .. _class_ItemList_get_fixed_column_width: - :ref:`int` **get_fixed_column_width** **(** **)** const +If column size has been fixed to a value, return that value. + .. _class_ItemList_get_fixed_icon_size: - :ref:`Vector2` **get_fixed_icon_size** **(** **)** const @@ -171,10 +196,14 @@ Member Function Description - :ref:`int` **get_item_at_pos** **(** :ref:`Vector2` pos, :ref:`bool` exact=false **)** const +Given a position within the control return the item (if any) at that point. + .. _class_ItemList_get_item_count: - :ref:`int` **get_item_count** **(** **)** const +Return count of items currently in the item list. + .. _class_ItemList_get_item_custom_bg_color: - :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** const @@ -195,18 +224,26 @@ Member Function Description - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const +Return the text for specified item index. + .. _class_ItemList_get_item_tooltip: - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const +Return tooltip hint for specified item index. + .. _class_ItemList_get_max_columns: - :ref:`int` **get_max_columns** **(** **)** const +Return total number of columns in use by the list. + .. _class_ItemList_get_max_text_lines: - :ref:`int` **get_max_text_lines** **(** **)** const +Return total number of lines currently in use by the list. + .. _class_ItemList_get_select_mode: - :ref:`int` **get_select_mode** **(** **)** const @@ -215,40 +252,58 @@ Member Function Description - :ref:`IntArray` **get_selected_items** **(** **)** -Returns a list of selected indexes. +Returns the list of selected indexes. .. _class_ItemList_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const +Returns whether or not the item at the specified index is disabled + .. _class_ItemList_is_item_selectable: - :ref:`bool` **is_item_selectable** **(** :ref:`int` idx **)** const +Returns whether or not the item at the specified index is selectable. + .. _class_ItemList_is_same_column_width: - :ref:`int` **is_same_column_width** **(** **)** const +Returns whether or not all columns of the list are of the same size. + .. _class_ItemList_is_selected: - :ref:`bool` **is_selected** **(** :ref:`int` idx **)** const +Returns whether or not item at the specified index is currently selected. + .. _class_ItemList_remove_item: - void **remove_item** **(** :ref:`int` idx **)** +Remove item at specified index from the list. + .. _class_ItemList_select: - void **select** **(** :ref:`int` idx, :ref:`bool` single=true **)** +Select the item at the specified index. + +Note: This method does not trigger the item selection signal. + .. _class_ItemList_set_allow_rmb_select: - void **set_allow_rmb_select** **(** :ref:`bool` allow **)** +Allow (or disallow) selection of (selectable) items in the list using right mouse button. + .. _class_ItemList_set_fixed_column_width: - void **set_fixed_column_width** **(** :ref:`int` width **)** +Set the size (width) all columns in the list are to use. + .. _class_ItemList_set_fixed_icon_size: - void **set_fixed_icon_size** **(** :ref:`Vector2` size **)** @@ -269,10 +324,16 @@ Returns a list of selected indexes. - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** +Disable (or enable) item at specified index. + +Disabled items are not be selectable and do not fire activation (Enter or double-click) signals. + .. _class_ItemList_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** +Set (or replace) icon of the item at the specified index. + .. _class_ItemList_set_item_icon_region: - void **set_item_icon_region** **(** :ref:`int` idx, :ref:`Rect2` rect **)** @@ -281,30 +342,44 @@ Returns a list of selected indexes. - void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** +Sets a value (of any type) to be stored with the item at the specified index. + .. _class_ItemList_set_item_selectable: - void **set_item_selectable** **(** :ref:`int` idx, :ref:`bool` selectable **)** +Allow or disallow selection of the item at the specified index. + .. _class_ItemList_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** +Sets text of item at specified index. + .. _class_ItemList_set_item_tooltip: - void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** +Sets tooltip hint for item at specified index. + .. _class_ItemList_set_max_columns: - void **set_max_columns** **(** :ref:`int` amount **)** +Set maximum number of columns to use for the list. + .. _class_ItemList_set_max_text_lines: - void **set_max_text_lines** **(** :ref:`int` lines **)** +Set maximum number of lines to use for the list. + .. _class_ItemList_set_same_column_width: - void **set_same_column_width** **(** :ref:`bool` enable **)** +Sets a fixed size (width) to use for all columns of the list. + .. _class_ItemList_set_select_mode: - void **set_select_mode** **(** :ref:`int` mode **)** @@ -313,8 +388,12 @@ Returns a list of selected indexes. - void **sort_items_by_text** **(** **)** +Sorts items in the list by their text. + .. _class_ItemList_unselect: - void **unselect** **(** :ref:`int` idx **)** +Ensure item at specified index is not selected. + diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 0baafb9bf..56ffe25ce 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -20,19 +20,19 @@ Base container control for popups and dialogs. Member Functions ---------------- -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_exclusive` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2((0, 0)) **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2((0, 0)) **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclusive` **(** :ref:`bool` enable **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_exclusive` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup` **(** **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2(0, 0) **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2(0, 0) **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclusive` **(** :ref:`bool` enable **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -68,13 +68,13 @@ Popup (show the control in modal form). .. _class_Popup_popup_centered: -- void **popup_centered** **(** :ref:`Vector2` size=Vector2((0, 0)) **)** +- void **popup_centered** **(** :ref:`Vector2` size=Vector2(0, 0) **)** Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". .. _class_Popup_popup_centered_minsize: -- void **popup_centered_minsize** **(** :ref:`Vector2` minsize=Vector2((0, 0)) **)** +- void **popup_centered_minsize** **(** :ref:`Vector2` minsize=Vector2(0, 0) **)** Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than ``minsize``. diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index bfcbe7646..0ec039ce7 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -35,13 +35,20 @@ Member Functions +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`commit_action` **(** **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_action` **(** :ref:`String` name, :ref:`bool` mergeable=false **)** | +| void | :ref:`create_action` **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_current_action_name` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_version` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Numeric Constants +----------------- + +- **MERGE_DISABLE** = **0** +- **MERGE_ENDS** = **1** +- **MERGE_ALL** = **2** + Description ----------- @@ -106,7 +113,7 @@ Commit the action. All 'do' methods/properties are called/set when this function .. _class_UndoRedo_create_action: -- void **create_action** **(** :ref:`String` name, :ref:`bool` mergeable=false **)** +- void **create_action** **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property` and :ref:`add_undo_property`. diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 7bc56a529..6d3f3993d 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -18,117 +18,117 @@ Creates a sub-view into the screen. Member Functions ---------------- -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`find_world` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Camera` | :ref:`get_camera` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_canvas_transform` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_final_transform` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_global_canvas_transform` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_mouse_pos` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_render_target_clear_on_new_frame` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_render_target_filter` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_render_target_gen_mipmaps` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RenderTargetTexture` | :ref:`get_render_target_texture` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_target_update_mode` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_render_target_vflip` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_screen_capture` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_viewport` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`get_world` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener_2d` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_input_disabled` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_render_target` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_screen_capture` **(** **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`render_target_clear` **(** **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_render_target` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_canvas_transform` **(** :ref:`Matrix32` xform **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_canvas_transform` **(** :ref:`Matrix32` xform **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_object_picking` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rect` **(** :ref:`Rect2` rect **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_clear_on_new_frame` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_filter` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_gen_mipmaps` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_to_screen_rect` **(** :ref:`Rect2` rect **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_update_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_render_target_vflip` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2((-1, -1)), :ref:`Vector2` margin=Vector2((0, 0)) **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world` **(** :ref:`World` world **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_worlds` **(** **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | -+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`find_world` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Camera` | :ref:`get_camera` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Matrix32` | :ref:`get_canvas_transform` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Matrix32` | :ref:`get_final_transform` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Matrix32` | :ref:`get_global_canvas_transform` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_mouse_pos` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_render_target_clear_on_new_frame` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_render_target_filter` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_render_target_gen_mipmaps` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RenderTargetTexture` | :ref:`get_render_target_texture` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_render_target_update_mode` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_render_target_vflip` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_screen_capture` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_viewport` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`get_world` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_audio_listener` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_audio_listener_2d` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_input_disabled` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_render_target` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_screen_capture` **(** **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`render_target_clear` **(** **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_render_target` **(** :ref:`bool` enable **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_canvas_transform` **(** :ref:`Matrix32` xform **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_canvas_transform` **(** :ref:`Matrix32` xform **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_physics_object_picking` **(** :ref:`bool` enable **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rect` **(** :ref:`Rect2` rect **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_render_target_clear_on_new_frame` **(** :ref:`bool` enable **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_render_target_filter` **(** :ref:`bool` enable **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_render_target_gen_mipmaps` **(** :ref:`bool` enable **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_render_target_to_screen_rect` **(** :ref:`Rect2` rect **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_render_target_update_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_render_target_vflip` **(** :ref:`bool` enable **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2(-1, -1), :ref:`Vector2` margin=Vector2(0, 0) **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world` **(** :ref:`World` world **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_worlds` **(** **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -443,7 +443,7 @@ Set whether the render target should be flipped on the Y axis. .. _class_Viewport_set_size_override: -- void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2((-1, -1)), :ref:`Vector2` margin=Vector2((0, 0)) **)** +- void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2(-1, -1), :ref:`Vector2` margin=Vector2(0, 0) **)** Set the size of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to ``(-1, -1)``, it won't update the size.