stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 18:29:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current 2.1 branch

Browse Source
This commit is contained in:
Rémi Verschelde
2016-09-01 18:59:18 +02:00
parent 3ac75e771d
commit c182553382
14 changed files with 420 additions and 247 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_basebutton.rst
+2
View File
@@ -57,6 +57,8 @@ Member Functions
Signals
-------
- **button_down** **(** **)**
- **button_up** **(** **)**
- **pressed** **(** **)**
- **released** **(** **)**
- **toggled** **(** :ref:`bool<class_bool>` pressed **)**
classes/class_bitmapfont.rst
+30 -30
View File
@@ -18,42 +18,42 @@ Brief Description
Member Functions
----------------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_char<class_BitmapFont_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2((0, 0)), :ref:`float<class_float>` advance=-1 **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_kerning_pair<class_BitmapFont_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_texture<class_BitmapFont_add_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_BitmapFont_clear>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_from_fnt<class_BitmapFont_create_from_fnt>` **(** :ref:`String<class_string>` path **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_char_size<class_BitmapFont_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_fallback<class_BitmapFont_get_fallback>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_BitmapFont_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_get_texture_count>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ascent<class_BitmapFont_set_ascent>` **(** :ref:`float<class_float>` px **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_distance_field_hint<class_BitmapFont_set_distance_field_hint>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fallback<class_BitmapFont_set_fallback>` **(** :ref:`Object<class_object>` fallback **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_height<class_BitmapFont_set_height>` **(** :ref:`float<class_float>` px **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_char<class_BitmapFont_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2(0, 0), :ref:`float<class_float>` advance=-1 **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_kerning_pair<class_BitmapFont_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_texture<class_BitmapFont_add_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_BitmapFont_clear>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_from_fnt<class_BitmapFont_create_from_fnt>` **(** :ref:`String<class_string>` path **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_char_size<class_BitmapFont_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_fallback<class_BitmapFont_get_fallback>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_BitmapFont_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_get_texture_count>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ascent<class_BitmapFont_set_ascent>` **(** :ref:`float<class_float>` px **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_distance_field_hint<class_BitmapFont_set_distance_field_hint>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fallback<class_BitmapFont_set_fallback>` **(** :ref:`Object<class_object>` fallback **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_height<class_BitmapFont_set_height>` **(** :ref:`float<class_float>` px **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_BitmapFont_add_char:
- void **add_char** **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2((0, 0)), :ref:`float<class_float>` advance=-1 **)**
- void **add_char** **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2(0, 0), :ref:`float<class_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.
classes/class_control.rst
+4 -4
View File
@@ -53,7 +53,7 @@ Member Functions
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_constant<class_Control_get_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cursor_shape<class_Control_get_cursor_shape>` **(** :ref:`Vector2<class_vector2>` pos=Vector2((0, 0)) **)** const |
| :ref:`int<class_int>` | :ref:`get_cursor_shape<class_Control_get_cursor_shape>` **(** :ref:`Vector2<class_vector2>` pos=Vector2(0, 0) **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_custom_minimum_size<class_Control_get_custom_minimum_size>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -107,7 +107,7 @@ Member Functions
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Theme<class_theme>` | :ref:`get_theme<class_Control_get_theme>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_tooltip<class_Control_get_tooltip>` **(** :ref:`Vector2<class_vector2>` atpos=Vector2((0, 0)) **)** const |
| :ref:`String<class_string>` | :ref:`get_tooltip<class_Control_get_tooltip>` **(** :ref:`Vector2<class_vector2>` atpos=Vector2(0, 0) **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_v_size_flags<class_Control_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<class_int>` **get_cursor_shape** **(** :ref:`Vector2<class_vector2>` pos=Vector2((0, 0)) **)** const
- :ref:`int<class_int>` **get_cursor_shape** **(** :ref:`Vector2<class_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<class_theme>` override, if one exists (see :ref:`set_theme<
.. _class_Control_get_tooltip:
- :ref:`String<class_string>` **get_tooltip** **(** :ref:`Vector2<class_vector2>` atpos=Vector2((0, 0)) **)** const
- :ref:`String<class_string>` **get_tooltip** **(** :ref:`Vector2<class_vector2>` atpos=Vector2(0, 0) **)** const
Return the tooltip, which will appear when the cursor is resting over this control.
classes/class_curve2d.rst
+36 -36
View File
@@ -18,41 +18,41 @@ Describes a Bezier curve in 2D space.
Member Functions
----------------
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Curve2D_add_point>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`Vector2<class_vector2>` in=Vector2((0, 0)), :ref:`Vector2<class_vector2>` out=Vector2((0, 0)), :ref:`int<class_int>` atpos=-1 **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve2D_get_bake_interval>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve2D_get_baked_length>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_baked_points<class_Curve2D_get_baked_points>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve2D_get_point_count>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_in<class_Curve2D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_out<class_Curve2D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_pos<class_Curve2D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolate<class_Curve2D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolate_baked<class_Curve2D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolatef<class_Curve2D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve2D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve2D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve2D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve2D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve2D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`tesselate<class_Curve2D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Curve2D_add_point>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`Vector2<class_vector2>` in=Vector2(0, 0), :ref:`Vector2<class_vector2>` out=Vector2(0, 0), :ref:`int<class_int>` atpos=-1 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve2D_get_bake_interval>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve2D_get_baked_length>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_baked_points<class_Curve2D_get_baked_points>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve2D_get_point_count>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_in<class_Curve2D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_out<class_Curve2D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_pos<class_Curve2D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolate<class_Curve2D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolate_baked<class_Curve2D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolatef<class_Curve2D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve2D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve2D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve2D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve2D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve2D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`tesselate<class_Curve2D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -66,7 +66,7 @@ Member Function Description
.. _class_Curve2D_add_point:
- void **add_point** **(** :ref:`Vector2<class_vector2>` pos, :ref:`Vector2<class_vector2>` in=Vector2((0, 0)), :ref:`Vector2<class_vector2>` out=Vector2((0, 0)), :ref:`int<class_int>` atpos=-1 **)**
- void **add_point** **(** :ref:`Vector2<class_vector2>` pos, :ref:`Vector2<class_vector2>` in=Vector2(0, 0), :ref:`Vector2<class_vector2>` out=Vector2(0, 0), :ref:`int<class_int>` atpos=-1 **)**
Adds a point to a curve, at position "pos", with control points "in" and "out".
classes/class_curve3d.rst
+42 -42
View File
@@ -18,47 +18,47 @@ Describes a Bezier curve in 3D space.
Member Functions
----------------
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Curve3D_add_point>` **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` in=Vector3((0, 0, 0)), :ref:`Vector3<class_vector3>` out=Vector3((0, 0, 0)), :ref:`int<class_int>` atpos=-1 **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve3D_get_bake_interval>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve3D_get_baked_length>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_baked_points<class_Curve3D_get_baked_points>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RealArray<class_realarray>` | :ref:`get_baked_tilts<class_Curve3D_get_baked_tilts>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve3D_get_point_count>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_in<class_Curve3D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_out<class_Curve3D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_Curve3D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_tilt<class_Curve3D_get_point_tilt>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate<class_Curve3D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate_baked<class_Curve3D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolatef<class_Curve3D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve3D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve3D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve3D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve3D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve3D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_tilt<class_Curve3D_set_point_tilt>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`tesselate<class_Curve3D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Curve3D_add_point>` **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` in=Vector3(0, 0, 0), :ref:`Vector3<class_vector3>` out=Vector3(0, 0, 0), :ref:`int<class_int>` atpos=-1 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve3D_get_bake_interval>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve3D_get_baked_length>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_baked_points<class_Curve3D_get_baked_points>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RealArray<class_realarray>` | :ref:`get_baked_tilts<class_Curve3D_get_baked_tilts>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve3D_get_point_count>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_in<class_Curve3D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_out<class_Curve3D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_Curve3D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_tilt<class_Curve3D_get_point_tilt>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate<class_Curve3D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate_baked<class_Curve3D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolatef<class_Curve3D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve3D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve3D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve3D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve3D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve3D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_tilt<class_Curve3D_set_point_tilt>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`tesselate<class_Curve3D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -72,7 +72,7 @@ Member Function Description
.. _class_Curve3D_add_point:
- void **add_point** **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` in=Vector3((0, 0, 0)), :ref:`Vector3<class_vector3>` out=Vector3((0, 0, 0)), :ref:`int<class_int>` atpos=-1 **)**
- void **add_point** **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` in=Vector3(0, 0, 0), :ref:`Vector3<class_vector3>` out=Vector3(0, 0, 0), :ref:`int<class_int>` atpos=-1 **)**
Adds a point to a curve, at position "pos", with control points "in" and "out".
classes/class_editorplugin.rst
+32
View File
@@ -57,12 +57,16 @@ Member Functions
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`UndoRedo<class_undoredo>` | :ref:`get_undo_redo<class_EditorPlugin_get_undo_redo>` **(** **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_window_layout<class_EditorPlugin_get_window_layout>` **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`handles<class_EditorPlugin_handles>` **(** :ref:`Object<class_object>` object **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_main_screen<class_EditorPlugin_has_main_screen>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_visible<class_EditorPlugin_make_visible>` **(** :ref:`bool<class_bool>` visible **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`queue_save_layout<class_EditorPlugin_queue_save_layout>` **(** **)** const |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_bottom_panel<class_EditorPlugin_remove_control_from_bottom_panel>` **(** :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_docks<class_EditorPlugin_remove_control_from_docks>` **(** :ref:`Control<class_control>` control **)** |
@@ -73,8 +77,12 @@ Member Functions
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_import_plugin<class_EditorPlugin_remove_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` plugin **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`save_external_data<class_EditorPlugin_save_external_data>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_state<class_EditorPlugin_set_state>` **(** :ref:`Dictionary<class_dictionary>` state **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_layout<class_EditorPlugin_set_window_layout>` **(** :ref:`ConfigFile<class_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<class_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<class_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<class_bool>` **handles** **(** :ref:`Object<class_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<class_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<class_dictionary>` state **)** virtual
Restore the state saved by :ref:`EditorPlugin.get_state<class_EditorPlugin_get_state>`.
.. _class_EditorPlugin_set_window_layout:
- void **set_window_layout** **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual
Restore the plugin GUI layout saved by :ref:`EditorPlugin.get_window_layout<class_EditorPlugin_get_window_layout>`.
classes/class_editorsettings.rst
+30
View File
@@ -18,6 +18,8 @@ Object that holds the project-independent editor settings.
Member Functions
----------------
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_property_info<class_EditorSettings_add_property_info>` **(** :ref:`Dictionary<class_dictionary>` info **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase<class_EditorSettings_erase>` **(** :ref:`String<class_string>` property **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
@@ -55,6 +57,34 @@ Accessing the settings is done by using the regular :ref:`Object<class_object>`
Member Function Description
---------------------------
.. _class_EditorSettings_add_property_info:
- void **add_property_info** **(** :ref:`Dictionary<class_dictionary>` info **)**
Add a custom property info to a property. The dictionary must contain: name::ref:`String<class_string>`(the name of the property) and type::ref:`int<class_int>`(see TYPE\_\* in :ref:`@Global Scope<class_@global scope>`), and optionally hint::ref:`int<class_int>`(see PROPERTY_HINT\_\* in :ref:`@Global Scope<class_@global scope>`), hint_string::ref:`String<class_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<class_string>` property **)**
classes/class_globals.rst
+23
View File
@@ -18,6 +18,8 @@ Contains global variables accessible from everywhere.
Member Functions
----------------
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_property_info<class_Globals_add_property_info>` **(** :ref:`Dictionary<class_dictionary>` hint **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Globals_clear>` **(** :ref:`String<class_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<class_dictionary>` hint **)**
Add a custom property info to a property. The dictionary must contain: name::ref:`String<class_string>`(the name of the property) and type::ref:`int<class_int>`(see TYPE\_\* in :ref:`@Global Scope<class_@global scope>`), and optionally hint::ref:`int<class_int>`(see PROPERTY_HINT\_\* in :ref:`@Global Scope<class_@global scope>`), hint_string::ref:`String<class_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<class_string>` name **)**
classes/class_immediategeometry.rst
+2 -2
View File
@@ -23,7 +23,7 @@ Member Functions
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_vertex<class_ImmediateGeometry_add_vertex>` **(** :ref:`Vector3<class_vector3>` pos **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`begin<class_ImmediateGeometry_begin>` **(** :ref:`int<class_int>` primitive, :ref:`Texture<class_texture>` texture=Object() **)** |
| void | :ref:`begin<class_ImmediateGeometry_begin>` **(** :ref:`int<class_int>` primitive, :ref:`Texture<class_texture>` texture=NULL **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ImmediateGeometry_clear>` **(** **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -57,7 +57,7 @@ Add a vertex with the currently set color/uv/etc.
.. _class_ImmediateGeometry_begin:
- void **begin** **(** :ref:`int<class_int>` primitive, :ref:`Texture<class_texture>` texture=Object() **)**
- void **begin** **(** :ref:`int<class_int>` primitive, :ref:`Texture<class_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.
classes/class_input.rst
+2 -2
View File
@@ -63,7 +63,7 @@ Member Functions
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_joy_mapping<class_Input_remove_joy_mapping>` **(** :ref:`String<class_string>` guid **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_mouse_cursor<class_Input_set_custom_mouse_cursor>` **(** :ref:`Texture<class_texture>` image, :ref:`Vector2<class_vector2>` hotspot=Vector2((0, 0)) **)** |
| void | :ref:`set_custom_mouse_cursor<class_Input_set_custom_mouse_cursor>` **(** :ref:`Texture<class_texture>` image, :ref:`Vector2<class_vector2>` hotspot=Vector2(0, 0) **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mouse_mode<class_Input_set_mouse_mode>` **(** :ref:`int<class_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<class_texture>` image, :ref:`Vector2<class_vector2>` hotspot=Vector2((0, 0)) **)**
- void **set_custom_mouse_cursor** **(** :ref:`Texture<class_texture>` image, :ref:`Vector2<class_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.
classes/class_itemlist.rst
+81 -2
View File
@@ -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<class_texture>` icon, :ref:`bool<class_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<class_string>` text, :ref:`Texture<class_texture>` icon=NULL, :ref:`bool<class_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<class_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<class_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<class_vector2>` **get_fixed_icon_size** **(** **)** const
@@ -171,10 +196,14 @@ Member Function Description
- :ref:`int<class_int>` **get_item_at_pos** **(** :ref:`Vector2<class_vector2>` pos, :ref:`bool<class_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<class_int>` **get_item_count** **(** **)** const
Return count of items currently in the item list.
.. _class_ItemList_get_item_custom_bg_color:
- :ref:`Color<class_color>` **get_item_custom_bg_color** **(** :ref:`int<class_int>` idx **)** const
@@ -195,18 +224,26 @@ Member Function Description
- :ref:`String<class_string>` **get_item_text** **(** :ref:`int<class_int>` idx **)** const
Return the text for specified item index.
.. _class_ItemList_get_item_tooltip:
- :ref:`String<class_string>` **get_item_tooltip** **(** :ref:`int<class_int>` idx **)** const
Return tooltip hint for specified item index.
.. _class_ItemList_get_max_columns:
- :ref:`int<class_int>` **get_max_columns** **(** **)** const
Return total number of columns in use by the list.
.. _class_ItemList_get_max_text_lines:
- :ref:`int<class_int>` **get_max_text_lines** **(** **)** const
Return total number of lines currently in use by the list.
.. _class_ItemList_get_select_mode:
- :ref:`int<class_int>` **get_select_mode** **(** **)** const
@@ -215,40 +252,58 @@ Member Function Description
- :ref:`IntArray<class_intarray>` **get_selected_items** **(** **)**
Returns a list of selected indexes.
Returns the list of selected indexes.
.. _class_ItemList_is_item_disabled:
- :ref:`bool<class_bool>` **is_item_disabled** **(** :ref:`int<class_int>` idx **)** const
Returns whether or not the item at the specified index is disabled
.. _class_ItemList_is_item_selectable:
- :ref:`bool<class_bool>` **is_item_selectable** **(** :ref:`int<class_int>` idx **)** const
Returns whether or not the item at the specified index is selectable.
.. _class_ItemList_is_same_column_width:
- :ref:`int<class_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<class_bool>` **is_selected** **(** :ref:`int<class_int>` idx **)** const
Returns whether or not item at the specified index is currently selected.
.. _class_ItemList_remove_item:
- void **remove_item** **(** :ref:`int<class_int>` idx **)**
Remove item at specified index from the list.
.. _class_ItemList_select:
- void **select** **(** :ref:`int<class_int>` idx, :ref:`bool<class_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<class_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<class_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<class_vector2>` size **)**
@@ -269,10 +324,16 @@ Returns a list of selected indexes.
- void **set_item_disabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_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<class_int>` idx, :ref:`Texture<class_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<class_int>` idx, :ref:`Rect2<class_rect2>` rect **)**
@@ -281,30 +342,44 @@ Returns a list of selected indexes.
- void **set_item_metadata** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_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<class_int>` idx, :ref:`bool<class_bool>` selectable **)**
Allow or disallow selection of the item at the specified index.
.. _class_ItemList_set_item_text:
- void **set_item_text** **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` text **)**
Sets text of item at specified index.
.. _class_ItemList_set_item_tooltip:
- void **set_item_tooltip** **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` tooltip **)**
Sets tooltip hint for item at specified index.
.. _class_ItemList_set_max_columns:
- void **set_max_columns** **(** :ref:`int<class_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<class_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<class_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<class_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<class_int>` idx **)**
Ensure item at specified index is not selected.
classes/class_popup.rst
+15 -15
View File
@@ -20,19 +20,19 @@ Base container control for popups and dialogs.
Member Functions
----------------
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_exclusive<class_Popup_is_exclusive>` **(** **)** const |
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`popup<class_Popup_popup>` **(** **)** |
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`popup_centered<class_Popup_popup_centered>` **(** :ref:`Vector2<class_vector2>` size=Vector2((0, 0)) **)** |
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`popup_centered_minsize<class_Popup_popup_centered_minsize>` **(** :ref:`Vector2<class_vector2>` minsize=Vector2((0, 0)) **)** |
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`popup_centered_ratio<class_Popup_popup_centered_ratio>` **(** :ref:`float<class_float>` ratio=0.75 **)** |
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_exclusive<class_Popup_set_exclusive>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_exclusive<class_Popup_is_exclusive>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`popup<class_Popup_popup>` **(** **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`popup_centered<class_Popup_popup_centered>` **(** :ref:`Vector2<class_vector2>` size=Vector2(0, 0) **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`popup_centered_minsize<class_Popup_popup_centered_minsize>` **(** :ref:`Vector2<class_vector2>` minsize=Vector2(0, 0) **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`popup_centered_ratio<class_Popup_popup_centered_ratio>` **(** :ref:`float<class_float>` ratio=0.75 **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_exclusive<class_Popup_set_exclusive>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -68,13 +68,13 @@ Popup (show the control in modal form).
.. _class_Popup_popup_centered:
- void **popup_centered** **(** :ref:`Vector2<class_vector2>` size=Vector2((0, 0)) **)**
- void **popup_centered** **(** :ref:`Vector2<class_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<class_vector2>` minsize=Vector2((0, 0)) **)**
- void **popup_centered_minsize** **(** :ref:`Vector2<class_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``.
classes/class_undoredo.rst
+9 -2
View File
@@ -35,13 +35,20 @@ Member Functions
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`commit_action<class_UndoRedo_commit_action>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_action<class_UndoRedo_create_action>` **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` mergeable=false **)** |
| void | :ref:`create_action<class_UndoRedo_create_action>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` merge_mode=0 **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_action_name<class_UndoRedo_get_current_action_name>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_version<class_UndoRedo_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<class_string>` name, :ref:`bool<class_bool>` mergeable=false **)**
- void **create_action** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` merge_mode=0 **)**
Create a new action. After this is called, do all your calls to :ref:`add_do_method<class_UndoRedo_add_do_method>`, :ref:`add_undo_method<class_UndoRedo_add_undo_method>`, :ref:`add_do_property<class_UndoRedo_add_do_property>` and :ref:`add_undo_property<class_UndoRedo_add_undo_property>`.
classes/class_viewport.rst
+112 -112
View File
@@ -18,117 +18,117 @@ Creates a sub-view into the screen.
Member Functions
----------------
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`World<class_world>` | :ref:`find_world<class_Viewport_find_world>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`World2D<class_world2d>` | :ref:`find_world_2d<class_Viewport_find_world_2d>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Camera<class_camera>` | :ref:`get_camera<class_Viewport_get_camera>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_canvas_transform<class_Viewport_get_canvas_transform>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_final_transform<class_Viewport_get_final_transform>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_global_canvas_transform<class_Viewport_get_global_canvas_transform>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_mouse_pos<class_Viewport_get_mouse_pos>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_physics_object_picking<class_Viewport_get_physics_object_picking>` **(** **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_Viewport_get_rect>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_render_target_clear_on_new_frame<class_Viewport_get_render_target_clear_on_new_frame>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_render_target_filter<class_Viewport_get_render_target_filter>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_render_target_gen_mipmaps<class_Viewport_get_render_target_gen_mipmaps>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RenderTargetTexture<class_rendertargettexture>` | :ref:`get_render_target_texture<class_Viewport_get_render_target_texture>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_render_target_update_mode<class_Viewport_get_render_target_update_mode>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_render_target_vflip<class_Viewport_get_render_target_vflip>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`get_screen_capture<class_Viewport_get_screen_capture>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_size_override<class_Viewport_get_size_override>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_viewport<class_Viewport_get_viewport>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_visible_rect<class_Viewport_get_visible_rect>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`World<class_world>` | :ref:`get_world<class_Viewport_get_world>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`gui_get_drag_data<class_Viewport_gui_get_drag_data>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gui_has_modal_stack<class_Viewport_gui_has_modal_stack>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_transparent_background<class_Viewport_has_transparent_background>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`input<class_Viewport_input>` **(** :ref:`InputEvent<class_inputevent>` local_event **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_audio_listener<class_Viewport_is_audio_listener>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_audio_listener_2d<class_Viewport_is_audio_listener_2d>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_input_disabled<class_Viewport_is_input_disabled>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_set_as_render_target<class_Viewport_is_set_as_render_target>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_size_override_enabled<class_Viewport_is_size_override_enabled>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_size_override_stretch_enabled<class_Viewport_is_size_override_stretch_enabled>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_using_own_world<class_Viewport_is_using_own_world>` **(** **)** const |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`queue_screen_capture<class_Viewport_queue_screen_capture>` **(** **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`render_target_clear<class_Viewport_render_target_clear>` **(** **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_audio_listener<class_Viewport_set_as_audio_listener>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_audio_listener_2d<class_Viewport_set_as_audio_listener_2d>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_render_target<class_Viewport_set_as_render_target>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_canvas_transform<class_Viewport_set_canvas_transform>` **(** :ref:`Matrix32<class_matrix32>` xform **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_disable_input<class_Viewport_set_disable_input>` **(** :ref:`bool<class_bool>` disable **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_global_canvas_transform<class_Viewport_set_global_canvas_transform>` **(** :ref:`Matrix32<class_matrix32>` xform **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_physics_object_picking<class_Viewport_set_physics_object_picking>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rect<class_Viewport_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_clear_on_new_frame<class_Viewport_set_render_target_clear_on_new_frame>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_filter<class_Viewport_set_render_target_filter>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_gen_mipmaps<class_Viewport_set_render_target_gen_mipmaps>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_to_screen_rect<class_Viewport_set_render_target_to_screen_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_update_mode<class_Viewport_set_render_target_update_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_vflip<class_Viewport_set_render_target_vflip>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_size_override<class_Viewport_set_size_override>` **(** :ref:`bool<class_bool>` enable, :ref:`Vector2<class_vector2>` size=Vector2((-1, -1)), :ref:`Vector2<class_vector2>` margin=Vector2((0, 0)) **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_size_override_stretch<class_Viewport_set_size_override_stretch>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transparent_background<class_Viewport_set_transparent_background>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_own_world<class_Viewport_set_use_own_world>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_world<class_Viewport_set_world>` **(** :ref:`World<class_world>` world **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unhandled_input<class_Viewport_unhandled_input>` **(** :ref:`InputEvent<class_inputevent>` local_event **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_worlds<class_Viewport_update_worlds>` **(** **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`warp_mouse<class_Viewport_warp_mouse>` **(** :ref:`Vector2<class_vector2>` to_pos **)** |
+--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`World<class_world>` | :ref:`find_world<class_Viewport_find_world>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`World2D<class_world2d>` | :ref:`find_world_2d<class_Viewport_find_world_2d>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Camera<class_camera>` | :ref:`get_camera<class_Viewport_get_camera>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_canvas_transform<class_Viewport_get_canvas_transform>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_final_transform<class_Viewport_get_final_transform>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_global_canvas_transform<class_Viewport_get_global_canvas_transform>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_mouse_pos<class_Viewport_get_mouse_pos>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_physics_object_picking<class_Viewport_get_physics_object_picking>` **(** **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_Viewport_get_rect>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_render_target_clear_on_new_frame<class_Viewport_get_render_target_clear_on_new_frame>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_render_target_filter<class_Viewport_get_render_target_filter>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_render_target_gen_mipmaps<class_Viewport_get_render_target_gen_mipmaps>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RenderTargetTexture<class_rendertargettexture>` | :ref:`get_render_target_texture<class_Viewport_get_render_target_texture>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_render_target_update_mode<class_Viewport_get_render_target_update_mode>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_render_target_vflip<class_Viewport_get_render_target_vflip>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`get_screen_capture<class_Viewport_get_screen_capture>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_size_override<class_Viewport_get_size_override>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_viewport<class_Viewport_get_viewport>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_visible_rect<class_Viewport_get_visible_rect>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`World<class_world>` | :ref:`get_world<class_Viewport_get_world>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`gui_get_drag_data<class_Viewport_gui_get_drag_data>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gui_has_modal_stack<class_Viewport_gui_has_modal_stack>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_transparent_background<class_Viewport_has_transparent_background>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`input<class_Viewport_input>` **(** :ref:`InputEvent<class_inputevent>` local_event **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_audio_listener<class_Viewport_is_audio_listener>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_audio_listener_2d<class_Viewport_is_audio_listener_2d>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_input_disabled<class_Viewport_is_input_disabled>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_set_as_render_target<class_Viewport_is_set_as_render_target>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_size_override_enabled<class_Viewport_is_size_override_enabled>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_size_override_stretch_enabled<class_Viewport_is_size_override_stretch_enabled>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_using_own_world<class_Viewport_is_using_own_world>` **(** **)** const |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`queue_screen_capture<class_Viewport_queue_screen_capture>` **(** **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`render_target_clear<class_Viewport_render_target_clear>` **(** **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_audio_listener<class_Viewport_set_as_audio_listener>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_audio_listener_2d<class_Viewport_set_as_audio_listener_2d>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_render_target<class_Viewport_set_as_render_target>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_canvas_transform<class_Viewport_set_canvas_transform>` **(** :ref:`Matrix32<class_matrix32>` xform **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_disable_input<class_Viewport_set_disable_input>` **(** :ref:`bool<class_bool>` disable **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_global_canvas_transform<class_Viewport_set_global_canvas_transform>` **(** :ref:`Matrix32<class_matrix32>` xform **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_physics_object_picking<class_Viewport_set_physics_object_picking>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rect<class_Viewport_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_clear_on_new_frame<class_Viewport_set_render_target_clear_on_new_frame>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_filter<class_Viewport_set_render_target_filter>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_gen_mipmaps<class_Viewport_set_render_target_gen_mipmaps>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_to_screen_rect<class_Viewport_set_render_target_to_screen_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_update_mode<class_Viewport_set_render_target_update_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_target_vflip<class_Viewport_set_render_target_vflip>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_size_override<class_Viewport_set_size_override>` **(** :ref:`bool<class_bool>` enable, :ref:`Vector2<class_vector2>` size=Vector2(-1, -1), :ref:`Vector2<class_vector2>` margin=Vector2(0, 0) **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_size_override_stretch<class_Viewport_set_size_override_stretch>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transparent_background<class_Viewport_set_transparent_background>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_own_world<class_Viewport_set_use_own_world>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_world<class_Viewport_set_world>` **(** :ref:`World<class_world>` world **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unhandled_input<class_Viewport_unhandled_input>` **(** :ref:`InputEvent<class_inputevent>` local_event **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_worlds<class_Viewport_update_worlds>` **(** **)** |
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`warp_mouse<class_Viewport_warp_mouse>` **(** :ref:`Vector2<class_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<class_bool>` enable, :ref:`Vector2<class_vector2>` size=Vector2((-1, -1)), :ref:`Vector2<class_vector2>` margin=Vector2((0, 0)) **)**
- void **set_size_override** **(** :ref:`bool<class_bool>` enable, :ref:`Vector2<class_vector2>` size=Vector2(-1, -1), :ref:`Vector2<class_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.