godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current 2.1 XML

Browse Source
This commit is contained in:
Rémi Verschelde
2016-11-19 14:32:56 +01:00
parent 7400cce692
commit 503b242a94
31 changed files with 800 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
classes/class_area.rst
View File

@@ -88,9 +88,9 @@ Signals
-------
- **area_enter** **(** :ref:`Object<class_object>` area **)**
- **area_enter_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` area_shape **)**
- **area_enter_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **area_exit** **(** :ref:`Object<class_object>` area **)**
- **area_exit_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` area_shape **)**
- **area_exit_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **body_enter** **(** :ref:`Object<class_object>` body **)**
- **body_enter_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **body_exit** **(** :ref:`Object<class_object>` body **)**

4
classes/class_area2d.rst
View File

@@ -88,9 +88,9 @@ Signals
-------
- **area_enter** **(** :ref:`Object<class_object>` area **)**
- **area_enter_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` area_shape **)**
- **area_enter_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **area_exit** **(** :ref:`Object<class_object>` area **)**
- **area_exit_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` area_shape **)**
- **area_exit_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
- **body_enter** **(** :ref:`Object<class_object>` body **)**
- **body_enter_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **body_exit** **(** :ref:`Object<class_object>` body **)**

104
classes/class_astar.rst Normal file
View File

@@ -0,0 +1,104 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_AStar:
AStar
=====
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_AStar_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_AStar_clear>` **(** **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`connect_points<class_AStar_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_get_available_point_id>` **(** **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_get_closest_point>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_closest_pos_in_segment<class_AStar_get_closest_pos_in_segment>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`get_id_path<class_AStar_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_point_path<class_AStar_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_AStar_get_point_pos>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_AStar_remove_point>` **(** :ref:`int<class_int>` id **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_AStar_add_point:
- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)**
.. _class_AStar_are_points_connected:
- :ref:`bool<class_bool>` **are_points_connected** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const
.. _class_AStar_clear:
- void **clear** **(** **)**
.. _class_AStar_connect_points:
- void **connect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)**
.. _class_AStar_disconnect_points:
- void **disconnect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)**
.. _class_AStar_get_available_point_id:
- :ref:`int<class_int>` **get_available_point_id** **(** **)** const
.. _class_AStar_get_closest_point:
- :ref:`int<class_int>` **get_closest_point** **(** :ref:`Vector3<class_vector3>` to_pos **)** const
.. _class_AStar_get_closest_pos_in_segment:
- :ref:`Vector3<class_vector3>` **get_closest_pos_in_segment** **(** :ref:`Vector3<class_vector3>` to_pos **)** const
.. _class_AStar_get_id_path:
- :ref:`IntArray<class_intarray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
.. _class_AStar_get_point_path:
- :ref:`Vector3Array<class_vector3array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
.. _class_AStar_get_point_pos:
- :ref:`Vector3<class_vector3>` **get_point_pos** **(** :ref:`int<class_int>` id **)** const
.. _class_AStar_get_point_weight_scale:
- :ref:`float<class_float>` **get_point_weight_scale** **(** :ref:`int<class_int>` id **)** const
.. _class_AStar_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` id **)**

66
classes/class_buttonarray.rst
View File

@@ -20,31 +20,35 @@ Array of Buttons.
Member Functions
----------------
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_button<class_ButtonArray_add_button>` **(** :ref:`String<class_string>` text **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_icon_button<class_ButtonArray_add_icon_button>` **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text="" **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ButtonArray_clear>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_button<class_ButtonArray_erase_button>` **(** :ref:`int<class_int>` button_idx **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_button_count<class_ButtonArray_get_button_count>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_button_icon<class_ButtonArray_get_button_icon>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_button_text<class_ButtonArray_get_button_text>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_hovered<class_ButtonArray_get_hovered>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selected<class_ButtonArray_get_selected>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_icon<class_ButtonArray_set_button_icon>` **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_text<class_ButtonArray_set_button_text>` **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_ButtonArray_set_selected>` **(** :ref:`int<class_int>` button_idx **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_button<class_ButtonArray_add_button>` **(** :ref:`String<class_string>` text, :ref:`String<class_string>` tooltip="" **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_icon_button<class_ButtonArray_add_icon_button>` **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text="", :ref:`String<class_string>` tooltip="" **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ButtonArray_clear>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_button<class_ButtonArray_erase_button>` **(** :ref:`int<class_int>` button_idx **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_button_count<class_ButtonArray_get_button_count>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_button_icon<class_ButtonArray_get_button_icon>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_button_text<class_ButtonArray_get_button_text>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_button_tooltip<class_ButtonArray_get_button_tooltip>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_hovered<class_ButtonArray_get_hovered>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selected<class_ButtonArray_get_selected>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_icon<class_ButtonArray_set_button_icon>` **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_text<class_ButtonArray_set_button_text>` **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_tooltip<class_ButtonArray_set_button_tooltip>` **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_ButtonArray_set_selected>` **(** :ref:`int<class_int>` button_idx **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -72,13 +76,13 @@ Member Function Description
.. _class_ButtonArray_add_button:
- void **add_button** **(** :ref:`String<class_string>` text **)**
- void **add_button** **(** :ref:`String<class_string>` text, :ref:`String<class_string>` tooltip="" **)**
Append a new button to the array, with the specified text.
.. _class_ButtonArray_add_icon_button:
- void **add_icon_button** **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text="" **)**
- void **add_icon_button** **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text="", :ref:`String<class_string>` tooltip="" **)**
Append a new button to the array, with the specified icon and text.
@@ -112,6 +116,10 @@ Return the icon of the specified button.
Return the text of the specified button.
.. _class_ButtonArray_get_button_tooltip:
- :ref:`String<class_string>` **get_button_tooltip** **(** :ref:`int<class_int>` button_idx **)** const
.. _class_ButtonArray_get_hovered:
- :ref:`int<class_int>` **get_hovered** **(** **)** const
@@ -136,6 +144,10 @@ Set the icon of the specified button.
Define the text of the specified button.
.. _class_ButtonArray_set_button_tooltip:
- void **set_button_tooltip** **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)**
.. _class_ButtonArray_set_selected:
- void **set_selected** **(** :ref:`int<class_int>` button_idx **)**

5
classes/class_buttongroup.rst
View File

@@ -30,6 +30,11 @@ Member Functions
| void | :ref:`set_pressed_button<class_ButtonGroup_set_pressed_button>` **(** :ref:`BaseButton<class_basebutton>` button **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **button_selected** **(** :ref:`Object<class_object>` button **)**
Description
-----------

24
classes/class_camera.rst
View File

@@ -29,12 +29,16 @@ Member Functions
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_fov<class_Camera_get_fov>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera_get_h_offset>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_keep_aspect_mode<class_Camera_get_keep_aspect_mode>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_projection<class_Camera_get_projection>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_size<class_Camera_get_size>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera_get_v_offset>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_visible_layers<class_Camera_get_visible_layers>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_zfar<class_Camera_get_zfar>` **(** **)** const |
@@ -57,12 +61,16 @@ Member Functions
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_environment<class_Camera_set_environment>` **(** :ref:`Environment<class_environment>` env **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_offset<class_Camera_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_keep_aspect_mode<class_Camera_set_keep_aspect_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_orthogonal<class_Camera_set_orthogonal>` **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_perspective<class_Camera_set_perspective>` **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_v_offset<class_Camera_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_visible_layers<class_Camera_set_visible_layers>` **(** :ref:`int<class_int>` mask **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`unproject_position<class_Camera_unproject_position>` **(** :ref:`Vector3<class_vector3>` world_point **)** const |
@@ -102,6 +110,10 @@ Get the camera transform. Subclassed cameras (such as CharacterCamera) may provi
- :ref:`float<class_float>` **get_fov** **(** **)** const
.. _class_Camera_get_h_offset:
- :ref:`float<class_float>` **get_h_offset** **(** **)** const
.. _class_Camera_get_keep_aspect_mode:
- :ref:`int<class_int>` **get_keep_aspect_mode** **(** **)** const
@@ -114,6 +126,10 @@ Get the camera transform. Subclassed cameras (such as CharacterCamera) may provi
- :ref:`float<class_float>` **get_size** **(** **)** const
.. _class_Camera_get_v_offset:
- :ref:`float<class_float>` **get_v_offset** **(** **)** const
.. _class_Camera_get_visible_layers:
- :ref:`int<class_int>` **get_visible_layers** **(** **)** const
@@ -166,6 +182,10 @@ Return a 3D position in worldspace, that is the result of projecting a point on
- void **set_environment** **(** :ref:`Environment<class_environment>` env **)**
.. _class_Camera_set_h_offset:
- void **set_h_offset** **(** :ref:`float<class_float>` ofs **)**
.. _class_Camera_set_keep_aspect_mode:
- void **set_keep_aspect_mode** **(** :ref:`int<class_int>` mode **)**
@@ -182,6 +202,10 @@ Set the camera projection to orthogonal mode, by specifying a width and the *nea
Set the camera projection to perspective mode, by specifying a *FOV* Y angle in degrees (FOV means Field of View), and the *near* and *far* clip planes in worldspace units.
.. _class_Camera_set_v_offset:
- void **set_v_offset** **(** :ref:`float<class_float>` ofs **)**
.. _class_Camera_set_visible_layers:
- void **set_visible_layers** **(** :ref:`int<class_int>` mask **)**

2
classes/class_directory.rst
View File

@@ -150,7 +150,7 @@ On Unix desktop systems, return the available space on the current directory's d
Initialise the stream used to list all files and directories using the :ref:`get_next<class_Directory_get_next>` function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with :ref:`list_dir_end<class_Directory_list_dir_end>`.
Return false if the stream could not be initialised.
Return true if the stream could not be initialised.
.. _class_Directory_list_dir_end:

8
classes/class_editorplugin.rst
View File

@@ -49,6 +49,8 @@ Member Functions
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorSettings<class_editorsettings>` | :ref:`get_editor_settings<class_EditorPlugin_get_editor_settings>` **(** **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_control>` | :ref:`get_editor_viewport<class_EditorPlugin_get_editor_viewport>` **(** **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_name<class_EditorPlugin_get_name>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorSelection<class_editorselection>` | :ref:`get_selection<class_EditorPlugin_get_selection>` **(** **)** |
@@ -226,6 +228,12 @@ This is for editors that edit script based objects. You can return a list of bre
Get the general settings for the editor (the same window that appears in the Settings menu).
.. _class_EditorPlugin_get_editor_viewport:
- :ref:`Control<class_control>` **get_editor_viewport** **(** **)**
Get the main editor control. Use this as a parent for main screens.
.. _class_EditorPlugin_get_name:
- :ref:`String<class_string>` **get_name** **(** **)** virtual

58
classes/class_httprequest.rst
View File

@@ -18,33 +18,33 @@ A Node with the ability to send HTTP requests.
Member Functions
----------------
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cancel_request<class_HTTPRequest_cancel_request>` **(** **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_body_size<class_HTTPRequest_get_body_size>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_body_size_limit<class_HTTPRequest_get_body_size_limit>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_download_file<class_HTTPRequest_get_download_file>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_downloaded_bytes<class_HTTPRequest_get_downloaded_bytes>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_http_client_status<class_HTTPRequest_get_http_client_status>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_max_redirects<class_HTTPRequest_get_max_redirects>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_using_threads<class_HTTPRequest_is_using_threads>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`request<class_HTTPRequest_request>` **(** :ref:`String<class_string>` url, :ref:`StringArray<class_stringarray>` custom_headers=StringArray([]), :ref:`bool<class_bool>` ssl_validate_domain=true **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_body_size_limit<class_HTTPRequest_set_body_size_limit>` **(** :ref:`int<class_int>` bytes **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_download_file<class_HTTPRequest_set_download_file>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_max_redirects<class_HTTPRequest_set_max_redirects>` **(** :ref:`int<class_int>` amount **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_threads<class_HTTPRequest_set_use_threads>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cancel_request<class_HTTPRequest_cancel_request>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_body_size<class_HTTPRequest_get_body_size>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_body_size_limit<class_HTTPRequest_get_body_size_limit>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_download_file<class_HTTPRequest_get_download_file>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_downloaded_bytes<class_HTTPRequest_get_downloaded_bytes>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_http_client_status<class_HTTPRequest_get_http_client_status>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_max_redirects<class_HTTPRequest_get_max_redirects>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_using_threads<class_HTTPRequest_is_using_threads>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`request<class_HTTPRequest_request>` **(** :ref:`String<class_string>` url, :ref:`StringArray<class_stringarray>` custom_headers=StringArray([]), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`int<class_int>` method=0, :ref:`String<class_string>` request_data="" **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_body_size_limit<class_HTTPRequest_set_body_size_limit>` **(** :ref:`int<class_int>` bytes **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_download_file<class_HTTPRequest_set_download_file>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_max_redirects<class_HTTPRequest_set_max_redirects>` **(** :ref:`int<class_int>` amount **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_threads<class_HTTPRequest_set_use_threads>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -127,9 +127,9 @@ Whether this request is using threads.
.. _class_HTTPRequest_request:
- :ref:`int<class_int>` **request** **(** :ref:`String<class_string>` url, :ref:`StringArray<class_stringarray>` custom_headers=StringArray([]), :ref:`bool<class_bool>` ssl_validate_domain=true **)**
- :ref:`int<class_int>` **request** **(** :ref:`String<class_string>` url, :ref:`StringArray<class_stringarray>` custom_headers=StringArray([]), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`int<class_int>` method=0, :ref:`String<class_string>` request_data="" **)**
Make a HTTP GET request. The url is the complete url including "http://" or "https://" which will be parsed for a host and a port.
Make a HTTP request (by default GET, unless specified otherwise as method). The url is the complete url including "http://" or "https://" which will be parsed for a host and a port.
The custom_headers are HTTP request headers which will be used. If User-Agent is not specified a Godot specific will be used.

44
classes/class_immediategeometry.rst
View File

@@ -18,34 +18,34 @@ Node to draw simple geometry from code, ala OpenGL 1.x
Member Functions
----------------
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_sphere<class_ImmediateGeometry_add_sphere>` **(** :ref:`int<class_int>` lats, :ref:`int<class_int>` lons, :ref:`float<class_float>` radius **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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=NULL **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ImmediateGeometry_clear>` **(** **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`end<class_ImmediateGeometry_end>` **(** **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ImmediateGeometry_set_color>` **(** :ref:`Color<class_color>` color **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_normal<class_ImmediateGeometry_set_normal>` **(** :ref:`Vector3<class_vector3>` normal **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tangent<class_ImmediateGeometry_set_tangent>` **(** :ref:`Plane<class_plane>` tangent **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv<class_ImmediateGeometry_set_uv>` **(** :ref:`Vector2<class_vector2>` uv **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv2<class_ImmediateGeometry_set_uv2>` **(** :ref:`Vector2<class_vector2>` uv **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_sphere<class_ImmediateGeometry_add_sphere>` **(** :ref:`int<class_int>` lats, :ref:`int<class_int>` lons, :ref:`float<class_float>` radius, :ref:`bool<class_bool>` add_uv=true **)** |
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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=NULL **)** |
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ImmediateGeometry_clear>` **(** **)** |
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`end<class_ImmediateGeometry_end>` **(** **)** |
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ImmediateGeometry_set_color>` **(** :ref:`Color<class_color>` color **)** |
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_normal<class_ImmediateGeometry_set_normal>` **(** :ref:`Vector3<class_vector3>` normal **)** |
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tangent<class_ImmediateGeometry_set_tangent>` **(** :ref:`Plane<class_plane>` tangent **)** |
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv<class_ImmediateGeometry_set_uv>` **(** :ref:`Vector2<class_vector2>` uv **)** |
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv2<class_ImmediateGeometry_set_uv2>` **(** :ref:`Vector2<class_vector2>` uv **)** |
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_ImmediateGeometry_add_sphere:
- void **add_sphere** **(** :ref:`int<class_int>` lats, :ref:`int<class_int>` lons, :ref:`float<class_float>` radius **)**
- void **add_sphere** **(** :ref:`int<class_int>` lats, :ref:`int<class_int>` lons, :ref:`float<class_float>` radius, :ref:`bool<class_bool>` add_uv=true **)**
Simple helper to draw an uvsphere, with given latitudes, longitude and radius.

28
classes/class_input.rst
View File

@@ -35,6 +35,14 @@ Member Functions
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_axis<class_Input_get_joy_axis>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_axis_index_from_string<class_Input_get_joy_axis_index_from_string>` **(** :ref:`String<class_string>` axis **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_axis_string<class_Input_get_joy_axis_string>` **(** :ref:`int<class_int>` axis_index **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_button_index_from_string<class_Input_get_joy_button_index_from_string>` **(** :ref:`String<class_string>` button **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_button_string<class_Input_get_joy_button_string>` **(** :ref:`int<class_int>` button_index **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_guid<class_Input_get_joy_guid>` **(** :ref:`int<class_int>` device **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_name<class_Input_get_joy_name>` **(** :ref:`int<class_int>` device **)** |
@@ -136,6 +144,22 @@ If the device has a gyroscope, this will return the rate of rotation in rad/s ar
Returns the current value of the joystick axis at given index (see JOY\_\* constants in :ref:`@Global Scope<class_@global scope>`)
.. _class_Input_get_joy_axis_index_from_string:
- :ref:`int<class_int>` **get_joy_axis_index_from_string** **(** :ref:`String<class_string>` axis **)**
.. _class_Input_get_joy_axis_string:
- :ref:`String<class_string>` **get_joy_axis_string** **(** :ref:`int<class_int>` axis_index **)**
.. _class_Input_get_joy_button_index_from_string:
- :ref:`int<class_int>` **get_joy_button_index_from_string** **(** :ref:`String<class_string>` button **)**
.. _class_Input_get_joy_button_string:
- :ref:`String<class_string>` **get_joy_button_string** **(** :ref:`int<class_int>` button_index **)**
.. _class_Input_get_joy_guid:
- :ref:`String<class_string>` **get_joy_guid** **(** :ref:`int<class_int>` device **)** const
@@ -236,7 +260,9 @@ Set the mouse mode. See the constants for more information.
- void **start_joy_vibration** **(** :ref:`int<class_int>` device, :ref:`float<class_float>` weak_magnitude, :ref:`float<class_float>` strong_magnitude, :ref:`float<class_float>` duration=0 **)**
Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will play the vibration indefinitely).
Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely).
Note that not every hardware is compatible with long effect durations, it is recommended to restart an effect if in need to play it for more than a few seconds.
.. _class_Input_stop_joy_vibration:

16
classes/class_instanceplaceholder.rst
View File

@@ -18,11 +18,13 @@ Placeholder for the root :ref:`Node<class_node>` of a :ref:`PackedScene<class_pa
Member Functions
----------------
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_instance_path<class_InstancePlaceholder_get_instance_path>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`replace_by_instance<class_InstancePlaceholder_replace_by_instance>` **(** :ref:`PackedScene<class_packedscene>` custom_scene=NULL **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_instance_path<class_InstancePlaceholder_get_instance_path>` **(** **)** const |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_stored_values<class_InstancePlaceholder_get_stored_values>` **(** :ref:`bool<class_bool>` with_order=false **)** |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`replace_by_instance<class_InstancePlaceholder_replace_by_instance>` **(** :ref:`PackedScene<class_packedscene>` custom_scene=NULL **)** |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -40,6 +42,10 @@ Member Function Description
Retrieve the path to the :ref:`PackedScene<class_packedscene>` resource file that is loaded by default when calling :ref:`replace_by_instance<class_InstancePlaceholder_replace_by_instance>`.
.. _class_InstancePlaceholder_get_stored_values:
- :ref:`Dictionary<class_dictionary>` **get_stored_values** **(** :ref:`bool<class_bool>` with_order=false **)**
.. _class_InstancePlaceholder_replace_by_instance:
- void **replace_by_instance** **(** :ref:`PackedScene<class_packedscene>` custom_scene=NULL **)**

24
classes/class_itemlist.rst
View File

@@ -61,10 +61,14 @@ Member Functions
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`get_selected_items<class_ItemList_get_selected_items>` **(** **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_v_scroll<class_ItemList_get_v_scroll>` **(** **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_disabled<class_ItemList_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_selectable<class_ItemList_is_item_selectable>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_tooltip_enabled<class_ItemList_is_item_tooltip_enabled>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`is_same_column_width<class_ItemList_is_same_column_width>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selected<class_ItemList_is_selected>` **(** :ref:`int<class_int>` idx **)** const |
@@ -99,6 +103,8 @@ Member Functions
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_tooltip<class_ItemList_set_item_tooltip>` **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` tooltip **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_tooltip_enabled<class_ItemList_set_item_tooltip_enabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_max_columns<class_ItemList_set_max_columns>` **(** :ref:`int<class_int>` amount **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_max_text_lines<class_ItemList_set_max_text_lines>` **(** :ref:`int<class_int>` lines **)** |
@@ -254,6 +260,12 @@ Return total number of lines currently in use by the list.
Returns the list of selected indexes.
.. _class_ItemList_get_v_scroll:
- :ref:`Object<class_object>` **get_v_scroll** **(** **)**
Returns the current vertical scroll bar for the List.
.. _class_ItemList_is_item_disabled:
- :ref:`bool<class_bool>` **is_item_disabled** **(** :ref:`int<class_int>` idx **)** const
@@ -266,6 +278,12 @@ Returns whether or not the item at the specified index is disabled
Returns whether or not the item at the specified index is selectable.
.. _class_ItemList_is_item_tooltip_enabled:
- :ref:`bool<class_bool>` **is_item_tooltip_enabled** **(** :ref:`int<class_int>` idx **)** const
Returns whether the tooptip is enabled for specified item index.
.. _class_ItemList_is_same_column_width:
- :ref:`int<class_int>` **is_same_column_width** **(** **)** const
@@ -362,6 +380,12 @@ Sets text of item at specified index.
Sets tooltip hint for item at specified index.
.. _class_ItemList_set_item_tooltip_enabled:
- void **set_item_tooltip_enabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**
Sets whether the tooltip is enabled for specified item index.
.. _class_ItemList_set_max_columns:
- void **set_max_columns** **(** :ref:`int<class_int>` amount **)**

12
classes/class_light2d.rst
View File

@@ -51,12 +51,16 @@ Member Functions
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_z_range_min<class_Light2D_get_z_range_min>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editor_only<class_Light2D_is_editor_only>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_enabled<class_Light2D_is_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_shadow_enabled<class_Light2D_is_shadow_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_Light2D_set_color>` **(** :ref:`Color<class_color>` color **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_editor_only<class_Light2D_set_editor_only>` **(** :ref:`bool<class_bool>` editor_only **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enabled<class_Light2D_set_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_energy<class_Light2D_set_energy>` **(** :ref:`float<class_float>` energy **)** |
@@ -204,6 +208,10 @@ Get the maximum Z value that objects of the scene can be in order to be affected
Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D.
.. _class_Light2D_is_editor_only:
- :ref:`bool<class_bool>` **is_editor_only** **(** **)** const
.. _class_Light2D_is_enabled:
- :ref:`bool<class_bool>` **is_enabled** **(** **)** const
@@ -222,6 +230,10 @@ Return true if shadow casting is enabled for this Light2D, else return false.
Set the color of the Light2D.
.. _class_Light2D_set_editor_only:
- void **set_editor_only** **(** :ref:`bool<class_bool>` editor_only **)**
.. _class_Light2D_set_enabled:
- void **set_enabled** **(** :ref:`bool<class_bool>` enabled **)**

1
classes/class_linkbutton.rst
View File

@@ -33,6 +33,7 @@ Numeric Constants
- **UNDERLINE_MODE_ALWAYS** = **0** --- The LinkButton will always show an underline at the bottom of its text
- **UNDERLINE_MODE_ON_HOVER** = **1** --- The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it.
- **UNDERLINE_MODE_NEVER** = **2** --- The LinkButton will never show an underline at the bottom of its text.
Description
-----------

6
classes/class_os.rst
View File

@@ -153,7 +153,7 @@ Member Functions
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_video_mode_resizable<class_OS_is_video_mode_resizable>` **(** :ref:`int<class_int>` screen=0 **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_vsnc_enabled<class_OS_is_vsnc_enabled>` **(** **)** const |
| :ref:`bool<class_bool>` | :ref:`is_vsync_enabled<class_OS_is_vsync_enabled>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_window_fullscreen<class_OS_is_window_fullscreen>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -698,9 +698,9 @@ Return true if the current video mode is fullscreen.
Return true if the window is resizable.
.. _class_OS_is_vsnc_enabled:
.. _class_OS_is_vsync_enabled:
- :ref:`bool<class_bool>` **is_vsnc_enabled** **(** **)** const
- :ref:`bool<class_bool>` **is_vsync_enabled** **(** **)** const
.. _class_OS_is_window_fullscreen:

4
classes/class_particles2d.rst
View File

@@ -123,12 +123,12 @@ Member Functions
Numeric Constants
-----------------
- **PARAM_DIRECTION** = **0** --- Direction in radians at which the particles will be launched, Notice that when the direction is set to 0 the particles will be launched to the negative
- **PARAM_DIRECTION** = **0** --- Direction in degrees at which the particles will be launched, Notice that when the direction is set to 0 the particles will be launched to the negative
- **PARAM_SPREAD** = **1**
- **PARAM_LINEAR_VELOCITY** = **2** --- Velocity at which the particles will be launched.
- **PARAM_SPIN_VELOCITY** = **3** --- The speed at which particles will spin around its own center.
- **PARAM_ORBIT_VELOCITY** = **4** --- Velocity at which the particles will orbit around the emitter center
- **PARAM_GRAVITY_DIRECTION** = **5** --- Direction in radians at which the particles will be attracted
- **PARAM_GRAVITY_DIRECTION** = **5** --- Direction in degrees at which the particles will be attracted
- **PARAM_GRAVITY_STRENGTH** = **6** --- Strength of the gravitation attraction for each particle
- **PARAM_RADIAL_ACCEL** = **7**
- **PARAM_TANGENTIAL_ACCEL** = **8**

18
classes/class_popupmenu.rst
View File

@@ -59,6 +59,8 @@ Member Functions
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_item_text<class_PopupMenu_get_item_text>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_item_tooltip<class_PopupMenu_get_item_tooltip>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_checkable<class_PopupMenu_is_item_checkable>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_checked<class_PopupMenu_is_item_checked>` **(** :ref:`int<class_int>` idx **)** const |
@@ -91,6 +93,10 @@ Member Functions
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_text<class_PopupMenu_set_item_text>` **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` text **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_tooltip<class_PopupMenu_set_item_tooltip>` **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` tooltip **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`toggle_item_checked<class_PopupMenu_toggle_item_checked>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -215,6 +221,10 @@ Return the submenu name of the item at index "idx".
Return the text of the item at index "idx".
.. _class_PopupMenu_get_item_tooltip:
- :ref:`String<class_string>` **get_item_tooltip** **(** :ref:`int<class_int>` idx **)** const
.. _class_PopupMenu_is_item_checkable:
- :ref:`bool<class_bool>` **is_item_checkable** **(** :ref:`int<class_int>` idx **)** const
@@ -309,4 +319,12 @@ Sets the submenu of the item at index "idx". The submenu is the name of a child
Set the text of the item at index "idx".
.. _class_PopupMenu_set_item_tooltip:
- void **set_item_tooltip** **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` tooltip **)**
.. _class_PopupMenu_toggle_item_checked:
- void **toggle_item_checked** **(** :ref:`int<class_int>` idx **)**

55
classes/class_raycast.rst
View File

@@ -13,7 +13,7 @@ RayCast
Brief Description
-----------------
Query the closest object intersecting a ray.
Member Functions
----------------
@@ -25,6 +25,8 @@ Member Functions
+--------------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_exceptions<class_RayCast_clear_exceptions>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`force_raycast_update<class_RayCast_force_raycast_update>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_cast_to<class_RayCast_get_cast_to>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_collider<class_RayCast_get_collider>` **(** **)** const |
@@ -56,6 +58,23 @@ Member Functions
| void | :ref:`set_type_mask<class_RayCast_set_type_mask>` **(** :ref:`int<class_int>` mask **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------+
Description
-----------
A RayCast represents a line from its origin to its destination position ``cast_to``, it is used to query the 3D space in order to find the closest object intersecting with the ray.
RayCast can ignore some objects by adding them to the exception list via ``add_exception``, setting proper filtering with layers, or by filtering object types with type masks.
Only enabled raycasts will be able to query the space and report collisions!
RayCast calculates intersection every fixed frame (see :ref:`Node<class_node>`), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use :ref:`force_raycast_update<class_RayCast_force_raycast_update>` after adjusting the raycast.
Member Function Description
---------------------------
@@ -63,6 +82,8 @@ Member Function Description
- void **add_exception** **(** :ref:`Object<class_object>` node **)**
Adds a collision exception so the ray does not report collisions with the specified ``node``.
.. _class_RayCast_add_exception_rid:
- void **add_exception_rid** **(** :ref:`RID<class_rid>` rid **)**
@@ -71,22 +92,38 @@ Member Function Description
- void **clear_exceptions** **(** **)**
Removes all collision exception for this ray.
.. _class_RayCast_force_raycast_update:
- void **force_raycast_update** **(** **)**
Updates the collision information in case if this object's properties changed during the current frame (for example position, rotation or the cast_point). Note, ``set_enabled`` is not required for this to work.
.. _class_RayCast_get_cast_to:
- :ref:`Vector3<class_vector3>` **get_cast_to** **(** **)** const
Return the destination point of this ray object.
.. _class_RayCast_get_collider:
- :ref:`Object<class_object>` **get_collider** **(** **)** const
Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use :ref:`is_colliding<class_RayCast_is_colliding>` to check if the object returned is actually colliding with the ray.
.. _class_RayCast_get_collider_shape:
- :ref:`int<class_int>` **get_collider_shape** **(** **)** const
Returns the collision shape of the closest object the ray is pointing to.
.. _class_RayCast_get_collision_normal:
- :ref:`Vector3<class_vector3>` **get_collision_normal** **(** **)** const
Returns the normal of the intersecting object shape face containing the collision point.
.. _class_RayCast_get_collision_point:
- :ref:`Vector3<class_vector3>` **get_collision_point** **(** **)** const
@@ -97,22 +134,32 @@ Returns collision point. This point is in **global** coordinate system.
- :ref:`int<class_int>` **get_layer_mask** **(** **)** const
Returns the layer mask for this ray.
.. _class_RayCast_get_type_mask:
- :ref:`int<class_int>` **get_type_mask** **(** **)** const
Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>`.
.. _class_RayCast_is_colliding:
- :ref:`bool<class_bool>` **is_colliding** **(** **)** const
Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length).
.. _class_RayCast_is_enabled:
- :ref:`bool<class_bool>` **is_enabled** **(** **)** const
Returns whether this raycast is enabled or not.
.. _class_RayCast_remove_exception:
- void **remove_exception** **(** :ref:`Object<class_object>` node **)**
Removes a collision exception so the ray does report collisions with the specified ``node``.
.. _class_RayCast_remove_exception_rid:
- void **remove_exception_rid** **(** :ref:`RID<class_rid>` rid **)**
@@ -127,12 +174,18 @@ Sets to which point ray should be casted. This point is in **local** coordinate
- void **set_enabled** **(** :ref:`bool<class_bool>` enabled **)**
Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions.
.. _class_RayCast_set_layer_mask:
- void **set_layer_mask** **(** :ref:`int<class_int>` mask **)**
Set the mask to filter objects. Only objects with at least the same mask element set will be detected.
.. _class_RayCast_set_type_mask:
- void **set_type_mask** **(** :ref:`int<class_int>` mask **)**
Set the types of objects to detect. For ``mask`` use a logic sum (OR operation) of constants defined in :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>`, eg. ``PhysicsDirectSpaceState.TYPE_MASK_STATIC_BODY | PhysicsDirectSpaceState.TYPE_MASK_KINEMATIC_BODY`` to detect only those two types.

34
classes/class_raycast2d.rst
View File

@@ -13,7 +13,7 @@ RayCast2D
Brief Description
-----------------
Query the closest object intersecting a ray
Query the closest object intersecting a ray.
Member Functions
----------------
@@ -25,6 +25,8 @@ Member Functions
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_exceptions<class_RayCast2D_clear_exceptions>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| void | :ref:`force_raycast_update<class_RayCast2D_force_raycast_update>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_cast_to<class_RayCast2D_get_cast_to>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_collider<class_RayCast2D_get_collider>` **(** **)** const |
@@ -61,6 +63,18 @@ Description
A RayCast2D represents a line from its origin to its destination position ``cast_to``, it is used to query the 2D space in order to find the closest object intersecting with the ray.
RayCast2D can ignore some objects by adding them to the exception list via ``add_exception``, setting proper filtering with layers, or by filtering object types with type masks.
Only enabled raycasts will be able to query the space and report collisions!
RayCast2D calculates intersection every fixed frame (see :ref:`Node<class_node>`), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use :ref:`force_raycast_update<class_RayCast2D_force_raycast_update>` after adjusting the raycast.
Member Function Description
---------------------------
@@ -80,11 +94,17 @@ Adds a collision exception so the ray does not report collisions with the specif
Removes all collision exception for this ray.
.. _class_RayCast2D_force_raycast_update:
- void **force_raycast_update** **(** **)**
Updates the collision information in case if this object's properties changed during the current frame (for example position, rotation or the cast_point). Note, ``set_enabled`` is not required for this to work.
.. _class_RayCast2D_get_cast_to:
- :ref:`Vector2<class_vector2>` **get_cast_to** **(** **)** const
Return the destination point of this ray object
Return the destination point of this ray object.
.. _class_RayCast2D_get_collider:
@@ -108,7 +128,7 @@ Returns the normal of the intersecting object shape face containing the collisio
- :ref:`Vector2<class_vector2>` **get_collision_point** **(** **)** const
Returns the collision point in which the ray intersects the closest object.
Returns the collision point in which the ray intersects the closest object. This point is in **global** coordinate system.
.. _class_RayCast2D_get_layer_mask:
@@ -120,6 +140,8 @@ Returns the layer mask for this ray.
- :ref:`int<class_int>` **get_type_mask** **(** **)** const
Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>`.
.. _class_RayCast2D_is_colliding:
- :ref:`bool<class_bool>` **is_colliding** **(** **)** const
@@ -130,7 +152,7 @@ Return whether the closest object the ray is pointing to is colliding with the v
- :ref:`bool<class_bool>` **is_enabled** **(** **)** const
Returns whether this raycast is enabled or not
Returns whether this raycast is enabled or not.
.. _class_RayCast2D_remove_exception:
@@ -158,8 +180,12 @@ Enables the RayCast2D. Only enabled raycasts will be able to query the space and
- void **set_layer_mask** **(** :ref:`int<class_int>` mask **)**
Set the mask to filter objects. Only objects with at least the same mask element set will be detected.
.. _class_RayCast2D_set_type_mask:
- void **set_type_mask** **(** :ref:`int<class_int>` mask **)**
Set the types of objects to detect. For ``mask`` use a logic sum (OR operation) of constants defined in :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>`, eg. ``Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY`` to detect only those two types.

2
classes/class_reference.rst
View File

@@ -8,7 +8,7 @@ Reference
**Inherits:** :ref:`Object<class_object>`
**Inherited By:** :ref:`RegEx<class_regex>`, :ref:`SurfaceTool<class_surfacetool>`, :ref:`SpatialGizmo<class_spatialgizmo>`, :ref:`EditorScenePostImport<class_editorscenepostimport>`, :ref:`PhysicsShapeQueryResult<class_physicsshapequeryresult>`, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>`, :ref:`FuncRef<class_funcref>`, :ref:`File<class_file>`, :ref:`TCP_Server<class_tcp_server>`, :ref:`Physics2DShapeQueryResult<class_physics2dshapequeryresult>`, :ref:`ConfigFile<class_configfile>`, :ref:`StreamPeer<class_streampeer>`, :ref:`HTTPClient<class_httpclient>`, :ref:`AudioStreamPlayback<class_audiostreamplayback>`, :ref:`Physics2DShapeQueryParameters<class_physics2dshapequeryparameters>`, :ref:`MeshDataTool<class_meshdatatool>`, :ref:`GDFunctionState<class_gdfunctionstate>`, :ref:`EditorExportPlugin<class_editorexportplugin>`, :ref:`EditorScript<class_editorscript>`, :ref:`Mutex<class_mutex>`, :ref:`PacketPeer<class_packetpeer>`, :ref:`Semaphore<class_semaphore>`, :ref:`XMLParser<class_xmlparser>`, :ref:`EditorImportPlugin<class_editorimportplugin>`, :ref:`Directory<class_directory>`, :ref:`Marshalls<class_marshalls>`, :ref:`WeakRef<class_weakref>`, :ref:`SceneState<class_scenestate>`, :ref:`GDNativeClass<class_gdnativeclass>`, :ref:`PCKPacker<class_pckpacker>`, :ref:`Resource<class_resource>`, :ref:`Thread<class_thread>`, :ref:`PackedDataContainerRef<class_packeddatacontainerref>`, :ref:`ResourceInteractiveLoader<class_resourceinteractiveloader>`, :ref:`ResourceImportMetadata<class_resourceimportmetadata>`, :ref:`PhysicsShapeQueryParameters<class_physicsshapequeryparameters>`
**Inherited By:** :ref:`RegEx<class_regex>`, :ref:`SurfaceTool<class_surfacetool>`, :ref:`SpatialGizmo<class_spatialgizmo>`, :ref:`EditorScenePostImport<class_editorscenepostimport>`, :ref:`PhysicsShapeQueryResult<class_physicsshapequeryresult>`, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>`, :ref:`FuncRef<class_funcref>`, :ref:`File<class_file>`, :ref:`TCP_Server<class_tcp_server>`, :ref:`Physics2DShapeQueryResult<class_physics2dshapequeryresult>`, :ref:`ConfigFile<class_configfile>`, :ref:`StreamPeer<class_streampeer>`, :ref:`HTTPClient<class_httpclient>`, :ref:`AudioStreamPlayback<class_audiostreamplayback>`, :ref:`Physics2DShapeQueryParameters<class_physics2dshapequeryparameters>`, :ref:`MeshDataTool<class_meshdatatool>`, :ref:`GDFunctionState<class_gdfunctionstate>`, :ref:`EditorExportPlugin<class_editorexportplugin>`, :ref:`EditorScript<class_editorscript>`, :ref:`Mutex<class_mutex>`, :ref:`PacketPeer<class_packetpeer>`, :ref:`Semaphore<class_semaphore>`, :ref:`XMLParser<class_xmlparser>`, :ref:`EditorImportPlugin<class_editorimportplugin>`, :ref:`Directory<class_directory>`, :ref:`Marshalls<class_marshalls>`, :ref:`AStar<class_astar>`, :ref:`SceneState<class_scenestate>`, :ref:`GDNativeClass<class_gdnativeclass>`, :ref:`PCKPacker<class_pckpacker>`, :ref:`WeakRef<class_weakref>`, :ref:`Resource<class_resource>`, :ref:`Thread<class_thread>`, :ref:`PackedDataContainerRef<class_packeddatacontainerref>`, :ref:`ResourceInteractiveLoader<class_resourceinteractiveloader>`, :ref:`ResourceImportMetadata<class_resourceimportmetadata>`, :ref:`PhysicsShapeQueryParameters<class_physicsshapequeryparameters>`
**Category:** Core

2
classes/class_scrollcontainer.rst
View File

@@ -39,7 +39,7 @@ Member Functions
Description
-----------
A ScrollContainer node with a :ref:`Control<class_control>` child and scrollbar child (:ref:`HScrollbar<class_hscrollbar>`, :ref:`VScrollBar<class_vscrollbar>`, or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel<class_panel>` control.
A ScrollContainer node with a :ref:`Control<class_control>` child and scrollbar child (:ref:`HScrollbar<class_hscrollbar>`, :ref:`VScrollBar<class_vscrollbar>`, or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel<class_panel>` control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension).
Member Function Description
---------------------------

150
classes/class_string.rst
View File

@@ -16,6 +16,56 @@ Built-in string class.
Member Functions
----------------
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`bool<class_bool>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`int<class_int>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`float<class_float>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Vector2<class_vector2>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Rect2<class_rect2>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Vector3<class_vector3>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Matrix32<class_matrix32>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Plane<class_plane>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Quat<class_quat>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`AABB<class_aabb>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Matrix3<class_matrix3>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Transform<class_transform>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Color<class_color>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`NodePath<class_nodepath>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`RID<class_rid>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`InputEvent<class_inputevent>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Dictionary<class_dictionary>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Array<class_array>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`RawArray<class_rawarray>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`IntArray<class_intarray>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`RealArray<class_realarray>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`StringArray<class_stringarray>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Vector2Array<class_vector2array>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`Vector3Array<class_vector3array>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`String<class_String_String>` **(** :ref:`ColorArray<class_colorarray>` from **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`basename<class_String_basename>` **(** **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
@@ -150,6 +200,106 @@ This is the built-in string class (and the one used by GDScript). It supports Un
Member Function Description
---------------------------
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`bool<class_bool>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`int<class_int>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`float<class_float>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Vector2<class_vector2>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Rect2<class_rect2>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Vector3<class_vector3>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Matrix32<class_matrix32>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Plane<class_plane>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Quat<class_quat>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`AABB<class_aabb>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Matrix3<class_matrix3>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Transform<class_transform>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Color<class_color>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`NodePath<class_nodepath>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`RID<class_rid>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`InputEvent<class_inputevent>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Dictionary<class_dictionary>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Array<class_array>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`RawArray<class_rawarray>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`IntArray<class_intarray>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`RealArray<class_realarray>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`StringArray<class_stringarray>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Vector2Array<class_vector2array>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`Vector3Array<class_vector3array>` from **)**
.. _class_String_String:
- :ref:`String<class_string>` **String** **(** :ref:`ColorArray<class_colorarray>` from **)**
.. _class_String_basename:
- :ref:`String<class_string>` **basename** **(** **)**

88
classes/class_tree.rst
View File

@@ -13,7 +13,7 @@ Tree
Brief Description
-----------------
Control to show a tree of items.
Member Functions
----------------
@@ -112,6 +112,24 @@ Numeric Constants
- **DROP_MODE_ON_ITEM** = **1**
- **DROP_MODE_INBETWEEN** = **2**
Description
-----------
This shows a tree of items that can be selected, expanded and collapsed. The tree can have multiple columns with custom controls like text editing, buttons and popups. It can be useful for structural displaying and interactions.
Trees are built via code, using :ref:`TreeItem<class_treeitem>` objects to create the structure. They have a single root but multiple root can be simulated if a dummy hidden root is added.
::
func _ready():
var tree = Tree.new()
var root = tree.create_item()
tree.set_hide_root(true)
var child1 = tree.create_item(root)
var child2 = tree.create_item(root)
var subchild1 = tree.create_item(child1)
subchild1.set_text(0, "Subchild1")
Member Function Description
---------------------------
@@ -119,136 +137,204 @@ Member Function Description
- :ref:`bool<class_bool>` **are_column_titles_visible** **(** **)** const
Get whether the column titles are being shown.
.. _class_Tree_clear:
- void **clear** **(** **)**
Clear the tree. This erases all of the items.
.. _class_Tree_create_item:
- :ref:`TreeItem<class_treeitem>` **create_item** **(** :ref:`TreeItem<class_treeitem>` parent=NULL **)**
Create an item in the tree and add it as the last child of ``parent``. If parent is not given, it will be added as the last child of the root, or it'll the be the root itself if the tree is empty.
.. _class_Tree_ensure_cursor_is_visible:
- void **ensure_cursor_is_visible** **(** **)**
Make the current selected item visible. This will scroll the tree to make sure the selected item is in sight.
.. _class_Tree_get_allow_rmb_select:
- :ref:`bool<class_bool>` **get_allow_rmb_select** **(** **)** const
Get whether a right click can select items.
.. _class_Tree_get_column_at_pos:
- :ref:`int<class_int>` **get_column_at_pos** **(** :ref:`Vector2<class_vector2>` pos **)** const
Get the column index under the given point.
.. _class_Tree_get_column_title:
- :ref:`String<class_string>` **get_column_title** **(** :ref:`int<class_int>` column **)** const
Get the title of the given column.
.. _class_Tree_get_column_width:
- :ref:`int<class_int>` **get_column_width** **(** :ref:`int<class_int>` column **)** const
Get the width of the given column in pixels.
.. _class_Tree_get_columns:
- :ref:`int<class_int>` **get_columns** **(** **)** const
Get the amount of columns.
.. _class_Tree_get_custom_popup_rect:
- :ref:`Rect2<class_rect2>` **get_custom_popup_rect** **(** **)** const
Get the rectangle for custom popups. Helper to create custom cell controls that display a popup. See :ref:`TreeItem.set_cell_mode<class_TreeItem_set_cell_mode>`.
.. _class_Tree_get_drop_mode_flags:
- :ref:`int<class_int>` **get_drop_mode_flags** **(** **)** const
Get the flags of the current drop mode.
.. _class_Tree_get_edited:
- :ref:`TreeItem<class_treeitem>` **get_edited** **(** **)** const
Get the current edited item. This is only available for custom cell mode.
.. _class_Tree_get_edited_column:
- :ref:`int<class_int>` **get_edited_column** **(** **)** const
Get the column of the cell for the current edited icon. This is only available for custom cell mode.
.. _class_Tree_get_item_area_rect:
- :ref:`Rect2<class_rect2>` **get_item_area_rect** **(** :ref:`TreeItem<class_treeitem>` item, :ref:`int<class_int>` column=-1 **)** const
Get the rectangle area of the the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns.
.. _class_Tree_get_item_at_pos:
- :ref:`TreeItem<class_treeitem>` **get_item_at_pos** **(** :ref:`Vector2<class_vector2>` pos **)** const
Get the tree item at the specified position (relative to the tree origin position).
.. _class_Tree_get_next_selected:
- :ref:`TreeItem<class_treeitem>` **get_next_selected** **(** :ref:`TreeItem<class_treeitem>` from **)**
Get the next selected item after the given one.
.. _class_Tree_get_pressed_button:
- :ref:`int<class_int>` **get_pressed_button** **(** **)** const
Get the index of the last pressed button.
.. _class_Tree_get_root:
- :ref:`TreeItem<class_treeitem>` **get_root** **(** **)**
Get the root item of the tree.
.. _class_Tree_get_scroll:
- :ref:`Vector2<class_vector2>` **get_scroll** **(** **)** const
Get the current scrolling position.
.. _class_Tree_get_selected:
- :ref:`TreeItem<class_treeitem>` **get_selected** **(** **)** const
Get the currently selected item.
.. _class_Tree_get_selected_column:
- :ref:`int<class_int>` **get_selected_column** **(** **)** const
Get the column number of the current selection.
.. _class_Tree_get_single_select_cell_editing_only_when_already_selected:
- :ref:`bool<class_bool>` **get_single_select_cell_editing_only_when_already_selected** **(** **)** const
Get whether the editing of a cell should only happen when it is already selected.
.. _class_Tree_is_folding_hidden:
- :ref:`bool<class_bool>` **is_folding_hidden** **(** **)** const
Get whether the folding arrow is hidden.
.. _class_Tree_set_allow_rmb_select:
- void **set_allow_rmb_select** **(** :ref:`bool<class_bool>` allow **)**
Set whether or not a right mouse button click can select items.
.. _class_Tree_set_column_expand:
- void **set_column_expand** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` expand **)**
Set whether a column will have the "Expand" flag of :ref:`Control<class_control>`.
.. _class_Tree_set_column_min_width:
- void **set_column_min_width** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` min_width **)**
Set the minimum width of a column.
.. _class_Tree_set_column_title:
- void **set_column_title** **(** :ref:`int<class_int>` column, :ref:`String<class_string>` title **)**
Set the title of a column.
.. _class_Tree_set_column_titles_visible:
- void **set_column_titles_visible** **(** :ref:`bool<class_bool>` visible **)**
Set whether the column titles visibility.
.. _class_Tree_set_columns:
- void **set_columns** **(** :ref:`int<class_int>` amount **)**
Set the amount of columns.
.. _class_Tree_set_drop_mode_flags:
- void **set_drop_mode_flags** **(** :ref:`int<class_int>` flags **)**
Set the drop mode as an OR combination of flags. See ``DROP_MODE\_\*`` constants.
.. _class_Tree_set_hide_folding:
- void **set_hide_folding** **(** :ref:`bool<class_bool>` hide **)**
Set whether the folding arrow should be hidden.
.. _class_Tree_set_hide_root:
- void **set_hide_root** **(** :ref:`bool<class_bool>` enable **)**
Set whether the root of the tree should be hidden.
.. _class_Tree_set_select_mode:
- void **set_select_mode** **(** :ref:`int<class_int>` mode **)**
Set the selection mode. Use one of the ``SELECT\_\*`` constants.
.. _class_Tree_set_single_select_cell_editing_only_when_already_selected:
- void **set_single_select_cell_editing_only_when_already_selected** **(** :ref:`bool<class_bool>` enable **)**
Set whether the editing of a cell should only happen when it is already selected.

6
classes/class_vector2.rst
View File

@@ -27,6 +27,8 @@ Member Functions
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`angle_to_point<class_Vector2_angle_to_point>` **(** :ref:`Vector2<class_vector2>` to **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`clamped<class_Vector2_clamped>` **(** :ref:`float<class_float>` length **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`cubic_interpolate<class_Vector2_cubic_interpolate>` **(** :ref:`Vector2<class_vector2>` b, :ref:`Vector2<class_vector2>` pre_a, :ref:`Vector2<class_vector2>` post_b, :ref:`float<class_float>` t **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`distance_squared_to<class_Vector2_distance_squared_to>` **(** :ref:`Vector2<class_vector2>` to **)** |
@@ -106,6 +108,10 @@ Returns the angle in radians between the two vectors.
Returns the angle in radians between the line connecting the two points and the x coordinate.
.. _class_Vector2_clamped:
- :ref:`Vector2<class_vector2>` **clamped** **(** :ref:`float<class_float>` length **)**
.. _class_Vector2_cubic_interpolate:
- :ref:`Vector2<class_vector2>` **cubic_interpolate** **(** :ref:`Vector2<class_vector2>` b, :ref:`Vector2<class_vector2>` pre_a, :ref:`Vector2<class_vector2>` post_b, :ref:`float<class_float>` t **)**

6
classes/class_vector3.rst
View File

@@ -21,6 +21,8 @@ Member Functions
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`abs<class_Vector3_abs>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`angle_to<class_Vector3_angle_to>` **(** :ref:`Vector3<class_vector3>` to **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`ceil<class_Vector3_ceil>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`cross<class_Vector3_cross>` **(** :ref:`Vector3<class_vector3>` b **)** |
@@ -92,6 +94,10 @@ Returns a Vector3 with the given components.
Returns a new vector with all components in absolute values (e.g. positive).
.. _class_Vector3_angle_to:
- :ref:`float<class_float>` **angle_to** **(** :ref:`Vector3<class_vector3>` to **)**
.. _class_Vector3_ceil:
- :ref:`Vector3<class_vector3>` **ceil** **(** **)**

51
classes/class_videoplayer.rst
View File

@@ -13,7 +13,7 @@ VideoPlayer
Brief Description
-----------------
Control to play video files.
Member Functions
----------------
@@ -64,6 +64,11 @@ Member Functions
| void | :ref:`stop<class_VideoPlayer_stop>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------+
Description
-----------
This control has the ability to play video streams. The only format accepted is the OGV Theora, so any other format must be converted before using in a project.
Member Function Description
---------------------------
@@ -71,88 +76,132 @@ Member Function Description
- :ref:`int<class_int>` **get_audio_track** **(** **)** const
Get the selected audio track (for multitrack videos).
.. _class_VideoPlayer_get_buffering_msec:
- :ref:`int<class_int>` **get_buffering_msec** **(** **)** const
Get the amount of miliseconds to store in buffer while playing.
.. _class_VideoPlayer_get_stream:
- :ref:`VideoStream<class_videostream>` **get_stream** **(** **)** const
Get the video stream.
.. _class_VideoPlayer_get_stream_name:
- :ref:`String<class_string>` **get_stream_name** **(** **)** const
Get the name of the video stream.
.. _class_VideoPlayer_get_stream_pos:
- :ref:`float<class_float>` **get_stream_pos** **(** **)** const
Get the current position of the stream, in seconds.
.. _class_VideoPlayer_get_video_texture:
- :ref:`Texture<class_texture>` **get_video_texture** **(** **)**
Get the current frame of the video as a :ref:`Texture<class_texture>`.
.. _class_VideoPlayer_get_volume:
- :ref:`float<class_float>` **get_volume** **(** **)** const
Get the volume of the audio track as a linear value.
.. _class_VideoPlayer_get_volume_db:
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
Get the volume of the audio track in decibels.
.. _class_VideoPlayer_has_autoplay:
- :ref:`bool<class_bool>` **has_autoplay** **(** **)** const
Get whether or not the video is set as autoplay.
.. _class_VideoPlayer_has_expand:
- :ref:`bool<class_bool>` **has_expand** **(** **)** const
Get whether or not the expand property is set.
.. _class_VideoPlayer_is_paused:
- :ref:`bool<class_bool>` **is_paused** **(** **)** const
Get whether or not the video is paused.
.. _class_VideoPlayer_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
Get whether or not the video is playing.
.. _class_VideoPlayer_play:
- void **play** **(** **)**
Start the video playback.
.. _class_VideoPlayer_set_audio_track:
- void **set_audio_track** **(** :ref:`int<class_int>` track **)**
Set the audio track (for multitrack videos).
.. _class_VideoPlayer_set_autoplay:
- void **set_autoplay** **(** :ref:`bool<class_bool>` enabled **)**
Set whether this node should start playing automatically.
.. _class_VideoPlayer_set_buffering_msec:
- void **set_buffering_msec** **(** :ref:`int<class_int>` msec **)**
Set the amount of miliseconds to buffer during playback.
.. _class_VideoPlayer_set_expand:
- void **set_expand** **(** :ref:`bool<class_bool>` enable **)**
Set the expand property. If enabled, the video will grow or shrink to fit the player size, otherwise it will play at the stream resolution.
.. _class_VideoPlayer_set_paused:
- void **set_paused** **(** :ref:`bool<class_bool>` paused **)**
Set whether the video should pause the playback.
.. _class_VideoPlayer_set_stream:
- void **set_stream** **(** :ref:`VideoStream<class_videostream>` stream **)**
Set the video stream for this player.
.. _class_VideoPlayer_set_volume:
- void **set_volume** **(** :ref:`float<class_float>` volume **)**
Set the audio volume as a linear value.
.. _class_VideoPlayer_set_volume_db:
- void **set_volume_db** **(** :ref:`float<class_float>` db **)**
Set the audio volume in decibels.
.. _class_VideoPlayer_stop:
- void **stop** **(** **)**
Stop the video playback.

2
classes/class_viewport.rst
View File

@@ -485,6 +485,6 @@ Force update of the 2D and 3D worlds.
- void **warp_mouse** **(** :ref:`Vector2<class_vector2>` to_pos **)**
Wrap the mouse to a position, relative to the viewport.
Warp the mouse to a position, relative to the viewport.

26
classes/class_visualinstance.rst
View File

@@ -20,21 +20,33 @@ Brief Description
Member Functions
----------------
+------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_layer_mask<class_VisualInstance_get_layer_mask>` **(** **)** const |
+------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`set_base<class_VisualInstance_set_base>` **(** :ref:`RID<class_rid>` base **)** |
+------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer_mask<class_VisualInstance_set_layer_mask>` **(** :ref:`int<class_int>` mask **)** |
+------------------------+-----------------------------------------------------------------------------------------------------+
+--------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`get_aabb<class_VisualInstance_get_aabb>` **(** **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_layer_mask<class_VisualInstance_get_layer_mask>` **(** **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`get_transformed_aabb<class_VisualInstance_get_transformed_aabb>` **(** **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`set_base<class_VisualInstance_set_base>` **(** :ref:`RID<class_rid>` base **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer_mask<class_VisualInstance_set_layer_mask>` **(** :ref:`int<class_int>` mask **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_VisualInstance_get_aabb:
- :ref:`AABB<class_aabb>` **get_aabb** **(** **)** const
.. _class_VisualInstance_get_layer_mask:
- :ref:`int<class_int>` **get_layer_mask** **(** **)** const
.. _class_VisualInstance_get_transformed_aabb:
- :ref:`AABB<class_aabb>` **get_transformed_aabb** **(** **)** const
.. _class_VisualInstance_set_base:
- void **set_base** **(** :ref:`RID<class_rid>` base **)**

16
classes/class_visualserver.rst
View File

@@ -67,6 +67,8 @@ Member Functions
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`canvas_item_set_self_opacity<class_VisualServer_canvas_item_set_self_opacity>` **(** :ref:`RID<class_rid>` arg0, :ref:`float<class_float>` arg1 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`canvas_item_set_sort_children_by_y<class_VisualServer_canvas_item_set_sort_children_by_y>` **(** :ref:`RID<class_rid>` arg0, :ref:`bool<class_bool>` arg1 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`canvas_item_set_transform<class_VisualServer_canvas_item_set_transform>` **(** :ref:`RID<class_rid>` arg0, :ref:`Matrix32<class_matrix32>` arg1 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`canvas_item_set_z<class_VisualServer_canvas_item_set_z>` **(** :ref:`RID<class_rid>` arg0, :ref:`int<class_int>` arg1 **)** |
@@ -83,6 +85,8 @@ Member Functions
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`free_rid<class_VisualServer_free_rid>` **(** :ref:`RID<class_rid>` arg0 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_default_clear_color<class_VisualServer_get_default_clear_color>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_render_info<class_VisualServer_get_render_info>` **(** :ref:`int<class_int>` arg0 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_test_cube<class_VisualServer_get_test_cube>` **(** **)** |
@@ -171,7 +175,7 @@ Member Functions
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`material_set_shader<class_VisualServer_material_set_shader>` **(** :ref:`RID<class_rid>` shader, :ref:`RID<class_rid>` arg1 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`mesh_add_surface<class_VisualServer_mesh_add_surface>` **(** :ref:`RID<class_rid>` arg0, :ref:`int<class_int>` arg1, :ref:`Array<class_array>` arg2, :ref:`Array<class_array>` arg3, :ref:`bool<class_bool>` arg4=-1 **)** |
| void | :ref:`mesh_add_surface<class_VisualServer_mesh_add_surface>` **(** :ref:`RID<class_rid>` arg0, :ref:`int<class_int>` arg1, :ref:`Array<class_array>` arg2, :ref:`Array<class_array>` arg3=Array(), :ref:`bool<class_bool>` arg4=false **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`mesh_add_surface_from_planes<class_VisualServer_mesh_add_surface_from_planes>` **(** :ref:`RID<class_rid>` arg0, :ref:`Array<class_array>` arg1 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -566,6 +570,10 @@ Member Function Description
- void **canvas_item_set_self_opacity** **(** :ref:`RID<class_rid>` arg0, :ref:`float<class_float>` arg1 **)**
.. _class_VisualServer_canvas_item_set_sort_children_by_y:
- void **canvas_item_set_sort_children_by_y** **(** :ref:`RID<class_rid>` arg0, :ref:`bool<class_bool>` arg1 **)**
.. _class_VisualServer_canvas_item_set_transform:
- void **canvas_item_set_transform** **(** :ref:`RID<class_rid>` arg0, :ref:`Matrix32<class_matrix32>` arg1 **)**
@@ -598,6 +606,10 @@ Member Function Description
- void **free_rid** **(** :ref:`RID<class_rid>` arg0 **)**
.. _class_VisualServer_get_default_clear_color:
- :ref:`Color<class_color>` **get_default_clear_color** **(** **)** const
.. _class_VisualServer_get_render_info:
- :ref:`int<class_int>` **get_render_info** **(** :ref:`int<class_int>` arg0 **)**
@@ -776,7 +788,7 @@ Member Function Description
.. _class_VisualServer_mesh_add_surface:
- void **mesh_add_surface** **(** :ref:`RID<class_rid>` arg0, :ref:`int<class_int>` arg1, :ref:`Array<class_array>` arg2, :ref:`Array<class_array>` arg3, :ref:`bool<class_bool>` arg4=-1 **)**
- void **mesh_add_surface** **(** :ref:`RID<class_rid>` arg0, :ref:`int<class_int>` arg1, :ref:`Array<class_array>` arg2, :ref:`Array<class_array>` arg3=Array(), :ref:`bool<class_bool>` arg4=false **)**
.. _class_VisualServer_mesh_add_surface_from_planes:

55
classes/class_xmlparser.rst
View File

@@ -13,7 +13,7 @@ XMLParser
Brief Description
-----------------
Low-level class for creating parsers for XML files.
Member Functions
----------------
@@ -57,13 +57,18 @@ Member Functions
Numeric Constants
-----------------
- **NODE_NONE** = **0**
- **NODE_ELEMENT** = **1**
- **NODE_ELEMENT_END** = **2**
- **NODE_TEXT** = **3**
- **NODE_COMMENT** = **4**
- **NODE_CDATA** = **5**
- **NODE_UNKNOWN** = **6**
- **NODE_NONE** = **0** --- There's no node (no file or buffer opened)
- **NODE_ELEMENT** = **1** --- Element (tag)
- **NODE_ELEMENT_END** = **2** --- End of element
- **NODE_TEXT** = **3** --- Text node
- **NODE_COMMENT** = **4** --- Comment node
- **NODE_CDATA** = **5** --- CDATA content
- **NODE_UNKNOWN** = **6** --- Unknown node
Description
-----------
This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low level so it can be applied to any possible schema.
Member Function Description
---------------------------
@@ -72,68 +77,102 @@ Member Function Description
- :ref:`int<class_int>` **get_attribute_count** **(** **)** const
Get the amount of attributes in the current element.
.. _class_XMLParser_get_attribute_name:
- :ref:`String<class_string>` **get_attribute_name** **(** :ref:`int<class_int>` idx **)** const
Get the name of the attribute specified by the index in ``idx`` argument.
.. _class_XMLParser_get_attribute_value:
- :ref:`String<class_string>` **get_attribute_value** **(** :ref:`int<class_int>` idx **)** const
Get the value of the attribute specified by the index in ``idx`` argument.
.. _class_XMLParser_get_current_line:
- :ref:`int<class_int>` **get_current_line** **(** **)** const
Get the current line in the parsed file (currently not implemented).
.. _class_XMLParser_get_named_attribute_value:
- :ref:`String<class_string>` **get_named_attribute_value** **(** :ref:`String<class_string>` name **)** const
Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute.
.. _class_XMLParser_get_named_attribute_value_safe:
- :ref:`String<class_string>` **get_named_attribute_value_safe** **(** :ref:`String<class_string>` name **)** const
Get the value of a certain attribute of the current element by name. This will return an empty :ref:`String<class_string>` if the attribute is not found.
.. _class_XMLParser_get_node_data:
- :ref:`String<class_string>` **get_node_data** **(** **)** const
Get the contents of a text node. This will raise an error in any other type of node.
.. _class_XMLParser_get_node_name:
- :ref:`String<class_string>` **get_node_name** **(** **)** const
Get the name of the current element node. This will raise an error if the current node type is not ``NODE_ELEMENT`` nor ``NODE_ELEMENT_END``
.. _class_XMLParser_get_node_offset:
- :ref:`int<class_int>` **get_node_offset** **(** **)** const
Get the byte offset of the current node since the beginning of the file or buffer.
.. _class_XMLParser_get_node_type:
- :ref:`int<class_int>` **get_node_type** **(** **)**
Get the type of the current node. Compare with ``NODE\_\*`` constants.
.. _class_XMLParser_has_attribute:
- :ref:`bool<class_bool>` **has_attribute** **(** :ref:`String<class_string>` name **)** const
Check whether or not the current element has a certain attribute.
.. _class_XMLParser_is_empty:
- :ref:`bool<class_bool>` **is_empty** **(** **)** const
Check whether the current element is empty (this only works for completely empty tags, e.g. <element \>).
.. _class_XMLParser_open:
- :ref:`int<class_int>` **open** **(** :ref:`String<class_string>` file **)**
Open a XML file for parsing. This returns an error code.
.. _class_XMLParser_open_buffer:
- :ref:`int<class_int>` **open_buffer** **(** :ref:`RawArray<class_rawarray>` buffer **)**
Open a XML raw buffer for parsing. This returns an error code.
.. _class_XMLParser_read:
- :ref:`int<class_int>` **read** **(** **)**
Read the next node of the file. This returns an error code.
.. _class_XMLParser_seek:
- :ref:`int<class_int>` **seek** **(** :ref:`int<class_int>` pos **)**
Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code.
.. _class_XMLParser_skip_section:
- void **skip_section** **(** **)**
Skips the current section. If the node contains other elements, they will be ignored and the cursor will go to the closing of the current element.