mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
classref: Sync with current master XML
This commit is contained in:
Rémi Verschelde
15
classes/class_@visualscript.rst
Normal file
15
classes/class_@visualscript.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
.. 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_@VisualScript:
|
||||
|
||||
@VisualScript
|
||||
=============
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
@@ -35,6 +35,8 @@ Member Functions
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`LineEdit<class_lineedit>` | :ref:`register_text_enter<class_AcceptDialog_register_text_enter>` **(** :ref:`Object<class_object>` line_edit **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_child_rect<class_AcceptDialog_set_child_rect>` **(** :ref:`Control<class_control>` child **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_hide_on_ok<class_AcceptDialog_set_hide_on_ok>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_text<class_AcceptDialog_set_text>` **(** :ref:`String<class_string>` text **)** |
|
||||
@@ -98,6 +100,10 @@ Return the built-in label text.
|
||||
|
||||
Register a :ref:`LineEdit<class_lineedit>` in the dialog. When the enter key is pressed, the dialog will be accepted.
|
||||
|
||||
.. _class_AcceptDialog_set_child_rect:
|
||||
|
||||
- void **set_child_rect** **(** :ref:`Control<class_control>` child **)**
|
||||
|
||||
.. _class_AcceptDialog_set_hide_on_ok:
|
||||
|
||||
- void **set_hide_on_ok** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
@@ -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 **)**
|
||||
|
||||
@@ -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
104
classes/class_astar.rst
Normal 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 **)**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ AudioStream
|
||||
|
||||
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`AudioStreamSpeex<class_audiostreamspeex>`, :ref:`AudioStreamMPC<class_audiostreammpc>`, :ref:`AudioStreamOGGVorbis<class_audiostreamoggvorbis>`, :ref:`AudioStreamOpus<class_audiostreamopus>`
|
||||
**Inherited By:** :ref:`AudioStreamMPC<class_audiostreammpc>`, :ref:`AudioStreamOGGVorbis<class_audiostreamoggvorbis>`, :ref:`AudioStreamOpus<class_audiostreamopus>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
.. 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_AudioStreamSpeex:
|
||||
|
||||
AudioStreamSpeex
|
||||
================
|
||||
|
||||
**Inherits:** :ref:`AudioStream<class_audiostream>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Speex audio stream driver.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Speex audio stream driver. Speex is very useful for compressed speech. It allows loading a very large amount of speech in memory at little IO/latency cost.
|
||||
|
||||
@@ -18,71 +18,79 @@ Camera node for 2D scenes.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`align<class_Camera2D_align>` **(** **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_anchor_mode<class_Camera2D_get_anchor_mode>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_pos<class_Camera2D_get_camera_pos>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Viewport<class_viewport>` | :ref:`get_custom_viewport<class_Camera2D_get_custom_viewport>` **(** **)** const |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_drag_margin<class_Camera2D_get_drag_margin>` **(** :ref:`int<class_int>` margin **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_follow_smoothing<class_Camera2D_get_follow_smoothing>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera2D_get_h_offset>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_limit<class_Camera2D_get_limit>` **(** :ref:`int<class_int>` margin **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_Camera2D_get_offset>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera2D_get_v_offset>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_zoom<class_Camera2D_get_zoom>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_current<class_Camera2D_is_current>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_follow_smoothing_enabled<class_Camera2D_is_follow_smoothing_enabled>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_h_drag_enabled<class_Camera2D_is_h_drag_enabled>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_limit_smoothing_enabled<class_Camera2D_is_limit_smoothing_enabled>` **(** **)** const |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_rotating<class_Camera2D_is_rotating>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_v_drag_enabled<class_Camera2D_is_v_drag_enabled>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_current<class_Camera2D_make_current>` **(** **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reset_smoothing<class_Camera2D_reset_smoothing>` **(** **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_anchor_mode<class_Camera2D_set_anchor_mode>` **(** :ref:`int<class_int>` anchor_mode **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_custom_viewport<class_Camera2D_set_custom_viewport>` **(** :ref:`Viewport<class_viewport>` viewport **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_drag_margin<class_Camera2D_set_drag_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_enable_follow_smoothing<class_Camera2D_set_enable_follow_smoothing>` **(** :ref:`bool<class_bool>` follow_smoothing **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_follow_smoothing<class_Camera2D_set_follow_smoothing>` **(** :ref:`float<class_float>` follow_smoothing **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_h_drag_enabled<class_Camera2D_set_h_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_h_offset<class_Camera2D_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_limit<class_Camera2D_set_limit>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_limit_smoothing_enabled<class_Camera2D_set_limit_smoothing_enabled>` **(** :ref:`bool<class_bool>` limit_smoothing_enabled **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_offset<class_Camera2D_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rotating<class_Camera2D_set_rotating>` **(** :ref:`bool<class_bool>` rotating **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_v_drag_enabled<class_Camera2D_set_v_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_v_offset<class_Camera2D_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_zoom<class_Camera2D_set_zoom>` **(** :ref:`Vector2<class_vector2>` zoom **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -130,6 +138,10 @@ Return the camera position.
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_camera_screen_center** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_get_custom_viewport:
|
||||
|
||||
- :ref:`Viewport<class_viewport>` **get_custom_viewport** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_get_drag_margin:
|
||||
|
||||
- :ref:`float<class_float>` **get_drag_margin** **(** :ref:`int<class_int>` margin **)** const
|
||||
@@ -178,6 +190,10 @@ Return true of this is the current camera (see :ref:`make_current<class_Camera2D
|
||||
|
||||
- :ref:`bool<class_bool>` **is_h_drag_enabled** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_is_limit_smoothing_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_limit_smoothing_enabled** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_is_rotating:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_rotating** **(** **)** const
|
||||
@@ -204,6 +220,10 @@ This has no effect if smoothing is disabled.
|
||||
|
||||
- void **set_anchor_mode** **(** :ref:`int<class_int>` anchor_mode **)**
|
||||
|
||||
.. _class_Camera2D_set_custom_viewport:
|
||||
|
||||
- void **set_custom_viewport** **(** :ref:`Viewport<class_viewport>` viewport **)**
|
||||
|
||||
.. _class_Camera2D_set_drag_margin:
|
||||
|
||||
- void **set_drag_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)**
|
||||
@@ -232,6 +252,14 @@ Set the margins needed to drag the camera (relative to the screen size). Margin
|
||||
|
||||
Set the scrolling limit in pixels.
|
||||
|
||||
.. _class_Camera2D_set_limit_smoothing_enabled:
|
||||
|
||||
- void **set_limit_smoothing_enabled** **(** :ref:`bool<class_bool>` limit_smoothing_enabled **)**
|
||||
|
||||
Smooth camera when reaching camera limits.
|
||||
|
||||
This requires camera smoothing being enabled to have a noticeable effect.
|
||||
|
||||
.. _class_Camera2D_set_offset:
|
||||
|
||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
||||
|
||||
@@ -29,7 +29,7 @@ Member Functions
|
||||
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_colored_polygon<class_CanvasItem_draw_colored_polygon>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`Color<class_color>` color, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array([]), :ref:`Texture<class_texture>` texture=NULL **)** |
|
||||
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_line<class_CanvasItem_draw_line>` **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1 **)** |
|
||||
| void | :ref:`draw_line<class_CanvasItem_draw_line>` **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polygon<class_CanvasItem_draw_polygon>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array([]), :ref:`Texture<class_texture>` texture=NULL **)** |
|
||||
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -198,9 +198,9 @@ Draw a colored polygon of any amount of points, convex or concave.
|
||||
|
||||
.. _class_CanvasItem_draw_line:
|
||||
|
||||
- void **draw_line** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1 **)**
|
||||
- void **draw_line** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
Draw a line from a 2D point to another, with a given color and width.
|
||||
Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
|
||||
|
||||
.. _class_CanvasItem_draw_polygon:
|
||||
|
||||
|
||||
@@ -20,35 +20,37 @@ Canvas Item layer.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Viewport<class_viewport>` | :ref:`get_custom_viewport<class_CanvasLayer_get_custom_viewport>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_layer<class_CanvasLayer_get_layer>` **(** **)** const |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_CanvasLayer_get_offset>` **(** **)** const |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_rotation<class_CanvasLayer_get_rotation>` **(** **)** const |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_rotationd<class_CanvasLayer_get_rotationd>` **(** **)** const |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_CanvasLayer_get_scale>` **(** **)** const |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Matrix32<class_matrix32>` | :ref:`get_transform<class_CanvasLayer_get_transform>` **(** **)** const |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`get_viewport<class_CanvasLayer_get_viewport>` **(** **)** const |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_custom_viewport<class_CanvasLayer_set_custom_viewport>` **(** :ref:`Viewport<class_viewport>` viewport **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_layer<class_CanvasLayer_set_layer>` **(** :ref:`int<class_int>` layer **)** |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_offset<class_CanvasLayer_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rotation<class_CanvasLayer_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rotationd<class_CanvasLayer_set_rotationd>` **(** :ref:`float<class_float>` degrees **)** |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_scale<class_CanvasLayer_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_transform<class_CanvasLayer_set_transform>` **(** :ref:`Matrix32<class_matrix32>` transform **)** |
|
||||
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -58,6 +60,10 @@ Canvas Item layer. :ref:`CanvasItem<class_canvasitem>` nodes that are direct or
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_CanvasLayer_get_custom_viewport:
|
||||
|
||||
- :ref:`Viewport<class_viewport>` **get_custom_viewport** **(** **)** const
|
||||
|
||||
.. _class_CanvasLayer_get_layer:
|
||||
|
||||
- :ref:`int<class_int>` **get_layer** **(** **)** const
|
||||
@@ -94,18 +100,16 @@ Return the base scale for this layer (helper).
|
||||
|
||||
Return the base transform for this layer.
|
||||
|
||||
.. _class_CanvasLayer_get_viewport:
|
||||
|
||||
- :ref:`RID<class_rid>` **get_viewport** **(** **)** const
|
||||
|
||||
Return the viewport RID for this layer.
|
||||
|
||||
.. _class_CanvasLayer_get_world_2d:
|
||||
|
||||
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
|
||||
|
||||
Return the :ref:`World2D<class_world2d>` used by this layer.
|
||||
|
||||
.. _class_CanvasLayer_set_custom_viewport:
|
||||
|
||||
- void **set_custom_viewport** **(** :ref:`Viewport<class_viewport>` viewport **)**
|
||||
|
||||
.. _class_CanvasLayer_set_layer:
|
||||
|
||||
- void **set_layer** **(** :ref:`int<class_int>` layer **)**
|
||||
|
||||
38
classes/class_colorframe.rst
Normal file
38
classes/class_colorframe.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
.. 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_ColorFrame:
|
||||
|
||||
ColorFrame
|
||||
==========
|
||||
|
||||
**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_frame_color<class_ColorFrame_get_frame_color>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame_color<class_ColorFrame_set_frame_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_ColorFrame_get_frame_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_frame_color** **(** **)** const
|
||||
|
||||
.. _class_ColorFrame_set_frame_color:
|
||||
|
||||
- void **set_frame_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Control
|
||||
|
||||
**Inherits:** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`Label<class_label>`, :ref:`Tabs<class_tabs>`, :ref:`TextureFrame<class_textureframe>`, :ref:`ButtonArray<class_buttonarray>`, :ref:`VideoPlayer<class_videoplayer>`, :ref:`LineEdit<class_lineedit>`, :ref:`Container<class_container>`, :ref:`ReferenceFrame<class_referenceframe>`, :ref:`Patch9Frame<class_patch9frame>`, :ref:`TextEdit<class_textedit>`, :ref:`BaseButton<class_basebutton>`, :ref:`Popup<class_popup>`, :ref:`Tree<class_tree>`, :ref:`Separator<class_separator>`, :ref:`Panel<class_panel>`, :ref:`TabContainer<class_tabcontainer>`, :ref:`Range<class_range>`, :ref:`RichTextLabel<class_richtextlabel>`, :ref:`GraphEdit<class_graphedit>`, :ref:`ItemList<class_itemlist>`
|
||||
**Inherited By:** :ref:`Label<class_label>`, :ref:`Tabs<class_tabs>`, :ref:`TextureFrame<class_textureframe>`, :ref:`ButtonArray<class_buttonarray>`, :ref:`VideoPlayer<class_videoplayer>`, :ref:`LineEdit<class_lineedit>`, :ref:`ColorFrame<class_colorframe>`, :ref:`Container<class_container>`, :ref:`ReferenceFrame<class_referenceframe>`, :ref:`Patch9Frame<class_patch9frame>`, :ref:`TextEdit<class_textedit>`, :ref:`BaseButton<class_basebutton>`, :ref:`Popup<class_popup>`, :ref:`Tree<class_tree>`, :ref:`Separator<class_separator>`, :ref:`Panel<class_panel>`, :ref:`TabContainer<class_tabcontainer>`, :ref:`Range<class_range>`, :ref:`RichTextLabel<class_richtextlabel>`, :ref:`GraphEdit<class_graphedit>`, :ref:`ItemList<class_itemlist>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
99
classes/class_editorfilesystem.rst
Normal file
99
classes/class_editorfilesystem.rst
Normal file
@@ -0,0 +1,99 @@
|
||||
.. 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_EditorFileSystem:
|
||||
|
||||
EditorFileSystem
|
||||
================
|
||||
|
||||
**Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Resource filesystem, as the editor sees it.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_file_type<class_EditorFileSystem_get_file_type>` **(** :ref:`String<class_string>` path **)** const |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_filesystem<class_EditorFileSystem_get_filesystem>` **(** **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_path<class_EditorFileSystem_get_path>` **(** :ref:`String<class_string>` path **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_scanning_progress<class_EditorFileSystem_get_scanning_progress>` **(** **)** const |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_scanning<class_EditorFileSystem_is_scanning>` **(** **)** const |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`scan<class_EditorFileSystem_scan>` **(** **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`scan_sources<class_EditorFileSystem_scan_sources>` **(** **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update_file<class_EditorFileSystem_update_file>` **(** :ref:`String<class_string>` path **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **filesystem_changed** **(** **)**
|
||||
- **sources_changed** **(** :ref:`bool<class_bool>` exist **)**
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
This object holds information of all resources in the filesystem, their types, etc.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_EditorFileSystem_get_file_type:
|
||||
|
||||
- :ref:`String<class_string>` **get_file_type** **(** :ref:`String<class_string>` path **)** const
|
||||
|
||||
Get the type of the file, given the full path.
|
||||
|
||||
.. _class_EditorFileSystem_get_filesystem:
|
||||
|
||||
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_filesystem** **(** **)**
|
||||
|
||||
Get the root directory object.
|
||||
|
||||
.. _class_EditorFileSystem_get_path:
|
||||
|
||||
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_path** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
.. _class_EditorFileSystem_get_scanning_progress:
|
||||
|
||||
- :ref:`float<class_float>` **get_scanning_progress** **(** **)** const
|
||||
|
||||
Return the scan progress for 0 to 1 if the FS is being scanned.
|
||||
|
||||
.. _class_EditorFileSystem_is_scanning:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_scanning** **(** **)** const
|
||||
|
||||
Return true of the filesystem is being scanned.
|
||||
|
||||
.. _class_EditorFileSystem_scan:
|
||||
|
||||
- void **scan** **(** **)**
|
||||
|
||||
Scan the filesystem for changes.
|
||||
|
||||
.. _class_EditorFileSystem_scan_sources:
|
||||
|
||||
- void **scan_sources** **(** **)**
|
||||
|
||||
Check if the source of any imported resource changed.
|
||||
|
||||
.. _class_EditorFileSystem_update_file:
|
||||
|
||||
- void **update_file** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Update a file information. Call this if an external program (not Godot) modified the file.
|
||||
|
||||
|
||||
98
classes/class_editorfilesystemdirectory.rst
Normal file
98
classes/class_editorfilesystemdirectory.rst
Normal file
@@ -0,0 +1,98 @@
|
||||
.. 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_EditorFileSystemDirectory:
|
||||
|
||||
EditorFileSystemDirectory
|
||||
=========================
|
||||
|
||||
**Inherits:** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
A diretory for the resource filesystem.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_dir_index<class_EditorFileSystemDirectory_find_dir_index>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_file_index<class_EditorFileSystemDirectory_find_file_index>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_file<class_EditorFileSystemDirectory_get_file>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_file_count<class_EditorFileSystemDirectory_get_file_count>` **(** **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_file_path<class_EditorFileSystemDirectory_get_file_path>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_file_type<class_EditorFileSystemDirectory_get_file_type>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_name<class_EditorFileSystemDirectory_get_name>` **(** **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_parent<class_EditorFileSystemDirectory_get_parent>` **(** **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_path<class_EditorFileSystemDirectory_get_path>` **(** **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`get_subdir<class_EditorFileSystemDirectory_get_subdir>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdir_count<class_EditorFileSystemDirectory_get_subdir_count>` **(** **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_missing_sources<class_EditorFileSystemDirectory_is_missing_sources>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_EditorFileSystemDirectory_find_dir_index:
|
||||
|
||||
- :ref:`int<class_int>` **find_dir_index** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_find_file_index:
|
||||
|
||||
- :ref:`int<class_int>` **find_file_index** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_file:
|
||||
|
||||
- :ref:`String<class_string>` **get_file** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_file_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_file_count** **(** **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_file_path:
|
||||
|
||||
- :ref:`String<class_string>` **get_file_path** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_file_type:
|
||||
|
||||
- :ref:`String<class_string>` **get_file_type** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_name** **(** **)**
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_parent:
|
||||
|
||||
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_parent** **(** **)**
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_path:
|
||||
|
||||
- :ref:`String<class_string>` **get_path** **(** **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_subdir:
|
||||
|
||||
- :ref:`Object<class_object>` **get_subdir** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_subdir_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdir_count** **(** **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_is_missing_sources:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_missing_sources** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
|
||||
@@ -18,71 +18,87 @@ Used by the editor to extend it's functionality.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ToolButton<class_toolbutton>` | :ref:`add_control_to_bottom_panel<class_EditorPlugin_add_control_to_bottom_panel>` **(** :ref:`Control<class_control>` control, :ref:`String<class_string>` title **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>` **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_control_to_dock<class_EditorPlugin_add_control_to_dock>` **(** :ref:`int<class_int>` slot, :ref:`Control<class_control>` control **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_custom_type<class_EditorPlugin_add_custom_type>` **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_export_plugin<class_EditorPlugin_add_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` plugin **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_import_plugin<class_EditorPlugin_add_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` plugin **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`apply_changes<class_EditorPlugin_apply_changes>` **(** **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_EditorPlugin_clear>` **(** **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorSpatialGizmo<class_editorspatialgizmo>` | :ref:`create_spatial_gizmo<class_EditorPlugin_create_spatial_gizmo>` **(** :ref:`Spatial<class_spatial>` for_spatial **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`edit<class_EditorPlugin_edit>` **(** :ref:`Object<class_object>` object **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`forward_input_event<class_EditorPlugin_forward_input_event>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`forward_canvas_input_event<class_EditorPlugin_forward_canvas_input_event>` **(** :ref:`Matrix32<class_matrix32>` canvas_xform, :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`forward_draw_over_canvas<class_EditorPlugin_forward_draw_over_canvas>` **(** :ref:`Matrix32<class_matrix32>` canvas_xform, :ref:`Control<class_control>` canvas **)** virtual |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`forward_spatial_input_event<class_EditorPlugin_forward_spatial_input_event>` **(** :ref:`Camera<class_camera>` camera, :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Control<class_control>` | :ref:`get_base_control<class_EditorPlugin_get_base_control>` **(** **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringArray<class_stringarray>` | :ref:`get_breakpoints<class_EditorPlugin_get_breakpoints>` **(** **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`EditorFileSystem<class_editorfilesystem>` | :ref:`get_resource_filesystem<class_EditorPlugin_get_resource_filesystem>` **(** **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorResourcePreview<class_editorresourcepreview>` | :ref:`get_resource_previewer<class_EditorPlugin_get_resource_previewer>` **(** **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorSelection<class_editorselection>` | :ref:`get_selection<class_EditorPlugin_get_selection>` **(** **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`get_state<class_EditorPlugin_get_state>` **(** **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`UndoRedo<class_undoredo>` | :ref:`get_undo_redo<class_EditorPlugin_get_undo_redo>` **(** **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`get_window_layout<class_EditorPlugin_get_window_layout>` **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`handles<class_EditorPlugin_handles>` **(** :ref:`Object<class_object>` object **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_main_screen<class_EditorPlugin_has_main_screen>` **(** **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`hide_bottom_panel<class_EditorPlugin_hide_bottom_panel>` **(** **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`inspect_object<class_EditorPlugin_inspect_object>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` for_property="" **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_bottom_panel_item_visible<class_EditorPlugin_make_bottom_panel_item_visible>` **(** :ref:`Control<class_control>` item **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_visible<class_EditorPlugin_make_visible>` **(** :ref:`bool<class_bool>` visible **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue_save_layout<class_EditorPlugin_queue_save_layout>` **(** **)** const |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_control_from_bottom_panel<class_EditorPlugin_remove_control_from_bottom_panel>` **(** :ref:`Control<class_control>` control **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_control_from_docks<class_EditorPlugin_remove_control_from_docks>` **(** :ref:`Control<class_control>` control **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_custom_type<class_EditorPlugin_remove_custom_type>` **(** :ref:`String<class_string>` type **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_export_plugin<class_EditorPlugin_remove_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` plugin **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_import_plugin<class_EditorPlugin_remove_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` plugin **)** |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`save_external_data<class_EditorPlugin_save_external_data>` **(** **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_state<class_EditorPlugin_set_state>` **(** :ref:`Dictionary<class_dictionary>` state **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_window_layout<class_EditorPlugin_set_window_layout>` **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual |
|
||||
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update_canvas<class_EditorPlugin_update_canvas>` **(** **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -190,13 +206,17 @@ This is used for plugins that create gizmos used by the spatial editor. Just che
|
||||
|
||||
This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object.
|
||||
|
||||
.. _class_EditorPlugin_forward_input_event:
|
||||
.. _class_EditorPlugin_forward_canvas_input_event:
|
||||
|
||||
- :ref:`bool<class_bool>` **forward_input_event** **(** :ref:`InputEvent<class_inputevent>` event **)** virtual
|
||||
- :ref:`bool<class_bool>` **forward_canvas_input_event** **(** :ref:`Matrix32<class_matrix32>` canvas_xform, :ref:`InputEvent<class_inputevent>` event **)** virtual
|
||||
|
||||
This is a low level function for plugins that edit a given object type derived from CanvasItem to capture the input in the 2D editor viewport. The function is only being called if your object is being edited.
|
||||
If your plugin is active (because handles() returned true to the object), any input interaction with the 2D canvas editor will be first forwarded here. The canvas transform (containing zoom and offset to transform to edited world coordinates) is provided, but the input supplied is in untransformed coordinates to the canvas editor. Return true if you want to eat this event and not pass it to the canvas editor.
|
||||
|
||||
Return true if you want to capture the input, otherwise false.
|
||||
.. _class_EditorPlugin_forward_draw_over_canvas:
|
||||
|
||||
- void **forward_draw_over_canvas** **(** :ref:`Matrix32<class_matrix32>` canvas_xform, :ref:`Control<class_control>` canvas **)** virtual
|
||||
|
||||
This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call :ref:`update_canvas<class_EditorPlugin_update_canvas>`.
|
||||
|
||||
.. _class_EditorPlugin_forward_spatial_input_event:
|
||||
|
||||
@@ -226,12 +246,30 @@ 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
|
||||
|
||||
Get the name of the editor plugin. For main scren plugins this is what will appear in the selector (which by default is 2D, 3D, Script).
|
||||
|
||||
.. _class_EditorPlugin_get_resource_filesystem:
|
||||
|
||||
- :ref:`EditorFileSystem<class_editorfilesystem>` **get_resource_filesystem** **(** **)**
|
||||
|
||||
Get the filesystem cache for all resources in the project.
|
||||
|
||||
.. _class_EditorPlugin_get_resource_previewer:
|
||||
|
||||
- :ref:`EditorResourcePreview<class_editorresourcepreview>` **get_resource_previewer** **(** **)**
|
||||
|
||||
Get tool for generating resource previews.
|
||||
|
||||
.. _class_EditorPlugin_get_selection:
|
||||
|
||||
- :ref:`EditorSelection<class_editorselection>` **get_selection** **(** **)**
|
||||
@@ -268,6 +306,20 @@ Implement this function if your plugin edits a specific type of object (Resource
|
||||
|
||||
Return true if this is a main screen editor plugin (it goes in the main screen selector together with 2D, 3D, Script).
|
||||
|
||||
.. _class_EditorPlugin_hide_bottom_panel:
|
||||
|
||||
- void **hide_bottom_panel** **(** **)**
|
||||
|
||||
.. _class_EditorPlugin_inspect_object:
|
||||
|
||||
- void **inspect_object** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` for_property="" **)**
|
||||
|
||||
Inspect an object in the inspector.
|
||||
|
||||
.. _class_EditorPlugin_make_bottom_panel_item_visible:
|
||||
|
||||
- void **make_bottom_panel_item_visible** **(** :ref:`Control<class_control>` item **)**
|
||||
|
||||
.. _class_EditorPlugin_make_visible:
|
||||
|
||||
- void **make_visible** **(** :ref:`bool<class_bool>` visible **)** virtual
|
||||
@@ -330,4 +382,10 @@ Restore the state saved by :ref:`EditorPlugin.get_state<class_EditorPlugin_get_s
|
||||
|
||||
Restore the plugin GUI layout saved by :ref:`EditorPlugin.get_window_layout<class_EditorPlugin_get_window_layout>`.
|
||||
|
||||
.. _class_EditorPlugin_update_canvas:
|
||||
|
||||
- void **update_canvas** **(** **)**
|
||||
|
||||
Updates the control used to draw the edited scene over the 2D canvas. This is used together with :ref:`forward_canvas_input_event<class_EditorPlugin_forward_canvas_input_event>`.
|
||||
|
||||
|
||||
|
||||
76
classes/class_editorresourcepreview.rst
Normal file
76
classes/class_editorresourcepreview.rst
Normal file
@@ -0,0 +1,76 @@
|
||||
.. 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_EditorResourcePreview:
|
||||
|
||||
EditorResourcePreview
|
||||
=====================
|
||||
|
||||
**Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Helper to generate previews of reources or files.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_preview_generator<class_EditorResourcePreview_add_preview_generator>` **(** :ref:`EditorResourcePreviewGenerator<class_editorresourcepreviewgenerator>` generator **)** |
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`check_for_invalidation<class_EditorResourcePreview_check_for_invalidation>` **(** :ref:`String<class_string>` path **)** |
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue_edited_resource_preview<class_EditorResourcePreview_queue_edited_resource_preview>` **(** :ref:`Resource<class_resource>` resource, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` receiver_func, :ref:`Variant<class_variant>` userdata **)** |
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue_resource_preview<class_EditorResourcePreview_queue_resource_preview>` **(** :ref:`String<class_string>` path, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` receiver_func, :ref:`Variant<class_variant>` userdata **)** |
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_preview_generator<class_EditorResourcePreview_remove_preview_generator>` **(** :ref:`EditorResourcePreviewGenerator<class_editorresourcepreviewgenerator>` generator **)** |
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **preview_invalidated** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
This object is used to generate previews for resources of files.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_EditorResourcePreview_add_preview_generator:
|
||||
|
||||
- void **add_preview_generator** **(** :ref:`EditorResourcePreviewGenerator<class_editorresourcepreviewgenerator>` generator **)**
|
||||
|
||||
Create an own, custom preview generator.
|
||||
|
||||
.. _class_EditorResourcePreview_check_for_invalidation:
|
||||
|
||||
- void **check_for_invalidation** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Check if the resource changed, if so it will be invalidated and the corresponding signal emitted.
|
||||
|
||||
.. _class_EditorResourcePreview_queue_edited_resource_preview:
|
||||
|
||||
- void **queue_edited_resource_preview** **(** :ref:`Resource<class_resource>` resource, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` receiver_func, :ref:`Variant<class_variant>` userdata **)**
|
||||
|
||||
Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texure (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.
|
||||
|
||||
.. _class_EditorResourcePreview_queue_resource_preview:
|
||||
|
||||
- void **queue_resource_preview** **(** :ref:`String<class_string>` path, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` receiver_func, :ref:`Variant<class_variant>` userdata **)**
|
||||
|
||||
Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texure (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.
|
||||
|
||||
.. _class_EditorResourcePreview_remove_preview_generator:
|
||||
|
||||
- void **remove_preview_generator** **(** :ref:`EditorResourcePreviewGenerator<class_editorresourcepreviewgenerator>` generator **)**
|
||||
|
||||
Remove a custom preview generator.
|
||||
|
||||
|
||||
63
classes/class_editorresourcepreviewgenerator.rst
Normal file
63
classes/class_editorresourcepreviewgenerator.rst
Normal file
@@ -0,0 +1,63 @@
|
||||
.. 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_EditorResourcePreviewGenerator:
|
||||
|
||||
EditorResourcePreviewGenerator
|
||||
==============================
|
||||
|
||||
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Custom generator of previews.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_texture>` | :ref:`generate<class_EditorResourcePreviewGenerator_generate>` **(** :ref:`Resource<class_resource>` from **)** virtual |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_texture>` | :ref:`generate_from_path<class_EditorResourcePreviewGenerator_generate_from_path>` **(** :ref:`String<class_string>` path **)** virtual |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`handles<class_EditorResourcePreviewGenerator_handles>` **(** :ref:`String<class_string>` type **)** virtual |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Custom code to generate previews. Please check "file_dialog/thumbnail_size" in EditorSettings to find out the right size to do previews at.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_EditorResourcePreviewGenerator_generate:
|
||||
|
||||
- :ref:`Texture<class_texture>` **generate** **(** :ref:`Resource<class_resource>` from **)** virtual
|
||||
|
||||
Generate a preview from a given resource. This must be always implemented.
|
||||
|
||||
Returning an empty texture is an OK way to fail and let another generator take care.
|
||||
|
||||
Care must be taken because this function is always called from a thread (not the main thread).
|
||||
|
||||
.. _class_EditorResourcePreviewGenerator_generate_from_path:
|
||||
|
||||
- :ref:`Texture<class_texture>` **generate_from_path** **(** :ref:`String<class_string>` path **)** virtual
|
||||
|
||||
Generate a preview directly from a path, implementing this is optional, as default code will load and call generate()
|
||||
|
||||
Returning an empty texture is an OK way to fail and let another generator take care.
|
||||
|
||||
Care must be taken because this function is always called from a thread (not the main thread).
|
||||
|
||||
.. _class_EditorResourcePreviewGenerator_handles:
|
||||
|
||||
- :ref:`bool<class_bool>` **handles** **(** :ref:`String<class_string>` type **)** virtual
|
||||
|
||||
Return if your generator supports this resource type.
|
||||
|
||||
|
||||
@@ -18,15 +18,17 @@ Manages the SceneTree selection in the editor.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_EditorSelection_add_node>` **(** :ref:`Node<class_node>` node **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_EditorSelection_clear>` **(** **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_selected_nodes<class_EditorSelection_get_selected_nodes>` **(** **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_transformable_selected_nodes<class_EditorSelection_get_transformable_selected_nodes>` **(** **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_EditorSelection_remove_node>` **(** :ref:`Node<class_node>` node **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -59,6 +61,12 @@ Clear the selection.
|
||||
|
||||
Get the list of selectes nodes.
|
||||
|
||||
.. _class_EditorSelection_get_transformable_selected_nodes:
|
||||
|
||||
- :ref:`Array<class_array>` **get_transformable_selected_nodes** **(** **)**
|
||||
|
||||
Get the list of selected nodes, optimized for transform operations (ie, moving them, rotating, etc). This list avoids situations where a node is selected and also chid/grandchild.
|
||||
|
||||
.. _class_EditorSelection_remove_node:
|
||||
|
||||
- void **remove_node** **(** :ref:`Node<class_node>` node **)**
|
||||
|
||||
@@ -18,13 +18,13 @@ Reference to a function in an object.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`call_func<class_FuncRef_call_func>` **(** :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL, :ref:`Variant<class_variant>` arg5=NULL, :ref:`Variant<class_variant>` arg6=NULL, :ref:`Variant<class_variant>` arg7=NULL, :ref:`Variant<class_variant>` arg8=NULL, :ref:`Variant<class_variant>` arg9=NULL **)** |
|
||||
+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`call_func<class_FuncRef_call_func>` **(** **)** vararg |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_function<class_FuncRef_set_function>` **(** :ref:`String<class_string>` name **)** |
|
||||
+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_instance<class_FuncRef_set_instance>` **(** :ref:`Object<class_object>` instance **)** |
|
||||
+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -38,9 +38,7 @@ Member Function Description
|
||||
|
||||
.. _class_FuncRef_call_func:
|
||||
|
||||
- void **call_func** **(** :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL, :ref:`Variant<class_variant>` arg5=NULL, :ref:`Variant<class_variant>` arg6=NULL, :ref:`Variant<class_variant>` arg7=NULL, :ref:`Variant<class_variant>` arg8=NULL, :ref:`Variant<class_variant>` arg9=NULL **)**
|
||||
|
||||
Call the referenced function with the given arguments. The argument count must correspond to the required number of arguments in the function. Returns the return value of the function call.
|
||||
- :ref:`Variant<class_variant>` **call_func** **(** **)** vararg
|
||||
|
||||
.. _class_FuncRef_set_function:
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ Member Functions
|
||||
+----------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`RawArray<class_rawarray>` | :ref:`get_as_byte_code<class_GDScript_get_as_byte_code>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------+
|
||||
| void | :ref:`new<class_GDScript_new>` **(** **)** |
|
||||
| :ref:`Object<class_object>` | :ref:`new<class_GDScript_new>` **(** **)** vararg |
|
||||
+----------------------------------+-----------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
@@ -33,6 +33,6 @@ Member Function Description
|
||||
|
||||
.. _class_GDScript_new:
|
||||
|
||||
- void **new** **(** **)**
|
||||
- :ref:`Object<class_object>` **new** **(** **)** vararg
|
||||
|
||||
|
||||
|
||||
@@ -27,14 +27,26 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_scroll_ofs<class_GraphEdit_get_scroll_ofs>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_snap<class_GraphEdit_get_snap>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_zoom<class_GraphEdit_get_zoom>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_node_connected<class_GraphEdit_is_node_connected>` **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_right_disconnects_enabled<class_GraphEdit_is_right_disconnects_enabled>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_using_snap<class_GraphEdit_is_using_snap>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_right_disconnects<class_GraphEdit_set_right_disconnects>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_scroll_ofs<class_GraphEdit_set_scroll_ofs>` **(** :ref:`Vector2<class_vector2>` ofs **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_selected<class_GraphEdit_set_selected>` **(** :ref:`Object<class_object>` node **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_snap<class_GraphEdit_set_snap>` **(** :ref:`int<class_int>` pixels **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_snap<class_GraphEdit_set_use_snap>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_zoom<class_GraphEdit_set_zoom>` **(** :ref:`float<class_float>` p_zoom **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@@ -44,10 +56,13 @@ Signals
|
||||
- **_begin_node_move** **(** **)**
|
||||
- **_end_node_move** **(** **)**
|
||||
- **connection_request** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_string>` to, :ref:`int<class_int>` to_slot **)**
|
||||
- **connection_to_empty** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`Vector2<class_vector2>` release_pos **)**
|
||||
- **delete_nodes_request** **(** **)**
|
||||
- **disconnection_request** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_string>` to, :ref:`int<class_int>` to_slot **)**
|
||||
- **duplicate_nodes_request** **(** **)**
|
||||
- **node_selected** **(** :ref:`Object<class_object>` node **)**
|
||||
- **popup_request** **(** :ref:`Vector2<class_vector2>` p_position **)**
|
||||
- **scroll_offset_changed** **(** :ref:`Vector2<class_vector2>` ofs **)**
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -83,6 +98,10 @@ Return an Array containing the list of connections. A connection consists in a s
|
||||
|
||||
Return the scroll offset.
|
||||
|
||||
.. _class_GraphEdit_get_snap:
|
||||
|
||||
- :ref:`int<class_int>` **get_snap** **(** **)** const
|
||||
|
||||
.. _class_GraphEdit_get_zoom:
|
||||
|
||||
- :ref:`float<class_float>` **get_zoom** **(** **)** const
|
||||
@@ -101,12 +120,32 @@ Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_
|
||||
|
||||
Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise.
|
||||
|
||||
.. _class_GraphEdit_is_using_snap:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_using_snap** **(** **)** const
|
||||
|
||||
.. _class_GraphEdit_set_right_disconnects:
|
||||
|
||||
- void **set_right_disconnects** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void.
|
||||
|
||||
.. _class_GraphEdit_set_scroll_ofs:
|
||||
|
||||
- void **set_scroll_ofs** **(** :ref:`Vector2<class_vector2>` ofs **)**
|
||||
|
||||
.. _class_GraphEdit_set_selected:
|
||||
|
||||
- void **set_selected** **(** :ref:`Object<class_object>` node **)**
|
||||
|
||||
.. _class_GraphEdit_set_snap:
|
||||
|
||||
- void **set_snap** **(** :ref:`int<class_int>` pixels **)**
|
||||
|
||||
.. _class_GraphEdit_set_use_snap:
|
||||
|
||||
- void **set_use_snap** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_GraphEdit_set_zoom:
|
||||
|
||||
- void **set_zoom** **(** :ref:`float<class_float>` p_zoom **)**
|
||||
|
||||
@@ -18,53 +18,69 @@ A GraphNode is a container with several input and output slots allowing connecti
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_all_slots<class_GraphNode_clear_all_slots>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_slot<class_GraphNode_clear_slot>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_connection_input_color<class_GraphNode_get_connection_input_color>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_connection_input_count<class_GraphNode_get_connection_input_count>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_connection_input_pos<class_GraphNode_get_connection_input_pos>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_connection_input_type<class_GraphNode_get_connection_input_type>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_connection_output_color<class_GraphNode_get_connection_output_color>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_connection_output_count<class_GraphNode_get_connection_output_count>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_connection_output_pos<class_GraphNode_get_connection_output_pos>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_connection_output_type<class_GraphNode_get_connection_output_type>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_modulate<class_GraphNode_get_modulate>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_GraphNode_get_offset>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_overlay<class_GraphNode_get_overlay>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_slot_color_left<class_GraphNode_get_slot_color_left>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_slot_color_right<class_GraphNode_get_slot_color_right>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_slot_type_left<class_GraphNode_get_slot_type_left>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_slot_type_right<class_GraphNode_get_slot_type_right>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_title<class_GraphNode_get_title>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_close_button_visible<class_GraphNode_is_close_button_visible>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_comment<class_GraphNode_is_comment>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_resizeable<class_GraphNode_is_resizeable>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_left<class_GraphNode_is_slot_enabled_left>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_right<class_GraphNode_is_slot_enabled_right>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_comment<class_GraphNode_set_comment>` **(** :ref:`bool<class_bool>` comment **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_modulate<class_GraphNode_set_modulate>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_offset<class_GraphNode_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_overlay<class_GraphNode_set_overlay>` **(** :ref:`int<class_int>` overlay **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_resizeable<class_GraphNode_set_resizeable>` **(** :ref:`bool<class_bool>` resizeable **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_show_close_button<class_GraphNode_set_show_close_button>` **(** :ref:`bool<class_bool>` show **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_slot<class_GraphNode_set_slot>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_slot<class_GraphNode_set_slot>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right, :ref:`Object<class_object>` custom_left=NULL, :ref:`Object<class_object>` custom_right=NULL **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_title<class_GraphNode_set_title>` **(** :ref:`String<class_string>` title **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -73,6 +89,14 @@ Signals
|
||||
- **dragged** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to **)**
|
||||
- **offset_changed** **(** **)**
|
||||
- **raise_request** **(** **)**
|
||||
- **resize_request** **(** :ref:`Vector2<class_vector2>` new_minsize **)**
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **OVERLAY_DISABLED** = **0**
|
||||
- **OVERLAY_BREAKPOINT** = **1**
|
||||
- **OVERLAY_POSITION** = **2**
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -142,12 +166,20 @@ Return the position of the output connection 'idx'.
|
||||
|
||||
Return the type of the output connection 'idx'.
|
||||
|
||||
.. _class_GraphNode_get_modulate:
|
||||
|
||||
- :ref:`Color<class_color>` **get_modulate** **(** **)** const
|
||||
|
||||
.. _class_GraphNode_get_offset:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
|
||||
|
||||
Return the offset of the GraphNode.
|
||||
|
||||
.. _class_GraphNode_get_overlay:
|
||||
|
||||
- :ref:`int<class_int>` **get_overlay** **(** **)** const
|
||||
|
||||
.. _class_GraphNode_get_slot_color_left:
|
||||
|
||||
- :ref:`Color<class_color>` **get_slot_color_left** **(** :ref:`int<class_int>` idx **)** const
|
||||
@@ -184,6 +216,14 @@ Return the title of the GraphNode.
|
||||
|
||||
Returns true if the close button is shown. False otherwise.
|
||||
|
||||
.. _class_GraphNode_is_comment:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_comment** **(** **)** const
|
||||
|
||||
.. _class_GraphNode_is_resizeable:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_resizeable** **(** **)** const
|
||||
|
||||
.. _class_GraphNode_is_slot_enabled_left:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_slot_enabled_left** **(** :ref:`int<class_int>` idx **)** const
|
||||
@@ -196,12 +236,28 @@ Return true if left (input) slot 'idx' is enabled. False otherwise.
|
||||
|
||||
Return true if right (output) slot 'idx' is enabled. False otherwise.
|
||||
|
||||
.. _class_GraphNode_set_comment:
|
||||
|
||||
- void **set_comment** **(** :ref:`bool<class_bool>` comment **)**
|
||||
|
||||
.. _class_GraphNode_set_modulate:
|
||||
|
||||
- void **set_modulate** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
.. _class_GraphNode_set_offset:
|
||||
|
||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
||||
|
||||
Set the offset of the GraphNode.
|
||||
|
||||
.. _class_GraphNode_set_overlay:
|
||||
|
||||
- void **set_overlay** **(** :ref:`int<class_int>` overlay **)**
|
||||
|
||||
.. _class_GraphNode_set_resizeable:
|
||||
|
||||
- void **set_resizeable** **(** :ref:`bool<class_bool>` resizeable **)**
|
||||
|
||||
.. _class_GraphNode_set_show_close_button:
|
||||
|
||||
- void **set_show_close_button** **(** :ref:`bool<class_bool>` show **)**
|
||||
@@ -210,9 +266,7 @@ Show the close button on the GraphNode if 'show' is true (disabled by default).
|
||||
|
||||
.. _class_GraphNode_set_slot:
|
||||
|
||||
- void **set_slot** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right **)**
|
||||
|
||||
Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input, 'right' are output. 'type' is an integer defining the type of the slot. Refer to description for the compatibility between slot types.
|
||||
- void **set_slot** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right, :ref:`Object<class_object>` custom_left=NULL, :ref:`Object<class_object>` custom_right=NULL **)**
|
||||
|
||||
.. _class_GraphNode_set_title:
|
||||
|
||||
|
||||
@@ -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 **)** |
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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,13 +127,7 @@ 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 **)**
|
||||
|
||||
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.
|
||||
|
||||
The custom_headers are HTTP request headers which will be used. If User-Agent is not specified a Godot specific will be used.
|
||||
|
||||
The ssl_validate_domain specifies if in case of HTTPS the server certificate should be verified.
|
||||
- :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="" **)**
|
||||
|
||||
.. _class_HTTPRequest_set_body_size_limit:
|
||||
|
||||
|
||||
@@ -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_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.
|
||||
|
||||
|
||||
@@ -27,13 +27,21 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_joy_mapping<class_Input_add_joy_mapping>` **(** :ref:`String<class_string>` mapping, :ref:`bool<class_bool>` update_existing=false **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_accelerometer<class_Input_get_accelerometer>` **(** **)** |
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_accelerometer<class_Input_get_accelerometer>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_connected_joysticks<class_Input_get_connected_joysticks>` **(** **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_gyroscope<class_Input_get_gyroscope>` **(** **)** |
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_gyroscope<class_Input_get_gyroscope>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_joy_axis<class_Input_get_joy_axis>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** |
|
||||
| :ref:`float<class_float>` | :ref:`get_joy_axis<class_Input_get_joy_axis>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -43,7 +51,7 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_joy_vibration_strength<class_Input_get_joy_vibration_strength>` **(** :ref:`int<class_int>` device **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_magnetometer<class_Input_get_magnetometer>` **(** **)** |
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_magnetometer<class_Input_get_magnetometer>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_mouse_button_mask<class_Input_get_mouse_button_mask>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -51,15 +59,19 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_mouse_speed<class_Input_get_mouse_speed>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_Input_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_just_pressed<class_Input_is_action_just_pressed>` **(** :ref:`String<class_string>` action **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_joy_button_pressed<class_Input_is_joy_button_pressed>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)** |
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_just_released<class_Input_is_action_just_released>` **(** :ref:`String<class_string>` action **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_Input_is_action_pressed>` **(** :ref:`String<class_string>` action **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_joy_button_pressed<class_Input_is_joy_button_pressed>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_joy_known<class_Input_is_joy_known>` **(** :ref:`int<class_int>` device **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_key_pressed<class_Input_is_key_pressed>` **(** :ref:`int<class_int>` scancode **)** |
|
||||
| :ref:`bool<class_bool>` | :ref:`is_key_pressed<class_Input_is_key_pressed>` **(** :ref:`int<class_int>` scancode **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_mouse_button_pressed<class_Input_is_mouse_button_pressed>` **(** :ref:`int<class_int>` button **)** |
|
||||
| :ref:`bool<class_bool>` | :ref:`is_mouse_button_pressed<class_Input_is_mouse_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_joy_mapping<class_Input_remove_joy_mapping>` **(** :ref:`String<class_string>` guid **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -114,7 +126,7 @@ Add a new mapping entry (in SDL2 format) to the mapping database. Optionally upd
|
||||
|
||||
.. _class_Input_get_accelerometer:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_accelerometer** **(** **)**
|
||||
- :ref:`Vector3<class_vector3>` **get_accelerometer** **(** **)** const
|
||||
|
||||
If the device has an accelerometer, this will return the movement.
|
||||
|
||||
@@ -126,16 +138,32 @@ Returns an :ref:`Array<class_array>` containing the device IDs of all currently
|
||||
|
||||
.. _class_Input_get_gyroscope:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_gyroscope** **(** **)**
|
||||
- :ref:`Vector3<class_vector3>` **get_gyroscope** **(** **)** const
|
||||
|
||||
If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's x, y, and z axis.
|
||||
|
||||
.. _class_Input_get_joy_axis:
|
||||
|
||||
- :ref:`float<class_float>` **get_joy_axis** **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)**
|
||||
- :ref:`float<class_float>` **get_joy_axis** **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** const
|
||||
|
||||
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
|
||||
@@ -162,7 +190,7 @@ Returns the strength of the joystick vibration: x is the strength of the weak mo
|
||||
|
||||
.. _class_Input_get_magnetometer:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_magnetometer** **(** **)**
|
||||
- :ref:`Vector3<class_vector3>` **get_magnetometer** **(** **)** const
|
||||
|
||||
If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes.
|
||||
|
||||
@@ -184,15 +212,23 @@ Return the mouse mode. See the constants for more information.
|
||||
|
||||
Returns the mouse speed for the last time the cursor was moved, and this until the next frame where the mouse moves. This means that even if the mouse is not moving, this function will still return the value of the last motion.
|
||||
|
||||
.. _class_Input_is_action_just_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_just_pressed** **(** :ref:`String<class_string>` action **)** const
|
||||
|
||||
.. _class_Input_is_action_just_released:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_just_released** **(** :ref:`String<class_string>` action **)** const
|
||||
|
||||
.. _class_Input_is_action_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)** const
|
||||
|
||||
Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with :ref:`InputMap<class_inputmap>`.
|
||||
|
||||
.. _class_Input_is_joy_button_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_joy_button_pressed** **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)**
|
||||
- :ref:`bool<class_bool>` **is_joy_button_pressed** **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)** const
|
||||
|
||||
Returns if the joystick button at the given index is currently pressed. (see JOY\_\* constants in :ref:`@Global Scope<class_@global scope>`)
|
||||
|
||||
@@ -204,13 +240,13 @@ Returns if the specified device is known by the system. This means that it sets
|
||||
|
||||
.. _class_Input_is_key_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_key_pressed** **(** :ref:`int<class_int>` scancode **)**
|
||||
- :ref:`bool<class_bool>` **is_key_pressed** **(** :ref:`int<class_int>` scancode **)** const
|
||||
|
||||
Returns true or false depending on whether the key is pressed or not. You can pass KEY\_\*, which are pre-defined constants listed in :ref:`@Global Scope<class_@global scope>`.
|
||||
|
||||
.. _class_Input_is_mouse_button_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_mouse_button_pressed** **(** :ref:`int<class_int>` button **)**
|
||||
- :ref:`bool<class_bool>` **is_mouse_button_pressed** **(** :ref:`int<class_int>` button **)** const
|
||||
|
||||
Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON\_\*, which are pre-defined constants listed in :ref:`@Global Scope<class_@global scope>`.
|
||||
|
||||
@@ -236,7 +272,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:
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ Remove an action from the :ref:`InputMap<class_inputmap>`.
|
||||
|
||||
- :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const
|
||||
|
||||
Return whether the given event is part of an existing action.
|
||||
Return whether the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent<class_inputevent>` is not pressed (for proper release detection). See :ref:`action_has_event<class_InputMap_action_has_event>` if you don't want this behavior.
|
||||
|
||||
.. _class_InputMap_get_action_from_id:
|
||||
|
||||
|
||||
@@ -20,19 +20,19 @@ IP Protocol support functions.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase_resolve_item<class_IP_erase_resolve_item>` **(** :ref:`int<class_int>` id **)** |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_local_addresses<class_IP_get_local_addresses>` **(** **)** const |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_resolve_item_address<class_IP_get_resolve_item_address>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_resolve_item_status<class_IP_get_resolve_item_status>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`resolve_hostname<class_IP_resolve_hostname>` **(** :ref:`String<class_string>` host **)** |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`resolve_hostname_queue_item<class_IP_resolve_hostname_queue_item>` **(** :ref:`String<class_string>` host **)** |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`resolve_hostname<class_IP_resolve_hostname>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`resolve_hostname_queue_item<class_IP_resolve_hostname_queue_item>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -76,14 +76,14 @@ Return the status of hostname queued for resolving, given it's queue ID. Returne
|
||||
|
||||
.. _class_IP_resolve_hostname:
|
||||
|
||||
- :ref:`String<class_string>` **resolve_hostname** **(** :ref:`String<class_string>` host **)**
|
||||
- :ref:`String<class_string>` **resolve_hostname** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY **)**
|
||||
|
||||
Resolve a given hostname, blocking. Resolved hostname is returned as an IP.
|
||||
Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type".
|
||||
|
||||
.. _class_IP_resolve_hostname_queue_item:
|
||||
|
||||
- :ref:`int<class_int>` **resolve_hostname_queue_item** **(** :ref:`String<class_string>` host **)**
|
||||
- :ref:`int<class_int>` **resolve_hostname_queue_item** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY **)**
|
||||
|
||||
Create a queue item for resolving a given hostname. The queue ID is returned, or RESOLVER_INVALID_ID on error.
|
||||
Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error.
|
||||
|
||||
|
||||
|
||||
@@ -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 **)**
|
||||
|
||||
@@ -18,35 +18,45 @@ Kinematic body 2D node.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`get_collider<class_KinematicBody2D_get_collider>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`get_collider_metadata<class_KinematicBody2D_get_collider_metadata>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collider_shape<class_KinematicBody2D_get_collider_shape>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_collider_velocity<class_KinematicBody2D_get_collider_velocity>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_collision_margin<class_KinematicBody2D_get_collision_margin>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_normal<class_KinematicBody2D_get_collision_normal>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_pos<class_KinematicBody2D_get_collision_pos>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_move_and_slide_colliders<class_KinematicBody2D_get_move_and_slide_colliders>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_travel<class_KinematicBody2D_get_travel>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_colliding<class_KinematicBody2D_is_colliding>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_move_and_slide_on_ceiling<class_KinematicBody2D_is_move_and_slide_on_ceiling>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_move_and_slide_on_floor<class_KinematicBody2D_is_move_and_slide_on_floor>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_move_and_slide_on_wall<class_KinematicBody2D_is_move_and_slide_on_wall>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`move<class_KinematicBody2D_move>` **(** :ref:`Vector2<class_vector2>` rel_vec **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`move_and_slide<class_KinematicBody2D_move_and_slide>` **(** :ref:`Vector2<class_vector2>` linear_velocity, :ref:`Vector2<class_vector2>` floor_normal=Vector2(0, 0), :ref:`float<class_float>` slope_stop_min_velocity=5, :ref:`int<class_int>` max_bounces=4 **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`move_to<class_KinematicBody2D_move_to>` **(** :ref:`Vector2<class_vector2>` position **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`revert_motion<class_KinematicBody2D_revert_motion>` **(** **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_margin<class_KinematicBody2D_set_collision_margin>` **(** :ref:`float<class_float>` pixels **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`test_move<class_KinematicBody2D_test_move>` **(** :ref:`Vector2<class_vector2>` rel_vec **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`test_move<class_KinematicBody2D_test_move>` **(** :ref:`Matrix32<class_matrix32>` from, :ref:`Vector2<class_vector2>` rel_vec **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -102,6 +112,10 @@ Return the normal of the surface the body collided with. This is useful to imple
|
||||
|
||||
Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with :ref:`is_colliding<class_KinematicBody2D_is_colliding>`.
|
||||
|
||||
.. _class_KinematicBody2D_get_move_and_slide_colliders:
|
||||
|
||||
- :ref:`Array<class_array>` **get_move_and_slide_colliders** **(** **)** const
|
||||
|
||||
.. _class_KinematicBody2D_get_travel:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_travel** **(** **)** const
|
||||
@@ -114,12 +128,28 @@ Return the last movement done by the body.
|
||||
|
||||
Return whether the body is colliding with another.
|
||||
|
||||
.. _class_KinematicBody2D_is_move_and_slide_on_ceiling:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_move_and_slide_on_ceiling** **(** **)** const
|
||||
|
||||
.. _class_KinematicBody2D_is_move_and_slide_on_floor:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_move_and_slide_on_floor** **(** **)** const
|
||||
|
||||
.. _class_KinematicBody2D_is_move_and_slide_on_wall:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_move_and_slide_on_wall** **(** **)** const
|
||||
|
||||
.. _class_KinematicBody2D_move:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **move** **(** :ref:`Vector2<class_vector2>` rel_vec **)**
|
||||
|
||||
Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped.
|
||||
|
||||
.. _class_KinematicBody2D_move_and_slide:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **move_and_slide** **(** :ref:`Vector2<class_vector2>` linear_velocity, :ref:`Vector2<class_vector2>` floor_normal=Vector2(0, 0), :ref:`float<class_float>` slope_stop_min_velocity=5, :ref:`int<class_int>` max_bounces=4 **)**
|
||||
|
||||
.. _class_KinematicBody2D_move_to:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **move_to** **(** :ref:`Vector2<class_vector2>` position **)**
|
||||
@@ -140,8 +170,8 @@ Set the collision margin for this object. A collision margin is an amount (in pi
|
||||
|
||||
.. _class_KinematicBody2D_test_move:
|
||||
|
||||
- :ref:`bool<class_bool>` **test_move** **(** :ref:`Vector2<class_vector2>` rel_vec **)**
|
||||
- :ref:`bool<class_bool>` **test_move** **(** :ref:`Matrix32<class_matrix32>` from, :ref:`Vector2<class_vector2>` rel_vec **)**
|
||||
|
||||
Return true if there would be a collision if the body moved in the given direction.
|
||||
Return true if there would be a collision if the body moved from the given point in the given direction.
|
||||
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ Member Functions
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`cursor_get_blink_speed<class_LineEdit_cursor_get_blink_speed>` **(** **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`cursor_set_blink_enabled<class_LineEdit_cursor_set_blink_enabled>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
| void | :ref:`cursor_set_blink_enabled<class_LineEdit_cursor_set_blink_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`cursor_set_blink_speed<class_LineEdit_cursor_set_blink_speed>` **(** :ref:`float<class_float>` blink_speed **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -35,6 +35,8 @@ Member Functions
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_cursor_pos<class_LineEdit_get_cursor_pos>` **(** **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_expand_to_text_length<class_LineEdit_get_expand_to_text_length>` **(** **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_max_length<class_LineEdit_get_max_length>` **(** **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PopupMenu<class_popupmenu>` | :ref:`get_menu<class_LineEdit_get_menu>` **(** **)** const |
|
||||
@@ -61,6 +63,8 @@ Member Functions
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_editable<class_LineEdit_set_editable>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_expand_to_text_length<class_LineEdit_set_expand_to_text_length>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_max_length<class_LineEdit_set_max_length>` **(** :ref:`int<class_int>` chars **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_placeholder<class_LineEdit_set_placeholder>` **(** :ref:`String<class_string>` text **)** |
|
||||
@@ -127,7 +131,7 @@ Gets the line edit caret blink speed.
|
||||
|
||||
.. _class_LineEdit_cursor_set_blink_enabled:
|
||||
|
||||
- void **cursor_set_blink_enabled** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **cursor_set_blink_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
Set the line edit caret to blink.
|
||||
|
||||
@@ -147,6 +151,10 @@ Set the line edit caret blink speed. Cannot be less then or equal to 0.
|
||||
|
||||
Return the cursor position inside the :ref:`LineEdit<class_lineedit>`.
|
||||
|
||||
.. _class_LineEdit_get_expand_to_text_length:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_expand_to_text_length** **(** **)** const
|
||||
|
||||
.. _class_LineEdit_get_max_length:
|
||||
|
||||
- :ref:`int<class_int>` **get_max_length** **(** **)** const
|
||||
@@ -213,6 +221,10 @@ Set the cursor position inside the :ref:`LineEdit<class_lineedit>`, causing it t
|
||||
|
||||
Set the *editable* status of the :ref:`LineEdit<class_lineedit>`. When disabled, existing text can't be modified and new text can't be added.
|
||||
|
||||
.. _class_LineEdit_set_expand_to_text_length:
|
||||
|
||||
- void **set_expand_to_text_length** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_LineEdit_set_max_length:
|
||||
|
||||
- void **set_max_length** **(** :ref:`int<class_int>` chars **)**
|
||||
|
||||
@@ -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
|
||||
-----------
|
||||
|
||||
75
classes/class_networkedmultiplayerenet.rst
Normal file
75
classes/class_networkedmultiplayerenet.rst
Normal file
@@ -0,0 +1,75 @@
|
||||
.. 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_NetworkedMultiplayerENet:
|
||||
|
||||
NetworkedMultiplayerENet
|
||||
========================
|
||||
|
||||
**Inherits:** :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` **<** :ref:`PacketPeer<class_packetpeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
PacketPeer implementation using the ENet library.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`close_connection<class_NetworkedMultiplayerENet_close_connection>` **(** **)** |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`create_client<class_NetworkedMultiplayerENet_create_client>` **(** :ref:`String<class_string>` ip, :ref:`int<class_int>` port, :ref:`int<class_int>` in_bandwidth=0, :ref:`int<class_int>` out_bandwidth=0 **)** |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`create_server<class_NetworkedMultiplayerENet_create_server>` **(** :ref:`int<class_int>` port, :ref:`int<class_int>` max_clients=32, :ref:`int<class_int>` in_bandwidth=0, :ref:`int<class_int>` out_bandwidth=0 **)** |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_compression_mode<class_NetworkedMultiplayerENet_get_compression_mode>` **(** **)** const |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bind_ip<class_NetworkedMultiplayerENet_set_bind_ip>` **(** :ref:`String<class_string>` ip **)** |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_compression_mode<class_NetworkedMultiplayerENet_set_compression_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **COMPRESS_NONE** = **0**
|
||||
- **COMPRESS_RANGE_CODER** = **1**
|
||||
- **COMPRESS_FASTLZ** = **2**
|
||||
- **COMPRESS_ZLIB** = **3**
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
A connection (or a listening server) that should be passed to :ref:`SceneTree.set_network_peer<class_SceneTree_set_network_peer>`. Socket events can be handled by connecting to :ref:`SceneTree<class_scenetree>` signals.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_NetworkedMultiplayerENet_close_connection:
|
||||
|
||||
- void **close_connection** **(** **)**
|
||||
|
||||
.. _class_NetworkedMultiplayerENet_create_client:
|
||||
|
||||
- :ref:`int<class_int>` **create_client** **(** :ref:`String<class_string>` ip, :ref:`int<class_int>` port, :ref:`int<class_int>` in_bandwidth=0, :ref:`int<class_int>` out_bandwidth=0 **)**
|
||||
|
||||
.. _class_NetworkedMultiplayerENet_create_server:
|
||||
|
||||
- :ref:`int<class_int>` **create_server** **(** :ref:`int<class_int>` port, :ref:`int<class_int>` max_clients=32, :ref:`int<class_int>` in_bandwidth=0, :ref:`int<class_int>` out_bandwidth=0 **)**
|
||||
|
||||
.. _class_NetworkedMultiplayerENet_get_compression_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_compression_mode** **(** **)** const
|
||||
|
||||
.. _class_NetworkedMultiplayerENet_set_bind_ip:
|
||||
|
||||
- void **set_bind_ip** **(** :ref:`String<class_string>` ip **)**
|
||||
|
||||
.. _class_NetworkedMultiplayerENet_set_compression_mode:
|
||||
|
||||
- void **set_compression_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
|
||||
97
classes/class_networkedmultiplayerpeer.rst
Normal file
97
classes/class_networkedmultiplayerpeer.rst
Normal file
@@ -0,0 +1,97 @@
|
||||
.. 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_NetworkedMultiplayerPeer:
|
||||
|
||||
NetworkedMultiplayerPeer
|
||||
========================
|
||||
|
||||
**Inherits:** :ref:`PacketPeer<class_packetpeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`NetworkedMultiplayerENet<class_networkedmultiplayerenet>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_connection_status<class_NetworkedMultiplayerPeer_get_connection_status>` **(** **)** const |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_packet_peer<class_NetworkedMultiplayerPeer_get_packet_peer>` **(** **)** const |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_unique_id<class_NetworkedMultiplayerPeer_get_unique_id>` **(** **)** const |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_refusing_new_connections<class_NetworkedMultiplayerPeer_is_refusing_new_connections>` **(** **)** const |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`poll<class_NetworkedMultiplayerPeer_poll>` **(** **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_refuse_new_connections<class_NetworkedMultiplayerPeer_set_refuse_new_connections>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_target_peer<class_NetworkedMultiplayerPeer_set_target_peer>` **(** :ref:`int<class_int>` id **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_transfer_mode<class_NetworkedMultiplayerPeer_set_transfer_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **connection_failed** **(** **)**
|
||||
- **connection_succeeded** **(** **)**
|
||||
- **peer_connected** **(** :ref:`int<class_int>` id **)**
|
||||
- **peer_disconnected** **(** :ref:`int<class_int>` id **)**
|
||||
- **server_disconnected** **(** **)**
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **TRANSFER_MODE_UNRELIABLE** = **0**
|
||||
- **TRANSFER_MODE_UNRELIABLE_ORDERED** = **1**
|
||||
- **TRANSFER_MODE_RELIABLE** = **2**
|
||||
- **CONNECTION_DISCONNECTED** = **0**
|
||||
- **CONNECTION_CONNECTING** = **1**
|
||||
- **CONNECTION_CONNECTED** = **2**
|
||||
- **TARGET_PEER_BROADCAST** = **0**
|
||||
- **TARGET_PEER_SERVER** = **1**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_NetworkedMultiplayerPeer_get_connection_status:
|
||||
|
||||
- :ref:`int<class_int>` **get_connection_status** **(** **)** const
|
||||
|
||||
.. _class_NetworkedMultiplayerPeer_get_packet_peer:
|
||||
|
||||
- :ref:`int<class_int>` **get_packet_peer** **(** **)** const
|
||||
|
||||
.. _class_NetworkedMultiplayerPeer_get_unique_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_unique_id** **(** **)** const
|
||||
|
||||
.. _class_NetworkedMultiplayerPeer_is_refusing_new_connections:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_refusing_new_connections** **(** **)** const
|
||||
|
||||
.. _class_NetworkedMultiplayerPeer_poll:
|
||||
|
||||
- void **poll** **(** **)**
|
||||
|
||||
.. _class_NetworkedMultiplayerPeer_set_refuse_new_connections:
|
||||
|
||||
- void **set_refuse_new_connections** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_NetworkedMultiplayerPeer_set_target_peer:
|
||||
|
||||
- void **set_target_peer** **(** :ref:`int<class_int>` id **)**
|
||||
|
||||
.. _class_NetworkedMultiplayerPeer_set_transfer_mode:
|
||||
|
||||
- void **set_transfer_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Node
|
||||
|
||||
**Inherits:** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`Viewport<class_viewport>`, :ref:`Timer<class_timer>`, :ref:`CanvasLayer<class_canvaslayer>`, :ref:`EventPlayer<class_eventplayer>`, :ref:`SoundRoomParams<class_soundroomparams>`, :ref:`Spatial<class_spatial>`, :ref:`AnimationPlayer<class_animationplayer>`, :ref:`EditorPlugin<class_editorplugin>`, :ref:`ResourcePreloader<class_resourcepreloader>`, :ref:`AnimationTreePlayer<class_animationtreeplayer>`, :ref:`SamplePlayer<class_sampleplayer>`, :ref:`InstancePlaceholder<class_instanceplaceholder>`, :ref:`HTTPRequest<class_httprequest>`, :ref:`StreamPlayer<class_streamplayer>`, :ref:`CanvasItem<class_canvasitem>`, :ref:`Tween<class_tween>`
|
||||
**Inherited By:** :ref:`Viewport<class_viewport>`, :ref:`Timer<class_timer>`, :ref:`CanvasLayer<class_canvaslayer>`, :ref:`EventPlayer<class_eventplayer>`, :ref:`SoundRoomParams<class_soundroomparams>`, :ref:`Tween<class_tween>`, :ref:`Spatial<class_spatial>`, :ref:`AnimationPlayer<class_animationplayer>`, :ref:`EditorFileSystem<class_editorfilesystem>`, :ref:`EditorPlugin<class_editorplugin>`, :ref:`ResourcePreloader<class_resourcepreloader>`, :ref:`AnimationTreePlayer<class_animationtreeplayer>`, :ref:`SamplePlayer<class_sampleplayer>`, :ref:`InstancePlaceholder<class_instanceplaceholder>`, :ref:`HTTPRequest<class_httprequest>`, :ref:`StreamPlayer<class_streamplayer>`, :ref:`EditorResourcePreview<class_editorresourcepreview>`, :ref:`CanvasItem<class_canvasitem>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
@@ -20,139 +20,165 @@ Base class for all the *scene* elements.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_enter_tree<class_Node__enter_tree>` **(** **)** virtual |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_exit_tree<class_Node__exit_tree>` **(** **)** virtual |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_fixed_process<class_Node__fixed_process>` **(** :ref:`float<class_float>` delta **)** virtual |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_input<class_Node__input>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_process<class_Node__process>` **(** :ref:`float<class_float>` delta **)** virtual |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_ready<class_Node__ready>` **(** **)** virtual |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_unhandled_input<class_Node__unhandled_input>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_unhandled_key_input<class_Node__unhandled_key_input>` **(** :ref:`InputEvent<class_inputevent>` key_event **)** virtual |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_child<class_Node_add_child>` **(** :ref:`Node<class_node>` node, :ref:`bool<class_bool>` legible_unique_name=false **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_to_group<class_Node_add_to_group>` **(** :ref:`String<class_string>` group, :ref:`bool<class_bool>` persistent=false **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_process<class_Node_can_process>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_node>` | :ref:`duplicate<class_Node_duplicate>` **(** :ref:`bool<class_bool>` use_instancing=false **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_node>` | :ref:`find_node<class_Node_find_node>` **(** :ref:`String<class_string>` mask, :ref:`bool<class_bool>` recursive=true, :ref:`bool<class_bool>` owned=true **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_node>` | :ref:`get_child<class_Node_get_child>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_child_count<class_Node_get_child_count>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_children<class_Node_get_children>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_filename<class_Node_get_filename>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_fixed_process_delta_time<class_Node_get_fixed_process_delta_time>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_groups<class_Node_get_groups>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_index<class_Node_get_index>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_name<class_Node_get_name>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_network_mode<class_Node_get_network_mode>` **(** **)** const |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_node>` | :ref:`get_node<class_Node_get_node>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_node_and_resource<class_Node_get_node_and_resource>` **(** :ref:`NodePath<class_nodepath>` path **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_node>` | :ref:`get_owner<class_Node_get_owner>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_node>` | :ref:`get_parent<class_Node_get_parent>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_path<class_Node_get_path>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_path_to<class_Node_get_path_to>` **(** :ref:`Node<class_node>` node **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_pause_mode<class_Node_get_pause_mode>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_position_in_parent<class_Node_get_position_in_parent>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_process_delta_time<class_Node_get_process_delta_time>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_scene_instance_load_placeholder<class_Node_get_scene_instance_load_placeholder>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SceneTree<class_scenetree>` | :ref:`get_tree<class_Node_get_tree>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`get_viewport<class_Node_get_viewport>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_node<class_Node_has_node>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_node_and_resource<class_Node_has_node_and_resource>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_a_parent_of<class_Node_is_a_parent_of>` **(** :ref:`Node<class_node>` node **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_displayed_folded<class_Node_is_displayed_folded>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_fixed_processing<class_Node_is_fixed_processing>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_greater_than<class_Node_is_greater_than>` **(** :ref:`Node<class_node>` node **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_in_group<class_Node_is_in_group>` **(** :ref:`String<class_string>` group **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_inside_tree<class_Node_is_inside_tree>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_network_master<class_Node_is_network_master>` **(** **)** const |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_processing<class_Node_is_processing>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_processing_input<class_Node_is_processing_input>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_processing_unhandled_input<class_Node_is_processing_unhandled_input>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_processing_unhandled_key_input<class_Node_is_processing_unhandled_key_input>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`move_child<class_Node_move_child>` **(** :ref:`Node<class_node>` child_node, :ref:`int<class_int>` to_pos **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`print_stray_nodes<class_Node_print_stray_nodes>` **(** **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`print_tree<class_Node_print_tree>` **(** **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`propagate_notification<class_Node_propagate_notification>` **(** :ref:`int<class_int>` what **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue_free<class_Node_queue_free>` **(** **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`raise<class_Node_raise>` **(** **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_and_skip<class_Node_remove_and_skip>` **(** **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_child<class_Node_remove_child>` **(** :ref:`Node<class_node>` node **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_from_group<class_Node_remove_from_group>` **(** :ref:`String<class_string>` group **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`replace_by<class_Node_replace_by>` **(** :ref:`Node<class_node>` node, :ref:`bool<class_bool>` keep_data=false **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rpc<class_Node_rpc>` **(** :ref:`String<class_string>` method **)** vararg |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rpc_config<class_Node_rpc_config>` **(** :ref:`String<class_string>` method, :ref:`int<class_int>` mode **)** |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rpc_id<class_Node_rpc_id>` **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` method **)** vararg |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rpc_unreliable<class_Node_rpc_unreliable>` **(** :ref:`String<class_string>` method **)** vararg |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rpc_unreliable_id<class_Node_rpc_unreliable_id>` **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` method **)** vararg |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rset<class_Node_rset>` **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rset_config<class_Node_rset_config>` **(** :ref:`String<class_string>` property, :ref:`int<class_int>` mode **)** |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rset_id<class_Node_rset_id>` **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rset_unreliable<class_Node_rset_unreliable>` **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rset_unreliable_id<class_Node_rset_unreliable_id>` **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_display_folded<class_Node_set_display_folded>` **(** :ref:`bool<class_bool>` fold **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_filename<class_Node_set_filename>` **(** :ref:`String<class_string>` filename **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fixed_process<class_Node_set_fixed_process>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_name<class_Node_set_name>` **(** :ref:`String<class_string>` name **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_network_mode<class_Node_set_network_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_owner<class_Node_set_owner>` **(** :ref:`Node<class_node>` owner **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pause_mode<class_Node_set_pause_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_process<class_Node_set_process>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_process_input<class_Node_set_process_input>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_process_unhandled_input<class_Node_set_process_unhandled_input>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_process_unhandled_key_input<class_Node_set_process_unhandled_key_input>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_scene_instance_load_placeholder<class_Node_set_scene_instance_load_placeholder>` **(** :ref:`bool<class_bool>` load_placeholder **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -177,6 +203,15 @@ Numeric Constants
|
||||
- **NOTIFICATION_INSTANCED** = **20**
|
||||
- **NOTIFICATION_DRAG_BEGIN** = **21**
|
||||
- **NOTIFICATION_DRAG_END** = **22**
|
||||
- **NOTIFICATION_PATH_CHANGED** = **23**
|
||||
- **NETWORK_MODE_INHERIT** = **0**
|
||||
- **NETWORK_MODE_MASTER** = **1**
|
||||
- **NETWORK_MODE_SLAVE** = **2**
|
||||
- **RPC_MODE_DISABLED** = **0**
|
||||
- **RPC_MODE_REMOTE** = **1**
|
||||
- **RPC_MODE_SYNC** = **2**
|
||||
- **RPC_MODE_MASTER** = **3**
|
||||
- **RPC_MODE_SLAVE** = **4**
|
||||
- **PAUSE_MODE_INHERIT** = **0**
|
||||
- **PAUSE_MODE_STOP** = **1**
|
||||
- **PAUSE_MODE_PROCESS** = **2**
|
||||
@@ -202,6 +237,8 @@ To keep track of the scene hierarchy (especially when instancing scenes into oth
|
||||
|
||||
Finally, when a node is freed with :ref:`free<class_Node_free>` or :ref:`queue_free<class_Node_queue_free>`, it will also free all its children.
|
||||
|
||||
**Networking with nodes:** After connecting to a server (or making one, see :ref:`NetworkedMultiplayerENet<class_networkedmultiplayerenet>`) it is possible to use the built-in RPC (remote procedure call) system to easily communicate over the network. By calling :ref:`rpc<class_Node_rpc>` with a method name, it will be called locally, and in all connected peers (peers = clients and the server that accepts connections), with behaviour varying depending on the network mode (:ref:`set_network_mode<class_Node_set_network_mode>`) on the receiving peer. To identify which :ref:`Node<class_node>` receives the RPC call Godot will use it's :ref:`NodePath<class_nodepath>` (make sure node names are the same on all peers).
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
@@ -353,6 +390,10 @@ Get the node index, i.e. its position among the siblings of its parent.
|
||||
|
||||
Return the name of the node. This name is unique among the siblings (other child nodes from the same parent).
|
||||
|
||||
.. _class_Node_get_network_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_network_mode** **(** **)** const
|
||||
|
||||
.. _class_Node_get_node:
|
||||
|
||||
- :ref:`Node<class_node>` **get_node** **(** :ref:`NodePath<class_nodepath>` path **)** const
|
||||
@@ -475,6 +516,10 @@ Return *true* if "node" occurs later in the scene hierarchy than the current nod
|
||||
|
||||
- :ref:`bool<class_bool>` **is_inside_tree** **(** **)** const
|
||||
|
||||
.. _class_Node_is_network_master:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_network_master** **(** **)** const
|
||||
|
||||
.. _class_Node_is_processing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_processing** **(** **)** const
|
||||
@@ -553,6 +598,66 @@ Remove a node from a group.
|
||||
|
||||
Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost.
|
||||
|
||||
.. _class_Node_rpc:
|
||||
|
||||
- void **rpc** **(** :ref:`String<class_string>` method **)** vararg
|
||||
|
||||
Send a remote procedure call request to all peers on the network (and locally), optionally sending additional data as arguments. Call request will be received by nodes with the same :ref:`NodePath<class_nodepath>`.
|
||||
|
||||
.. _class_Node_rpc_config:
|
||||
|
||||
- void **rpc_config** **(** :ref:`String<class_string>` method, :ref:`int<class_int>` mode **)**
|
||||
|
||||
Change the method's RPC mode (one of RPC_MODE\_\* constants).
|
||||
|
||||
.. _class_Node_rpc_id:
|
||||
|
||||
- void **rpc_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` method **)** vararg
|
||||
|
||||
Send a :ref:`rpc<class_Node_rpc>` to a specific peer identified by *peer_id*.
|
||||
|
||||
.. _class_Node_rpc_unreliable:
|
||||
|
||||
- void **rpc_unreliable** **(** :ref:`String<class_string>` method **)** vararg
|
||||
|
||||
Send a :ref:`rpc<class_Node_rpc>` using an unreliable protocol.
|
||||
|
||||
.. _class_Node_rpc_unreliable_id:
|
||||
|
||||
- void **rpc_unreliable_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` method **)** vararg
|
||||
|
||||
Send a :ref:`rpc<class_Node_rpc>` to a specific peer identified by *peer_id* using an unreliable protocol.
|
||||
|
||||
.. _class_Node_rset:
|
||||
|
||||
- void **rset** **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)**
|
||||
|
||||
Remotely change property's value on other peers (and locally).
|
||||
|
||||
.. _class_Node_rset_config:
|
||||
|
||||
- void **rset_config** **(** :ref:`String<class_string>` property, :ref:`int<class_int>` mode **)**
|
||||
|
||||
Change the property's RPC mode (one of RPC_MODE\_\* constants).
|
||||
|
||||
.. _class_Node_rset_id:
|
||||
|
||||
- void **rset_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)**
|
||||
|
||||
Remotely change property's value on a specific peer identified by *peer_id*.
|
||||
|
||||
.. _class_Node_rset_unreliable:
|
||||
|
||||
- void **rset_unreliable** **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)**
|
||||
|
||||
Remotely change property's value on other peers (and locally) using an unreliable protocol.
|
||||
|
||||
.. _class_Node_rset_unreliable_id:
|
||||
|
||||
- void **rset_unreliable_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)**
|
||||
|
||||
Remotely change property's value on a specific peer identified by *peer_id* using an unreliable protocol.
|
||||
|
||||
.. _class_Node_set_display_folded:
|
||||
|
||||
- void **set_display_folded** **(** :ref:`bool<class_bool>` fold **)**
|
||||
@@ -575,6 +680,12 @@ Enables or disables node fixed framerate processing. When a node is being proces
|
||||
|
||||
Set the name of the :ref:`Node<class_node>`. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed.
|
||||
|
||||
.. _class_Node_set_network_mode:
|
||||
|
||||
- void **set_network_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
Change the networking mode of the :ref:`Node<class_node>`, where *mode* is one of the constants NETWORK_MODE\_\*. Master nodes will only call gdscript methods defined as *master func* if a RPC call is received (slave nodes will only call *slave func*; both will call *remote func* if the call is not local, and *sync func* in any case). Inherit mode looks at the parent node to determine the value (root node depends on the :ref:`SceneTree<class_scenetree>` having a networking peer set with :ref:`SceneTree.set_network_peer<class_SceneTree_set_network_peer>`)
|
||||
|
||||
.. _class_Node_set_owner:
|
||||
|
||||
- void **set_owner** **(** :ref:`Node<class_node>` owner **)**
|
||||
|
||||
@@ -27,6 +27,12 @@ Member Functions
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_global_pos<class_Node2D_get_global_pos>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_global_rot<class_Node2D_get_global_rot>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_global_rotd<class_Node2D_get_global_rotd>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_global_scale<class_Node2D_get_global_scale>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_pos<class_Node2D_get_pos>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Matrix32<class_matrix32>` | :ref:`get_relative_transform_to_parent<class_Node2D_get_relative_transform_to_parent>` **(** :ref:`Object<class_object>` parent **)** const |
|
||||
@@ -55,6 +61,12 @@ Member Functions
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_global_pos<class_Node2D_set_global_pos>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_global_rot<class_Node2D_set_global_rot>` **(** :ref:`float<class_float>` radians **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_global_rotd<class_Node2D_set_global_rotd>` **(** :ref:`float<class_float>` degrees **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_global_scale<class_Node2D_set_global_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_global_transform<class_Node2D_set_global_transform>` **(** :ref:`Matrix32<class_matrix32>` xform **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pos<class_Node2D_set_pos>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
||||
@@ -100,6 +112,24 @@ Return the rotation angle in radians needed for the 2d node to point at 'point'
|
||||
|
||||
Return the global position of the 2D node.
|
||||
|
||||
.. _class_Node2D_get_global_rot:
|
||||
|
||||
- :ref:`float<class_float>` **get_global_rot** **(** **)** const
|
||||
|
||||
Return the global rotation in radians of the 2D node.
|
||||
|
||||
.. _class_Node2D_get_global_rotd:
|
||||
|
||||
- :ref:`float<class_float>` **get_global_rotd** **(** **)** const
|
||||
|
||||
Return the global rotation in degrees of the 2D node.
|
||||
|
||||
.. _class_Node2D_get_global_scale:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_global_scale** **(** **)** const
|
||||
|
||||
Return the global scale of the 2D node.
|
||||
|
||||
.. _class_Node2D_get_pos:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_pos** **(** **)** const
|
||||
@@ -182,6 +212,24 @@ Apply the 'ratio' scale to the 2D node, according to its current scale value.
|
||||
|
||||
Set the global position of the 2D node to 'pos'.
|
||||
|
||||
.. _class_Node2D_set_global_rot:
|
||||
|
||||
- void **set_global_rot** **(** :ref:`float<class_float>` radians **)**
|
||||
|
||||
Set the global rotation in radians of the 2D node.
|
||||
|
||||
.. _class_Node2D_set_global_rotd:
|
||||
|
||||
- void **set_global_rotd** **(** :ref:`float<class_float>` degrees **)**
|
||||
|
||||
Set the global rotation in degrees of the 2D node.
|
||||
|
||||
.. _class_Node2D_set_global_scale:
|
||||
|
||||
- void **set_global_scale** **(** :ref:`Vector2<class_vector2>` scale **)**
|
||||
|
||||
Set the global scale of the 2D node.
|
||||
|
||||
.. _class_Node2D_set_global_transform:
|
||||
|
||||
- void **set_global_transform** **(** :ref:`Matrix32<class_matrix32>` xform **)**
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
Object
|
||||
======
|
||||
|
||||
**Inherited By:** :ref:`Reference<class_reference>`, :ref:`Physics2DServer<class_physics2dserver>`, :ref:`Input<class_input>`, :ref:`SpatialSound2DServer<class_spatialsound2dserver>`, :ref:`Node<class_node>`, :ref:`Geometry<class_geometry>`, :ref:`TreeItem<class_treeitem>`, :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>`, :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>`, :ref:`MainLoop<class_mainloop>`, :ref:`InputMap<class_inputmap>`, :ref:`UndoRedo<class_undoredo>`, :ref:`PhysicsServer<class_physicsserver>`, :ref:`ResourceSaver<class_resourcesaver>`, :ref:`Performance<class_performance>`, :ref:`PathRemap<class_pathremap>`, :ref:`ResourceLoader<class_resourceloader>`, :ref:`AudioServer<class_audioserver>`, :ref:`SpatialSoundServer<class_spatialsoundserver>`, :ref:`VisualServer<class_visualserver>`, :ref:`IP<class_ip>`, :ref:`OS<class_os>`, :ref:`Globals<class_globals>`, :ref:`PhysicsDirectBodyState<class_physicsdirectbodystate>`, :ref:`EditorSelection<class_editorselection>`, :ref:`Physics2DDirectBodyState<class_physics2ddirectbodystate>`, :ref:`TranslationServer<class_translationserver>`
|
||||
**Inherited By:** :ref:`Reference<class_reference>`, :ref:`Physics2DServer<class_physics2dserver>`, :ref:`Input<class_input>`, :ref:`SpatialSound2DServer<class_spatialsound2dserver>`, :ref:`Node<class_node>`, :ref:`Geometry<class_geometry>`, :ref:`TreeItem<class_treeitem>`, :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>`, :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>`, :ref:`MainLoop<class_mainloop>`, :ref:`InputMap<class_inputmap>`, :ref:`UndoRedo<class_undoredo>`, :ref:`PhysicsServer<class_physicsserver>`, :ref:`ResourceSaver<class_resourcesaver>`, :ref:`Performance<class_performance>`, :ref:`PathRemap<class_pathremap>`, :ref:`ResourceLoader<class_resourceloader>`, :ref:`AudioServer<class_audioserver>`, :ref:`SpatialSoundServer<class_spatialsoundserver>`, :ref:`VisualServer<class_visualserver>`, :ref:`IP<class_ip>`, :ref:`OS<class_os>`, :ref:`Globals<class_globals>`, :ref:`PhysicsDirectBodyState<class_physicsdirectbodystate>`, :ref:`EditorSelection<class_editorselection>`, :ref:`Physics2DDirectBodyState<class_physics2ddirectbodystate>`, :ref:`TranslationServer<class_translationserver>`, :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
@@ -18,87 +18,87 @@ Base class for all non built-in types.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`XL_MESSAGE<class_Object_XL_MESSAGE>` **(** :ref:`String<class_string>` message **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_get<class_Object__get>` **(** :ref:`String<class_string>` property **)** virtual |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`_get_property_list<class_Object__get_property_list>` **(** **)** virtual |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_init<class_Object__init>` **(** **)** virtual |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_notification<class_Object__notification>` **(** :ref:`int<class_int>` what **)** virtual |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_set<class_Object__set>` **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** virtual |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_user_signal<class_Object_add_user_signal>` **(** :ref:`String<class_string>` signal, :ref:`Array<class_array>` arguments=Array() **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`call<class_Object_call>` **(** :ref:`String<class_string>` method, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL, :ref:`Variant<class_variant>` arg5=NULL, :ref:`Variant<class_variant>` arg6=NULL, :ref:`Variant<class_variant>` arg7=NULL, :ref:`Variant<class_variant>` arg8=NULL, :ref:`Variant<class_variant>` arg9=NULL **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`call_deferred<class_Object_call_deferred>` **(** :ref:`String<class_string>` method, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`call<class_Object_call>` **(** :ref:`String<class_string>` method **)** vararg |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`call_deferred<class_Object_call_deferred>` **(** :ref:`String<class_string>` method **)** vararg |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`callv<class_Object_callv>` **(** :ref:`String<class_string>` method, :ref:`Array<class_array>` arg_array **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_translate_messages<class_Object_can_translate_messages>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`connect<class_Object_connect>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method, :ref:`Array<class_array>` binds=Array(), :ref:`int<class_int>` flags=0 **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect<class_Object_disconnect>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`emit_signal<class_Object_emit_signal>` **(** :ref:`String<class_string>` signal, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`emit_signal<class_Object_emit_signal>` **(** :ref:`String<class_string>` signal **)** vararg |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`free<class_Object_free>` **(** **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`get<class_Object_get>` **(** :ref:`String<class_string>` property **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_instance_ID<class_Object_get_instance_ID>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`get_meta<class_Object_get_meta>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringArray<class_stringarray>` | :ref:`get_meta_list<class_Object_get_meta_list>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_method_list<class_Object_get_method_list>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_property_list<class_Object_get_property_list>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Script<class_script>` | :ref:`get_script<class_Object_get_script>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_signal_connection_list<class_Object_get_signal_connection_list>` **(** :ref:`String<class_string>` signal **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_signal_list<class_Object_get_signal_list>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_type<class_Object_get_type>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_meta<class_Object_has_meta>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_method<class_Object_has_method>` **(** :ref:`String<class_string>` method **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_user_signal<class_Object_has_user_signal>` **(** :ref:`String<class_string>` signal **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_blocking_signals<class_Object_is_blocking_signals>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_connected<class_Object_is_connected>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_queued_for_deletion<class_Object_is_queued_for_deletion>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_type<class_Object_is_type>` **(** :ref:`String<class_string>` type **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`notification<class_Object_notification>` **(** :ref:`int<class_int>` what, :ref:`bool<class_bool>` reversed=false **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`property_list_changed_notify<class_Object_property_list_changed_notify>` **(** **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set<class_Object_set>` **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_block_signals<class_Object_set_block_signals>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_message_translation<class_Object_set_message_translation>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_meta<class_Object_set_meta>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_script<class_Object_set_script>` **(** :ref:`Script<class_script>` script **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`tr<class_Object_tr>` **(** :ref:`String<class_string>` message **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -172,15 +172,11 @@ Add a user signal (can be added anytime). Arguments are optional, but can be add
|
||||
|
||||
.. _class_Object_call:
|
||||
|
||||
- void **call** **(** :ref:`String<class_string>` method, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL, :ref:`Variant<class_variant>` arg5=NULL, :ref:`Variant<class_variant>` arg6=NULL, :ref:`Variant<class_variant>` arg7=NULL, :ref:`Variant<class_variant>` arg8=NULL, :ref:`Variant<class_variant>` arg9=NULL **)**
|
||||
|
||||
Call a function in the object, result is returned.
|
||||
- :ref:`Variant<class_variant>` **call** **(** :ref:`String<class_string>` method **)** vararg
|
||||
|
||||
.. _class_Object_call_deferred:
|
||||
|
||||
- void **call_deferred** **(** :ref:`String<class_string>` method, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL **)**
|
||||
|
||||
Create and store a function in the object. The call will take place on idle time.
|
||||
- void **call_deferred** **(** :ref:`String<class_string>` method **)** vararg
|
||||
|
||||
.. _class_Object_callv:
|
||||
|
||||
@@ -206,9 +202,7 @@ Disconnect a signal from a method.
|
||||
|
||||
.. _class_Object_emit_signal:
|
||||
|
||||
- void **emit_signal** **(** :ref:`String<class_string>` signal, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL **)**
|
||||
|
||||
Emit a signal. Arguments are passed in an array.
|
||||
- void **emit_signal** **(** :ref:`String<class_string>` signal **)** vararg
|
||||
|
||||
.. _class_Object_free:
|
||||
|
||||
|
||||
@@ -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 |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -486,7 +486,7 @@ Returns the model name of the current device.
|
||||
|
||||
- :ref:`String<class_string>` **get_name** **(** **)** const
|
||||
|
||||
Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "WinRT", "X11"
|
||||
Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11"
|
||||
|
||||
.. _class_OS_get_process_ID:
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ PacketPeer
|
||||
|
||||
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`PacketPeerStream<class_packetpeerstream>`, :ref:`PacketPeerUDP<class_packetpeerudp>`
|
||||
**Inherited By:** :ref:`PacketPeerStream<class_packetpeerstream>`, :ref:`PacketPeerUDP<class_packetpeerudp>`, :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
|
||||
@@ -18,23 +18,23 @@ UDP packet peer.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`close<class_PacketPeerUDP_close>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_packet_address<class_PacketPeerUDP_get_packet_address>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_packet_ip<class_PacketPeerUDP_get_packet_ip>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_packet_port<class_PacketPeerUDP_get_packet_port>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_listening<class_PacketPeerUDP_is_listening>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Error | :ref:`listen<class_PacketPeerUDP_listen>` **(** :ref:`int<class_int>` port, :ref:`int<class_int>` recv_buf_size=65536 **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`set_send_address<class_PacketPeerUDP_set_send_address>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Error | :ref:`listen<class_PacketPeerUDP_listen>` **(** :ref:`int<class_int>` port, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY, :ref:`int<class_int>` recv_buf_size=65536 **)** |
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`set_send_address<class_PacketPeerUDP_set_send_address>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY **)** |
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Error | :ref:`wait<class_PacketPeerUDP_wait>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -76,15 +76,21 @@ Return whether this :ref:`PacketPeerUDP<class_packetpeerudp>` is listening.
|
||||
|
||||
.. _class_PacketPeerUDP_listen:
|
||||
|
||||
- Error **listen** **(** :ref:`int<class_int>` port, :ref:`int<class_int>` recv_buf_size=65536 **)**
|
||||
- Error **listen** **(** :ref:`int<class_int>` port, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY, :ref:`int<class_int>` recv_buf_size=65536 **)**
|
||||
|
||||
Make this :ref:`PacketPeerUDP<class_packetpeerudp>` listen on the "port" using a buffer size "recv_buf_size". Listens on all available adresses.
|
||||
Make this :ref:`PacketPeerUDP<class_packetpeerudp>` listen on the "port" using protocol "ip_type" and a buffer size "recv_buf_size". Listens on all available adresses.
|
||||
|
||||
IP_TYPE_IPV4 = IPv4 only
|
||||
|
||||
IP_TYPE_IPV6 = IPv6 only
|
||||
|
||||
IP_TYPE_ANY = Dual stack (supports both IPv6 and IPv4 connections).
|
||||
|
||||
.. _class_PacketPeerUDP_set_send_address:
|
||||
|
||||
- :ref:`int<class_int>` **set_send_address** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)**
|
||||
- :ref:`int<class_int>` **set_send_address** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY **)**
|
||||
|
||||
Set the destination address and port for sending packets and variables, a hostname will be resolved if valid.
|
||||
Set the destination address and port for sending packets and variables, a hostname will be resolved using "ip_type" (v4/v6/any) if valid.
|
||||
|
||||
.. _class_PacketPeerUDP_wait:
|
||||
|
||||
|
||||
@@ -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**
|
||||
|
||||
@@ -20,181 +20,181 @@ Physics 2D Server.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_add_shape<class_Physics2DServer_area_add_shape>` **(** :ref:`RID<class_rid>` area, :ref:`RID<class_rid>` shape, :ref:`Matrix32<class_matrix32>` transform=((1, 0), (0, 1), (0, 0)) **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_attach_object_instance_ID<class_Physics2DServer_area_attach_object_instance_ID>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` id **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_clear_shapes<class_Physics2DServer_area_clear_shapes>` **(** :ref:`RID<class_rid>` area **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`area_create<class_Physics2DServer_area_create>` **(** **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_get_object_instance_ID<class_Physics2DServer_area_get_object_instance_ID>` **(** :ref:`RID<class_rid>` area **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_get_param<class_Physics2DServer_area_get_param>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` param **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`area_get_shape<class_Physics2DServer_area_get_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_get_shape_count<class_Physics2DServer_area_get_shape_count>` **(** :ref:`RID<class_rid>` area **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Matrix32<class_matrix32>` | :ref:`area_get_shape_transform<class_Physics2DServer_area_get_shape_transform>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`area_get_space<class_Physics2DServer_area_get_space>` **(** :ref:`RID<class_rid>` area **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_get_space_override_mode<class_Physics2DServer_area_get_space_override_mode>` **(** :ref:`RID<class_rid>` area **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Matrix32<class_matrix32>` | :ref:`area_get_transform<class_Physics2DServer_area_get_transform>` **(** :ref:`RID<class_rid>` area **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_remove_shape<class_Physics2DServer_area_remove_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_collision_mask<class_Physics2DServer_area_set_collision_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_layer_mask<class_Physics2DServer_area_set_layer_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_monitor_callback<class_Physics2DServer_area_set_monitor_callback>` **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_param<class_Physics2DServer_area_set_param>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` param, :ref:`Variant<class_variant>` value **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_shape<class_Physics2DServer_area_set_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`RID<class_rid>` shape **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_shape_transform<class_Physics2DServer_area_set_shape_transform>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx, :ref:`Matrix32<class_matrix32>` transform **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_space<class_Physics2DServer_area_set_space>` **(** :ref:`RID<class_rid>` area, :ref:`RID<class_rid>` space **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_space_override_mode<class_Physics2DServer_area_set_space_override_mode>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_transform<class_Physics2DServer_area_set_transform>` **(** :ref:`RID<class_rid>` area, :ref:`Matrix32<class_matrix32>` transform **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_add_collision_exception<class_Physics2DServer_body_add_collision_exception>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` excepted_body **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_add_force<class_Physics2DServer_body_add_force>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` offset, :ref:`Vector2<class_vector2>` force **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_add_shape<class_Physics2DServer_body_add_shape>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` shape, :ref:`Matrix32<class_matrix32>` transform=((1, 0), (0, 1), (0, 0)) **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_apply_impulse<class_Physics2DServer_body_apply_impulse>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` pos, :ref:`Vector2<class_vector2>` impulse **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_attach_object_instance_ID<class_Physics2DServer_body_attach_object_instance_ID>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` id **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_clear_shapes<class_Physics2DServer_body_clear_shapes>` **(** :ref:`RID<class_rid>` body **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`body_create<class_Physics2DServer_body_create>` **(** :ref:`int<class_int>` mode=2, :ref:`bool<class_bool>` init_sleeping=false **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_Physics2DServer_body_get_collision_mask>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_continuous_collision_detection_mode<class_Physics2DServer_body_get_continuous_collision_detection_mode>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_layer_mask<class_Physics2DServer_body_get_layer_mask>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_Physics2DServer_body_get_max_contacts_reported>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_mode<class_Physics2DServer_body_get_mode>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_object_instance_ID<class_Physics2DServer_body_get_object_instance_ID>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`body_get_one_way_collision_direction<class_Physics2DServer_body_get_one_way_collision_direction>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`body_get_one_way_collision_max_depth<class_Physics2DServer_body_get_one_way_collision_max_depth>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`body_get_param<class_Physics2DServer_body_get_param>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` param **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`body_get_shape<class_Physics2DServer_body_get_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_shape_count<class_Physics2DServer_body_get_shape_count>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_get_shape_metadata<class_Physics2DServer_body_get_shape_metadata>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Matrix32<class_matrix32>` | :ref:`body_get_shape_transform<class_Physics2DServer_body_get_shape_transform>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`body_get_space<class_Physics2DServer_body_get_space>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_get_state<class_Physics2DServer_body_get_state>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` state **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`body_is_omitting_force_integration<class_Physics2DServer_body_is_omitting_force_integration>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`body_is_shape_set_as_trigger<class_Physics2DServer_body_is_shape_set_as_trigger>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_remove_collision_exception<class_Physics2DServer_body_remove_collision_exception>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` excepted_body **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_remove_shape<class_Physics2DServer_body_remove_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_axis_velocity<class_Physics2DServer_body_set_axis_velocity>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` axis_velocity **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_collision_mask<class_Physics2DServer_body_set_collision_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_continuous_collision_detection_mode<class_Physics2DServer_body_set_continuous_collision_detection_mode>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_force_integration_callback<class_Physics2DServer_body_set_force_integration_callback>` **(** :ref:`RID<class_rid>` body, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata=NULL **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_layer_mask<class_Physics2DServer_body_set_layer_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_max_contacts_reported<class_Physics2DServer_body_set_max_contacts_reported>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` amount **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_mode<class_Physics2DServer_body_set_mode>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_omit_force_integration<class_Physics2DServer_body_set_omit_force_integration>` **(** :ref:`RID<class_rid>` body, :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_one_way_collision_direction<class_Physics2DServer_body_set_one_way_collision_direction>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` normal **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_one_way_collision_max_depth<class_Physics2DServer_body_set_one_way_collision_max_depth>` **(** :ref:`RID<class_rid>` body, :ref:`float<class_float>` depth **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_param<class_Physics2DServer_body_set_param>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_shape<class_Physics2DServer_body_set_shape>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`RID<class_rid>` shape **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_shape_as_trigger<class_Physics2DServer_body_set_shape_as_trigger>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_shape_metadata<class_Physics2DServer_body_set_shape_metadata>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`Variant<class_variant>` metadata **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_shape_transform<class_Physics2DServer_body_set_shape_transform>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` shape_idx, :ref:`Matrix32<class_matrix32>` transform **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_space<class_Physics2DServer_body_set_space>` **(** :ref:`RID<class_rid>` body, :ref:`RID<class_rid>` space **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_state<class_Physics2DServer_body_set_state>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` state, :ref:`Variant<class_variant>` value **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`body_test_motion<class_Physics2DServer_body_test_motion>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` motion, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` result=NULL **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`body_test_motion<class_Physics2DServer_body_test_motion>` **(** :ref:`RID<class_rid>` body, :ref:`Matrix32<class_matrix32>` from, :ref:`Vector2<class_vector2>` motion, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` result=NULL **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`damped_spring_joint_create<class_Physics2DServer_damped_spring_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b=RID() **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damped_string_joint_get_param<class_Physics2DServer_damped_string_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`damped_string_joint_set_param<class_Physics2DServer_damped_string_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`free_rid<class_Physics2DServer_free_rid>` **(** :ref:`RID<class_rid>` rid **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_process_info<class_Physics2DServer_get_process_info>` **(** :ref:`int<class_int>` process_info **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`groove_joint_create<class_Physics2DServer_groove_joint_create>` **(** :ref:`Vector2<class_vector2>` groove1_a, :ref:`Vector2<class_vector2>` groove2_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a=RID(), :ref:`RID<class_rid>` body_b=RID() **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`joint_get_param<class_Physics2DServer_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`joint_get_type<class_Physics2DServer_joint_get_type>` **(** :ref:`RID<class_rid>` joint **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`joint_set_param<class_Physics2DServer_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`pin_joint_create<class_Physics2DServer_pin_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b=RID() **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_active<class_Physics2DServer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`shape_create<class_Physics2DServer_shape_create>` **(** :ref:`int<class_int>` type **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_get_data<class_Physics2DServer_shape_get_data>` **(** :ref:`RID<class_rid>` shape **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_get_type<class_Physics2DServer_shape_get_type>` **(** :ref:`RID<class_rid>` shape **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_set_data<class_Physics2DServer_shape_set_data>` **(** :ref:`RID<class_rid>` shape, :ref:`Variant<class_variant>` data **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`space_create<class_Physics2DServer_space_create>` **(** **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>` | :ref:`space_get_direct_state<class_Physics2DServer_space_get_direct_state>` **(** :ref:`RID<class_rid>` space **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`space_get_param<class_Physics2DServer_space_get_param>` **(** :ref:`RID<class_rid>` space, :ref:`int<class_int>` param **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`space_is_active<class_Physics2DServer_space_is_active>` **(** :ref:`RID<class_rid>` space **)** const |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`space_set_active<class_Physics2DServer_space_set_active>` **(** :ref:`RID<class_rid>` space, :ref:`bool<class_bool>` active **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`space_set_param<class_Physics2DServer_space_set_param>` **(** :ref:`RID<class_rid>` space, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
||||
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -671,9 +671,9 @@ Set a body state (see BODY_STATE\* constants).
|
||||
|
||||
.. _class_Physics2DServer_body_test_motion:
|
||||
|
||||
- :ref:`bool<class_bool>` **body_test_motion** **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` motion, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` result=NULL **)**
|
||||
- :ref:`bool<class_bool>` **body_test_motion** **(** :ref:`RID<class_rid>` body, :ref:`Matrix32<class_matrix32>` from, :ref:`Vector2<class_vector2>` motion, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` result=NULL **)**
|
||||
|
||||
Return whether a body can move in a given direction. Apart from the boolean return value, a :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` can be passed to return additional information in.
|
||||
Return whether a body can move from a given point in a given direction. Apart from the boolean return value, a :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` can be passed to return additional information in.
|
||||
|
||||
.. _class_Physics2DServer_damped_spring_joint_create:
|
||||
|
||||
|
||||
@@ -16,31 +16,33 @@ Raw byte array.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RawArray<class_rawarray>` | :ref:`RawArray<class_RawArray_RawArray>` **(** :ref:`Array<class_array>` from **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`append<class_RawArray_append>` **(** :ref:`int<class_int>` byte **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`append_array<class_RawArray_append_array>` **(** :ref:`RawArray<class_rawarray>` array **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_string_from_ascii<class_RawArray_get_string_from_ascii>` **(** **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_string_from_utf8<class_RawArray_get_string_from_utf8>` **(** **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`insert<class_RawArray_insert>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` byte **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`invert<class_RawArray_invert>` **(** **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_back<class_RawArray_push_back>` **(** :ref:`int<class_int>` byte **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove<class_RawArray_remove>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resize<class_RawArray_resize>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set<class_RawArray_set>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` byte **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_RawArray_size>` **(** **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RawArray<class_rawarray>` | :ref:`subarray<class_RawArray_subarray>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)** |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -120,4 +122,10 @@ Change the byte at the given index.
|
||||
|
||||
Return the size of the array.
|
||||
|
||||
.. _class_RawArray_subarray:
|
||||
|
||||
- :ref:`RawArray<class_rawarray>` **subarray** **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)**
|
||||
|
||||
Returns the slice of the :ref:`RawArray<class_rawarray>` between indices (inclusive) as a new :ref:`RawArray<class_rawarray>`. Any negative index is considered to be from the end of the array.
|
||||
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
@@ -13,54 +13,72 @@ RayCast2D
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Query the closest object intersecting a ray
|
||||
Query the closest object intersecting a ray.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_exception<class_RayCast2D_add_exception>` **(** :ref:`Object<class_object>` node **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_exception_rid<class_RayCast2D_add_exception_rid>` **(** :ref:`RID<class_rid>` rid **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collider_shape<class_RayCast2D_get_collider_shape>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_normal<class_RayCast2D_get_collision_normal>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_point<class_RayCast2D_get_collision_point>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_exclude_parent_body<class_RayCast2D_get_exclude_parent_body>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_layer_mask<class_RayCast2D_get_layer_mask>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_type_mask<class_RayCast2D_get_type_mask>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_colliding<class_RayCast2D_is_colliding>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_enabled<class_RayCast2D_is_enabled>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_exception<class_RayCast2D_remove_exception>` **(** :ref:`Object<class_object>` node **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_exception_rid<class_RayCast2D_remove_exception_rid>` **(** :ref:`RID<class_rid>` rid **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_cast_to<class_RayCast2D_set_cast_to>` **(** :ref:`Vector2<class_vector2>` local_point **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_enabled<class_RayCast2D_set_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_exclude_parent_body<class_RayCast2D_set_exclude_parent_body>` **(** :ref:`bool<class_bool>` mask **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_layer_mask<class_RayCast2D_set_layer_mask>` **(** :ref:`int<class_int>` mask **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_type_mask<class_RayCast2D_set_type_mask>` **(** :ref:`int<class_int>` mask **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
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 +98,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 +132,13 @@ 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_exclude_parent_body:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_exclude_parent_body** **(** **)** const
|
||||
|
||||
Returns whether this ray should hit your parent node, if it's a body.
|
||||
|
||||
.. _class_RayCast2D_get_layer_mask:
|
||||
|
||||
@@ -120,6 +150,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 +162,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:
|
||||
|
||||
@@ -154,12 +186,22 @@ Sets the ray destination point, so that the ray will test from the ray's origin
|
||||
|
||||
Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions.
|
||||
|
||||
.. _class_RayCast2D_set_exclude_parent_body:
|
||||
|
||||
- void **set_exclude_parent_body** **(** :ref:`bool<class_bool>` mask **)**
|
||||
|
||||
Toggle whether this ray should hit your parent node, if it's a body.
|
||||
|
||||
.. _class_RayCast2D_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_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.
|
||||
|
||||
|
||||
|
||||
@@ -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:`RegExMatch<class_regexmatch>`, :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:`VisualScriptFunctionState<class_visualscriptfunctionstate>`, :ref:`Physics2DShapeQueryParameters<class_physics2dshapequeryparameters>`, :ref:`MeshDataTool<class_meshdatatool>`, :ref:`GDFunctionState<class_gdfunctionstate>`, :ref:`EditorResourcePreviewGenerator<class_editorresourcepreviewgenerator>`, :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:`SceneTreeTimer<class_scenetreetimer>`, :ref:`Thread<class_thread>`, :ref:`PackedDataContainerRef<class_packeddatacontainerref>`, :ref:`ResourceInteractiveLoader<class_resourceinteractiveloader>`, :ref:`ResourceImportMetadata<class_resourceimportmetadata>`, :ref:`PhysicsShapeQueryParameters<class_physicsshapequeryparameters>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
|
||||
@@ -18,23 +18,23 @@ Simple regular expression matcher.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_RegEx_clear>` **(** **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`compile<class_RegEx_compile>` **(** :ref:`String<class_string>` pattern, :ref:`int<class_int>` capture=9 **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find<class_RegEx_find>` **(** :ref:`String<class_string>` text, :ref:`int<class_int>` start=0, :ref:`int<class_int>` end=-1 **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_capture<class_RegEx_get_capture>` **(** :ref:`int<class_int>` capture **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_capture_count<class_RegEx_get_capture_count>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_capture_start<class_RegEx_get_capture_start>` **(** :ref:`int<class_int>` capture **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StringArray<class_stringarray>` | :ref:`get_captures<class_RegEx_get_captures>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`compile<class_RegEx_compile>` **(** :ref:`String<class_string>` pattern **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_group_count<class_RegEx_get_group_count>` **(** **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_names<class_RegEx_get_names>` **(** **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_pattern<class_RegEx_get_pattern>` **(** **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_valid<class_RegEx_is_valid>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`search<class_RegEx_search>` **(** :ref:`String<class_string>` text, :ref:`int<class_int>` start=0, :ref:`int<class_int>` end=-1 **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`sub<class_RegEx_sub>` **(** :ref:`String<class_string>` text, :ref:`String<class_string>` replacement, :ref:`bool<class_bool>` all=false, :ref:`int<class_int>` start=0, :ref:`int<class_int>` end=-1 **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -59,6 +59,8 @@ Currently supported features:
|
||||
|
||||
\* Capturing ``()`` and non-capturing ``(?:)`` groups
|
||||
|
||||
\* Named capturing groups ``(?P<name>)``
|
||||
|
||||
\* Any character ``.``
|
||||
|
||||
\* Shorthand character classes ``\w \W \s \S \d \D``
|
||||
@@ -75,7 +77,7 @@ Currently supported features:
|
||||
|
||||
\* Alternation ``|``
|
||||
|
||||
\* Backreferences ``\1`` and ``\g{1}``
|
||||
\* Backreferences ``\1``, ``\g{1}``, and ``\g<name>``
|
||||
|
||||
\* POSIX character classes ``:ref:`[:alnum:<class_[:alnum:>`]``
|
||||
|
||||
@@ -92,41 +94,31 @@ Member Function Description
|
||||
|
||||
- void **clear** **(** **)**
|
||||
|
||||
This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object, and forgets all captures made by the last :ref:`find<class_RegEx_find>`.
|
||||
This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object.
|
||||
|
||||
.. _class_RegEx_compile:
|
||||
|
||||
- :ref:`int<class_int>` **compile** **(** :ref:`String<class_string>` pattern, :ref:`int<class_int>` capture=9 **)**
|
||||
- :ref:`int<class_int>` **compile** **(** :ref:`String<class_string>` pattern **)**
|
||||
|
||||
Compiles and assign the regular expression pattern to use. The limit on the number of capturing groups can be specified or made unlimited if negative.
|
||||
Compiles and assign the regular expression pattern to use.
|
||||
|
||||
.. _class_RegEx_find:
|
||||
.. _class_RegEx_get_group_count:
|
||||
|
||||
- :ref:`int<class_int>` **find** **(** :ref:`String<class_string>` text, :ref:`int<class_int>` start=0, :ref:`int<class_int>` end=-1 **)** const
|
||||
- :ref:`int<class_int>` **get_group_count** **(** **)** const
|
||||
|
||||
This method tries to find the pattern within the string, and returns the position where it was found. It also stores any capturing group (see :ref:`get_capture<class_RegEx_get_capture>`) for further retrieval.
|
||||
Returns the number of numeric capturing groups.
|
||||
|
||||
.. _class_RegEx_get_capture:
|
||||
.. _class_RegEx_get_names:
|
||||
|
||||
- :ref:`String<class_string>` **get_capture** **(** :ref:`int<class_int>` capture **)** const
|
||||
- :ref:`Array<class_array>` **get_names** **(** **)** const
|
||||
|
||||
Returns a captured group. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses *(?:)*).
|
||||
Returns an array of names of named capturing groups.
|
||||
|
||||
.. _class_RegEx_get_capture_count:
|
||||
.. _class_RegEx_get_pattern:
|
||||
|
||||
- :ref:`int<class_int>` **get_capture_count** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_pattern** **(** **)** const
|
||||
|
||||
Returns the number of capturing groups. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses *(?:)*).
|
||||
|
||||
.. _class_RegEx_get_capture_start:
|
||||
|
||||
- :ref:`int<class_int>` **get_capture_start** **(** :ref:`int<class_int>` capture **)** const
|
||||
|
||||
.. _class_RegEx_get_captures:
|
||||
|
||||
- :ref:`StringArray<class_stringarray>` **get_captures** **(** **)** const
|
||||
|
||||
Return a list of all the captures made by the regular expression.
|
||||
Returns the expression used to compile the code.
|
||||
|
||||
.. _class_RegEx_is_valid:
|
||||
|
||||
@@ -134,4 +126,16 @@ Return a list of all the captures made by the regular expression.
|
||||
|
||||
Returns whether this object has a valid regular expression assigned.
|
||||
|
||||
.. _class_RegEx_search:
|
||||
|
||||
- :ref:`Object<class_object>` **search** **(** :ref:`String<class_string>` text, :ref:`int<class_int>` start=0, :ref:`int<class_int>` end=-1 **)** const
|
||||
|
||||
Searches the text for the compiled pattern. Returns a :ref:`RegExMatch<class_regexmatch>` container of the first matching reult if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be.
|
||||
|
||||
.. _class_RegEx_sub:
|
||||
|
||||
- :ref:`String<class_string>` **sub** **(** :ref:`String<class_string>` text, :ref:`String<class_string>` replacement, :ref:`bool<class_bool>` all=false, :ref:`int<class_int>` start=0, :ref:`int<class_int>` end=-1 **)** const
|
||||
|
||||
Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as ``\1`` and ``\g<name>`` expanded and resolved. By default only the first instance is replaced but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be.
|
||||
|
||||
|
||||
|
||||
90
classes/class_regexmatch.rst
Normal file
90
classes/class_regexmatch.rst
Normal file
@@ -0,0 +1,90 @@
|
||||
.. 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_RegExMatch:
|
||||
|
||||
RegExMatch
|
||||
==========
|
||||
|
||||
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`expand<class_RegExMatch_expand>` **(** :ref:`String<class_string>` template **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_end<class_RegExMatch_get_end>` **(** :ref:`Variant<class_variant>` name=0 **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_group_array<class_RegExMatch_get_group_array>` **(** **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_group_count<class_RegExMatch_get_group_count>` **(** **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`get_name_dict<class_RegExMatch_get_name_dict>` **(** **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_names<class_RegExMatch_get_names>` **(** **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_start<class_RegExMatch_get_start>` **(** :ref:`Variant<class_variant>` name=0 **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_string<class_RegExMatch_get_string>` **(** :ref:`Variant<class_variant>` name=0 **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_RegExMatch_expand:
|
||||
|
||||
- :ref:`String<class_string>` **expand** **(** :ref:`String<class_string>` template **)** const
|
||||
|
||||
Using results from the search, returns the specified string with escapes and backreferences such as ``\1`` and ``\g<name>`` expanded and resolved.
|
||||
|
||||
.. _class_RegExMatch_get_end:
|
||||
|
||||
- :ref:`int<class_int>` **get_end** **(** :ref:`Variant<class_variant>` name=0 **)** const
|
||||
|
||||
Returns the end position of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
|
||||
|
||||
.. _class_RegExMatch_get_group_array:
|
||||
|
||||
- :ref:`Array<class_array>` **get_group_array** **(** **)** const
|
||||
|
||||
Returns an array of the results of the numeric groups.
|
||||
|
||||
.. _class_RegExMatch_get_group_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_group_count** **(** **)** const
|
||||
|
||||
Returns the number of numeric capturing groups.
|
||||
|
||||
.. _class_RegExMatch_get_name_dict:
|
||||
|
||||
- :ref:`Dictionary<class_dictionary>` **get_name_dict** **(** **)** const
|
||||
|
||||
Returns a dictionary containing the named capturing groups and their results.
|
||||
|
||||
.. _class_RegExMatch_get_names:
|
||||
|
||||
- :ref:`Array<class_array>` **get_names** **(** **)** const
|
||||
|
||||
Returns an array of names of named capturing groups.
|
||||
|
||||
.. _class_RegExMatch_get_start:
|
||||
|
||||
- :ref:`int<class_int>` **get_start** **(** :ref:`Variant<class_variant>` name=0 **)** const
|
||||
|
||||
Returns the starting position of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
|
||||
|
||||
.. _class_RegExMatch_get_string:
|
||||
|
||||
- :ref:`String<class_string>` **get_string** **(** :ref:`Variant<class_variant>` name=0 **)** const
|
||||
|
||||
Returns the result of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
|
||||
|
||||
|
||||
38
classes/class_remotetransform.rst
Normal file
38
classes/class_remotetransform.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
.. 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_RemoteTransform:
|
||||
|
||||
RemoteTransform
|
||||
===============
|
||||
|
||||
**Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_remote_node<class_RemoteTransform_get_remote_node>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_remote_node<class_RemoteTransform_set_remote_node>` **(** :ref:`NodePath<class_nodepath>` path **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_RemoteTransform_get_remote_node:
|
||||
|
||||
- :ref:`NodePath<class_nodepath>` **get_remote_node** **(** **)** const
|
||||
|
||||
.. _class_RemoteTransform_set_remote_node:
|
||||
|
||||
- void **set_remote_node** **(** :ref:`NodePath<class_nodepath>` path **)**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Resource
|
||||
|
||||
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`Theme<class_theme>`, :ref:`AudioStream<class_audiostream>`, :ref:`EventStream<class_eventstream>`, :ref:`CubeMap<class_cubemap>`, :ref:`DynamicFontData<class_dynamicfontdata>`, :ref:`Translation<class_translation>`, :ref:`Curve2D<class_curve2d>`, :ref:`Shape<class_shape>`, :ref:`Shape2D<class_shape2d>`, :ref:`Shader<class_shader>`, :ref:`ColorRamp<class_colorramp>`, :ref:`StyleBox<class_stylebox>`, :ref:`Environment<class_environment>`, :ref:`Material<class_material>`, :ref:`VideoStream<class_videostream>`, :ref:`RoomBounds<class_roombounds>`, :ref:`PackedScene<class_packedscene>`, :ref:`Texture<class_texture>`, :ref:`Script<class_script>`, :ref:`OccluderPolygon2D<class_occluderpolygon2d>`, :ref:`Mesh<class_mesh>`, :ref:`TileSet<class_tileset>`, :ref:`ShortCut<class_shortcut>`, :ref:`BitMap<class_bitmap>`, :ref:`Animation<class_animation>`, :ref:`Sample<class_sample>`, :ref:`PolygonPathFinder<class_polygonpathfinder>`, :ref:`BakedLight<class_bakedlight>`, :ref:`World<class_world>`, :ref:`SampleLibrary<class_samplelibrary>`, :ref:`World2D<class_world2d>`, :ref:`Font<class_font>`, :ref:`SpriteFrames<class_spriteframes>`, :ref:`MeshLibrary<class_meshlibrary>`, :ref:`Curve3D<class_curve3d>`, :ref:`NavigationPolygon<class_navigationpolygon>`, :ref:`EditorSettings<class_editorsettings>`, :ref:`MultiMesh<class_multimesh>`, :ref:`CanvasItemMaterial<class_canvasitemmaterial>`, :ref:`PackedDataContainer<class_packeddatacontainer>`, :ref:`NavigationMesh<class_navigationmesh>`
|
||||
**Inherited By:** :ref:`Theme<class_theme>`, :ref:`AudioStream<class_audiostream>`, :ref:`EventStream<class_eventstream>`, :ref:`CubeMap<class_cubemap>`, :ref:`DynamicFontData<class_dynamicfontdata>`, :ref:`Translation<class_translation>`, :ref:`Curve2D<class_curve2d>`, :ref:`Shape<class_shape>`, :ref:`Shape2D<class_shape2d>`, :ref:`Shader<class_shader>`, :ref:`ColorRamp<class_colorramp>`, :ref:`StyleBox<class_stylebox>`, :ref:`Material<class_material>`, :ref:`VideoStream<class_videostream>`, :ref:`RoomBounds<class_roombounds>`, :ref:`PackedScene<class_packedscene>`, :ref:`Texture<class_texture>`, :ref:`Script<class_script>`, :ref:`OccluderPolygon2D<class_occluderpolygon2d>`, :ref:`Mesh<class_mesh>`, :ref:`TileSet<class_tileset>`, :ref:`ShortCut<class_shortcut>`, :ref:`BitMap<class_bitmap>`, :ref:`Animation<class_animation>`, :ref:`Sample<class_sample>`, :ref:`PolygonPathFinder<class_polygonpathfinder>`, :ref:`BakedLight<class_bakedlight>`, :ref:`World<class_world>`, :ref:`SampleLibrary<class_samplelibrary>`, :ref:`VisualScriptNode<class_visualscriptnode>`, :ref:`World2D<class_world2d>`, :ref:`Font<class_font>`, :ref:`SpriteFrames<class_spriteframes>`, :ref:`MeshLibrary<class_meshlibrary>`, :ref:`Curve3D<class_curve3d>`, :ref:`NavigationPolygon<class_navigationpolygon>`, :ref:`EditorSettings<class_editorsettings>`, :ref:`Environment<class_environment>`, :ref:`MultiMesh<class_multimesh>`, :ref:`CanvasItemMaterial<class_canvasitemmaterial>`, :ref:`PackedDataContainer<class_packeddatacontainer>`, :ref:`NavigationMesh<class_navigationmesh>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
|
||||
@@ -18,73 +18,90 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`call_group<class_SceneTree_call_group>` **(** :ref:`int<class_int>` flags, :ref:`String<class_string>` group, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`call_group<class_SceneTree_call_group>` **(** :ref:`int<class_int>` flags, :ref:`String<class_string>` group, :ref:`String<class_string>` method **)** vararg |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`change_scene<class_SceneTree_change_scene>` **(** :ref:`String<class_string>` path **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`change_scene_to<class_SceneTree_change_scene_to>` **(** :ref:`PackedScene<class_packedscene>` packed_scene **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SceneTreeTimer<class_scenetreetimer>` | :ref:`create_timer<class_SceneTree_create_timer>` **(** :ref:`float<class_float>` time_sec **)** |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_node>` | :ref:`get_current_scene<class_SceneTree_get_current_scene>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`get_edited_scene_root<class_SceneTree_get_edited_scene_root>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_frame<class_SceneTree_get_frame>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_network_unique_id<class_SceneTree_get_network_unique_id>` **(** **)** const |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_node_count<class_SceneTree_get_node_count>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_nodes_in_group<class_SceneTree_get_nodes_in_group>` **(** :ref:`String<class_string>` group **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Viewport<class_viewport>` | :ref:`get_root<class_SceneTree_get_root>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_group<class_SceneTree_has_group>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_debugging_collisions_hint<class_SceneTree_is_debugging_collisions_hint>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_debugging_navigation_hint<class_SceneTree_is_debugging_navigation_hint>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_editor_hint<class_SceneTree_is_editor_hint>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_network_server<class_SceneTree_is_network_server>` **(** **)** const |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_paused<class_SceneTree_is_paused>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_refusing_new_network_connections<class_SceneTree_is_refusing_new_network_connections>` **(** **)** const |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`notify_group<class_SceneTree_notify_group>` **(** :ref:`int<class_int>` call_flags, :ref:`String<class_string>` group, :ref:`int<class_int>` notification **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue_delete<class_SceneTree_queue_delete>` **(** :ref:`Object<class_object>` obj **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`quit<class_SceneTree_quit>` **(** **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`reload_current_scene<class_SceneTree_reload_current_scene>` **(** **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_auto_accept_quit<class_SceneTree_set_auto_accept_quit>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_current_scene<class_SceneTree_set_current_scene>` **(** :ref:`Node<class_node>` child_node **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_debug_collisions_hint<class_SceneTree_set_debug_collisions_hint>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_debug_navigation_hint<class_SceneTree_set_debug_navigation_hint>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_edited_scene_root<class_SceneTree_set_edited_scene_root>` **(** :ref:`Object<class_object>` scene **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_editor_hint<class_SceneTree_set_editor_hint>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_group<class_SceneTree_set_group>` **(** :ref:`int<class_int>` call_flags, :ref:`String<class_string>` group, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_input_as_handled<class_SceneTree_set_input_as_handled>` **(** **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_network_peer<class_SceneTree_set_network_peer>` **(** :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` peer **)** |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pause<class_SceneTree_set_pause>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_refuse_new_network_connections<class_SceneTree_set_refuse_new_network_connections>` **(** :ref:`bool<class_bool>` refuse **)** |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_screen_stretch<class_SceneTree_set_screen_stretch>` **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` aspect, :ref:`Vector2<class_vector2>` minsize **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **connected_to_server** **(** **)**
|
||||
- **connection_failed** **(** **)**
|
||||
- **files_dropped** **(** :ref:`StringArray<class_stringarray>` files, :ref:`int<class_int>` screen **)**
|
||||
- **fixed_frame** **(** **)**
|
||||
- **idle_frame** **(** **)**
|
||||
- **network_peer_connected** **(** :ref:`int<class_int>` id **)**
|
||||
- **network_peer_disconnected** **(** :ref:`int<class_int>` id **)**
|
||||
- **node_configuration_warning_changed** **(** :ref:`Object<class_object>` node **)**
|
||||
- **node_removed** **(** :ref:`Object<class_object>` node **)**
|
||||
- **screen_resized** **(** **)**
|
||||
- **server_disconnected** **(** **)**
|
||||
- **tree_changed** **(** **)**
|
||||
|
||||
Numeric Constants
|
||||
@@ -107,7 +124,7 @@ Member Function Description
|
||||
|
||||
.. _class_SceneTree_call_group:
|
||||
|
||||
- void **call_group** **(** :ref:`int<class_int>` flags, :ref:`String<class_string>` group, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL **)**
|
||||
- void **call_group** **(** :ref:`int<class_int>` flags, :ref:`String<class_string>` group, :ref:`String<class_string>` method **)** vararg
|
||||
|
||||
.. _class_SceneTree_change_scene:
|
||||
|
||||
@@ -117,6 +134,10 @@ Member Function Description
|
||||
|
||||
- :ref:`int<class_int>` **change_scene_to** **(** :ref:`PackedScene<class_packedscene>` packed_scene **)**
|
||||
|
||||
.. _class_SceneTree_create_timer:
|
||||
|
||||
- :ref:`SceneTreeTimer<class_scenetreetimer>` **create_timer** **(** :ref:`float<class_float>` time_sec **)**
|
||||
|
||||
.. _class_SceneTree_get_current_scene:
|
||||
|
||||
- :ref:`Node<class_node>` **get_current_scene** **(** **)** const
|
||||
@@ -129,6 +150,10 @@ Member Function Description
|
||||
|
||||
- :ref:`int<class_int>` **get_frame** **(** **)** const
|
||||
|
||||
.. _class_SceneTree_get_network_unique_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_network_unique_id** **(** **)** const
|
||||
|
||||
.. _class_SceneTree_get_node_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_node_count** **(** **)** const
|
||||
@@ -157,10 +182,20 @@ Member Function Description
|
||||
|
||||
- :ref:`bool<class_bool>` **is_editor_hint** **(** **)** const
|
||||
|
||||
.. _class_SceneTree_is_network_server:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_network_server** **(** **)** const
|
||||
|
||||
Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` is in server mode (listening for connections).
|
||||
|
||||
.. _class_SceneTree_is_paused:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_paused** **(** **)** const
|
||||
|
||||
.. _class_SceneTree_is_refusing_new_network_connections:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_refusing_new_network_connections** **(** **)** const
|
||||
|
||||
.. _class_SceneTree_notify_group:
|
||||
|
||||
- void **notify_group** **(** :ref:`int<class_int>` call_flags, :ref:`String<class_string>` group, :ref:`int<class_int>` notification **)**
|
||||
@@ -209,10 +244,20 @@ Member Function Description
|
||||
|
||||
- void **set_input_as_handled** **(** **)**
|
||||
|
||||
.. _class_SceneTree_set_network_peer:
|
||||
|
||||
- void **set_network_peer** **(** :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` peer **)**
|
||||
|
||||
Set the peer object to handle the RPC system (effectively enabling networking). Depending on the peer itself, the SceneTree will become a network server (check with :ref:`is_network_server()<class_SceneTree_is_network_server()>`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node<class_node>`), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals.
|
||||
|
||||
.. _class_SceneTree_set_pause:
|
||||
|
||||
- void **set_pause** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_SceneTree_set_refuse_new_network_connections:
|
||||
|
||||
- void **set_refuse_new_network_connections** **(** :ref:`bool<class_bool>` refuse **)**
|
||||
|
||||
.. _class_SceneTree_set_screen_stretch:
|
||||
|
||||
- void **set_screen_stretch** **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` aspect, :ref:`Vector2<class_vector2>` minsize **)**
|
||||
|
||||
43
classes/class_scenetreetimer.rst
Normal file
43
classes/class_scenetreetimer.rst
Normal file
@@ -0,0 +1,43 @@
|
||||
.. 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_SceneTreeTimer:
|
||||
|
||||
SceneTreeTimer
|
||||
==============
|
||||
|
||||
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_time_left<class_SceneTreeTimer_get_time_left>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_time_left<class_SceneTreeTimer_set_time_left>` **(** :ref:`float<class_float>` time **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **timeout** **(** **)**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_SceneTreeTimer_get_time_left:
|
||||
|
||||
- :ref:`float<class_float>` **get_time_left** **(** **)** const
|
||||
|
||||
.. _class_SceneTreeTimer_set_time_left:
|
||||
|
||||
- void **set_time_left** **(** :ref:`float<class_float>` time **)**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Script
|
||||
|
||||
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`GDScript<class_gdscript>`
|
||||
**Inherited By:** :ref:`VisualScript<class_visualscript>`, :ref:`GDScript<class_gdscript>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
|
||||
@@ -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
|
||||
---------------------------
|
||||
|
||||
@@ -8,7 +8,7 @@ Spatial
|
||||
|
||||
**Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`Joint<class_joint>`, :ref:`RayCast<class_raycast>`, :ref:`Camera<class_camera>`, :ref:`BoneAttachment<class_boneattachment>`, :ref:`CollisionShape<class_collisionshape>`, :ref:`Path<class_path>`, :ref:`VisualInstance<class_visualinstance>`, :ref:`VehicleWheel<class_vehiclewheel>`, :ref:`Position3D<class_position3d>`, :ref:`ProximityGroup<class_proximitygroup>`, :ref:`SpatialPlayer<class_spatialplayer>`, :ref:`WorldEnvironment<class_worldenvironment>`, :ref:`PathFollow<class_pathfollow>`, :ref:`NavigationMeshInstance<class_navigationmeshinstance>`, :ref:`Listener<class_listener>`, :ref:`InverseKinematics<class_inversekinematics>`, :ref:`VisibilityNotifier<class_visibilitynotifier>`, :ref:`Navigation<class_navigation>`, :ref:`CollisionPolygon<class_collisionpolygon>`, :ref:`GridMap<class_gridmap>`, :ref:`Skeleton<class_skeleton>`, :ref:`CollisionObject<class_collisionobject>`
|
||||
**Inherited By:** :ref:`Joint<class_joint>`, :ref:`RayCast<class_raycast>`, :ref:`Camera<class_camera>`, :ref:`BoneAttachment<class_boneattachment>`, :ref:`CollisionShape<class_collisionshape>`, :ref:`Path<class_path>`, :ref:`VisualInstance<class_visualinstance>`, :ref:`VehicleWheel<class_vehiclewheel>`, :ref:`Position3D<class_position3d>`, :ref:`ProximityGroup<class_proximitygroup>`, :ref:`RemoteTransform<class_remotetransform>`, :ref:`SpatialPlayer<class_spatialplayer>`, :ref:`WorldEnvironment<class_worldenvironment>`, :ref:`PathFollow<class_pathfollow>`, :ref:`NavigationMeshInstance<class_navigationmeshinstance>`, :ref:`Listener<class_listener>`, :ref:`InverseKinematics<class_inversekinematics>`, :ref:`VisibilityNotifier<class_visibilitynotifier>`, :ref:`Navigation<class_navigation>`, :ref:`CollisionPolygon<class_collisionpolygon>`, :ref:`GridMap<class_gridmap>`, :ref:`Skeleton<class_skeleton>`, :ref:`CollisionObject<class_collisionobject>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ StreamPeer
|
||||
|
||||
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`StreamPeerSSL<class_streampeerssl>`, :ref:`StreamPeerTCP<class_streampeertcp>`
|
||||
**Inherited By:** :ref:`StreamPeerBuffer<class_streampeerbuffer>`, :ref:`StreamPeerSSL<class_streampeerssl>`, :ref:`StreamPeerTCP<class_streampeertcp>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
|
||||
74
classes/class_streampeerbuffer.rst
Normal file
74
classes/class_streampeerbuffer.rst
Normal file
@@ -0,0 +1,74 @@
|
||||
.. 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_StreamPeerBuffer:
|
||||
|
||||
StreamPeerBuffer
|
||||
================
|
||||
|
||||
**Inherits:** :ref:`StreamPeer<class_streampeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_StreamPeerBuffer_clear>` **(** **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`StreamPeerBuffer<class_streampeerbuffer>` | :ref:`duplicate<class_StreamPeerBuffer_duplicate>` **(** **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RawArray<class_rawarray>` | :ref:`get_data_array<class_StreamPeerBuffer_get_data_array>` **(** **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_pos<class_StreamPeerBuffer_get_pos>` **(** **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_size<class_StreamPeerBuffer_get_size>` **(** **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resize<class_StreamPeerBuffer_resize>` **(** :ref:`int<class_int>` size **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_StreamPeerBuffer_seek>` **(** :ref:`int<class_int>` pos **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_data_array<class_StreamPeerBuffer_set_data_array>` **(** :ref:`RawArray<class_rawarray>` data **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_StreamPeerBuffer_clear:
|
||||
|
||||
- void **clear** **(** **)**
|
||||
|
||||
.. _class_StreamPeerBuffer_duplicate:
|
||||
|
||||
- :ref:`StreamPeerBuffer<class_streampeerbuffer>` **duplicate** **(** **)** const
|
||||
|
||||
.. _class_StreamPeerBuffer_get_data_array:
|
||||
|
||||
- :ref:`RawArray<class_rawarray>` **get_data_array** **(** **)** const
|
||||
|
||||
.. _class_StreamPeerBuffer_get_pos:
|
||||
|
||||
- :ref:`int<class_int>` **get_pos** **(** **)** const
|
||||
|
||||
.. _class_StreamPeerBuffer_get_size:
|
||||
|
||||
- :ref:`int<class_int>` **get_size** **(** **)** const
|
||||
|
||||
.. _class_StreamPeerBuffer_resize:
|
||||
|
||||
- void **resize** **(** :ref:`int<class_int>` size **)**
|
||||
|
||||
.. _class_StreamPeerBuffer_seek:
|
||||
|
||||
- void **seek** **(** :ref:`int<class_int>` pos **)**
|
||||
|
||||
.. _class_StreamPeerBuffer_set_data_array:
|
||||
|
||||
- void **set_data_array** **(** :ref:`RawArray<class_rawarray>` data **)**
|
||||
|
||||
|
||||
@@ -18,19 +18,19 @@ TCP Stream peer.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`connect<class_StreamPeerTCP_connect>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`connect<class_StreamPeerTCP_connect>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY **)** |
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect<class_StreamPeerTCP_disconnect>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_connected_host<class_StreamPeerTCP_get_connected_host>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_connected_port<class_StreamPeerTCP_get_connected_port>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_status<class_StreamPeerTCP_get_status>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_connected<class_StreamPeerTCP_is_connected>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -50,9 +50,9 @@ Member Function Description
|
||||
|
||||
.. _class_StreamPeerTCP_connect:
|
||||
|
||||
- :ref:`int<class_int>` **connect** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)**
|
||||
- :ref:`int<class_int>` **connect** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY **)**
|
||||
|
||||
Connect to the specified IP:port pair. Returns :ref:`OK<class_ok>` on success or :ref:`FAILED<class_failed>` on failure.
|
||||
Connect to the specified host:port pair. A hostname will be resolved using "ip_type" (v4/v6/any) if valid. Returns :ref:`OK<class_ok>` on success or :ref:`FAILED<class_failed>` on failure.
|
||||
|
||||
.. _class_StreamPeerTCP_disconnect:
|
||||
|
||||
|
||||
@@ -25,6 +25,8 @@ Member Functions
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_margin_size<class_StyleBoxTexture_get_margin_size>` **(** :ref:`int<class_int>` margin **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_modulate<class_StyleBoxTexture_get_modulate>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_rect2>` | :ref:`get_region_rect<class_StyleBoxTexture_get_region_rect>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_StyleBoxTexture_get_texture>` **(** **)** const |
|
||||
@@ -35,6 +37,8 @@ Member Functions
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_margin_size<class_StyleBoxTexture_set_margin_size>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_modulate<class_StyleBoxTexture_set_modulate>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_region_rect<class_StyleBoxTexture_set_region_rect>` **(** :ref:`Rect2<class_rect2>` region **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_texture<class_StyleBoxTexture_set_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
|
||||
@@ -65,6 +69,10 @@ Member Function Description
|
||||
|
||||
- :ref:`float<class_float>` **get_margin_size** **(** :ref:`int<class_int>` margin **)** const
|
||||
|
||||
.. _class_StyleBoxTexture_get_modulate:
|
||||
|
||||
- :ref:`Color<class_color>` **get_modulate** **(** **)** const
|
||||
|
||||
.. _class_StyleBoxTexture_get_region_rect:
|
||||
|
||||
- :ref:`Rect2<class_rect2>` **get_region_rect** **(** **)** const
|
||||
@@ -85,6 +93,10 @@ Member Function Description
|
||||
|
||||
- void **set_margin_size** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)**
|
||||
|
||||
.. _class_StyleBoxTexture_set_modulate:
|
||||
|
||||
- void **set_modulate** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
.. _class_StyleBoxTexture_set_region_rect:
|
||||
|
||||
- void **set_region_rect** **(** :ref:`Rect2<class_rect2>` region **)**
|
||||
|
||||
@@ -18,15 +18,15 @@ TCP Server.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_connection_available<class_TCP_Server_is_connection_available>` **(** **)** const |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`listen<class_TCP_Server_listen>` **(** :ref:`int<class_int>` port, :ref:`StringArray<class_stringarray>` accepted_hosts=StringArray([]) **)** |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`listen<class_TCP_Server_listen>` **(** :ref:`int<class_int>` port, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY, :ref:`StringArray<class_stringarray>` accepted_hosts=StringArray([]) **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_TCP_Server_stop>` **(** **)** |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`take_connection<class_TCP_Server_take_connection>` **(** **)** |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -44,9 +44,15 @@ Return true if a connection is available for taking.
|
||||
|
||||
.. _class_TCP_Server_listen:
|
||||
|
||||
- :ref:`int<class_int>` **listen** **(** :ref:`int<class_int>` port, :ref:`StringArray<class_stringarray>` accepted_hosts=StringArray([]) **)**
|
||||
- :ref:`int<class_int>` **listen** **(** :ref:`int<class_int>` port, :ref:`int<class_int>` ip_type=int.IP_TYPE_ANY, :ref:`StringArray<class_stringarray>` accepted_hosts=StringArray([]) **)**
|
||||
|
||||
Listen on a port, alternatively give a white-list of accepted hosts.
|
||||
Listen on a port using protocol "ip_type", alternatively give a white-list of accepted hosts.
|
||||
|
||||
IP_TYPE_IPV4 = IPv4 only
|
||||
|
||||
IP_TYPE_IPV6 = IPv6 only
|
||||
|
||||
IP_TYPE_ANY = Dual stack (supports both IPv6 and IPv4 connections).
|
||||
|
||||
.. _class_TCP_Server_stop:
|
||||
|
||||
|
||||
@@ -120,6 +120,7 @@ Signals
|
||||
- **breakpoint_toggled** **(** :ref:`int<class_int>` row **)**
|
||||
- **cursor_changed** **(** **)**
|
||||
- **request_completion** **(** **)**
|
||||
- **symbol_lookup** **(** :ref:`String<class_string>` symbol, :ref:`int<class_int>` row, :ref:`int<class_int>` column **)**
|
||||
- **text_changed** **(** **)**
|
||||
|
||||
Numeric Constants
|
||||
|
||||
@@ -13,7 +13,7 @@ Tree
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
Control to show a tree of items.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
@@ -63,6 +63,8 @@ Member Functions
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_single_select_cell_editing_only_when_already_selected<class_Tree_get_single_select_cell_editing_only_when_already_selected>` **(** **)** const |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_delayed_text_editor_enabled<class_Tree_is_delayed_text_editor_enabled>` **(** **)** const |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_folding_hidden<class_Tree_is_folding_hidden>` **(** **)** const |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_allow_rmb_select<class_Tree_set_allow_rmb_select>` **(** :ref:`bool<class_bool>` allow **)** |
|
||||
@@ -77,6 +79,8 @@ Member Functions
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_columns<class_Tree_set_columns>` **(** :ref:`int<class_int>` amount **)** |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_delayed_text_editor<class_Tree_set_delayed_text_editor>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_drop_mode_flags<class_Tree_set_drop_mode_flags>` **(** :ref:`int<class_int>` flags **)** |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_hide_folding<class_Tree_set_hide_folding>` **(** :ref:`bool<class_bool>` hide **)** |
|
||||
@@ -97,6 +101,7 @@ Signals
|
||||
- **empty_tree_rmb_selected** **(** :ref:`Vector2<class_vector2>` pos **)**
|
||||
- **item_activated** **(** **)**
|
||||
- **item_collapsed** **(** :ref:`Object<class_object>` item **)**
|
||||
- **item_double_clicked** **(** **)**
|
||||
- **item_edited** **(** **)**
|
||||
- **item_rmb_selected** **(** :ref:`Vector2<class_vector2>` pos **)**
|
||||
- **item_selected** **(** **)**
|
||||
@@ -112,6 +117,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 +142,212 @@ 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_delayed_text_editor_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_delayed_text_editor_enabled** **(** **)** const
|
||||
|
||||
.. _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_delayed_text_editor:
|
||||
|
||||
- void **set_delayed_text_editor** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _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.
|
||||
|
||||
|
||||
|
||||
@@ -41,15 +41,15 @@ Member Functions
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_repeat<class_Tween_is_repeat>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`remove<class_Tween_remove>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)** |
|
||||
| :ref:`bool<class_bool>` | :ref:`remove<class_Tween_remove>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`remove_all<class_Tween_remove_all>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`reset<class_Tween_reset>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)** |
|
||||
| :ref:`bool<class_bool>` | :ref:`reset<class_Tween_reset>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`reset_all<class_Tween_reset_all>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`resume<class_Tween_resume>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)** |
|
||||
| :ref:`bool<class_bool>` | :ref:`resume<class_Tween_resume>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`resume_all<class_Tween_resume_all>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -65,7 +65,7 @@ Member Functions
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`start<class_Tween_start>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stop<class_Tween_stop>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)** |
|
||||
| :ref:`bool<class_bool>` | :ref:`stop<class_Tween_stop>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stop_all<class_Tween_stop_all>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -200,9 +200,9 @@ Returns true if repeat has been set from editor GUI or :ref:`set_repeat<class_Tw
|
||||
|
||||
.. _class_Tween_remove:
|
||||
|
||||
- :ref:`bool<class_bool>` **remove** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)**
|
||||
- :ref:`bool<class_bool>` **remove** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**
|
||||
|
||||
Stop animating and completely remove a tween, given its object and property/method pair.
|
||||
Stop animating and completely remove a tween, given its object and property/method pair. Passing empty String as key will remove all tweens for given object.
|
||||
|
||||
.. _class_Tween_remove_all:
|
||||
|
||||
@@ -212,9 +212,9 @@ Stop animating and completely remove all tweens.
|
||||
|
||||
.. _class_Tween_reset:
|
||||
|
||||
- :ref:`bool<class_bool>` **reset** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)**
|
||||
- :ref:`bool<class_bool>` **reset** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**
|
||||
|
||||
Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair.
|
||||
Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. Passing empty String as key will reset all tweens for given object.
|
||||
|
||||
.. _class_Tween_reset_all:
|
||||
|
||||
@@ -224,9 +224,9 @@ Resets all tweens to their initial values (the ones given, not those before the
|
||||
|
||||
.. _class_Tween_resume:
|
||||
|
||||
- :ref:`bool<class_bool>` **resume** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)**
|
||||
- :ref:`bool<class_bool>` **resume** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**
|
||||
|
||||
Continue animating a stopped tween, given its object and property/method pair.
|
||||
Continue animating a stopped tween, given its object and property/method pair. Passing empty String as key will resume all tweens for given object.
|
||||
|
||||
.. _class_Tween_resume_all:
|
||||
|
||||
@@ -272,9 +272,9 @@ Start the tween node. You can define tweens both before and after this.
|
||||
|
||||
.. _class_Tween_stop:
|
||||
|
||||
- :ref:`bool<class_bool>` **stop** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key **)**
|
||||
- :ref:`bool<class_bool>` **stop** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**
|
||||
|
||||
Stop animating a tween, given its object and property/method pair.
|
||||
Stop animating a tween, given its object and property/method pair. Passing empty String as key will stop all tweens for given object.
|
||||
|
||||
.. _class_Tween_stop_all:
|
||||
|
||||
|
||||
@@ -18,29 +18,29 @@ Helper to manage UndoRedo in the editor or custom tools.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_do_method<class_UndoRedo_add_do_method>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_do_method<class_UndoRedo_add_do_method>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method **)** vararg |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_do_property<class_UndoRedo_add_do_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_do_reference<class_UndoRedo_add_do_reference>` **(** :ref:`Object<class_object>` object **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_undo_method<class_UndoRedo_add_undo_method>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_undo_method<class_UndoRedo_add_undo_method>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method **)** vararg |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_undo_property<class_UndoRedo_add_undo_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_undo_reference<class_UndoRedo_add_undo_reference>` **(** :ref:`Object<class_object>` object **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_history<class_UndoRedo_clear_history>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`commit_action<class_UndoRedo_commit_action>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create_action<class_UndoRedo_create_action>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` merge_mode=0 **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_current_action_name<class_UndoRedo_get_current_action_name>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_version<class_UndoRedo_get_version>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -61,11 +61,7 @@ Member Function Description
|
||||
|
||||
.. _class_UndoRedo_add_do_method:
|
||||
|
||||
- void **add_do_method** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL **)**
|
||||
|
||||
Add a call to a method in a given object with custom
|
||||
|
||||
arguments.
|
||||
- void **add_do_method** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method **)** vararg
|
||||
|
||||
.. _class_UndoRedo_add_do_property:
|
||||
|
||||
@@ -81,9 +77,7 @@ Add a 'do' reference that will be erased if the 'do' history is lost. This is us
|
||||
|
||||
.. _class_UndoRedo_add_undo_method:
|
||||
|
||||
- void **add_undo_method** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` arg0=NULL, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL **)**
|
||||
|
||||
Add a call to an undo method in a given object with custom arguments. Undo calls are used to revert 'do' calls.
|
||||
- void **add_undo_method** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` method **)** vararg
|
||||
|
||||
.. _class_UndoRedo_add_undo_property:
|
||||
|
||||
@@ -115,7 +109,11 @@ Commit the action. All 'do' methods/properties are called/set when this function
|
||||
|
||||
- void **create_action** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` merge_mode=0 **)**
|
||||
|
||||
Create a new action. After this is called, do all your calls to :ref:`add_do_method<class_UndoRedo_add_do_method>`, :ref:`add_undo_method<class_UndoRedo_add_undo_method>`, :ref:`add_do_property<class_UndoRedo_add_do_property>` and :ref:`add_undo_property<class_UndoRedo_add_undo_property>`.
|
||||
Create a new action. After this is called, do all your calls to :ref:`add_do_method<class_UndoRedo_add_do_method>`, :ref:`add_undo_method<class_UndoRedo_add_undo_method>`, :ref:`add_do_property<class_UndoRedo_add_do_property>` and :ref:`add_un
|
||||
|
||||
do_property<class_UndoRedo_add_un
|
||||
|
||||
do_property>`.
|
||||
|
||||
.. _class_UndoRedo_get_current_action_name:
|
||||
|
||||
|
||||
@@ -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 **)**
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
@@ -59,6 +59,8 @@ Member Functions
|
||||
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`World<class_world>` | :ref:`get_world<class_Viewport_get_world>` **(** **)** const |
|
||||
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_Viewport_get_world_2d>` **(** **)** const |
|
||||
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`gui_get_drag_data<class_Viewport_gui_get_drag_data>` **(** **)** const |
|
||||
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`gui_has_modal_stack<class_Viewport_gui_has_modal_stack>` **(** **)** const |
|
||||
@@ -123,6 +125,8 @@ Member Functions
|
||||
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_world<class_Viewport_set_world>` **(** :ref:`World<class_world>` world **)** |
|
||||
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_world_2d<class_Viewport_set_world_2d>` **(** :ref:`World2D<class_world2d>` world_2d **)** |
|
||||
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`unhandled_input<class_Viewport_unhandled_input>` **(** :ref:`InputEvent<class_inputevent>` local_event **)** |
|
||||
+--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update_worlds<class_Viewport_update_worlds>` **(** **)** |
|
||||
@@ -281,6 +285,10 @@ Return the final, visible rect in global screen coordinates.
|
||||
|
||||
Return the 3D world of the viewport.
|
||||
|
||||
.. _class_Viewport_get_world_2d:
|
||||
|
||||
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
|
||||
|
||||
.. _class_Viewport_gui_get_drag_data:
|
||||
|
||||
- :ref:`Variant<class_variant>` **gui_get_drag_data** **(** **)** const
|
||||
@@ -471,6 +479,10 @@ Make the viewport use a world separate from the parent viewport's world.
|
||||
|
||||
Change the 3D world of the viewport.
|
||||
|
||||
.. _class_Viewport_set_world_2d:
|
||||
|
||||
- void **set_world_2d** **(** :ref:`World2D<class_world2d>` world_2d **)**
|
||||
|
||||
.. _class_Viewport_unhandled_input:
|
||||
|
||||
- void **unhandled_input** **(** :ref:`InputEvent<class_inputevent>` local_event **)**
|
||||
@@ -485,6 +497,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.
|
||||
|
||||
|
||||
|
||||
@@ -20,21 +20,33 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
+--------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| :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 **)**
|
||||
|
||||
283
classes/class_visualscript.rst
Normal file
283
classes/class_visualscript.rst
Normal file
@@ -0,0 +1,283 @@
|
||||
.. 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_VisualScript:
|
||||
|
||||
VisualScript
|
||||
============
|
||||
|
||||
**Inherits:** :ref:`Script<class_script>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_custom_signal<class_VisualScript_add_custom_signal>` **(** :ref:`String<class_string>` name **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_function<class_VisualScript_add_function>` **(** :ref:`String<class_string>` name **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_VisualScript_add_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`Object<class_object>` node, :ref:`Vector2<class_vector2>` pos=Vector2(0, 0) **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_variable<class_VisualScript_add_variable>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` default_value=NULL, :ref:`bool<class_bool>` export=false **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`custom_signal_add_argument<class_VisualScript_custom_signal_add_argument>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`String<class_string>` argname, :ref:`int<class_int>` index=-1 **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`custom_signal_get_argument_count<class_VisualScript_custom_signal_get_argument_count>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`custom_signal_get_argument_name<class_VisualScript_custom_signal_get_argument_name>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`custom_signal_get_argument_type<class_VisualScript_custom_signal_get_argument_type>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`custom_signal_remove_argument<class_VisualScript_custom_signal_remove_argument>` **(** :ref:`String<class_string>` argidx, :ref:`int<class_int>` arg1 **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`custom_signal_set_argument_name<class_VisualScript_custom_signal_set_argument_name>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`String<class_string>` argname **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`custom_signal_set_argument_type<class_VisualScript_custom_signal_set_argument_type>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` type **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`custom_signal_swap_argument<class_VisualScript_custom_signal_swap_argument>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` withidx **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`data_connect<class_VisualScript_data_connect>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`data_disconnect<class_VisualScript_data_disconnect>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_function_node_id<class_VisualScript_get_function_node_id>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_function_scroll<class_VisualScript_get_function_scroll>` **(** :ref:`String<class_string>` arg0 **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`get_node<class_VisualScript_get_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_node_pos<class_VisualScript_get_node_pos>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`get_variable_default_value<class_VisualScript_get_variable_default_value>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_variable_export<class_VisualScript_get_variable_export>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`get_variable_info<class_VisualScript_get_variable_info>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_custom_signal<class_VisualScript_has_custom_signal>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_data_connection<class_VisualScript_has_data_connection>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_function<class_VisualScript_has_function>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_node<class_VisualScript_has_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_sequence_connection<class_VisualScript_has_sequence_connection>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_variable<class_VisualScript_has_variable>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_custom_signal<class_VisualScript_remove_custom_signal>` **(** :ref:`String<class_string>` name **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_function<class_VisualScript_remove_function>` **(** :ref:`String<class_string>` name **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_VisualScript_remove_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_variable<class_VisualScript_remove_variable>` **(** :ref:`String<class_string>` name **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_custom_signal<class_VisualScript_rename_custom_signal>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_function<class_VisualScript_rename_function>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_variable<class_VisualScript_rename_variable>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sequence_connect<class_VisualScript_sequence_connect>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sequence_disconnect<class_VisualScript_sequence_disconnect>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_function_scroll<class_VisualScript_set_function_scroll>` **(** :ref:`String<class_string>` ofs, :ref:`Vector2<class_vector2>` arg1 **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_instance_base_type<class_VisualScript_set_instance_base_type>` **(** :ref:`String<class_string>` type **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_node_pos<class_VisualScript_set_node_pos>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` pos **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_variable_default_value<class_VisualScript_set_variable_default_value>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_variable_export<class_VisualScript_set_variable_export>` **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_variable_info<class_VisualScript_set_variable_info>` **(** :ref:`String<class_string>` name, :ref:`Dictionary<class_dictionary>` value **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **node_ports_changed** **(** :ref:`String<class_string>` function, :ref:`int<class_int>` id **)**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScript_add_custom_signal:
|
||||
|
||||
- void **add_custom_signal** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_VisualScript_add_function:
|
||||
|
||||
- void **add_function** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_VisualScript_add_node:
|
||||
|
||||
- void **add_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`Object<class_object>` node, :ref:`Vector2<class_vector2>` pos=Vector2(0, 0) **)**
|
||||
|
||||
.. _class_VisualScript_add_variable:
|
||||
|
||||
- void **add_variable** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` default_value=NULL, :ref:`bool<class_bool>` export=false **)**
|
||||
|
||||
.. _class_VisualScript_custom_signal_add_argument:
|
||||
|
||||
- void **custom_signal_add_argument** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`String<class_string>` argname, :ref:`int<class_int>` index=-1 **)**
|
||||
|
||||
.. _class_VisualScript_custom_signal_get_argument_count:
|
||||
|
||||
- :ref:`int<class_int>` **custom_signal_get_argument_count** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_VisualScript_custom_signal_get_argument_name:
|
||||
|
||||
- :ref:`String<class_string>` **custom_signal_get_argument_name** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** const
|
||||
|
||||
.. _class_VisualScript_custom_signal_get_argument_type:
|
||||
|
||||
- :ref:`int<class_int>` **custom_signal_get_argument_type** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** const
|
||||
|
||||
.. _class_VisualScript_custom_signal_remove_argument:
|
||||
|
||||
- void **custom_signal_remove_argument** **(** :ref:`String<class_string>` argidx, :ref:`int<class_int>` arg1 **)**
|
||||
|
||||
.. _class_VisualScript_custom_signal_set_argument_name:
|
||||
|
||||
- void **custom_signal_set_argument_name** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`String<class_string>` argname **)**
|
||||
|
||||
.. _class_VisualScript_custom_signal_set_argument_type:
|
||||
|
||||
- void **custom_signal_set_argument_type** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` type **)**
|
||||
|
||||
.. _class_VisualScript_custom_signal_swap_argument:
|
||||
|
||||
- void **custom_signal_swap_argument** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` withidx **)**
|
||||
|
||||
.. _class_VisualScript_data_connect:
|
||||
|
||||
- void **data_connect** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)**
|
||||
|
||||
.. _class_VisualScript_data_disconnect:
|
||||
|
||||
- void **data_disconnect** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)**
|
||||
|
||||
.. _class_VisualScript_get_function_node_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_function_node_id** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_VisualScript_get_function_scroll:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_function_scroll** **(** :ref:`String<class_string>` arg0 **)** const
|
||||
|
||||
.. _class_VisualScript_get_node:
|
||||
|
||||
- :ref:`Object<class_object>` **get_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
|
||||
|
||||
.. _class_VisualScript_get_node_pos:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_node_pos** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
|
||||
|
||||
.. _class_VisualScript_get_variable_default_value:
|
||||
|
||||
- void **get_variable_default_value** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_VisualScript_get_variable_export:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_variable_export** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_VisualScript_get_variable_info:
|
||||
|
||||
- :ref:`Dictionary<class_dictionary>` **get_variable_info** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_VisualScript_has_custom_signal:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_custom_signal** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_VisualScript_has_data_connection:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_data_connection** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** const
|
||||
|
||||
.. _class_VisualScript_has_function:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_function** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_VisualScript_has_node:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
|
||||
|
||||
.. _class_VisualScript_has_sequence_connection:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_sequence_connection** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)** const
|
||||
|
||||
.. _class_VisualScript_has_variable:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_variable** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_VisualScript_remove_custom_signal:
|
||||
|
||||
- void **remove_custom_signal** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_VisualScript_remove_function:
|
||||
|
||||
- void **remove_function** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_VisualScript_remove_node:
|
||||
|
||||
- void **remove_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)**
|
||||
|
||||
.. _class_VisualScript_remove_variable:
|
||||
|
||||
- void **remove_variable** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_VisualScript_rename_custom_signal:
|
||||
|
||||
- void **rename_custom_signal** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
|
||||
|
||||
.. _class_VisualScript_rename_function:
|
||||
|
||||
- void **rename_function** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
|
||||
|
||||
.. _class_VisualScript_rename_variable:
|
||||
|
||||
- void **rename_variable** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
|
||||
|
||||
.. _class_VisualScript_sequence_connect:
|
||||
|
||||
- void **sequence_connect** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)**
|
||||
|
||||
.. _class_VisualScript_sequence_disconnect:
|
||||
|
||||
- void **sequence_disconnect** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)**
|
||||
|
||||
.. _class_VisualScript_set_function_scroll:
|
||||
|
||||
- void **set_function_scroll** **(** :ref:`String<class_string>` ofs, :ref:`Vector2<class_vector2>` arg1 **)**
|
||||
|
||||
.. _class_VisualScript_set_instance_base_type:
|
||||
|
||||
- void **set_instance_base_type** **(** :ref:`String<class_string>` type **)**
|
||||
|
||||
.. _class_VisualScript_set_node_pos:
|
||||
|
||||
- void **set_node_pos** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` pos **)**
|
||||
|
||||
.. _class_VisualScript_set_variable_default_value:
|
||||
|
||||
- void **set_variable_default_value** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)**
|
||||
|
||||
.. _class_VisualScript_set_variable_export:
|
||||
|
||||
- void **set_variable_export** **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_VisualScript_set_variable_info:
|
||||
|
||||
- void **set_variable_info** **(** :ref:`String<class_string>` name, :ref:`Dictionary<class_dictionary>` value **)**
|
||||
|
||||
|
||||
50
classes/class_visualscriptbasictypeconstant.rst
Normal file
50
classes/class_visualscriptbasictypeconstant.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. 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_VisualScriptBasicTypeConstant:
|
||||
|
||||
VisualScriptBasicTypeConstant
|
||||
=============================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_basic_type<class_VisualScriptBasicTypeConstant_get_basic_type>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_basic_type_constant<class_VisualScriptBasicTypeConstant_get_basic_type_constant>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_basic_type<class_VisualScriptBasicTypeConstant_set_basic_type>` **(** :ref:`int<class_int>` name **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_basic_type_constant<class_VisualScriptBasicTypeConstant_set_basic_type_constant>` **(** :ref:`String<class_string>` name **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptBasicTypeConstant_get_basic_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_basic_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptBasicTypeConstant_get_basic_type_constant:
|
||||
|
||||
- :ref:`String<class_string>` **get_basic_type_constant** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptBasicTypeConstant_set_basic_type:
|
||||
|
||||
- void **set_basic_type** **(** :ref:`int<class_int>` name **)**
|
||||
|
||||
.. _class_VisualScriptBasicTypeConstant_set_basic_type_constant:
|
||||
|
||||
- void **set_basic_type_constant** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
|
||||
38
classes/class_visualscriptbuiltinfunc.rst
Normal file
38
classes/class_visualscriptbuiltinfunc.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
.. 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_VisualScriptBuiltinFunc:
|
||||
|
||||
VisualScriptBuiltinFunc
|
||||
=======================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_func<class_VisualScriptBuiltinFunc_get_func>` **(** **)** |
|
||||
+------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_func<class_VisualScriptBuiltinFunc_set_func>` **(** :ref:`int<class_int>` which **)** |
|
||||
+------------------------+---------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptBuiltinFunc_get_func:
|
||||
|
||||
- :ref:`int<class_int>` **get_func** **(** **)**
|
||||
|
||||
.. _class_VisualScriptBuiltinFunc_set_func:
|
||||
|
||||
- void **set_func** **(** :ref:`int<class_int>` which **)**
|
||||
|
||||
|
||||
50
classes/class_visualscriptclassconstant.rst
Normal file
50
classes/class_visualscriptclassconstant.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. 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_VisualScriptClassConstant:
|
||||
|
||||
VisualScriptClassConstant
|
||||
=========================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_base_type<class_VisualScriptClassConstant_get_base_type>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_class_constant<class_VisualScriptClassConstant_get_class_constant>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_type<class_VisualScriptClassConstant_set_base_type>` **(** :ref:`String<class_string>` name **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_class_constant<class_VisualScriptClassConstant_set_class_constant>` **(** :ref:`String<class_string>` name **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptClassConstant_get_base_type:
|
||||
|
||||
- :ref:`String<class_string>` **get_base_type** **(** **)**
|
||||
|
||||
.. _class_VisualScriptClassConstant_get_class_constant:
|
||||
|
||||
- :ref:`String<class_string>` **get_class_constant** **(** **)**
|
||||
|
||||
.. _class_VisualScriptClassConstant_set_base_type:
|
||||
|
||||
- void **set_base_type** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_VisualScriptClassConstant_set_class_constant:
|
||||
|
||||
- void **set_class_constant** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
|
||||
62
classes/class_visualscriptcomment.rst
Normal file
62
classes/class_visualscriptcomment.rst
Normal file
@@ -0,0 +1,62 @@
|
||||
.. 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_VisualScriptComment:
|
||||
|
||||
VisualScriptComment
|
||||
===================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_description<class_VisualScriptComment_get_description>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_VisualScriptComment_get_size>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_title<class_VisualScriptComment_get_title>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_description<class_VisualScriptComment_set_description>` **(** :ref:`String<class_string>` description **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_size<class_VisualScriptComment_set_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_title<class_VisualScriptComment_set_title>` **(** :ref:`String<class_string>` title **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptComment_get_description:
|
||||
|
||||
- :ref:`String<class_string>` **get_description** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptComment_get_size:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_size** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptComment_get_title:
|
||||
|
||||
- :ref:`String<class_string>` **get_title** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptComment_set_description:
|
||||
|
||||
- void **set_description** **(** :ref:`String<class_string>` description **)**
|
||||
|
||||
.. _class_VisualScriptComment_set_size:
|
||||
|
||||
- void **set_size** **(** :ref:`Vector2<class_vector2>` size **)**
|
||||
|
||||
.. _class_VisualScriptComment_set_title:
|
||||
|
||||
- void **set_title** **(** :ref:`String<class_string>` title **)**
|
||||
|
||||
|
||||
17
classes/class_visualscriptcondition.rst
Normal file
17
classes/class_visualscriptcondition.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. 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_VisualScriptCondition:
|
||||
|
||||
VisualScriptCondition
|
||||
=====================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
50
classes/class_visualscriptconstant.rst
Normal file
50
classes/class_visualscriptconstant.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. 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_VisualScriptConstant:
|
||||
|
||||
VisualScriptConstant
|
||||
====================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_constant_type<class_VisualScriptConstant_get_constant_type>` **(** **)** const |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`get_constant_value<class_VisualScriptConstant_get_constant_value>` **(** **)** const |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_constant_type<class_VisualScriptConstant_set_constant_type>` **(** :ref:`int<class_int>` type **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_constant_value<class_VisualScriptConstant_set_constant_value>` **(** :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptConstant_get_constant_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_constant_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptConstant_get_constant_value:
|
||||
|
||||
- void **get_constant_value** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptConstant_set_constant_type:
|
||||
|
||||
- void **set_constant_type** **(** :ref:`int<class_int>` type **)**
|
||||
|
||||
.. _class_VisualScriptConstant_set_constant_value:
|
||||
|
||||
- void **set_constant_value** **(** :ref:`Variant<class_variant>` value **)**
|
||||
|
||||
|
||||
50
classes/class_visualscriptconstructor.rst
Normal file
50
classes/class_visualscriptconstructor.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. 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_VisualScriptConstructor:
|
||||
|
||||
VisualScriptConstructor
|
||||
=======================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`get_constructor<class_VisualScriptConstructor_get_constructor>` **(** **)** const |
|
||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_constructor_type<class_VisualScriptConstructor_get_constructor_type>` **(** **)** const |
|
||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_constructor<class_VisualScriptConstructor_set_constructor>` **(** :ref:`Dictionary<class_dictionary>` constructor **)** |
|
||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_constructor_type<class_VisualScriptConstructor_set_constructor_type>` **(** :ref:`int<class_int>` type **)** |
|
||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptConstructor_get_constructor:
|
||||
|
||||
- :ref:`Dictionary<class_dictionary>` **get_constructor** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptConstructor_get_constructor_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_constructor_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptConstructor_set_constructor:
|
||||
|
||||
- void **set_constructor** **(** :ref:`Dictionary<class_dictionary>` constructor **)**
|
||||
|
||||
.. _class_VisualScriptConstructor_set_constructor_type:
|
||||
|
||||
- void **set_constructor_type** **(** :ref:`int<class_int>` type **)**
|
||||
|
||||
|
||||
122
classes/class_visualscriptcustomnode.rst
Normal file
122
classes/class_visualscriptcustomnode.rst
Normal file
@@ -0,0 +1,122 @@
|
||||
.. 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_VisualScriptCustomNode:
|
||||
|
||||
VisualScriptCustomNode
|
||||
======================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`_get_caption<class_VisualScriptCustomNode__get_caption>` **(** **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`_get_category<class_VisualScriptCustomNode__get_category>` **(** **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`_get_input_value_port_count<class_VisualScriptCustomNode__get_input_value_port_count>` **(** **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`_get_input_value_port_name<class_VisualScriptCustomNode__get_input_value_port_name>` **(** :ref:`int<class_int>` idx **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`_get_input_value_port_type<class_VisualScriptCustomNode__get_input_value_port_type>` **(** :ref:`int<class_int>` idx **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`_get_output_sequence_port_count<class_VisualScriptCustomNode__get_output_sequence_port_count>` **(** **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`_get_output_sequence_port_text<class_VisualScriptCustomNode__get_output_sequence_port_text>` **(** :ref:`int<class_int>` idx **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`_get_output_value_port_count<class_VisualScriptCustomNode__get_output_value_port_count>` **(** **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`_get_output_value_port_name<class_VisualScriptCustomNode__get_output_value_port_name>` **(** :ref:`int<class_int>` idx **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`_get_output_value_port_type<class_VisualScriptCustomNode__get_output_value_port_type>` **(** :ref:`int<class_int>` idx **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`_get_text<class_VisualScriptCustomNode__get_text>` **(** **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`_get_working_memory_size<class_VisualScriptCustomNode__get_working_memory_size>` **(** **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`_has_input_sequence_port<class_VisualScriptCustomNode__has_input_sequence_port>` **(** **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`_step<class_VisualScriptCustomNode__step>` **(** :ref:`Array<class_array>` inputs, :ref:`Array<class_array>` outputs, :ref:`int<class_int>` start_mode, :ref:`Array<class_array>` working_mem **)** virtual |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **START_MODE_BEGIN_SEQUENCE** = **0**
|
||||
- **START_MODE_CONTINUE_SEQUENCE** = **1**
|
||||
- **START_MODE_RESUME_YIELD** = **2**
|
||||
- **STEP_PUSH_STACK_BIT** = **16777216**
|
||||
- **STEP_GO_BACK_BIT** = **33554432**
|
||||
- **STEP_NO_ADVANCE_BIT** = **67108864**
|
||||
- **STEP_EXIT_FUNCTION_BIT** = **134217728**
|
||||
- **STEP_YIELD_BIT** = **268435456**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_caption:
|
||||
|
||||
- :ref:`String<class_string>` **_get_caption** **(** **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_category:
|
||||
|
||||
- :ref:`String<class_string>` **_get_category** **(** **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_input_value_port_count:
|
||||
|
||||
- :ref:`int<class_int>` **_get_input_value_port_count** **(** **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_input_value_port_name:
|
||||
|
||||
- :ref:`String<class_string>` **_get_input_value_port_name** **(** :ref:`int<class_int>` idx **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_input_value_port_type:
|
||||
|
||||
- :ref:`int<class_int>` **_get_input_value_port_type** **(** :ref:`int<class_int>` idx **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_output_sequence_port_count:
|
||||
|
||||
- :ref:`int<class_int>` **_get_output_sequence_port_count** **(** **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_output_sequence_port_text:
|
||||
|
||||
- :ref:`String<class_string>` **_get_output_sequence_port_text** **(** :ref:`int<class_int>` idx **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_output_value_port_count:
|
||||
|
||||
- :ref:`int<class_int>` **_get_output_value_port_count** **(** **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_output_value_port_name:
|
||||
|
||||
- :ref:`String<class_string>` **_get_output_value_port_name** **(** :ref:`int<class_int>` idx **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_output_value_port_type:
|
||||
|
||||
- :ref:`int<class_int>` **_get_output_value_port_type** **(** :ref:`int<class_int>` idx **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_text:
|
||||
|
||||
- :ref:`String<class_string>` **_get_text** **(** **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__get_working_memory_size:
|
||||
|
||||
- :ref:`int<class_int>` **_get_working_memory_size** **(** **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__has_input_sequence_port:
|
||||
|
||||
- :ref:`bool<class_bool>` **_has_input_sequence_port** **(** **)** virtual
|
||||
|
||||
.. _class_VisualScriptCustomNode__step:
|
||||
|
||||
- :ref:`Variant<class_variant>` **_step** **(** :ref:`Array<class_array>` inputs, :ref:`Array<class_array>` outputs, :ref:`int<class_int>` start_mode, :ref:`Array<class_array>` working_mem **)** virtual
|
||||
|
||||
|
||||
50
classes/class_visualscriptdeconstruct.rst
Normal file
50
classes/class_visualscriptdeconstruct.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. 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_VisualScriptDeconstruct:
|
||||
|
||||
VisualScriptDeconstruct
|
||||
=======================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_deconstruct_input_type<class_VisualScriptDeconstruct_get_deconstruct_input_type>` **(** **)** const |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_deconstruct_type<class_VisualScriptDeconstruct_get_deconstruct_type>` **(** **)** const |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_deconstruct_input_type<class_VisualScriptDeconstruct_set_deconstruct_input_type>` **(** :ref:`int<class_int>` input_type **)** |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_deconstruct_type<class_VisualScriptDeconstruct_set_deconstruct_type>` **(** :ref:`int<class_int>` type **)** |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptDeconstruct_get_deconstruct_input_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_deconstruct_input_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptDeconstruct_get_deconstruct_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_deconstruct_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptDeconstruct_set_deconstruct_input_type:
|
||||
|
||||
- void **set_deconstruct_input_type** **(** :ref:`int<class_int>` input_type **)**
|
||||
|
||||
.. _class_VisualScriptDeconstruct_set_deconstruct_type:
|
||||
|
||||
- void **set_deconstruct_type** **(** :ref:`int<class_int>` type **)**
|
||||
|
||||
|
||||
38
classes/class_visualscriptemitsignal.rst
Normal file
38
classes/class_visualscriptemitsignal.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
.. 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_VisualScriptEmitSignal:
|
||||
|
||||
VisualScriptEmitSignal
|
||||
======================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_signal<class_VisualScriptEmitSignal_get_signal>` **(** **)** const |
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_signal<class_VisualScriptEmitSignal_set_signal>` **(** :ref:`String<class_string>` name **)** |
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptEmitSignal_get_signal:
|
||||
|
||||
- :ref:`String<class_string>` **get_signal** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptEmitSignal_set_signal:
|
||||
|
||||
- void **set_signal** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
|
||||
38
classes/class_visualscriptenginesingleton.rst
Normal file
38
classes/class_visualscriptenginesingleton.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
.. 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_VisualScriptEngineSingleton:
|
||||
|
||||
VisualScriptEngineSingleton
|
||||
===========================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_singleton<class_VisualScriptEngineSingleton_get_singleton>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_singleton<class_VisualScriptEngineSingleton_set_singleton>` **(** :ref:`String<class_string>` name **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptEngineSingleton_get_singleton:
|
||||
|
||||
- :ref:`String<class_string>` **get_singleton** **(** **)**
|
||||
|
||||
.. _class_VisualScriptEngineSingleton_set_singleton:
|
||||
|
||||
- void **set_singleton** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
|
||||
17
classes/class_visualscriptexpression.rst
Normal file
17
classes/class_visualscriptexpression.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. 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_VisualScriptExpression:
|
||||
|
||||
VisualScriptExpression
|
||||
======================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
17
classes/class_visualscriptfunction.rst
Normal file
17
classes/class_visualscriptfunction.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. 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_VisualScriptFunction:
|
||||
|
||||
VisualScriptFunction
|
||||
====================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
154
classes/class_visualscriptfunctioncall.rst
Normal file
154
classes/class_visualscriptfunctioncall.rst
Normal file
@@ -0,0 +1,154 @@
|
||||
.. 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_VisualScriptFunctionCall:
|
||||
|
||||
VisualScriptFunctionCall
|
||||
========================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_base_path<class_VisualScriptFunctionCall_get_base_path>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_base_script<class_VisualScriptFunctionCall_get_base_script>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_base_type<class_VisualScriptFunctionCall_get_base_type>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_basic_type<class_VisualScriptFunctionCall_get_basic_type>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_call_mode<class_VisualScriptFunctionCall_get_call_mode>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_function<class_VisualScriptFunctionCall_get_function>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_rpc_call_mode<class_VisualScriptFunctionCall_get_rpc_call_mode>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_singleton<class_VisualScriptFunctionCall_get_singleton>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_use_default_args<class_VisualScriptFunctionCall_get_use_default_args>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_validate<class_VisualScriptFunctionCall_get_validate>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_path<class_VisualScriptFunctionCall_set_base_path>` **(** :ref:`NodePath<class_nodepath>` base_path **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_script<class_VisualScriptFunctionCall_set_base_script>` **(** :ref:`String<class_string>` base_script **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_type<class_VisualScriptFunctionCall_set_base_type>` **(** :ref:`String<class_string>` base_type **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_basic_type<class_VisualScriptFunctionCall_set_basic_type>` **(** :ref:`int<class_int>` basic_type **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_call_mode<class_VisualScriptFunctionCall_set_call_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_function<class_VisualScriptFunctionCall_set_function>` **(** :ref:`String<class_string>` function **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rpc_call_mode<class_VisualScriptFunctionCall_set_rpc_call_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_singleton<class_VisualScriptFunctionCall_set_singleton>` **(** :ref:`String<class_string>` singleton **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_default_args<class_VisualScriptFunctionCall_set_use_default_args>` **(** :ref:`int<class_int>` amount **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_validate<class_VisualScriptFunctionCall_set_validate>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **CALL_MODE_SELF** = **0**
|
||||
- **CALL_MODE_NODE_PATH** = **1**
|
||||
- **CALL_MODE_INSTANCE** = **2**
|
||||
- **CALL_MODE_BASIC_TYPE** = **3**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptFunctionCall_get_base_path:
|
||||
|
||||
- :ref:`NodePath<class_nodepath>` **get_base_path** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptFunctionCall_get_base_script:
|
||||
|
||||
- :ref:`String<class_string>` **get_base_script** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptFunctionCall_get_base_type:
|
||||
|
||||
- :ref:`String<class_string>` **get_base_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptFunctionCall_get_basic_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_basic_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptFunctionCall_get_call_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_call_mode** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptFunctionCall_get_function:
|
||||
|
||||
- :ref:`String<class_string>` **get_function** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptFunctionCall_get_rpc_call_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_rpc_call_mode** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptFunctionCall_get_singleton:
|
||||
|
||||
- :ref:`String<class_string>` **get_singleton** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptFunctionCall_get_use_default_args:
|
||||
|
||||
- :ref:`int<class_int>` **get_use_default_args** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptFunctionCall_get_validate:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_validate** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptFunctionCall_set_base_path:
|
||||
|
||||
- void **set_base_path** **(** :ref:`NodePath<class_nodepath>` base_path **)**
|
||||
|
||||
.. _class_VisualScriptFunctionCall_set_base_script:
|
||||
|
||||
- void **set_base_script** **(** :ref:`String<class_string>` base_script **)**
|
||||
|
||||
.. _class_VisualScriptFunctionCall_set_base_type:
|
||||
|
||||
- void **set_base_type** **(** :ref:`String<class_string>` base_type **)**
|
||||
|
||||
.. _class_VisualScriptFunctionCall_set_basic_type:
|
||||
|
||||
- void **set_basic_type** **(** :ref:`int<class_int>` basic_type **)**
|
||||
|
||||
.. _class_VisualScriptFunctionCall_set_call_mode:
|
||||
|
||||
- void **set_call_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_VisualScriptFunctionCall_set_function:
|
||||
|
||||
- void **set_function** **(** :ref:`String<class_string>` function **)**
|
||||
|
||||
.. _class_VisualScriptFunctionCall_set_rpc_call_mode:
|
||||
|
||||
- void **set_rpc_call_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_VisualScriptFunctionCall_set_singleton:
|
||||
|
||||
- void **set_singleton** **(** :ref:`String<class_string>` singleton **)**
|
||||
|
||||
.. _class_VisualScriptFunctionCall_set_use_default_args:
|
||||
|
||||
- void **set_use_default_args** **(** :ref:`int<class_int>` amount **)**
|
||||
|
||||
.. _class_VisualScriptFunctionCall_set_validate:
|
||||
|
||||
- void **set_validate** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
|
||||
44
classes/class_visualscriptfunctionstate.rst
Normal file
44
classes/class_visualscriptfunctionstate.rst
Normal file
@@ -0,0 +1,44 @@
|
||||
.. 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_VisualScriptFunctionState:
|
||||
|
||||
VisualScriptFunctionState
|
||||
=========================
|
||||
|
||||
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_to_signal<class_VisualScriptFunctionState_connect_to_signal>` **(** :ref:`Object<class_object>` obj, :ref:`String<class_string>` signals, :ref:`Array<class_array>` args **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_valid<class_VisualScriptFunctionState_is_valid>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`resume<class_VisualScriptFunctionState_resume>` **(** :ref:`Array<class_array>` args=NULL **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptFunctionState_connect_to_signal:
|
||||
|
||||
- void **connect_to_signal** **(** :ref:`Object<class_object>` obj, :ref:`String<class_string>` signals, :ref:`Array<class_array>` args **)**
|
||||
|
||||
.. _class_VisualScriptFunctionState_is_valid:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_valid** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptFunctionState_resume:
|
||||
|
||||
- :ref:`Array<class_array>` **resume** **(** :ref:`Array<class_array>` args=NULL **)**
|
||||
|
||||
|
||||
38
classes/class_visualscriptglobalconstant.rst
Normal file
38
classes/class_visualscriptglobalconstant.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
.. 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_VisualScriptGlobalConstant:
|
||||
|
||||
VisualScriptGlobalConstant
|
||||
==========================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_global_constant<class_VisualScriptGlobalConstant_get_global_constant>` **(** **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_global_constant<class_VisualScriptGlobalConstant_set_global_constant>` **(** :ref:`int<class_int>` index **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptGlobalConstant_get_global_constant:
|
||||
|
||||
- :ref:`int<class_int>` **get_global_constant** **(** **)**
|
||||
|
||||
.. _class_VisualScriptGlobalConstant_set_global_constant:
|
||||
|
||||
- void **set_global_constant** **(** :ref:`int<class_int>` index **)**
|
||||
|
||||
|
||||
17
classes/class_visualscriptindexget.rst
Normal file
17
classes/class_visualscriptindexget.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. 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_VisualScriptIndexGet:
|
||||
|
||||
VisualScriptIndexGet
|
||||
====================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
17
classes/class_visualscriptindexset.rst
Normal file
17
classes/class_visualscriptindexset.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. 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_VisualScriptIndexSet:
|
||||
|
||||
VisualScriptIndexSet
|
||||
====================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
50
classes/class_visualscriptinputaction.rst
Normal file
50
classes/class_visualscriptinputaction.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. 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_VisualScriptInputAction:
|
||||
|
||||
VisualScriptInputAction
|
||||
=======================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_action_mode<class_VisualScriptInputAction_get_action_mode>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_action_name<class_VisualScriptInputAction_get_action_name>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_action_mode<class_VisualScriptInputAction_set_action_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_action_name<class_VisualScriptInputAction_set_action_name>` **(** :ref:`String<class_string>` name **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptInputAction_get_action_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_action_mode** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptInputAction_get_action_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_action_name** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptInputAction_set_action_mode:
|
||||
|
||||
- void **set_action_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_VisualScriptInputAction_set_action_name:
|
||||
|
||||
- void **set_action_name** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
|
||||
17
classes/class_visualscriptinputfilter.rst
Normal file
17
classes/class_visualscriptinputfilter.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. 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_VisualScriptInputFilter:
|
||||
|
||||
VisualScriptInputFilter
|
||||
=======================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
17
classes/class_visualscriptiterator.rst
Normal file
17
classes/class_visualscriptiterator.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. 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_VisualScriptIterator:
|
||||
|
||||
VisualScriptIterator
|
||||
====================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
50
classes/class_visualscriptlocalvar.rst
Normal file
50
classes/class_visualscriptlocalvar.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. 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_VisualScriptLocalVar:
|
||||
|
||||
VisualScriptLocalVar
|
||||
====================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_var_name<class_VisualScriptLocalVar_get_var_name>` **(** **)** const |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_var_type<class_VisualScriptLocalVar_get_var_type>` **(** **)** const |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_var_name<class_VisualScriptLocalVar_set_var_name>` **(** :ref:`String<class_string>` name **)** |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_var_type<class_VisualScriptLocalVar_set_var_type>` **(** :ref:`int<class_int>` type **)** |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptLocalVar_get_var_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_var_name** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptLocalVar_get_var_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_var_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptLocalVar_set_var_name:
|
||||
|
||||
- void **set_var_name** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_VisualScriptLocalVar_set_var_type:
|
||||
|
||||
- void **set_var_type** **(** :ref:`int<class_int>` type **)**
|
||||
|
||||
|
||||
50
classes/class_visualscriptlocalvarset.rst
Normal file
50
classes/class_visualscriptlocalvarset.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. 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_VisualScriptLocalVarSet:
|
||||
|
||||
VisualScriptLocalVarSet
|
||||
=======================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_var_name<class_VisualScriptLocalVarSet_get_var_name>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_var_type<class_VisualScriptLocalVarSet_get_var_type>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_var_name<class_VisualScriptLocalVarSet_set_var_name>` **(** :ref:`String<class_string>` name **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_var_type<class_VisualScriptLocalVarSet_set_var_type>` **(** :ref:`int<class_int>` type **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptLocalVarSet_get_var_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_var_name** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptLocalVarSet_get_var_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_var_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptLocalVarSet_set_var_name:
|
||||
|
||||
- void **set_var_name** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_VisualScriptLocalVarSet_set_var_type:
|
||||
|
||||
- void **set_var_type** **(** :ref:`int<class_int>` type **)**
|
||||
|
||||
|
||||
38
classes/class_visualscriptmathconstant.rst
Normal file
38
classes/class_visualscriptmathconstant.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
.. 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_VisualScriptMathConstant:
|
||||
|
||||
VisualScriptMathConstant
|
||||
========================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_math_constant<class_VisualScriptMathConstant_get_math_constant>` **(** **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_math_constant<class_VisualScriptMathConstant_set_math_constant>` **(** :ref:`int<class_int>` which **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptMathConstant_get_math_constant:
|
||||
|
||||
- :ref:`int<class_int>` **get_math_constant** **(** **)**
|
||||
|
||||
.. _class_VisualScriptMathConstant_set_math_constant:
|
||||
|
||||
- void **set_math_constant** **(** :ref:`int<class_int>` which **)**
|
||||
|
||||
|
||||
51
classes/class_visualscriptnode.rst
Normal file
51
classes/class_visualscriptnode.rst
Normal file
@@ -0,0 +1,51 @@
|
||||
.. 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_VisualScriptNode:
|
||||
|
||||
VisualScriptNode
|
||||
================
|
||||
|
||||
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`VisualScriptDeconstruct<class_visualscriptdeconstruct>`, :ref:`VisualScriptLocalVar<class_visualscriptlocalvar>`, :ref:`VisualScriptSceneNode<class_visualscriptscenenode>`, :ref:`VisualScriptBasicTypeConstant<class_visualscriptbasictypeconstant>`, :ref:`VisualScriptVariableSet<class_visualscriptvariableset>`, :ref:`VisualScriptSelf<class_visualscriptself>`, :ref:`VisualScriptConstant<class_visualscriptconstant>`, :ref:`VisualScriptReturn<class_visualscriptreturn>`, :ref:`VisualScriptSceneTree<class_visualscriptscenetree>`, :ref:`VisualScriptResourcePath<class_visualscriptresourcepath>`, :ref:`VisualScriptPropertyGet<class_visualscriptpropertyget>`, :ref:`VisualScriptVariableGet<class_visualscriptvariableget>`, :ref:`VisualScriptIndexGet<class_visualscriptindexget>`, :ref:`VisualScriptInputAction<class_visualscriptinputaction>`, :ref:`VisualScriptEmitSignal<class_visualscriptemitsignal>`, :ref:`VisualScriptSequence<class_visualscriptsequence>`, :ref:`VisualScriptTypeCast<class_visualscripttypecast>`, :ref:`VisualScriptGlobalConstant<class_visualscriptglobalconstant>`, :ref:`VisualScriptFunctionCall<class_visualscriptfunctioncall>`, :ref:`VisualScriptPreload<class_visualscriptpreload>`, :ref:`VisualScriptYield<class_visualscriptyield>`, :ref:`VisualScriptSwitch<class_visualscriptswitch>`, :ref:`VisualScriptBuiltinFunc<class_visualscriptbuiltinfunc>`, :ref:`VisualScriptIndexSet<class_visualscriptindexset>`, :ref:`VisualScriptClassConstant<class_visualscriptclassconstant>`, :ref:`VisualScriptEngineSingleton<class_visualscriptenginesingleton>`, :ref:`VisualScriptCondition<class_visualscriptcondition>`, :ref:`VisualScriptOperator<class_visualscriptoperator>`, :ref:`VisualScriptIterator<class_visualscriptiterator>`, :ref:`VisualScriptCustomNode<class_visualscriptcustomnode>`, :ref:`VisualScriptSubCall<class_visualscriptsubcall>`, :ref:`VisualScriptYieldSignal<class_visualscriptyieldsignal>`, :ref:`VisualScriptLocalVarSet<class_visualscriptlocalvarset>`, :ref:`VisualScriptWhile<class_visualscriptwhile>`, :ref:`VisualScriptConstructor<class_visualscriptconstructor>`, :ref:`VisualScriptMathConstant<class_visualscriptmathconstant>`, :ref:`VisualScriptComment<class_visualscriptcomment>`, :ref:`VisualScriptExpression<class_visualscriptexpression>`, :ref:`VisualScriptPropertySet<class_visualscriptpropertyset>`, :ref:`VisualScriptFunction<class_visualscriptfunction>`, :ref:`VisualScriptInputFilter<class_visualscriptinputfilter>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`get_default_input_value<class_VisualScriptNode_get_default_input_value>` **(** :ref:`int<class_int>` port_idx **)** const |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`VisualScript<class_visualscript>` | :ref:`get_visual_script<class_VisualScriptNode_get_visual_script>` **(** **)** const |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_default_input_value<class_VisualScriptNode_set_default_input_value>` **(** :ref:`int<class_int>` port_idx, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **ports_changed** **(** **)**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptNode_get_default_input_value:
|
||||
|
||||
- :ref:`Variant<class_variant>` **get_default_input_value** **(** :ref:`int<class_int>` port_idx **)** const
|
||||
|
||||
.. _class_VisualScriptNode_get_visual_script:
|
||||
|
||||
- :ref:`VisualScript<class_visualscript>` **get_visual_script** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptNode_set_default_input_value:
|
||||
|
||||
- void **set_default_input_value** **(** :ref:`int<class_int>` port_idx, :ref:`Variant<class_variant>` value **)**
|
||||
|
||||
|
||||
50
classes/class_visualscriptoperator.rst
Normal file
50
classes/class_visualscriptoperator.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. 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_VisualScriptOperator:
|
||||
|
||||
VisualScriptOperator
|
||||
====================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_operator<class_VisualScriptOperator_get_operator>` **(** **)** const |
|
||||
+------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_typed<class_VisualScriptOperator_get_typed>` **(** **)** const |
|
||||
+------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_operator<class_VisualScriptOperator_set_operator>` **(** :ref:`int<class_int>` op **)** |
|
||||
+------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_typed<class_VisualScriptOperator_set_typed>` **(** :ref:`int<class_int>` type **)** |
|
||||
+------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptOperator_get_operator:
|
||||
|
||||
- :ref:`int<class_int>` **get_operator** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptOperator_get_typed:
|
||||
|
||||
- :ref:`int<class_int>` **get_typed** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptOperator_set_operator:
|
||||
|
||||
- void **set_operator** **(** :ref:`int<class_int>` op **)**
|
||||
|
||||
.. _class_VisualScriptOperator_set_typed:
|
||||
|
||||
- void **set_typed** **(** :ref:`int<class_int>` type **)**
|
||||
|
||||
|
||||
38
classes/class_visualscriptpreload.rst
Normal file
38
classes/class_visualscriptpreload.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
.. 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_VisualScriptPreload:
|
||||
|
||||
VisualScriptPreload
|
||||
===================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`get_preload<class_VisualScriptPreload_get_preload>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_preload<class_VisualScriptPreload_set_preload>` **(** :ref:`Object<class_object>` resource **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptPreload_get_preload:
|
||||
|
||||
- :ref:`Object<class_object>` **get_preload** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPreload_set_preload:
|
||||
|
||||
- void **set_preload** **(** :ref:`Object<class_object>` resource **)**
|
||||
|
||||
|
||||
117
classes/class_visualscriptpropertyget.rst
Normal file
117
classes/class_visualscriptpropertyget.rst
Normal file
@@ -0,0 +1,117 @@
|
||||
.. 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_VisualScriptPropertyGet:
|
||||
|
||||
VisualScriptPropertyGet
|
||||
=======================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_base_path<class_VisualScriptPropertyGet_get_base_path>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_base_script<class_VisualScriptPropertyGet_get_base_script>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_base_type<class_VisualScriptPropertyGet_get_base_type>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_basic_type<class_VisualScriptPropertyGet_get_basic_type>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_call_mode<class_VisualScriptPropertyGet_get_call_mode>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_event_type<class_VisualScriptPropertyGet_get_event_type>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_property<class_VisualScriptPropertyGet_get_property>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_path<class_VisualScriptPropertyGet_set_base_path>` **(** :ref:`NodePath<class_nodepath>` base_path **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_script<class_VisualScriptPropertyGet_set_base_script>` **(** :ref:`String<class_string>` base_script **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_type<class_VisualScriptPropertyGet_set_base_type>` **(** :ref:`String<class_string>` base_type **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_basic_type<class_VisualScriptPropertyGet_set_basic_type>` **(** :ref:`int<class_int>` basic_type **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_call_mode<class_VisualScriptPropertyGet_set_call_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_event_type<class_VisualScriptPropertyGet_set_event_type>` **(** :ref:`int<class_int>` event_type **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_property<class_VisualScriptPropertyGet_set_property>` **(** :ref:`String<class_string>` property **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **CALL_MODE_SELF** = **0**
|
||||
- **CALL_MODE_NODE_PATH** = **1**
|
||||
- **CALL_MODE_INSTANCE** = **2**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptPropertyGet_get_base_path:
|
||||
|
||||
- :ref:`NodePath<class_nodepath>` **get_base_path** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertyGet_get_base_script:
|
||||
|
||||
- :ref:`String<class_string>` **get_base_script** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertyGet_get_base_type:
|
||||
|
||||
- :ref:`String<class_string>` **get_base_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertyGet_get_basic_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_basic_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertyGet_get_call_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_call_mode** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertyGet_get_event_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_event_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertyGet_get_property:
|
||||
|
||||
- :ref:`String<class_string>` **get_property** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertyGet_set_base_path:
|
||||
|
||||
- void **set_base_path** **(** :ref:`NodePath<class_nodepath>` base_path **)**
|
||||
|
||||
.. _class_VisualScriptPropertyGet_set_base_script:
|
||||
|
||||
- void **set_base_script** **(** :ref:`String<class_string>` base_script **)**
|
||||
|
||||
.. _class_VisualScriptPropertyGet_set_base_type:
|
||||
|
||||
- void **set_base_type** **(** :ref:`String<class_string>` base_type **)**
|
||||
|
||||
.. _class_VisualScriptPropertyGet_set_basic_type:
|
||||
|
||||
- void **set_basic_type** **(** :ref:`int<class_int>` basic_type **)**
|
||||
|
||||
.. _class_VisualScriptPropertyGet_set_call_mode:
|
||||
|
||||
- void **set_call_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_VisualScriptPropertyGet_set_event_type:
|
||||
|
||||
- void **set_event_type** **(** :ref:`int<class_int>` event_type **)**
|
||||
|
||||
.. _class_VisualScriptPropertyGet_set_property:
|
||||
|
||||
- void **set_property** **(** :ref:`String<class_string>` property **)**
|
||||
|
||||
|
||||
117
classes/class_visualscriptpropertyset.rst
Normal file
117
classes/class_visualscriptpropertyset.rst
Normal file
@@ -0,0 +1,117 @@
|
||||
.. 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_VisualScriptPropertySet:
|
||||
|
||||
VisualScriptPropertySet
|
||||
=======================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_base_path<class_VisualScriptPropertySet_get_base_path>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_base_script<class_VisualScriptPropertySet_get_base_script>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_base_type<class_VisualScriptPropertySet_get_base_type>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_basic_type<class_VisualScriptPropertySet_get_basic_type>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_call_mode<class_VisualScriptPropertySet_get_call_mode>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_event_type<class_VisualScriptPropertySet_get_event_type>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_property<class_VisualScriptPropertySet_get_property>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_path<class_VisualScriptPropertySet_set_base_path>` **(** :ref:`NodePath<class_nodepath>` base_path **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_script<class_VisualScriptPropertySet_set_base_script>` **(** :ref:`String<class_string>` base_script **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_type<class_VisualScriptPropertySet_set_base_type>` **(** :ref:`String<class_string>` base_type **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_basic_type<class_VisualScriptPropertySet_set_basic_type>` **(** :ref:`int<class_int>` basic_type **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_call_mode<class_VisualScriptPropertySet_set_call_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_event_type<class_VisualScriptPropertySet_set_event_type>` **(** :ref:`int<class_int>` event_type **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_property<class_VisualScriptPropertySet_set_property>` **(** :ref:`String<class_string>` property **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **CALL_MODE_SELF** = **0**
|
||||
- **CALL_MODE_NODE_PATH** = **1**
|
||||
- **CALL_MODE_INSTANCE** = **2**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptPropertySet_get_base_path:
|
||||
|
||||
- :ref:`NodePath<class_nodepath>` **get_base_path** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertySet_get_base_script:
|
||||
|
||||
- :ref:`String<class_string>` **get_base_script** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertySet_get_base_type:
|
||||
|
||||
- :ref:`String<class_string>` **get_base_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertySet_get_basic_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_basic_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertySet_get_call_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_call_mode** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertySet_get_event_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_event_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertySet_get_property:
|
||||
|
||||
- :ref:`String<class_string>` **get_property** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptPropertySet_set_base_path:
|
||||
|
||||
- void **set_base_path** **(** :ref:`NodePath<class_nodepath>` base_path **)**
|
||||
|
||||
.. _class_VisualScriptPropertySet_set_base_script:
|
||||
|
||||
- void **set_base_script** **(** :ref:`String<class_string>` base_script **)**
|
||||
|
||||
.. _class_VisualScriptPropertySet_set_base_type:
|
||||
|
||||
- void **set_base_type** **(** :ref:`String<class_string>` base_type **)**
|
||||
|
||||
.. _class_VisualScriptPropertySet_set_basic_type:
|
||||
|
||||
- void **set_basic_type** **(** :ref:`int<class_int>` basic_type **)**
|
||||
|
||||
.. _class_VisualScriptPropertySet_set_call_mode:
|
||||
|
||||
- void **set_call_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_VisualScriptPropertySet_set_event_type:
|
||||
|
||||
- void **set_event_type** **(** :ref:`int<class_int>` event_type **)**
|
||||
|
||||
.. _class_VisualScriptPropertySet_set_property:
|
||||
|
||||
- void **set_property** **(** :ref:`String<class_string>` property **)**
|
||||
|
||||
|
||||
38
classes/class_visualscriptresourcepath.rst
Normal file
38
classes/class_visualscriptresourcepath.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
.. 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_VisualScriptResourcePath:
|
||||
|
||||
VisualScriptResourcePath
|
||||
========================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_resource_path<class_VisualScriptResourcePath_get_resource_path>` **(** **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_resource_path<class_VisualScriptResourcePath_set_resource_path>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptResourcePath_get_resource_path:
|
||||
|
||||
- :ref:`String<class_string>` **get_resource_path** **(** **)**
|
||||
|
||||
.. _class_VisualScriptResourcePath_set_resource_path:
|
||||
|
||||
- void **set_resource_path** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
|
||||
50
classes/class_visualscriptreturn.rst
Normal file
50
classes/class_visualscriptreturn.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. 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_VisualScriptReturn:
|
||||
|
||||
VisualScriptReturn
|
||||
==================
|
||||
|
||||
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_return_type<class_VisualScriptReturn_get_return_type>` **(** **)** const |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_return_value_enabled<class_VisualScriptReturn_is_return_value_enabled>` **(** **)** const |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_enable_return_value<class_VisualScriptReturn_set_enable_return_value>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_return_type<class_VisualScriptReturn_set_return_type>` **(** :ref:`int<class_int>` type **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_VisualScriptReturn_get_return_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_return_type** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptReturn_is_return_value_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_return_value_enabled** **(** **)** const
|
||||
|
||||
.. _class_VisualScriptReturn_set_enable_return_value:
|
||||
|
||||
- void **set_enable_return_value** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_VisualScriptReturn_set_return_type:
|
||||
|
||||
- void **set_return_type** **(** :ref:`int<class_int>` type **)**
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user