From 495612a4be6c62703cc9fdff032297e50c3a4500 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sat, 19 Nov 2016 14:33:37 +0100 Subject: [PATCH] classref: Sync with current master XML --- classes/class_@visualscript.rst | 15 + classes/class_acceptdialog.rst | 6 + classes/class_area.rst | 4 +- classes/class_area2d.rst | 4 +- classes/class_astar.rst | 104 +++++ classes/class_audiostream.rst | 2 +- classes/class_audiostreamspeex.rst | 22 - classes/class_camera2d.rst | 158 +++++--- classes/class_canvasitem.rst | 6 +- classes/class_canvaslayer.rst | 74 ++-- classes/class_colorframe.rst | 38 ++ classes/class_control.rst | 2 +- classes/class_directory.rst | 2 +- classes/class_editorfilesystem.rst | 99 +++++ classes/class_editorfilesystemdirectory.rst | 98 +++++ classes/class_editorplugin.rst | 196 +++++---- classes/class_editorresourcepreview.rst | 76 ++++ .../class_editorresourcepreviewgenerator.rst | 63 +++ classes/class_editorselection.rst | 26 +- classes/class_funcref.rst | 18 +- classes/class_gdscript.rst | 4 +- classes/class_graphedit.rst | 39 ++ classes/class_graphnode.rst | 154 ++++--- classes/class_httprequest.rst | 62 ++- classes/class_immediategeometry.rst | 44 +- classes/class_input.rst | 72 +++- classes/class_inputmap.rst | 2 +- classes/class_ip.rst | 34 +- classes/class_itemlist.rst | 24 ++ classes/class_kinematicbody2d.rst | 92 +++-- classes/class_lineedit.rst | 16 +- classes/class_linkbutton.rst | 1 + classes/class_networkedmultiplayerenet.rst | 75 ++++ classes/class_networkedmultiplayerpeer.rst | 97 +++++ classes/class_node.rst | 379 +++++++++++------- classes/class_node2d.rst | 48 +++ classes/class_object.rst | 176 ++++---- classes/class_os.rst | 8 +- classes/class_packetpeer.rst | 2 +- classes/class_packetpeerudp.rst | 48 ++- classes/class_particles2d.rst | 4 +- classes/class_physics2dserver.rst | 354 ++++++++-------- classes/class_rawarray.rst | 58 +-- classes/class_raycast.rst | 55 ++- classes/class_raycast2d.rst | 124 ++++-- classes/class_reference.rst | 2 +- classes/class_regex.rst | 84 ++-- classes/class_regexmatch.rst | 90 +++++ classes/class_remotetransform.rst | 38 ++ classes/class_resource.rst | 2 +- classes/class_scenetree.rst | 161 +++++--- classes/class_scenetreetimer.rst | 43 ++ classes/class_script.rst | 2 +- classes/class_scrollcontainer.rst | 2 +- classes/class_spatial.rst | 2 +- classes/class_streampeer.rst | 2 +- classes/class_streampeerbuffer.rst | 74 ++++ classes/class_streampeertcp.rst | 30 +- classes/class_styleboxtexture.rst | 12 + classes/class_tcp_server.rst | 28 +- classes/class_textedit.rst | 1 + classes/class_tree.rst | 101 ++++- classes/class_tween.rst | 24 +- classes/class_undoredo.rst | 62 ++- classes/class_vector2.rst | 6 + classes/class_videoplayer.rst | 51 ++- classes/class_viewport.rst | 14 +- classes/class_visualinstance.rst | 26 +- classes/class_visualscript.rst | 283 +++++++++++++ .../class_visualscriptbasictypeconstant.rst | 50 +++ classes/class_visualscriptbuiltinfunc.rst | 38 ++ classes/class_visualscriptclassconstant.rst | 50 +++ classes/class_visualscriptcomment.rst | 62 +++ classes/class_visualscriptcondition.rst | 17 + classes/class_visualscriptconstant.rst | 50 +++ classes/class_visualscriptconstructor.rst | 50 +++ classes/class_visualscriptcustomnode.rst | 122 ++++++ classes/class_visualscriptdeconstruct.rst | 50 +++ classes/class_visualscriptemitsignal.rst | 38 ++ classes/class_visualscriptenginesingleton.rst | 38 ++ classes/class_visualscriptexpression.rst | 17 + classes/class_visualscriptfunction.rst | 17 + classes/class_visualscriptfunctioncall.rst | 154 +++++++ classes/class_visualscriptfunctionstate.rst | 44 ++ classes/class_visualscriptglobalconstant.rst | 38 ++ classes/class_visualscriptindexget.rst | 17 + classes/class_visualscriptindexset.rst | 17 + classes/class_visualscriptinputaction.rst | 50 +++ classes/class_visualscriptinputfilter.rst | 17 + classes/class_visualscriptiterator.rst | 17 + classes/class_visualscriptlocalvar.rst | 50 +++ classes/class_visualscriptlocalvarset.rst | 50 +++ classes/class_visualscriptmathconstant.rst | 38 ++ classes/class_visualscriptnode.rst | 51 +++ classes/class_visualscriptoperator.rst | 50 +++ classes/class_visualscriptpreload.rst | 38 ++ classes/class_visualscriptpropertyget.rst | 117 ++++++ classes/class_visualscriptpropertyset.rst | 117 ++++++ classes/class_visualscriptresourcepath.rst | 38 ++ classes/class_visualscriptreturn.rst | 50 +++ classes/class_visualscriptscenenode.rst | 38 ++ classes/class_visualscriptscenetree.rst | 17 + classes/class_visualscriptself.rst | 17 + classes/class_visualscriptsequence.rst | 38 ++ classes/class_visualscriptsubcall.rst | 32 ++ classes/class_visualscriptswitch.rst | 17 + classes/class_visualscripttypecast.rst | 50 +++ classes/class_visualscriptvariableget.rst | 38 ++ classes/class_visualscriptvariableset.rst | 38 ++ classes/class_visualscriptwhile.rst | 17 + classes/class_visualscriptyield.rst | 57 +++ classes/class_visualscriptyieldsignal.rst | 81 ++++ classes/class_visualserver.rst | 4 +- classes/class_xmlparser.rst | 55 ++- 114 files changed, 5089 insertions(+), 1087 deletions(-) create mode 100644 classes/class_@visualscript.rst create mode 100644 classes/class_astar.rst delete mode 100644 classes/class_audiostreamspeex.rst create mode 100644 classes/class_colorframe.rst create mode 100644 classes/class_editorfilesystem.rst create mode 100644 classes/class_editorfilesystemdirectory.rst create mode 100644 classes/class_editorresourcepreview.rst create mode 100644 classes/class_editorresourcepreviewgenerator.rst create mode 100644 classes/class_networkedmultiplayerenet.rst create mode 100644 classes/class_networkedmultiplayerpeer.rst create mode 100644 classes/class_regexmatch.rst create mode 100644 classes/class_remotetransform.rst create mode 100644 classes/class_scenetreetimer.rst create mode 100644 classes/class_streampeerbuffer.rst create mode 100644 classes/class_visualscript.rst create mode 100644 classes/class_visualscriptbasictypeconstant.rst create mode 100644 classes/class_visualscriptbuiltinfunc.rst create mode 100644 classes/class_visualscriptclassconstant.rst create mode 100644 classes/class_visualscriptcomment.rst create mode 100644 classes/class_visualscriptcondition.rst create mode 100644 classes/class_visualscriptconstant.rst create mode 100644 classes/class_visualscriptconstructor.rst create mode 100644 classes/class_visualscriptcustomnode.rst create mode 100644 classes/class_visualscriptdeconstruct.rst create mode 100644 classes/class_visualscriptemitsignal.rst create mode 100644 classes/class_visualscriptenginesingleton.rst create mode 100644 classes/class_visualscriptexpression.rst create mode 100644 classes/class_visualscriptfunction.rst create mode 100644 classes/class_visualscriptfunctioncall.rst create mode 100644 classes/class_visualscriptfunctionstate.rst create mode 100644 classes/class_visualscriptglobalconstant.rst create mode 100644 classes/class_visualscriptindexget.rst create mode 100644 classes/class_visualscriptindexset.rst create mode 100644 classes/class_visualscriptinputaction.rst create mode 100644 classes/class_visualscriptinputfilter.rst create mode 100644 classes/class_visualscriptiterator.rst create mode 100644 classes/class_visualscriptlocalvar.rst create mode 100644 classes/class_visualscriptlocalvarset.rst create mode 100644 classes/class_visualscriptmathconstant.rst create mode 100644 classes/class_visualscriptnode.rst create mode 100644 classes/class_visualscriptoperator.rst create mode 100644 classes/class_visualscriptpreload.rst create mode 100644 classes/class_visualscriptpropertyget.rst create mode 100644 classes/class_visualscriptpropertyset.rst create mode 100644 classes/class_visualscriptresourcepath.rst create mode 100644 classes/class_visualscriptreturn.rst create mode 100644 classes/class_visualscriptscenenode.rst create mode 100644 classes/class_visualscriptscenetree.rst create mode 100644 classes/class_visualscriptself.rst create mode 100644 classes/class_visualscriptsequence.rst create mode 100644 classes/class_visualscriptsubcall.rst create mode 100644 classes/class_visualscriptswitch.rst create mode 100644 classes/class_visualscripttypecast.rst create mode 100644 classes/class_visualscriptvariableget.rst create mode 100644 classes/class_visualscriptvariableset.rst create mode 100644 classes/class_visualscriptwhile.rst create mode 100644 classes/class_visualscriptyield.rst create mode 100644 classes/class_visualscriptyieldsignal.rst diff --git a/classes/class_@visualscript.rst b/classes/class_@visualscript.rst new file mode 100644 index 000000000..f16093002 --- /dev/null +++ b/classes/class_@visualscript.rst @@ -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 +----------------- + + + diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 51ce9564b..78d69ed43 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -35,6 +35,8 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`LineEdit` | :ref:`register_text_enter` **(** :ref:`Object` line_edit **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_child_rect` **(** :ref:`Control` child **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hide_on_ok` **(** :ref:`bool` enabled **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_text` **(** :ref:`String` text **)** | @@ -98,6 +100,10 @@ Return the built-in label text. Register a :ref:`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` child **)** + .. _class_AcceptDialog_set_hide_on_ok: - void **set_hide_on_ok** **(** :ref:`bool` enabled **)** diff --git a/classes/class_area.rst b/classes/class_area.rst index e6756606f..2a2b7b895 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -88,9 +88,9 @@ Signals ------- - **area_enter** **(** :ref:`Object` area **)** -- **area_enter_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` area_shape **)** +- **area_enter_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** - **area_exit** **(** :ref:`Object` area **)** -- **area_exit_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` area_shape **)** +- **area_exit_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** - **body_enter** **(** :ref:`Object` body **)** - **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** - **body_exit** **(** :ref:`Object` body **)** diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 7c63bc62c..f99aaff05 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -88,9 +88,9 @@ Signals ------- - **area_enter** **(** :ref:`Object` area **)** -- **area_enter_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` area_shape **)** +- **area_enter_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** - **area_exit** **(** :ref:`Object` area **)** -- **area_exit_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` area_shape **)** +- **area_exit_shape** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** - **body_enter** **(** :ref:`Object` body **)** - **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** - **body_exit** **(** :ref:`Object` body **)** diff --git a/classes/class_astar.rst b/classes/class_astar.rst new file mode 100644 index 000000000..8729c138a --- /dev/null +++ b/classes/class_astar.rst @@ -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` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_pos **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_pos_in_segment` **(** :ref:`Vector3` to_pos **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`IntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` id **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_AStar_add_point: + +- void **add_point** **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** + +.. _class_AStar_are_points_connected: + +- :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** const + +.. _class_AStar_clear: + +- void **clear** **(** **)** + +.. _class_AStar_connect_points: + +- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id **)** + +.. _class_AStar_disconnect_points: + +- void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id **)** + +.. _class_AStar_get_available_point_id: + +- :ref:`int` **get_available_point_id** **(** **)** const + +.. _class_AStar_get_closest_point: + +- :ref:`int` **get_closest_point** **(** :ref:`Vector3` to_pos **)** const + +.. _class_AStar_get_closest_pos_in_segment: + +- :ref:`Vector3` **get_closest_pos_in_segment** **(** :ref:`Vector3` to_pos **)** const + +.. _class_AStar_get_id_path: + +- :ref:`IntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** + +.. _class_AStar_get_point_path: + +- :ref:`Vector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** + +.. _class_AStar_get_point_pos: + +- :ref:`Vector3` **get_point_pos** **(** :ref:`int` id **)** const + +.. _class_AStar_get_point_weight_scale: + +- :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** const + +.. _class_AStar_remove_point: + +- void **remove_point** **(** :ref:`int` id **)** + + diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index a3b31ccc6..7118cf108 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -8,7 +8,7 @@ AudioStream **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioStreamSpeex`, :ref:`AudioStreamMPC`, :ref:`AudioStreamOGGVorbis`, :ref:`AudioStreamOpus` +**Inherited By:** :ref:`AudioStreamMPC`, :ref:`AudioStreamOGGVorbis`, :ref:`AudioStreamOpus` **Category:** Core diff --git a/classes/class_audiostreamspeex.rst b/classes/class_audiostreamspeex.rst deleted file mode 100644 index bbff4c53b..000000000 --- a/classes/class_audiostreamspeex.rst +++ /dev/null @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`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. - diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 4c4f31c80..b738621a4 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -18,71 +18,79 @@ Camera node for 2D scenes. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`align` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_current` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_update_scroll` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_anchor_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_pos` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_drag_margin` **(** :ref:`int` margin **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_follow_smoothing` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_h_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_limit` **(** :ref:`int` margin **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_v_offset` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_zoom` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_current` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_follow_smoothing_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_h_drag_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_rotating` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_v_drag_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_current` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset_smoothing` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_mode` **(** :ref:`int` anchor_mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_margin` **(** :ref:`int` margin, :ref:`float` drag_margin **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_follow_smoothing` **(** :ref:`bool` follow_smoothing **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_follow_smoothing` **(** :ref:`float` follow_smoothing **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_drag_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit` **(** :ref:`int` margin, :ref:`int` limit **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotating` **(** :ref:`bool` rotating **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_drag_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_zoom` **(** :ref:`Vector2` zoom **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`align` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_current` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_update_scroll` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_anchor_mode` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_pos` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_custom_viewport` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_drag_margin` **(** :ref:`int` margin **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_follow_smoothing` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_h_offset` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_limit` **(** :ref:`int` margin **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_v_offset` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_zoom` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_current` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_follow_smoothing_enabled` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_h_drag_enabled` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_limit_smoothing_enabled` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_rotating` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_v_drag_enabled` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_current` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset_smoothing` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor_mode` **(** :ref:`int` anchor_mode **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_viewport` **(** :ref:`Viewport` viewport **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_margin` **(** :ref:`int` margin, :ref:`float` drag_margin **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_follow_smoothing` **(** :ref:`bool` follow_smoothing **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_follow_smoothing` **(** :ref:`float` follow_smoothing **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_drag_enabled` **(** :ref:`bool` enabled **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit` **(** :ref:`int` margin, :ref:`int` limit **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit_smoothing_enabled` **(** :ref:`bool` limit_smoothing_enabled **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotating` **(** :ref:`bool` rotating **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_drag_enabled` **(** :ref:`bool` enabled **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_zoom` **(** :ref:`Vector2` zoom **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -130,6 +138,10 @@ Return the camera position. - :ref:`Vector2` **get_camera_screen_center** **(** **)** const +.. _class_Camera2D_get_custom_viewport: + +- :ref:`Viewport` **get_custom_viewport** **(** **)** const + .. _class_Camera2D_get_drag_margin: - :ref:`float` **get_drag_margin** **(** :ref:`int` margin **)** const @@ -178,6 +190,10 @@ Return true of this is the current camera (see :ref:`make_current` **is_h_drag_enabled** **(** **)** const +.. _class_Camera2D_is_limit_smoothing_enabled: + +- :ref:`bool` **is_limit_smoothing_enabled** **(** **)** const + .. _class_Camera2D_is_rotating: - :ref:`bool` **is_rotating** **(** **)** const @@ -204,6 +220,10 @@ This has no effect if smoothing is disabled. - void **set_anchor_mode** **(** :ref:`int` anchor_mode **)** +.. _class_Camera2D_set_custom_viewport: + +- void **set_custom_viewport** **(** :ref:`Viewport` viewport **)** + .. _class_Camera2D_set_drag_margin: - void **set_drag_margin** **(** :ref:`int` margin, :ref:`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` 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` offset **)** diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 26d151c40..c451df78a 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -29,7 +29,7 @@ Member Functions +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_colored_polygon` **(** :ref:`Vector2Array` points, :ref:`Color` color, :ref:`Vector2Array` uvs=Vector2Array([]), :ref:`Texture` texture=NULL **)** | +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1 **)** | +| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1, :ref:`bool` antialiased=false **)** | +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_polygon` **(** :ref:`Vector2Array` points, :ref:`ColorArray` colors, :ref:`Vector2Array` uvs=Vector2Array([]), :ref:`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` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1 **)** +- void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1, :ref:`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: diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index ce5ef1df4..383889da2 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -20,35 +20,37 @@ Canvas Item layer. Member Functions ---------------- -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotationd` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`get_transform` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_viewport` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer` **(** :ref:`int` layer **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotationd` **(** :ref:`float` degrees **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Matrix32` transform **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_custom_viewport` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotationd` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Matrix32` | :ref:`get_transform` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_viewport` **(** :ref:`Viewport` viewport **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer` **(** :ref:`int` layer **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotationd` **(** :ref:`float` degrees **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Matrix32` transform **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -58,6 +60,10 @@ Canvas Item layer. :ref:`CanvasItem` nodes that are direct or Member Function Description --------------------------- +.. _class_CanvasLayer_get_custom_viewport: + +- :ref:`Viewport` **get_custom_viewport** **(** **)** const + .. _class_CanvasLayer_get_layer: - :ref:`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` **get_viewport** **(** **)** const - -Return the viewport RID for this layer. - .. _class_CanvasLayer_get_world_2d: - :ref:`World2D` **get_world_2d** **(** **)** const Return the :ref:`World2D` used by this layer. +.. _class_CanvasLayer_set_custom_viewport: + +- void **set_custom_viewport** **(** :ref:`Viewport` viewport **)** + .. _class_CanvasLayer_set_layer: - void **set_layer** **(** :ref:`int` layer **)** diff --git a/classes/class_colorframe.rst b/classes/class_colorframe.rst new file mode 100644 index 000000000..4b230b969 --- /dev/null +++ b/classes/class_colorframe.rst @@ -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` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_frame_color` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame_color` **(** :ref:`Color` color **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_ColorFrame_get_frame_color: + +- :ref:`Color` **get_frame_color** **(** **)** const + +.. _class_ColorFrame_set_frame_color: + +- void **set_frame_color** **(** :ref:`Color` color **)** + + diff --git a/classes/class_control.rst b/classes/class_control.rst index 1b4e0a2d1..46e098363 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -8,7 +8,7 @@ Control **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Label`, :ref:`Tabs`, :ref:`TextureFrame`, :ref:`ButtonArray`, :ref:`VideoPlayer`, :ref:`LineEdit`, :ref:`Container`, :ref:`ReferenceFrame`, :ref:`Patch9Frame`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`GraphEdit`, :ref:`ItemList` +**Inherited By:** :ref:`Label`, :ref:`Tabs`, :ref:`TextureFrame`, :ref:`ButtonArray`, :ref:`VideoPlayer`, :ref:`LineEdit`, :ref:`ColorFrame`, :ref:`Container`, :ref:`ReferenceFrame`, :ref:`Patch9Frame`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`GraphEdit`, :ref:`ItemList` **Category:** Core diff --git a/classes/class_directory.rst b/classes/class_directory.rst index 9a362fb93..8a1b31686 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -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` function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with :ref:`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: diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst new file mode 100644 index 000000000..0781a62b8 --- /dev/null +++ b/classes/class_editorfilesystem.rst @@ -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` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +Resource filesystem, as the editor sees it. + +Member Functions +---------------- + ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_type` **(** :ref:`String` path **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem` **(** **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_path` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_scanning_progress` **(** **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scanning` **(** **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scan` **(** **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scan_sources` **(** **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_file` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **filesystem_changed** **(** **)** +- **sources_changed** **(** :ref:`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` **get_file_type** **(** :ref:`String` path **)** const + +Get the type of the file, given the full path. + +.. _class_EditorFileSystem_get_filesystem: + +- :ref:`EditorFileSystemDirectory` **get_filesystem** **(** **)** + +Get the root directory object. + +.. _class_EditorFileSystem_get_path: + +- :ref:`EditorFileSystemDirectory` **get_path** **(** :ref:`String` path **)** + +.. _class_EditorFileSystem_get_scanning_progress: + +- :ref:`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` **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` path **)** + +Update a file information. Call this if an external program (not Godot) modified the file. + + diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst new file mode 100644 index 000000000..e1907e160 --- /dev/null +++ b/classes/class_editorfilesystemdirectory.rst @@ -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` + +**Category:** Core + +Brief Description +----------------- + +A diretory for the resource filesystem. + +Member Functions +---------------- + ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_file_count` **(** **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path` **(** **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_subdir` **(** :ref:`int` idx **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdir_count` **(** **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_missing_sources` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_EditorFileSystemDirectory_find_dir_index: + +- :ref:`int` **find_dir_index** **(** :ref:`String` name **)** const + +.. _class_EditorFileSystemDirectory_find_file_index: + +- :ref:`int` **find_file_index** **(** :ref:`String` name **)** const + +.. _class_EditorFileSystemDirectory_get_file: + +- :ref:`String` **get_file** **(** :ref:`int` idx **)** const + +.. _class_EditorFileSystemDirectory_get_file_count: + +- :ref:`int` **get_file_count** **(** **)** const + +.. _class_EditorFileSystemDirectory_get_file_path: + +- :ref:`String` **get_file_path** **(** :ref:`int` idx **)** const + +.. _class_EditorFileSystemDirectory_get_file_type: + +- :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const + +.. _class_EditorFileSystemDirectory_get_name: + +- :ref:`String` **get_name** **(** **)** + +.. _class_EditorFileSystemDirectory_get_parent: + +- :ref:`EditorFileSystemDirectory` **get_parent** **(** **)** + +.. _class_EditorFileSystemDirectory_get_path: + +- :ref:`String` **get_path** **(** **)** const + +.. _class_EditorFileSystemDirectory_get_subdir: + +- :ref:`Object` **get_subdir** **(** :ref:`int` idx **)** + +.. _class_EditorFileSystemDirectory_get_subdir_count: + +- :ref:`int` **get_subdir_count** **(** **)** const + +.. _class_EditorFileSystemDirectory_is_missing_sources: + +- :ref:`bool` **is_missing_sources** **(** :ref:`int` idx **)** const + + diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 177a4b978..0a39c32a2 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -18,71 +18,87 @@ Used by the editor to extend it's functionality. Member Functions ---------------- -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ToolButton` | :ref:`add_control_to_bottom_panel` **(** :ref:`Control` control, :ref:`String` title **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_control_to_container` **(** :ref:`int` container, :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_control_to_dock` **(** :ref:`int` slot, :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` plugin **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_changes` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSpatialGizmo` | :ref:`create_spatial_gizmo` **(** :ref:`Spatial` for_spatial **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit` **(** :ref:`Object` object **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_input_event` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_spatial_input_event` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_base_control` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_breakpoints` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_main_screen` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_visible` **(** :ref:`bool` visible **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_save_layout` **(** **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` plugin **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`save_external_data` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ToolButton` | :ref:`add_control_to_bottom_panel` **(** :ref:`Control` control, :ref:`String` title **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_control_to_container` **(** :ref:`int` container, :ref:`Control` control **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_control_to_dock` **(** :ref:`int` slot, :ref:`Control` control **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` plugin **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_changes` **(** **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSpatialGizmo` | :ref:`create_spatial_gizmo` **(** :ref:`Spatial` for_spatial **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit` **(** :ref:`Object` object **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`forward_canvas_input_event` **(** :ref:`Matrix32` canvas_xform, :ref:`InputEvent` event **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`forward_draw_over_canvas` **(** :ref:`Matrix32` canvas_xform, :ref:`Control` canvas **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`forward_spatial_input_event` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_base_control` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringArray` | :ref:`get_breakpoints` **(** **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_main_screen` **(** **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide_bottom_panel` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property="" **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_bottom_panel_item_visible` **(** :ref:`Control` item **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_visible` **(** :ref:`bool` visible **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_save_layout` **(** **)** const | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` plugin **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`save_external_data` **(** **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`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` **forward_input_event** **(** :ref:`InputEvent` event **)** virtual +- :ref:`bool` **forward_canvas_input_event** **(** :ref:`Matrix32` canvas_xform, :ref:`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` canvas_xform, :ref:`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_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` **get_editor_viewport** **(** **)** + +Get the main editor control. Use this as a parent for main screens. + .. _class_EditorPlugin_get_name: - :ref:`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` **get_resource_filesystem** **(** **)** + +Get the filesystem cache for all resources in the project. + +.. _class_EditorPlugin_get_resource_previewer: + +- :ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** + +Get tool for generating resource previews. + .. _class_EditorPlugin_get_selection: - :ref:`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` object, :ref:`String` for_property="" **)** + +Inspect an object in the inspector. + +.. _class_EditorPlugin_make_bottom_panel_item_visible: + +- void **make_bottom_panel_item_visible** **(** :ref:`Control` item **)** + .. _class_EditorPlugin_make_visible: - void **make_visible** **(** :ref:`bool` visible **)** virtual @@ -330,4 +382,10 @@ Restore the state saved by :ref:`EditorPlugin.get_state`. +.. _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`. + diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst new file mode 100644 index 000000000..26e89ad3c --- /dev/null +++ b/classes/class_editorresourcepreview.rst @@ -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` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +Helper to generate previews of reources or files. + +Member Functions +---------------- + ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`check_for_invalidation` **(** :ref:`String` path **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_edited_resource_preview` **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_resource_preview` **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **preview_invalidated** **(** :ref:`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` generator **)** + +Create an own, custom preview generator. + +.. _class_EditorResourcePreview_check_for_invalidation: + +- void **check_for_invalidation** **(** :ref:`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` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`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` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`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` generator **)** + +Remove a custom preview generator. + + diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst new file mode 100644 index 000000000..93449c7cd --- /dev/null +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -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` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +Custom generator of previews. + +Member Functions +---------------- + ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`generate` **(** :ref:`Resource` from **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`generate_from_path` **(** :ref:`String` path **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles` **(** :ref:`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` **generate** **(** :ref:`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` **generate_from_path** **(** :ref:`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` **handles** **(** :ref:`String` type **)** virtual + +Return if your generator supports this resource type. + + diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index ea177c393..07f7e6c7e 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -18,15 +18,17 @@ Manages the SceneTree selection in the editor. Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`Node` node **)** | -+----------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_selected_nodes` **(** **)** | -+----------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`Node` node **)** | -+----------------------------+--------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`Node` node **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_selected_nodes` **(** **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_transformable_selected_nodes` **(** **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`Node` node **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -59,6 +61,12 @@ Clear the selection. Get the list of selectes nodes. +.. _class_EditorSelection_get_transformable_selected_nodes: + +- :ref:`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` node **)** diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index e6ac3303f..08a6d4534 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -18,13 +18,13 @@ Reference to a function in an object. Member Functions ---------------- -+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_func` **(** :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL, :ref:`Variant` arg6=NULL, :ref:`Variant` arg7=NULL, :ref:`Variant` arg8=NULL, :ref:`Variant` arg9=NULL **)** | -+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function` **(** :ref:`String` name **)** | -+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance` **(** :ref:`Object` instance **)** | -+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_func` **(** **)** vararg | ++--------------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_function` **(** :ref:`String` name **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance` **(** :ref:`Object` instance **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------+ Description ----------- @@ -38,9 +38,7 @@ Member Function Description .. _class_FuncRef_call_func: -- void **call_func** **(** :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL, :ref:`Variant` arg6=NULL, :ref:`Variant` arg7=NULL, :ref:`Variant` arg8=NULL, :ref:`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` **call_func** **(** **)** vararg .. _class_FuncRef_set_function: diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 4f140dec4..8c1b45a9c 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -21,7 +21,7 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------+ | :ref:`RawArray` | :ref:`get_as_byte_code` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------+ -| void | :ref:`new` **(** **)** | +| :ref:`Object` | :ref:`new` **(** **)** vararg | +----------------------------------+-----------------------------------------------------------------------------+ Member Function Description @@ -33,6 +33,6 @@ Member Function Description .. _class_GDScript_new: -- void **new** **(** **)** +- :ref:`Object` **new** **(** **)** vararg diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 00cf4b993..54d2c89c9 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -27,14 +27,26 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_scroll_ofs` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_snap` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_zoom` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_node_connected` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_right_disconnects_enabled` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_snap` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_right_disconnects` **(** :ref:`bool` enable **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scroll_ofs` **(** :ref:`Vector2` ofs **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selected` **(** :ref:`Object` node **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_snap` **(** :ref:`int` pixels **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_snap` **(** :ref:`bool` enable **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_zoom` **(** :ref:`float` p_zoom **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -44,10 +56,13 @@ Signals - **_begin_node_move** **(** **)** - **_end_node_move** **(** **)** - **connection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** +- **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_pos **)** - **delete_nodes_request** **(** **)** - **disconnection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** - **duplicate_nodes_request** **(** **)** +- **node_selected** **(** :ref:`Object` node **)** - **popup_request** **(** :ref:`Vector2` p_position **)** +- **scroll_offset_changed** **(** :ref:`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` **get_snap** **(** **)** const + .. _class_GraphEdit_get_zoom: - :ref:`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` **is_using_snap** **(** **)** const + .. _class_GraphEdit_set_right_disconnects: - void **set_right_disconnects** **(** :ref:`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` ofs **)** + +.. _class_GraphEdit_set_selected: + +- void **set_selected** **(** :ref:`Object` node **)** + +.. _class_GraphEdit_set_snap: + +- void **set_snap** **(** :ref:`int` pixels **)** + +.. _class_GraphEdit_set_use_snap: + +- void **set_use_snap** **(** :ref:`bool` enable **)** + .. _class_GraphEdit_set_zoom: - void **set_zoom** **(** :ref:`float` p_zoom **)** diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index d3155ec83..32985db8f 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -18,53 +18,69 @@ A GraphNode is a container with several input and output slots allowing connecti Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all_slots` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_slot` **(** :ref:`int` idx **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_input_count` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_input_pos` **(** :ref:`int` idx **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_output_count` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_output_pos` **(** :ref:`int` idx **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_title` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_close_button_visible` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_close_button` **(** :ref:`bool` show **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_title` **(** :ref:`String` title **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all_slots` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_slot` **(** :ref:`int` idx **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_input_count` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_connection_input_pos` **(** :ref:`int` idx **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_output_count` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_connection_output_pos` **(** :ref:`int` idx **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_modulate` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_overlay` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_title` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_close_button_visible` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_comment` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_resizeable` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_comment` **(** :ref:`bool` comment **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_modulate` **(** :ref:`Color` color **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_overlay` **(** :ref:`int` overlay **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_resizeable` **(** :ref:`bool` resizeable **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_show_close_button` **(** :ref:`bool` show **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Object` custom_left=NULL, :ref:`Object` custom_right=NULL **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_title` **(** :ref:`String` title **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -73,6 +89,14 @@ Signals - **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** - **offset_changed** **(** **)** - **raise_request** **(** **)** +- **resize_request** **(** :ref:`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` **get_modulate** **(** **)** const + .. _class_GraphNode_get_offset: - :ref:`Vector2` **get_offset** **(** **)** const Return the offset of the GraphNode. +.. _class_GraphNode_get_overlay: + +- :ref:`int` **get_overlay** **(** **)** const + .. _class_GraphNode_get_slot_color_left: - :ref:`Color` **get_slot_color_left** **(** :ref:`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` **is_comment** **(** **)** const + +.. _class_GraphNode_is_resizeable: + +- :ref:`bool` **is_resizeable** **(** **)** const + .. _class_GraphNode_is_slot_enabled_left: - :ref:`bool` **is_slot_enabled_left** **(** :ref:`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` comment **)** + +.. _class_GraphNode_set_modulate: + +- void **set_modulate** **(** :ref:`Color` color **)** + .. _class_GraphNode_set_offset: - void **set_offset** **(** :ref:`Vector2` offset **)** Set the offset of the GraphNode. +.. _class_GraphNode_set_overlay: + +- void **set_overlay** **(** :ref:`int` overlay **)** + +.. _class_GraphNode_set_resizeable: + +- void **set_resizeable** **(** :ref:`bool` resizeable **)** + .. _class_GraphNode_set_show_close_button: - void **set_show_close_button** **(** :ref:`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` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`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` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Object` custom_left=NULL, :ref:`Object` custom_right=NULL **)** .. _class_GraphNode_set_title: diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index c9e41c8a0..8d1464a1a 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -18,33 +18,33 @@ A Node with the ability to send HTTP requests. Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cancel_request` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_download_file` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_http_client_status` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_redirects` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_threads` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`StringArray` custom_headers=StringArray([]), :ref:`bool` ssl_validate_domain=true **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_download_file` **(** :ref:`String` path **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cancel_request` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_download_file` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_http_client_status` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_redirects` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_threads` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`StringArray` custom_headers=StringArray([]), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_download_file` **(** :ref:`String` path **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -127,13 +127,7 @@ Whether this request is using threads. .. _class_HTTPRequest_request: -- :ref:`int` **request** **(** :ref:`String` url, :ref:`StringArray` custom_headers=StringArray([]), :ref:`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` **request** **(** :ref:`String` url, :ref:`StringArray` custom_headers=StringArray([]), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** .. _class_HTTPRequest_set_body_size_limit: diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index 6feeba05e..5f5c7f414 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -18,34 +18,34 @@ Node to draw simple geometry from code, ala OpenGL 1.x Member Functions ---------------- -+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` pos **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`int` primitive, :ref:`Texture` texture=NULL **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`end` **(** **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal` **(** :ref:`Vector3` normal **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tangent` **(** :ref:`Plane` tangent **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv` **(** :ref:`Vector2` uv **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2` **(** :ref:`Vector2` uv **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_vertex` **(** :ref:`Vector3` pos **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`begin` **(** :ref:`int` primitive, :ref:`Texture` texture=NULL **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`end` **(** **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal` **(** :ref:`Vector3` normal **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tangent` **(** :ref:`Plane` tangent **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv` **(** :ref:`Vector2` uv **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv2` **(** :ref:`Vector2` uv **)** | ++-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_ImmediateGeometry_add_sphere: -- void **add_sphere** **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius **)** +- void **add_sphere** **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** Simple helper to draw an uvsphere, with given latitudes, longitude and radius. diff --git a/classes/class_input.rst b/classes/class_input.rst index 2c9b5c5ad..e6f33e345 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -27,13 +27,21 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** | +| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_connected_joysticks` **(** **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** | +| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** | +| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -43,7 +51,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** | +| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -51,15 +59,19 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_mouse_speed` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | +| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** | +| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** | +| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** | +| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_joy_mapping` **(** :ref:`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` **get_accelerometer** **(** **)** +- :ref:`Vector3` **get_accelerometer** **(** **)** const If the device has an accelerometer, this will return the movement. @@ -126,16 +138,32 @@ Returns an :ref:`Array` containing the device IDs of all currently .. _class_Input_get_gyroscope: -- :ref:`Vector3` **get_gyroscope** **(** **)** +- :ref:`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` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** +- :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** const Returns the current value of the joystick axis at given index (see JOY\_\* constants in :ref:`@Global Scope`) +.. _class_Input_get_joy_axis_index_from_string: + +- :ref:`int` **get_joy_axis_index_from_string** **(** :ref:`String` axis **)** + +.. _class_Input_get_joy_axis_string: + +- :ref:`String` **get_joy_axis_string** **(** :ref:`int` axis_index **)** + +.. _class_Input_get_joy_button_index_from_string: + +- :ref:`int` **get_joy_button_index_from_string** **(** :ref:`String` button **)** + +.. _class_Input_get_joy_button_string: + +- :ref:`String` **get_joy_button_string** **(** :ref:`int` button_index **)** + .. _class_Input_get_joy_guid: - :ref:`String` **get_joy_guid** **(** :ref:`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` **get_magnetometer** **(** **)** +- :ref:`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` **is_action_just_pressed** **(** :ref:`String` action **)** const + +.. _class_Input_is_action_just_released: + +- :ref:`bool` **is_action_just_released** **(** :ref:`String` action **)** const + .. _class_Input_is_action_pressed: -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** +- :ref:`bool` **is_action_pressed** **(** :ref:`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_Input_is_joy_button_pressed: -- :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** +- :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** const Returns if the joystick button at the given index is currently pressed. (see JOY\_\* constants in :ref:`@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` **is_key_pressed** **(** :ref:`int` scancode **)** +- :ref:`bool` **is_key_pressed** **(** :ref:`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_Input_is_mouse_button_pressed: -- :ref:`bool` **is_mouse_button_pressed** **(** :ref:`int` button **)** +- :ref:`bool` **is_mouse_button_pressed** **(** :ref:`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`. @@ -236,7 +272,9 @@ Set the mouse mode. See the constants for more information. - void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`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: diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 7af1a4bc0..d9e37886a 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -86,7 +86,7 @@ Remove an action from the :ref:`InputMap`. - :ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`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` is not pressed (for proper release detection). See :ref:`action_has_event` if you don't want this behavior. .. _class_InputMap_get_action_from_id: diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 02e73ea0b..88bbe76a8 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -20,19 +20,19 @@ IP Protocol support functions. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`int` ip_type=int.IP_TYPE_ANY **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`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` **resolve_hostname** **(** :ref:`String` host **)** +- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`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` **resolve_hostname_queue_item** **(** :ref:`String` host **)** +- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`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. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 667ea3f2c..49455aaba 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -61,10 +61,14 @@ Member Functions +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`IntArray` | :ref:`get_selected_items` **(** **)** | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_v_scroll` **(** **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_selectable` **(** :ref:`int` idx **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :ref:`int` idx **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`is_same_column_width` **(** **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** const | @@ -99,6 +103,8 @@ Member Functions +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_max_columns` **(** :ref:`int` amount **)** | +----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_max_text_lines` **(** :ref:`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` **get_v_scroll** **(** **)** + +Returns the current vertical scroll bar for the List. + .. _class_ItemList_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`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` **is_item_tooltip_enabled** **(** :ref:`int` idx **)** const + +Returns whether the tooptip is enabled for specified item index. + .. _class_ItemList_is_same_column_width: - :ref:`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` idx, :ref:`bool` enable **)** + +Sets whether the tooltip is enabled for specified item index. + .. _class_ItemList_set_max_columns: - void **set_max_columns** **(** :ref:`int` amount **)** diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 1eead77f7..28bf0b06e 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -18,35 +18,45 @@ Kinematic body 2D node. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_margin` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_pos` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_travel` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_to` **(** :ref:`Vector2` position **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`revert_motion` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_margin` **(** :ref:`float` pixels **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Vector2` rel_vec **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_margin` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_pos` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_move_and_slide_colliders` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_travel` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_colliding` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_move_and_slide_on_ceiling` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_move_and_slide_on_floor` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_move_and_slide_on_wall` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2(0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4 **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_to` **(** :ref:`Vector2` position **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`revert_motion` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_margin` **(** :ref:`float` pixels **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Matrix32` from, :ref:`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_get_move_and_slide_colliders: + +- :ref:`Array` **get_move_and_slide_colliders** **(** **)** const + .. _class_KinematicBody2D_get_travel: - :ref:`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` **is_move_and_slide_on_ceiling** **(** **)** const + +.. _class_KinematicBody2D_is_move_and_slide_on_floor: + +- :ref:`bool` **is_move_and_slide_on_floor** **(** **)** const + +.. _class_KinematicBody2D_is_move_and_slide_on_wall: + +- :ref:`bool` **is_move_and_slide_on_wall** **(** **)** const + .. _class_KinematicBody2D_move: - :ref:`Vector2` **move** **(** :ref:`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` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2(0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4 **)** + .. _class_KinematicBody2D_move_to: - :ref:`Vector2` **move_to** **(** :ref:`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` **test_move** **(** :ref:`Vector2` rel_vec **)** +- :ref:`bool` **test_move** **(** :ref:`Matrix32` from, :ref:`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. diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 1efb9029f..be91ab12f 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -27,7 +27,7 @@ Member Functions +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enable **)** | +| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enabled **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ @@ -35,6 +35,8 @@ Member Functions +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cursor_pos` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_expand_to_text_length` **(** **)** const | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_max_length` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | @@ -61,6 +63,8 @@ Member Functions +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_editable` **(** :ref:`bool` enabled **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_to_text_length` **(** :ref:`bool` enabled **)** | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_max_length` **(** :ref:`int` chars **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_placeholder` **(** :ref:`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` enable **)** +- void **cursor_set_blink_enabled** **(** :ref:`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_get_expand_to_text_length: + +- :ref:`bool` **get_expand_to_text_length** **(** **)** const + .. _class_LineEdit_get_max_length: - :ref:`int` **get_max_length** **(** **)** const @@ -213,6 +221,10 @@ Set the cursor position inside the :ref:`LineEdit`, causing it t Set the *editable* status of the :ref:`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` enabled **)** + .. _class_LineEdit_set_max_length: - void **set_max_length** **(** :ref:`int` chars **)** diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index 62ada58f2..34caf5fe6 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -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 ----------- diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst new file mode 100644 index 000000000..b6725019f --- /dev/null +++ b/classes/class_networkedmultiplayerenet.rst @@ -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` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +PacketPeer implementation using the ENet library. + +Member Functions +---------------- + ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close_connection` **(** **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_client` **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_compression_mode` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_compression_mode` **(** :ref:`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`. Socket events can be handled by connecting to :ref:`SceneTree` signals. + +Member Function Description +--------------------------- + +.. _class_NetworkedMultiplayerENet_close_connection: + +- void **close_connection** **(** **)** + +.. _class_NetworkedMultiplayerENet_create_client: + +- :ref:`int` **create_client** **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** + +.. _class_NetworkedMultiplayerENet_create_server: + +- :ref:`int` **create_server** **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** + +.. _class_NetworkedMultiplayerENet_get_compression_mode: + +- :ref:`int` **get_compression_mode** **(** **)** const + +.. _class_NetworkedMultiplayerENet_set_bind_ip: + +- void **set_bind_ip** **(** :ref:`String` ip **)** + +.. _class_NetworkedMultiplayerENet_set_compression_mode: + +- void **set_compression_mode** **(** :ref:`int` mode **)** + + diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst new file mode 100644 index 000000000..4184248c6 --- /dev/null +++ b/classes/class_networkedmultiplayerpeer.rst @@ -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` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`NetworkedMultiplayerENet` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_status` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_peer` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unique_id` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_refusing_new_connections` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`poll` **(** **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_refuse_new_connections` **(** :ref:`bool` enable **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_target_peer` **(** :ref:`int` id **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transfer_mode` **(** :ref:`int` mode **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **connection_failed** **(** **)** +- **connection_succeeded** **(** **)** +- **peer_connected** **(** :ref:`int` id **)** +- **peer_disconnected** **(** :ref:`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` **get_connection_status** **(** **)** const + +.. _class_NetworkedMultiplayerPeer_get_packet_peer: + +- :ref:`int` **get_packet_peer** **(** **)** const + +.. _class_NetworkedMultiplayerPeer_get_unique_id: + +- :ref:`int` **get_unique_id** **(** **)** const + +.. _class_NetworkedMultiplayerPeer_is_refusing_new_connections: + +- :ref:`bool` **is_refusing_new_connections** **(** **)** const + +.. _class_NetworkedMultiplayerPeer_poll: + +- void **poll** **(** **)** + +.. _class_NetworkedMultiplayerPeer_set_refuse_new_connections: + +- void **set_refuse_new_connections** **(** :ref:`bool` enable **)** + +.. _class_NetworkedMultiplayerPeer_set_target_peer: + +- void **set_target_peer** **(** :ref:`int` id **)** + +.. _class_NetworkedMultiplayerPeer_set_transfer_mode: + +- void **set_transfer_mode** **(** :ref:`int` mode **)** + + diff --git a/classes/class_node.rst b/classes/class_node.rst index 5bc366864..053935fe4 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -8,7 +8,7 @@ Node **Inherits:** :ref:`Object` -**Inherited By:** :ref:`Viewport`, :ref:`Timer`, :ref:`CanvasLayer`, :ref:`EventPlayer`, :ref:`SoundRoomParams`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`SamplePlayer`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`StreamPlayer`, :ref:`CanvasItem`, :ref:`Tween` +**Inherited By:** :ref:`Viewport`, :ref:`Timer`, :ref:`CanvasLayer`, :ref:`EventPlayer`, :ref:`SoundRoomParams`, :ref:`Tween`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorFileSystem`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`SamplePlayer`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`StreamPlayer`, :ref:`EditorResourcePreview`, :ref:`CanvasItem` **Category:** Core @@ -20,139 +20,165 @@ Base class for all the *scene* elements. Member Functions ---------------- -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_enter_tree` **(** **)** virtual | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_exit_tree` **(** **)** virtual | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_fixed_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_ready` **(** **)** virtual | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_key_input` **(** :ref:`InputEvent` key_event **)** virtual | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_process` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`duplicate` **(** :ref:`bool` use_instancing=false **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_child_count` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_children` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_filename` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fixed_process_delta_time` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_groups` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_owner` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_parent` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pause_mode` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_viewport` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fixed_processing` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_pos **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_stray_nodes` **(** **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_tree` **(** **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_free` **(** **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`raise` **(** **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_and_skip` **(** **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Node` node **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filename` **(** :ref:`String` filename **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_process` **(** :ref:`bool` enable **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_name` **(** :ref:`String` name **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_owner` **(** :ref:`Node` owner **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pause_mode` **(** :ref:`int` mode **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process` **(** :ref:`bool` enable **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_enter_tree` **(** **)** virtual | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_exit_tree` **(** **)** virtual | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_fixed_process` **(** :ref:`float` delta **)** virtual | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_ready` **(** **)** virtual | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_key_input` **(** :ref:`InputEvent` key_event **)** virtual | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_process` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`duplicate` **(** :ref:`bool` use_instancing=false **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_child_count` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_children` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_filename` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fixed_process_delta_time` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_groups` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_mode` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_owner` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_parent` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pause_mode` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_viewport` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fixed_processing` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_master` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_pos **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stray_nodes` **(** **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_tree` **(** **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_free` **(** **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`raise` **(** **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_and_skip` **(** **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Node` node **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rpc` **(** :ref:`String` method **)** vararg | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`int` mode **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rpc_unreliable` **(** :ref:`String` method **)** vararg | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`int` mode **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filename` **(** :ref:`String` filename **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_process` **(** :ref:`bool` enable **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_name` **(** :ref:`String` name **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_network_mode` **(** :ref:`int` mode **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_owner` **(** :ref:`Node` owner **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pause_mode` **(** :ref:`int` mode **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process` **(** :ref:`bool` enable **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`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` or :ref:`queue_free`, it will also free all its children. +**Networking with nodes:** After connecting to a server (or making one, see :ref:`NetworkedMultiplayerENet`) it is possible to use the built-in RPC (remote procedure call) system to easily communicate over the network. By calling :ref:`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`) on the receiving peer. To identify which :ref:`Node` receives the RPC call Godot will use it's :ref:`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` **get_network_mode** **(** **)** const + .. _class_Node_get_node: - :ref:`Node` **get_node** **(** :ref:`NodePath` path **)** const @@ -475,6 +516,10 @@ Return *true* if "node" occurs later in the scene hierarchy than the current nod - :ref:`bool` **is_inside_tree** **(** **)** const +.. _class_Node_is_network_master: + +- :ref:`bool` **is_network_master** **(** **)** const + .. _class_Node_is_processing: - :ref:`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` 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_Node_rpc_config: + +- void **rpc_config** **(** :ref:`String` method, :ref:`int` mode **)** + +Change the method's RPC mode (one of RPC_MODE\_\* constants). + +.. _class_Node_rpc_id: + +- void **rpc_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg + +Send a :ref:`rpc` to a specific peer identified by *peer_id*. + +.. _class_Node_rpc_unreliable: + +- void **rpc_unreliable** **(** :ref:`String` method **)** vararg + +Send a :ref:`rpc` using an unreliable protocol. + +.. _class_Node_rpc_unreliable_id: + +- void **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg + +Send a :ref:`rpc` to a specific peer identified by *peer_id* using an unreliable protocol. + +.. _class_Node_rset: + +- void **rset** **(** :ref:`String` property, :ref:`Variant` value **)** + +Remotely change property's value on other peers (and locally). + +.. _class_Node_rset_config: + +- void **rset_config** **(** :ref:`String` property, :ref:`int` mode **)** + +Change the property's RPC mode (one of RPC_MODE\_\* constants). + +.. _class_Node_rset_id: + +- void **rset_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** + +Remotely change property's value on a specific peer identified by *peer_id*. + +.. _class_Node_rset_unreliable: + +- void **rset_unreliable** **(** :ref:`String` property, :ref:`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` peer_id, :ref:`String` property, :ref:`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` 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`. 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` mode **)** + +Change the networking mode of the :ref:`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` having a networking peer set with :ref:`SceneTree.set_network_peer`) + .. _class_Node_set_owner: - void **set_owner** **(** :ref:`Node` owner **)** diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 5a56d59ba..48088c741 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -27,6 +27,12 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_global_pos` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_global_rot` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_global_rotd` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_scale` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_pos` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Matrix32` | :ref:`get_relative_transform_to_parent` **(** :ref:`Object` parent **)** const | @@ -55,6 +61,12 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_pos` **(** :ref:`Vector2` pos **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_rot` **(** :ref:`float` radians **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_rotd` **(** :ref:`float` degrees **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_transform` **(** :ref:`Matrix32` xform **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pos` **(** :ref:`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` **get_global_rot** **(** **)** const + +Return the global rotation in radians of the 2D node. + +.. _class_Node2D_get_global_rotd: + +- :ref:`float` **get_global_rotd** **(** **)** const + +Return the global rotation in degrees of the 2D node. + +.. _class_Node2D_get_global_scale: + +- :ref:`Vector2` **get_global_scale** **(** **)** const + +Return the global scale of the 2D node. + .. _class_Node2D_get_pos: - :ref:`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` radians **)** + +Set the global rotation in radians of the 2D node. + +.. _class_Node2D_set_global_rotd: + +- void **set_global_rotd** **(** :ref:`float` degrees **)** + +Set the global rotation in degrees of the 2D node. + +.. _class_Node2D_set_global_scale: + +- void **set_global_scale** **(** :ref:`Vector2` scale **)** + +Set the global scale of the 2D node. + .. _class_Node2D_set_global_transform: - void **set_global_transform** **(** :ref:`Matrix32` xform **)** diff --git a/classes/class_object.rst b/classes/class_object.rst index c6e76935f..dd2ca611d 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -6,7 +6,7 @@ Object ====== -**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`Input`, :ref:`SpatialSound2DServer`, :ref:`Node`, :ref:`Geometry`, :ref:`TreeItem`, :ref:`PhysicsDirectSpaceState`, :ref:`Physics2DDirectSpaceState`, :ref:`MainLoop`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`PathRemap`, :ref:`ResourceLoader`, :ref:`AudioServer`, :ref:`SpatialSoundServer`, :ref:`VisualServer`, :ref:`IP`, :ref:`OS`, :ref:`Globals`, :ref:`PhysicsDirectBodyState`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`TranslationServer` +**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`Input`, :ref:`SpatialSound2DServer`, :ref:`Node`, :ref:`Geometry`, :ref:`TreeItem`, :ref:`PhysicsDirectSpaceState`, :ref:`Physics2DDirectSpaceState`, :ref:`MainLoop`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`PathRemap`, :ref:`ResourceLoader`, :ref:`AudioServer`, :ref:`SpatialSoundServer`, :ref:`VisualServer`, :ref:`IP`, :ref:`OS`, :ref:`Globals`, :ref:`PhysicsDirectBodyState`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` **Category:** Core @@ -18,87 +18,87 @@ Base class for all non built-in types. Member Functions ---------------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`XL_MESSAGE` **(** :ref:`String` message **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_get` **(** :ref:`String` property **)** virtual | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_init` **(** **)** virtual | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=Array() **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call` **(** :ref:`String` method, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL, :ref:`Variant` arg6=NULL, :ref:`Variant` arg7=NULL, :ref:`Variant` arg8=NULL, :ref:`Variant` arg9=NULL **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_deferred` **(** :ref:`String` method, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=Array(), :ref:`int` flags=0 **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`emit_signal` **(** :ref:`String` signal, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get` **(** :ref:`String` property **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_instance_ID` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_meta` **(** :ref:`String` name **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_meta_list` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_method_list` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_property_list` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_script` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_type` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_type` **(** :ref:`String` type **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`property_list_changed_notify` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_script` **(** :ref:`Script` script **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`XL_MESSAGE` **(** :ref:`String` message **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_get` **(** :ref:`String` property **)** virtual | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_init` **(** **)** virtual | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=Array() **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=Array(), :ref:`int` flags=0 **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free` **(** **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get` **(** :ref:`String` property **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_instance_ID` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_meta` **(** :ref:`String` name **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringArray` | :ref:`get_meta_list` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_method_list` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_property_list` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`get_script` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_type` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_type` **(** :ref:`String` type **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`property_list_changed_notify` **(** **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_script` **(** :ref:`Script` script **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tr` **(** :ref:`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` method, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL, :ref:`Variant` arg6=NULL, :ref:`Variant` arg7=NULL, :ref:`Variant` arg8=NULL, :ref:`Variant` arg9=NULL **)** - -Call a function in the object, result is returned. +- :ref:`Variant` **call** **(** :ref:`String` method **)** vararg .. _class_Object_call_deferred: -- void **call_deferred** **(** :ref:`String` method, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL **)** - -Create and store a function in the object. The call will take place on idle time. +- void **call_deferred** **(** :ref:`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` signal, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL **)** - -Emit a signal. Arguments are passed in an array. +- void **emit_signal** **(** :ref:`String` signal **)** vararg .. _class_Object_free: diff --git a/classes/class_os.rst b/classes/class_os.rst index 1fbdd937c..928631133 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -153,7 +153,7 @@ Member Functions +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_video_mode_resizable` **(** :ref:`int` screen=0 **)** const | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_vsnc_enabled` **(** **)** const | +| :ref:`bool` | :ref:`is_vsync_enabled` **(** **)** const | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_window_fullscreen` **(** **)** const | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -486,7 +486,7 @@ Returns the model name of the current device. - :ref:`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` **is_vsnc_enabled** **(** **)** const +- :ref:`bool` **is_vsync_enabled** **(** **)** const .. _class_OS_is_window_fullscreen: diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index b75685c26..ea7713b90 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -8,7 +8,7 @@ PacketPeer **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`PacketPeerStream`, :ref:`PacketPeerUDP` +**Inherited By:** :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`NetworkedMultiplayerPeer` **Category:** Core diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index c2a52b360..585e421cc 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -18,23 +18,23 @@ UDP packet peer. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_address` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_port` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`listen` **(** :ref:`int` port, :ref:`int` recv_buf_size=65536 **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`set_send_address` **(** :ref:`String` host, :ref:`int` port **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`wait` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_address` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_port` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_listening` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`listen` **(** :ref:`int` port, :ref:`int` ip_type=int.IP_TYPE_ANY, :ref:`int` recv_buf_size=65536 **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`set_send_address` **(** :ref:`String` host, :ref:`int` port, :ref:`int` ip_type=int.IP_TYPE_ANY **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`wait` **(** **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -76,15 +76,21 @@ Return whether this :ref:`PacketPeerUDP` is listening. .. _class_PacketPeerUDP_listen: -- Error **listen** **(** :ref:`int` port, :ref:`int` recv_buf_size=65536 **)** +- Error **listen** **(** :ref:`int` port, :ref:`int` ip_type=int.IP_TYPE_ANY, :ref:`int` recv_buf_size=65536 **)** -Make this :ref:`PacketPeerUDP` listen on the "port" using a buffer size "recv_buf_size". Listens on all available adresses. +Make this :ref:`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` **set_send_address** **(** :ref:`String` host, :ref:`int` port **)** +- :ref:`int` **set_send_address** **(** :ref:`String` host, :ref:`int` port, :ref:`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: diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 179327180..36d9383d0 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -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** diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 0ee027c5b..1b8dea2a9 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -20,181 +20,181 @@ Physics 2D Server. Member Functions ---------------- -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_ID` **(** :ref:`RID` area, :ref:`int` id **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_create` **(** **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_ID` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_layer_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`int` mode **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Matrix32` transform **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` pos, :ref:`Vector2` impulse **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_ID` **(** :ref:`RID` body, :ref:`int` id **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_layer_mask` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_ID` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`body_get_one_way_collision_direction` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_one_way_collision_max_depth` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Matrix32` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_shape_set_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=NULL **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_layer_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_one_way_collision_direction` **(** :ref:`RID` body, :ref:`Vector2` normal **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_one_way_collision_max_depth` **(** :ref:`RID` body, :ref:`float` depth **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=RID(), :ref:`RID` body_b=RID() **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`space_create` **(** **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`int` param **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_attach_object_instance_ID` **(** :ref:`RID` area, :ref:`int` id **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_create` **(** **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_object_instance_ID` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Matrix32` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Matrix32` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_layer_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`int` param, :ref:`Variant` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`int` mode **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Matrix32` transform **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Matrix32` transform=((1, 0), (0, 1), (0, 0)) **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` pos, :ref:`Vector2` impulse **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_attach_object_instance_ID` **(** :ref:`RID` body, :ref:`int` id **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_layer_mask` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_object_instance_ID` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`body_get_one_way_collision_direction` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`body_get_one_way_collision_max_depth` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Matrix32` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_shape_set_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=NULL **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_layer_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_one_way_collision_direction` **(** :ref:`RID` body, :ref:`Vector2` normal **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_one_way_collision_max_depth` **(** :ref:`RID` body, :ref:`float` depth **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Matrix32` transform **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Matrix32` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=RID(), :ref:`RID` body_b=RID() **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`space_create` **(** **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`int` param **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`int` param, :ref:`float` value **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -671,9 +671,9 @@ Set a body state (see BODY_STATE\* constants). .. _class_Physics2DServer_body_test_motion: -- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** +- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Matrix32` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** -Return whether a body can move in a given direction. Apart from the boolean return value, a :ref:`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` can be passed to return additional information in. .. _class_Physics2DServer_damped_spring_joint_create: diff --git a/classes/class_rawarray.rst b/classes/class_rawarray.rst index 5f07693e2..1f9621655 100644 --- a/classes/class_rawarray.rst +++ b/classes/class_rawarray.rst @@ -16,31 +16,33 @@ Raw byte array. Member Functions ---------------- -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`RawArray` | :ref:`RawArray` **(** :ref:`Array` from **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`int` byte **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`RawArray` array **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`int` byte **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------+ ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`RawArray` | :ref:`RawArray` **(** :ref:`Array` from **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`int` byte **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`RawArray` array **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`int` byte **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`RawArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`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` **subarray** **(** :ref:`int` from, :ref:`int` to **)** + +Returns the slice of the :ref:`RawArray` between indices (inclusive) as a new :ref:`RawArray`. Any negative index is considered to be from the end of the array. + diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index 10c622d14..27da651ef 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -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` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_raycast_update` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_cast_to` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_collider` **(** **)** const | @@ -56,6 +58,23 @@ Member Functions | void | :ref:`set_type_mask` **(** :ref:`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`), 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` after adjusting the raycast. + Member Function Description --------------------------- @@ -63,6 +82,8 @@ Member Function Description - void **add_exception** **(** :ref:`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` 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` **get_cast_to** **(** **)** const +Return the destination point of this ray object. + .. _class_RayCast_get_collider: - :ref:`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` to check if the object returned is actually colliding with the ray. + .. _class_RayCast_get_collider_shape: - :ref:`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` **get_collision_normal** **(** **)** const +Returns the normal of the intersecting object shape face containing the collision point. + .. _class_RayCast_get_collision_point: - :ref:`Vector3` **get_collision_point** **(** **)** const @@ -97,22 +134,32 @@ Returns collision point. This point is in **global** coordinate system. - :ref:`int` **get_layer_mask** **(** **)** const +Returns the layer mask for this ray. + .. _class_RayCast_get_type_mask: - :ref:`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_RayCast_is_colliding: - :ref:`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` **is_enabled** **(** **)** const +Returns whether this raycast is enabled or not. + .. _class_RayCast_remove_exception: - void **remove_exception** **(** :ref:`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` rid **)** @@ -127,12 +174,18 @@ Sets to which point ray should be casted. This point is in **local** coordinate - void **set_enabled** **(** :ref:`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` 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` mask **)** +Set the types of objects to detect. For ``mask`` use a logic sum (OR operation) of constants defined in :ref:`PhysicsDirectSpaceState`, eg. ``PhysicsDirectSpaceState.TYPE_MASK_STATIC_BODY | PhysicsDirectSpaceState.TYPE_MASK_KINEMATIC_BODY`` to detect only those two types. + diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index d7a220d63..fc556f499 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -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` **(** :ref:`Object` node **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_exceptions` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_cast_to` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_type_mask` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cast_to` **(** :ref:`Vector2` local_point **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_type_mask` **(** :ref:`int` mask **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception` **(** :ref:`Object` node **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_exceptions` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_raycast_update` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_cast_to` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_exclude_parent_body` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_type_mask` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_colliding` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cast_to` **(** :ref:`Vector2` local_point **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclude_parent_body` **(** :ref:`bool` mask **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_type_mask` **(** :ref:`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`), 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` 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` **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` **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` **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` **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_RayCast2D_is_colliding: - :ref:`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` **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` 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` 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` mask **)** +Set the types of objects to detect. For ``mask`` use a logic sum (OR operation) of constants defined in :ref:`Physics2DDirectSpaceState`, eg. ``Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY`` to detect only those two types. + diff --git a/classes/class_reference.rst b/classes/class_reference.rst index f19723b7e..6b8d3faa5 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -8,7 +8,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`RegEx`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`EditorScenePostImport`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`Physics2DShapeQueryParameters`, :ref:`MeshDataTool`, :ref:`GDFunctionState`, :ref:`EditorExportPlugin`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`Marshalls`, :ref:`WeakRef`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`PCKPacker`, :ref:`Resource`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`ResourceImportMetadata`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`EditorScenePostImport`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`Physics2DShapeQueryParameters`, :ref:`MeshDataTool`, :ref:`GDFunctionState`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorExportPlugin`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`Marshalls`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`PCKPacker`, :ref:`WeakRef`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`ResourceImportMetadata`, :ref:`PhysicsShapeQueryParameters` **Category:** Core diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 7c969861c..b96a0387d 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -18,23 +18,23 @@ Simple regular expression matcher. Member Functions ---------------- -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compile` **(** :ref:`String` pattern, :ref:`int` capture=9 **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** :ref:`String` text, :ref:`int` start=0, :ref:`int` end=-1 **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_capture` **(** :ref:`int` capture **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_capture_count` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_capture_start` **(** :ref:`int` capture **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringArray` | :ref:`get_captures` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compile` **(** :ref:`String` pattern **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_group_count` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_names` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_pattern` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`search` **(** :ref:`String` text, :ref:`int` start=0, :ref:`int` end=-1 **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`sub` **(** :ref:`String` text, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` start=0, :ref:`int` end=-1 **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -59,6 +59,8 @@ Currently supported features: \* Capturing ``()`` and non-capturing ``(?:)`` groups +\* Named capturing groups ``(?P)`` + \* 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`` \* POSIX character classes ``:ref:`[: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`. +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` **compile** **(** :ref:`String` pattern, :ref:`int` capture=9 **)** +- :ref:`int` **compile** **(** :ref:`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` **find** **(** :ref:`String` text, :ref:`int` start=0, :ref:`int` end=-1 **)** const +- :ref:`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`) for further retrieval. +Returns the number of numeric capturing groups. -.. _class_RegEx_get_capture: +.. _class_RegEx_get_names: -- :ref:`String` **get_capture** **(** :ref:`int` capture **)** const +- :ref:`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` **get_capture_count** **(** **)** const +- :ref:`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` **get_capture_start** **(** :ref:`int` capture **)** const - -.. _class_RegEx_get_captures: - -- :ref:`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` **search** **(** :ref:`String` text, :ref:`int` start=0, :ref:`int` end=-1 **)** const + +Searches the text for the compiled pattern. Returns a :ref:`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` **sub** **(** :ref:`String` text, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` start=0, :ref:`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`` 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. + diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst new file mode 100644 index 000000000..959fa309f --- /dev/null +++ b/classes/class_regexmatch.rst @@ -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` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`expand` **(** :ref:`String` template **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_end` **(** :ref:`Variant` name=0 **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_group_array` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_group_count` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_name_dict` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_names` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_start` **(** :ref:`Variant` name=0 **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string` **(** :ref:`Variant` name=0 **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_RegExMatch_expand: + +- :ref:`String` **expand** **(** :ref:`String` template **)** const + +Using results from the search, returns the specified string with escapes and backreferences such as ``\1`` and ``\g`` expanded and resolved. + +.. _class_RegExMatch_get_end: + +- :ref:`int` **get_end** **(** :ref:`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` **get_group_array** **(** **)** const + +Returns an array of the results of the numeric groups. + +.. _class_RegExMatch_get_group_count: + +- :ref:`int` **get_group_count** **(** **)** const + +Returns the number of numeric capturing groups. + +.. _class_RegExMatch_get_name_dict: + +- :ref:`Dictionary` **get_name_dict** **(** **)** const + +Returns a dictionary containing the named capturing groups and their results. + +.. _class_RegExMatch_get_names: + +- :ref:`Array` **get_names** **(** **)** const + +Returns an array of names of named capturing groups. + +.. _class_RegExMatch_get_start: + +- :ref:`int` **get_start** **(** :ref:`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` **get_string** **(** :ref:`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). + + diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst new file mode 100644 index 000000000..c36c32182 --- /dev/null +++ b/classes/class_remotetransform.rst @@ -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` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_remote_node` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_RemoteTransform_get_remote_node: + +- :ref:`NodePath` **get_remote_node** **(** **)** const + +.. _class_RemoteTransform_set_remote_node: + +- void **set_remote_node** **(** :ref:`NodePath` path **)** + + diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 0a81ebf40..094644ba1 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -8,7 +8,7 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`EventStream`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Shader`, :ref:`ColorRamp`, :ref:`StyleBox`, :ref:`Environment`, :ref:`Material`, :ref:`VideoStream`, :ref:`RoomBounds`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Script`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`Sample`, :ref:`PolygonPathFinder`, :ref:`BakedLight`, :ref:`World`, :ref:`SampleLibrary`, :ref:`World2D`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`MultiMesh`, :ref:`CanvasItemMaterial`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` +**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`EventStream`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Shader`, :ref:`ColorRamp`, :ref:`StyleBox`, :ref:`Material`, :ref:`VideoStream`, :ref:`RoomBounds`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Script`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`Sample`, :ref:`PolygonPathFinder`, :ref:`BakedLight`, :ref:`World`, :ref:`SampleLibrary`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`MultiMesh`, :ref:`CanvasItemMaterial`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` **Category:** Core diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index ba16c06c3..69a940ec5 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -18,73 +18,90 @@ Brief Description Member Functions ---------------- -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_group` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`change_scene` **(** :ref:`String` path **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_current_scene` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_edited_scene_root` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_count` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`String` group **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_root` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debugging_collisions_hint` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debugging_navigation_hint` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editor_hint` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_paused` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`quit` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`reload_current_scene` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_scene` **(** :ref:`Node` child_node **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_collisions_hint` **(** :ref:`bool` enable **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_navigation_hint` **(** :ref:`bool` enable **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edited_scene_root` **(** :ref:`Object` scene **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor_hint` **(** :ref:`bool` enable **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_as_handled` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pause` **(** :ref:`bool` enable **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_stretch` **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`call_group` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`change_scene` **(** :ref:`String` path **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_current_scene` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_edited_scene_root` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_count` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`String` group **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_root` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debugging_collisions_hint` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debugging_navigation_hint` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editor_hint` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_server` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_paused` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_refusing_new_network_connections` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notify_group` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`quit` **(** **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`reload_current_scene` **(** **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_scene` **(** :ref:`Node` child_node **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_collisions_hint` **(** :ref:`bool` enable **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_navigation_hint` **(** :ref:`bool` enable **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edited_scene_root` **(** :ref:`Object` scene **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editor_hint` **(** :ref:`bool` enable **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_as_handled` **(** **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_network_peer` **(** :ref:`NetworkedMultiplayerPeer` peer **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pause` **(** :ref:`bool` enable **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_refuse_new_network_connections` **(** :ref:`bool` refuse **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_screen_stretch` **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- +- **connected_to_server** **(** **)** +- **connection_failed** **(** **)** - **files_dropped** **(** :ref:`StringArray` files, :ref:`int` screen **)** - **fixed_frame** **(** **)** - **idle_frame** **(** **)** +- **network_peer_connected** **(** :ref:`int` id **)** +- **network_peer_disconnected** **(** :ref:`int` id **)** - **node_configuration_warning_changed** **(** :ref:`Object` node **)** - **node_removed** **(** :ref:`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` flags, :ref:`String` group, :ref:`String` method, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL **)** +- void **call_group** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg .. _class_SceneTree_change_scene: @@ -117,6 +134,10 @@ Member Function Description - :ref:`int` **change_scene_to** **(** :ref:`PackedScene` packed_scene **)** +.. _class_SceneTree_create_timer: + +- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec **)** + .. _class_SceneTree_get_current_scene: - :ref:`Node` **get_current_scene** **(** **)** const @@ -129,6 +150,10 @@ Member Function Description - :ref:`int` **get_frame** **(** **)** const +.. _class_SceneTree_get_network_unique_id: + +- :ref:`int` **get_network_unique_id** **(** **)** const + .. _class_SceneTree_get_node_count: - :ref:`int` **get_node_count** **(** **)** const @@ -157,10 +182,20 @@ Member Function Description - :ref:`bool` **is_editor_hint** **(** **)** const +.. _class_SceneTree_is_network_server: + +- :ref:`bool` **is_network_server** **(** **)** const + +Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer` is in server mode (listening for connections). + .. _class_SceneTree_is_paused: - :ref:`bool` **is_paused** **(** **)** const +.. _class_SceneTree_is_refusing_new_network_connections: + +- :ref:`bool` **is_refusing_new_network_connections** **(** **)** const + .. _class_SceneTree_notify_group: - void **notify_group** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`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` 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()`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`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` enable **)** +.. _class_SceneTree_set_refuse_new_network_connections: + +- void **set_refuse_new_network_connections** **(** :ref:`bool` refuse **)** + .. _class_SceneTree_set_screen_stretch: - void **set_screen_stretch** **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize **)** diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst new file mode 100644 index 000000000..a3e800f89 --- /dev/null +++ b/classes/class_scenetreetimer.rst @@ -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` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_time_left` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_time_left` **(** :ref:`float` time **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **timeout** **(** **)** + +Member Function Description +--------------------------- + +.. _class_SceneTreeTimer_get_time_left: + +- :ref:`float` **get_time_left** **(** **)** const + +.. _class_SceneTreeTimer_set_time_left: + +- void **set_time_left** **(** :ref:`float` time **)** + + diff --git a/classes/class_script.rst b/classes/class_script.rst index 361729b72..89cfda453 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -8,7 +8,7 @@ Script **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`GDScript` +**Inherited By:** :ref:`VisualScript`, :ref:`GDScript` **Category:** Core diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 72ccd7bd4..35e8565e5 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -39,7 +39,7 @@ Member Functions Description ----------- -A ScrollContainer node with a :ref:`Control` child and scrollbar child (:ref:`HScrollbar`, :ref:`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` control. +A ScrollContainer node with a :ref:`Control` child and scrollbar child (:ref:`HScrollbar`, :ref:`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` 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 --------------------------- diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 846b2ceef..d2999f8a6 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -8,7 +8,7 @@ Spatial **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`Path`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`SpatialPlayer`, :ref:`WorldEnvironment`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`InverseKinematics`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`CollisionObject` +**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`Path`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`RemoteTransform`, :ref:`SpatialPlayer`, :ref:`WorldEnvironment`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`InverseKinematics`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`CollisionObject` **Category:** Core diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 95d720856..7d1462383 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -8,7 +8,7 @@ StreamPeer **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`StreamPeerSSL`, :ref:`StreamPeerTCP` +**Inherited By:** :ref:`StreamPeerBuffer`, :ref:`StreamPeerSSL`, :ref:`StreamPeerTCP` **Category:** Core diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst new file mode 100644 index 000000000..7b143bd5c --- /dev/null +++ b/classes/class_streampeerbuffer.rst @@ -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` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`RawArray` | :ref:`get_data_array` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pos` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_size` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` size **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`int` pos **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data_array` **(** :ref:`RawArray` data **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_StreamPeerBuffer_clear: + +- void **clear** **(** **)** + +.. _class_StreamPeerBuffer_duplicate: + +- :ref:`StreamPeerBuffer` **duplicate** **(** **)** const + +.. _class_StreamPeerBuffer_get_data_array: + +- :ref:`RawArray` **get_data_array** **(** **)** const + +.. _class_StreamPeerBuffer_get_pos: + +- :ref:`int` **get_pos** **(** **)** const + +.. _class_StreamPeerBuffer_get_size: + +- :ref:`int` **get_size** **(** **)** const + +.. _class_StreamPeerBuffer_resize: + +- void **resize** **(** :ref:`int` size **)** + +.. _class_StreamPeerBuffer_seek: + +- void **seek** **(** :ref:`int` pos **)** + +.. _class_StreamPeerBuffer_set_data_array: + +- void **set_data_array** **(** :ref:`RawArray` data **)** + + diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 17e06669c..868fa6a86 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -18,19 +18,19 @@ TCP Stream peer. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect` **(** :ref:`String` host, :ref:`int` port **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connected_host` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connected_port` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_status` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect` **(** :ref:`String` host, :ref:`int` port, :ref:`int` ip_type=int.IP_TYPE_ANY **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect` **(** **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connected_host` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connected_port` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_status` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -50,9 +50,9 @@ Member Function Description .. _class_StreamPeerTCP_connect: -- :ref:`int` **connect** **(** :ref:`String` host, :ref:`int` port **)** +- :ref:`int` **connect** **(** :ref:`String` host, :ref:`int` port, :ref:`int` ip_type=int.IP_TYPE_ANY **)** -Connect to the specified IP:port pair. Returns :ref:`OK` on success or :ref:`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` on success or :ref:`FAILED` on failure. .. _class_StreamPeerTCP_disconnect: diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 4b359ec02..a13baaee2 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -25,6 +25,8 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_margin_size` **(** :ref:`int` margin **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_modulate` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_texture` **(** **)** const | @@ -35,6 +37,8 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_modulate` **(** :ref:`Color` color **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_region_rect` **(** :ref:`Rect2` region **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | @@ -65,6 +69,10 @@ Member Function Description - :ref:`float` **get_margin_size** **(** :ref:`int` margin **)** const +.. _class_StyleBoxTexture_get_modulate: + +- :ref:`Color` **get_modulate** **(** **)** const + .. _class_StyleBoxTexture_get_region_rect: - :ref:`Rect2` **get_region_rect** **(** **)** const @@ -85,6 +93,10 @@ Member Function Description - void **set_margin_size** **(** :ref:`int` margin, :ref:`float` size **)** +.. _class_StyleBoxTexture_set_modulate: + +- void **set_modulate** **(** :ref:`Color` color **)** + .. _class_StyleBoxTexture_set_region_rect: - void **set_region_rect** **(** :ref:`Rect2` region **)** diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 8cc7ae506..f85ec882f 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -18,15 +18,15 @@ TCP Server. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`StringArray` accepted_hosts=StringArray([]) **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`take_connection` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`int` ip_type=int.IP_TYPE_ANY, :ref:`StringArray` accepted_hosts=StringArray([]) **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`take_connection` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -44,9 +44,15 @@ Return true if a connection is available for taking. .. _class_TCP_Server_listen: -- :ref:`int` **listen** **(** :ref:`int` port, :ref:`StringArray` accepted_hosts=StringArray([]) **)** +- :ref:`int` **listen** **(** :ref:`int` port, :ref:`int` ip_type=int.IP_TYPE_ANY, :ref:`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: diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 6e802eb63..79b99c6df 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -120,6 +120,7 @@ Signals - **breakpoint_toggled** **(** :ref:`int` row **)** - **cursor_changed** **(** **)** - **request_completion** **(** **)** +- **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** - **text_changed** **(** **)** Numeric Constants diff --git a/classes/class_tree.rst b/classes/class_tree.rst index e76fda37b..e6786bf8e 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -13,7 +13,7 @@ Tree Brief Description ----------------- - +Control to show a tree of items. Member Functions ---------------- @@ -63,6 +63,8 @@ Member Functions +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_single_select_cell_editing_only_when_already_selected` **(** **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_delayed_text_editor_enabled` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_folding_hidden` **(** **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | @@ -77,6 +79,8 @@ Member Functions +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_columns` **(** :ref:`int` amount **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_delayed_text_editor` **(** :ref:`bool` enable **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_drop_mode_flags` **(** :ref:`int` flags **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hide_folding` **(** :ref:`bool` hide **)** | @@ -97,6 +101,7 @@ Signals - **empty_tree_rmb_selected** **(** :ref:`Vector2` pos **)** - **item_activated** **(** **)** - **item_collapsed** **(** :ref:`Object` item **)** +- **item_double_clicked** **(** **)** - **item_edited** **(** **)** - **item_rmb_selected** **(** :ref:`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` 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` **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` **create_item** **(** :ref:`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` **get_allow_rmb_select** **(** **)** const +Get whether a right click can select items. + .. _class_Tree_get_column_at_pos: - :ref:`int` **get_column_at_pos** **(** :ref:`Vector2` pos **)** const +Get the column index under the given point. + .. _class_Tree_get_column_title: - :ref:`String` **get_column_title** **(** :ref:`int` column **)** const +Get the title of the given column. + .. _class_Tree_get_column_width: - :ref:`int` **get_column_width** **(** :ref:`int` column **)** const +Get the width of the given column in pixels. + .. _class_Tree_get_columns: - :ref:`int` **get_columns** **(** **)** const +Get the amount of columns. + .. _class_Tree_get_custom_popup_rect: - :ref:`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_Tree_get_drop_mode_flags: - :ref:`int` **get_drop_mode_flags** **(** **)** const +Get the flags of the current drop mode. + .. _class_Tree_get_edited: - :ref:`TreeItem` **get_edited** **(** **)** const +Get the current edited item. This is only available for custom cell mode. + .. _class_Tree_get_edited_column: - :ref:`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` **get_item_area_rect** **(** :ref:`TreeItem` item, :ref:`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` **get_item_at_pos** **(** :ref:`Vector2` pos **)** const +Get the tree item at the specified position (relative to the tree origin position). + .. _class_Tree_get_next_selected: - :ref:`TreeItem` **get_next_selected** **(** :ref:`TreeItem` from **)** +Get the next selected item after the given one. + .. _class_Tree_get_pressed_button: - :ref:`int` **get_pressed_button** **(** **)** const +Get the index of the last pressed button. + .. _class_Tree_get_root: - :ref:`TreeItem` **get_root** **(** **)** +Get the root item of the tree. + .. _class_Tree_get_scroll: - :ref:`Vector2` **get_scroll** **(** **)** const +Get the current scrolling position. + .. _class_Tree_get_selected: - :ref:`TreeItem` **get_selected** **(** **)** const +Get the currently selected item. + .. _class_Tree_get_selected_column: - :ref:`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` **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` **is_delayed_text_editor_enabled** **(** **)** const + .. _class_Tree_is_folding_hidden: - :ref:`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` allow **)** +Set whether or not a right mouse button click can select items. + .. _class_Tree_set_column_expand: - void **set_column_expand** **(** :ref:`int` column, :ref:`bool` expand **)** +Set whether a column will have the "Expand" flag of :ref:`Control`. + .. _class_Tree_set_column_min_width: - void **set_column_min_width** **(** :ref:`int` column, :ref:`int` min_width **)** +Set the minimum width of a column. + .. _class_Tree_set_column_title: - void **set_column_title** **(** :ref:`int` column, :ref:`String` title **)** +Set the title of a column. + .. _class_Tree_set_column_titles_visible: - void **set_column_titles_visible** **(** :ref:`bool` visible **)** +Set whether the column titles visibility. + .. _class_Tree_set_columns: - void **set_columns** **(** :ref:`int` amount **)** +Set the amount of columns. + +.. _class_Tree_set_delayed_text_editor: + +- void **set_delayed_text_editor** **(** :ref:`bool` enable **)** + .. _class_Tree_set_drop_mode_flags: - void **set_drop_mode_flags** **(** :ref:`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` hide **)** +Set whether the folding arrow should be hidden. + .. _class_Tree_set_hide_root: - void **set_hide_root** **(** :ref:`bool` enable **)** +Set whether the root of the tree should be hidden. + .. _class_Tree_set_select_mode: - void **set_select_mode** **(** :ref:`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` enable **)** +Set whether the editing of a cell should only happen when it is already selected. + diff --git a/classes/class_tween.rst b/classes/class_tween.rst index e35e27c3a..1c31d14eb 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -41,15 +41,15 @@ Member Functions +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_repeat` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key **)** | +| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`remove_all` **(** **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key **)** | +| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`reset_all` **(** **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key **)** | +| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`resume_all` **(** **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -65,7 +65,7 @@ Member Functions +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`start` **(** **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key **)** | +| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`stop_all` **(** **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -200,9 +200,9 @@ Returns true if repeat has been set from editor GUI or :ref:`set_repeat` **remove** **(** :ref:`Object` object, :ref:`String` key **)** +- :ref:`bool` **remove** **(** :ref:`Object` object, :ref:`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` **reset** **(** :ref:`Object` object, :ref:`String` key **)** +- :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`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` **resume** **(** :ref:`Object` object, :ref:`String` key **)** +- :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`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` **stop** **(** :ref:`Object` object, :ref:`String` key **)** +- :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`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: diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 0ec039ce7..add7e2af3 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -18,29 +18,29 @@ Helper to manage UndoRedo in the editor or custom tools. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_history` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_action` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_action` **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_version` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_history` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_action` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_action` **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_version` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -61,11 +61,7 @@ Member Function Description .. _class_UndoRedo_add_do_method: -- void **add_do_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL **)** - -Add a call to a method in a given object with custom - -arguments. +- void **add_do_method** **(** :ref:`Object` object, :ref:`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` object, :ref:`String` method, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`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` object, :ref:`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` name, :ref:`int` merge_mode=0 **)** -Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property` and :ref:`add_undo_property`. +Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property` and :ref:`add_un + +do_property`. .. _class_UndoRedo_get_current_action_name: diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 08911ae11..ec748f66a 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -27,6 +27,8 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angle_to_point` **(** :ref:`Vector2` to **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`clamped` **(** :ref:`float` length **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`cubic_interpolate` **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`distance_squared_to` **(** :ref:`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` **clamped** **(** :ref:`float` length **)** + .. _class_Vector2_cubic_interpolate: - :ref:`Vector2` **cubic_interpolate** **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 1546e7650..79359cb61 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -13,7 +13,7 @@ VideoPlayer Brief Description ----------------- - +Control to play video files. Member Functions ---------------- @@ -64,6 +64,11 @@ Member Functions | void | :ref:`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` **get_audio_track** **(** **)** const +Get the selected audio track (for multitrack videos). + .. _class_VideoPlayer_get_buffering_msec: - :ref:`int` **get_buffering_msec** **(** **)** const +Get the amount of miliseconds to store in buffer while playing. + .. _class_VideoPlayer_get_stream: - :ref:`VideoStream` **get_stream** **(** **)** const +Get the video stream. + .. _class_VideoPlayer_get_stream_name: - :ref:`String` **get_stream_name** **(** **)** const +Get the name of the video stream. + .. _class_VideoPlayer_get_stream_pos: - :ref:`float` **get_stream_pos** **(** **)** const +Get the current position of the stream, in seconds. + .. _class_VideoPlayer_get_video_texture: - :ref:`Texture` **get_video_texture** **(** **)** +Get the current frame of the video as a :ref:`Texture`. + .. _class_VideoPlayer_get_volume: - :ref:`float` **get_volume** **(** **)** const +Get the volume of the audio track as a linear value. + .. _class_VideoPlayer_get_volume_db: - :ref:`float` **get_volume_db** **(** **)** const +Get the volume of the audio track in decibels. + .. _class_VideoPlayer_has_autoplay: - :ref:`bool` **has_autoplay** **(** **)** const +Get whether or not the video is set as autoplay. + .. _class_VideoPlayer_has_expand: - :ref:`bool` **has_expand** **(** **)** const +Get whether or not the expand property is set. + .. _class_VideoPlayer_is_paused: - :ref:`bool` **is_paused** **(** **)** const +Get whether or not the video is paused. + .. _class_VideoPlayer_is_playing: - :ref:`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` track **)** +Set the audio track (for multitrack videos). + .. _class_VideoPlayer_set_autoplay: - void **set_autoplay** **(** :ref:`bool` enabled **)** +Set whether this node should start playing automatically. + .. _class_VideoPlayer_set_buffering_msec: - void **set_buffering_msec** **(** :ref:`int` msec **)** +Set the amount of miliseconds to buffer during playback. + .. _class_VideoPlayer_set_expand: - void **set_expand** **(** :ref:`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` paused **)** +Set whether the video should pause the playback. + .. _class_VideoPlayer_set_stream: - void **set_stream** **(** :ref:`VideoStream` stream **)** +Set the video stream for this player. + .. _class_VideoPlayer_set_volume: - void **set_volume** **(** :ref:`float` volume **)** +Set the audio volume as a linear value. + .. _class_VideoPlayer_set_volume_db: - void **set_volume_db** **(** :ref:`float` db **)** +Set the audio volume in decibels. + .. _class_VideoPlayer_stop: - void **stop** **(** **)** +Stop the video playback. + diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 6d3f3993d..66482409a 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -59,6 +59,8 @@ Member Functions +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`World` | :ref:`get_world` **(** **)** const | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | @@ -123,6 +125,8 @@ Member Functions +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_world` **(** :ref:`World` world **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`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` **get_world_2d** **(** **)** const + .. _class_Viewport_gui_get_drag_data: - :ref:`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` world_2d **)** + .. _class_Viewport_unhandled_input: - void **unhandled_input** **(** :ref:`InputEvent` local_event **)** @@ -485,6 +497,6 @@ Force update of the 2D and 3D worlds. - void **warp_mouse** **(** :ref:`Vector2` to_pos **)** -Wrap the mouse to a position, relative to the viewport. +Warp the mouse to a position, relative to the viewport. diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index 2030d89cf..d53bac32f 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -20,21 +20,33 @@ Brief Description Member Functions ---------------- -+------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base` **(** :ref:`RID` base **)** | -+------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | -+------------------------+-----------------------------------------------------------------------------------------------------+ ++--------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base` **(** :ref:`RID` base **)** | ++--------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | ++--------------------------+-----------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- +.. _class_VisualInstance_get_aabb: + +- :ref:`AABB` **get_aabb** **(** **)** const + .. _class_VisualInstance_get_layer_mask: - :ref:`int` **get_layer_mask** **(** **)** const +.. _class_VisualInstance_get_transformed_aabb: + +- :ref:`AABB` **get_transformed_aabb** **(** **)** const + .. _class_VisualInstance_set_base: - void **set_base** **(** :ref:`RID` base **)** diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst new file mode 100644 index 000000000..07bff658a --- /dev/null +++ b/classes/class_visualscript.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_signal` **(** :ref:`String` name **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_function` **(** :ref:`String` name **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`Object` node, :ref:`Vector2` pos=Vector2(0, 0) **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=NULL, :ref:`bool` export=false **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=-1 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`String` name, :ref:`int` argidx **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`custom_signal_get_argument_type` **(** :ref:`String` name, :ref:`int` argidx **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_remove_argument` **(** :ref:`String` argidx, :ref:`int` arg1 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_set_argument_name` **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_set_argument_type` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` type **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_swap_argument` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`data_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`data_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_function_node_id` **(** :ref:`String` name **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` arg0 **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_pos` **(** :ref:`String` func, :ref:`int` id **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_variable_default_value` **(** :ref:`String` name **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_variable_export` **(** :ref:`String` name **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`String` name **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`String` name **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_data_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_function` **(** :ref:`String` name **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` func, :ref:`int` id **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_variable` **(** :ref:`String` name **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_function` **(** :ref:`String` name **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`String` func, :ref:`int` id **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_variable` **(** :ref:`String` name **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_custom_signal` **(** :ref:`String` name, :ref:`String` new_name **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_function` **(** :ref:`String` name, :ref:`String` new_name **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_variable` **(** :ref:`String` name, :ref:`String` new_name **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sequence_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sequence_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_function_scroll` **(** :ref:`String` ofs, :ref:`Vector2` arg1 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_pos` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` pos **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_export` **(** :ref:`String` name, :ref:`bool` enable **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_info` **(** :ref:`String` name, :ref:`Dictionary` value **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **node_ports_changed** **(** :ref:`String` function, :ref:`int` id **)** + +Member Function Description +--------------------------- + +.. _class_VisualScript_add_custom_signal: + +- void **add_custom_signal** **(** :ref:`String` name **)** + +.. _class_VisualScript_add_function: + +- void **add_function** **(** :ref:`String` name **)** + +.. _class_VisualScript_add_node: + +- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`Object` node, :ref:`Vector2` pos=Vector2(0, 0) **)** + +.. _class_VisualScript_add_variable: + +- void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=NULL, :ref:`bool` export=false **)** + +.. _class_VisualScript_custom_signal_add_argument: + +- void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=-1 **)** + +.. _class_VisualScript_custom_signal_get_argument_count: + +- :ref:`int` **custom_signal_get_argument_count** **(** :ref:`String` name **)** const + +.. _class_VisualScript_custom_signal_get_argument_name: + +- :ref:`String` **custom_signal_get_argument_name** **(** :ref:`String` name, :ref:`int` argidx **)** const + +.. _class_VisualScript_custom_signal_get_argument_type: + +- :ref:`int` **custom_signal_get_argument_type** **(** :ref:`String` name, :ref:`int` argidx **)** const + +.. _class_VisualScript_custom_signal_remove_argument: + +- void **custom_signal_remove_argument** **(** :ref:`String` argidx, :ref:`int` arg1 **)** + +.. _class_VisualScript_custom_signal_set_argument_name: + +- void **custom_signal_set_argument_name** **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** + +.. _class_VisualScript_custom_signal_set_argument_type: + +- void **custom_signal_set_argument_type** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` type **)** + +.. _class_VisualScript_custom_signal_swap_argument: + +- void **custom_signal_swap_argument** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** + +.. _class_VisualScript_data_connect: + +- void **data_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** + +.. _class_VisualScript_data_disconnect: + +- void **data_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** + +.. _class_VisualScript_get_function_node_id: + +- :ref:`int` **get_function_node_id** **(** :ref:`String` name **)** const + +.. _class_VisualScript_get_function_scroll: + +- :ref:`Vector2` **get_function_scroll** **(** :ref:`String` arg0 **)** const + +.. _class_VisualScript_get_node: + +- :ref:`Object` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const + +.. _class_VisualScript_get_node_pos: + +- :ref:`Vector2` **get_node_pos** **(** :ref:`String` func, :ref:`int` id **)** const + +.. _class_VisualScript_get_variable_default_value: + +- void **get_variable_default_value** **(** :ref:`String` name **)** const + +.. _class_VisualScript_get_variable_export: + +- :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** const + +.. _class_VisualScript_get_variable_info: + +- :ref:`Dictionary` **get_variable_info** **(** :ref:`String` name **)** const + +.. _class_VisualScript_has_custom_signal: + +- :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** const + +.. _class_VisualScript_has_data_connection: + +- :ref:`bool` **has_data_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const + +.. _class_VisualScript_has_function: + +- :ref:`bool` **has_function** **(** :ref:`String` name **)** const + +.. _class_VisualScript_has_node: + +- :ref:`bool` **has_node** **(** :ref:`String` func, :ref:`int` id **)** const + +.. _class_VisualScript_has_sequence_connection: + +- :ref:`bool` **has_sequence_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const + +.. _class_VisualScript_has_variable: + +- :ref:`bool` **has_variable** **(** :ref:`String` name **)** const + +.. _class_VisualScript_remove_custom_signal: + +- void **remove_custom_signal** **(** :ref:`String` name **)** + +.. _class_VisualScript_remove_function: + +- void **remove_function** **(** :ref:`String` name **)** + +.. _class_VisualScript_remove_node: + +- void **remove_node** **(** :ref:`String` func, :ref:`int` id **)** + +.. _class_VisualScript_remove_variable: + +- void **remove_variable** **(** :ref:`String` name **)** + +.. _class_VisualScript_rename_custom_signal: + +- void **rename_custom_signal** **(** :ref:`String` name, :ref:`String` new_name **)** + +.. _class_VisualScript_rename_function: + +- void **rename_function** **(** :ref:`String` name, :ref:`String` new_name **)** + +.. _class_VisualScript_rename_variable: + +- void **rename_variable** **(** :ref:`String` name, :ref:`String` new_name **)** + +.. _class_VisualScript_sequence_connect: + +- void **sequence_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** + +.. _class_VisualScript_sequence_disconnect: + +- void **sequence_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** + +.. _class_VisualScript_set_function_scroll: + +- void **set_function_scroll** **(** :ref:`String` ofs, :ref:`Vector2` arg1 **)** + +.. _class_VisualScript_set_instance_base_type: + +- void **set_instance_base_type** **(** :ref:`String` type **)** + +.. _class_VisualScript_set_node_pos: + +- void **set_node_pos** **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` pos **)** + +.. _class_VisualScript_set_variable_default_value: + +- void **set_variable_default_value** **(** :ref:`String` name, :ref:`Variant` value **)** + +.. _class_VisualScript_set_variable_export: + +- void **set_variable_export** **(** :ref:`String` name, :ref:`bool` enable **)** + +.. _class_VisualScript_set_variable_info: + +- void **set_variable_info** **(** :ref:`String` name, :ref:`Dictionary` value **)** + + diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst new file mode 100644 index 000000000..16490e2be --- /dev/null +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_basic_type` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_basic_type_constant` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_basic_type` **(** :ref:`int` name **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_basic_type_constant` **(** :ref:`String` name **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptBasicTypeConstant_get_basic_type: + +- :ref:`int` **get_basic_type** **(** **)** const + +.. _class_VisualScriptBasicTypeConstant_get_basic_type_constant: + +- :ref:`String` **get_basic_type_constant** **(** **)** const + +.. _class_VisualScriptBasicTypeConstant_set_basic_type: + +- void **set_basic_type** **(** :ref:`int` name **)** + +.. _class_VisualScriptBasicTypeConstant_set_basic_type_constant: + +- void **set_basic_type_constant** **(** :ref:`String` name **)** + + diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst new file mode 100644 index 000000000..b8ed92cf8 --- /dev/null +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_func` **(** **)** | ++------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`set_func` **(** :ref:`int` which **)** | ++------------------------+---------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptBuiltinFunc_get_func: + +- :ref:`int` **get_func** **(** **)** + +.. _class_VisualScriptBuiltinFunc_set_func: + +- void **set_func** **(** :ref:`int` which **)** + + diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst new file mode 100644 index 000000000..bd3ad1c47 --- /dev/null +++ b/classes/class_visualscriptclassconstant.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class_constant` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` name **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_class_constant` **(** :ref:`String` name **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptClassConstant_get_base_type: + +- :ref:`String` **get_base_type** **(** **)** + +.. _class_VisualScriptClassConstant_get_class_constant: + +- :ref:`String` **get_class_constant** **(** **)** + +.. _class_VisualScriptClassConstant_set_base_type: + +- void **set_base_type** **(** :ref:`String` name **)** + +.. _class_VisualScriptClassConstant_set_class_constant: + +- void **set_class_constant** **(** :ref:`String` name **)** + + diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst new file mode 100644 index 000000000..652c87709 --- /dev/null +++ b/classes/class_visualscriptcomment.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_description` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_title` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_description` **(** :ref:`String` description **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_title` **(** :ref:`String` title **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptComment_get_description: + +- :ref:`String` **get_description** **(** **)** const + +.. _class_VisualScriptComment_get_size: + +- :ref:`Vector2` **get_size** **(** **)** const + +.. _class_VisualScriptComment_get_title: + +- :ref:`String` **get_title** **(** **)** const + +.. _class_VisualScriptComment_set_description: + +- void **set_description** **(** :ref:`String` description **)** + +.. _class_VisualScriptComment_set_size: + +- void **set_size** **(** :ref:`Vector2` size **)** + +.. _class_VisualScriptComment_set_title: + +- void **set_title** **(** :ref:`String` title **)** + + diff --git a/classes/class_visualscriptcondition.rst b/classes/class_visualscriptcondition.rst new file mode 100644 index 000000000..1caddc267 --- /dev/null +++ b/classes/class_visualscriptcondition.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst new file mode 100644 index 000000000..bc6e1fbe4 --- /dev/null +++ b/classes/class_visualscriptconstant.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constant_type` **(** **)** const | ++------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_constant_value` **(** **)** const | ++------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant_type` **(** :ref:`int` type **)** | ++------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant_value` **(** :ref:`Variant` value **)** | ++------------------------+----------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptConstant_get_constant_type: + +- :ref:`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` type **)** + +.. _class_VisualScriptConstant_set_constant_value: + +- void **set_constant_value** **(** :ref:`Variant` value **)** + + diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst new file mode 100644 index 000000000..6207d86ad --- /dev/null +++ b/classes/class_visualscriptconstructor.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_constructor` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constructor_type` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constructor` **(** :ref:`Dictionary` constructor **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constructor_type` **(** :ref:`int` type **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptConstructor_get_constructor: + +- :ref:`Dictionary` **get_constructor** **(** **)** const + +.. _class_VisualScriptConstructor_get_constructor_type: + +- :ref:`int` **get_constructor_type** **(** **)** const + +.. _class_VisualScriptConstructor_set_constructor: + +- void **set_constructor** **(** :ref:`Dictionary` constructor **)** + +.. _class_VisualScriptConstructor_set_constructor_type: + +- void **set_constructor_type** **(** :ref:`int` type **)** + + diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst new file mode 100644 index 000000000..d8c0a4e87 --- /dev/null +++ b/classes/class_visualscriptcustomnode.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_caption` **(** **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_category` **(** **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_input_value_port_count` **(** **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_input_value_port_name` **(** :ref:`int` idx **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_input_value_port_type` **(** :ref:`int` idx **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_sequence_port_count` **(** **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_output_sequence_port_text` **(** :ref:`int` idx **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_value_port_count` **(** **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_output_value_port_name` **(** :ref:`int` idx **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_value_port_type` **(** :ref:`int` idx **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_text` **(** **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_working_memory_size` **(** **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_has_input_sequence_port` **(** **)** virtual | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_step` **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`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` **_get_caption** **(** **)** virtual + +.. _class_VisualScriptCustomNode__get_category: + +- :ref:`String` **_get_category** **(** **)** virtual + +.. _class_VisualScriptCustomNode__get_input_value_port_count: + +- :ref:`int` **_get_input_value_port_count** **(** **)** virtual + +.. _class_VisualScriptCustomNode__get_input_value_port_name: + +- :ref:`String` **_get_input_value_port_name** **(** :ref:`int` idx **)** virtual + +.. _class_VisualScriptCustomNode__get_input_value_port_type: + +- :ref:`int` **_get_input_value_port_type** **(** :ref:`int` idx **)** virtual + +.. _class_VisualScriptCustomNode__get_output_sequence_port_count: + +- :ref:`int` **_get_output_sequence_port_count** **(** **)** virtual + +.. _class_VisualScriptCustomNode__get_output_sequence_port_text: + +- :ref:`String` **_get_output_sequence_port_text** **(** :ref:`int` idx **)** virtual + +.. _class_VisualScriptCustomNode__get_output_value_port_count: + +- :ref:`int` **_get_output_value_port_count** **(** **)** virtual + +.. _class_VisualScriptCustomNode__get_output_value_port_name: + +- :ref:`String` **_get_output_value_port_name** **(** :ref:`int` idx **)** virtual + +.. _class_VisualScriptCustomNode__get_output_value_port_type: + +- :ref:`int` **_get_output_value_port_type** **(** :ref:`int` idx **)** virtual + +.. _class_VisualScriptCustomNode__get_text: + +- :ref:`String` **_get_text** **(** **)** virtual + +.. _class_VisualScriptCustomNode__get_working_memory_size: + +- :ref:`int` **_get_working_memory_size** **(** **)** virtual + +.. _class_VisualScriptCustomNode__has_input_sequence_port: + +- :ref:`bool` **_has_input_sequence_port** **(** **)** virtual + +.. _class_VisualScriptCustomNode__step: + +- :ref:`Variant` **_step** **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual + + diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst new file mode 100644 index 000000000..b8b290edf --- /dev/null +++ b/classes/class_visualscriptdeconstruct.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_deconstruct_input_type` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_deconstruct_type` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_deconstruct_input_type` **(** :ref:`int` input_type **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_deconstruct_type` **(** :ref:`int` type **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptDeconstruct_get_deconstruct_input_type: + +- :ref:`int` **get_deconstruct_input_type** **(** **)** const + +.. _class_VisualScriptDeconstruct_get_deconstruct_type: + +- :ref:`int` **get_deconstruct_type** **(** **)** const + +.. _class_VisualScriptDeconstruct_set_deconstruct_input_type: + +- void **set_deconstruct_input_type** **(** :ref:`int` input_type **)** + +.. _class_VisualScriptDeconstruct_set_deconstruct_type: + +- void **set_deconstruct_type** **(** :ref:`int` type **)** + + diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst new file mode 100644 index 000000000..3d3fd7494 --- /dev/null +++ b/classes/class_visualscriptemitsignal.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_signal` **(** **)** const | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_signal` **(** :ref:`String` name **)** | ++------------------------------+-----------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptEmitSignal_get_signal: + +- :ref:`String` **get_signal** **(** **)** const + +.. _class_VisualScriptEmitSignal_set_signal: + +- void **set_signal** **(** :ref:`String` name **)** + + diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst new file mode 100644 index 000000000..3492e4195 --- /dev/null +++ b/classes/class_visualscriptenginesingleton.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_singleton` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_singleton` **(** :ref:`String` name **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptEngineSingleton_get_singleton: + +- :ref:`String` **get_singleton** **(** **)** + +.. _class_VisualScriptEngineSingleton_set_singleton: + +- void **set_singleton** **(** :ref:`String` name **)** + + diff --git a/classes/class_visualscriptexpression.rst b/classes/class_visualscriptexpression.rst new file mode 100644 index 000000000..cffd58f3f --- /dev/null +++ b/classes/class_visualscriptexpression.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualscriptfunction.rst b/classes/class_visualscriptfunction.rst new file mode 100644 index 000000000..f9b175ab1 --- /dev/null +++ b/classes/class_visualscriptfunction.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst new file mode 100644 index 000000000..0f44a21ca --- /dev/null +++ b/classes/class_visualscriptfunctioncall.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_script` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_basic_type` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_call_mode` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_function` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rpc_call_mode` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_singleton` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_use_default_args` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_validate` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_function` **(** :ref:`String` function **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rpc_call_mode` **(** :ref:`int` mode **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_singleton` **(** :ref:`String` singleton **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_default_args` **(** :ref:`int` amount **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_validate` **(** :ref:`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` **get_base_path** **(** **)** const + +.. _class_VisualScriptFunctionCall_get_base_script: + +- :ref:`String` **get_base_script** **(** **)** const + +.. _class_VisualScriptFunctionCall_get_base_type: + +- :ref:`String` **get_base_type** **(** **)** const + +.. _class_VisualScriptFunctionCall_get_basic_type: + +- :ref:`int` **get_basic_type** **(** **)** const + +.. _class_VisualScriptFunctionCall_get_call_mode: + +- :ref:`int` **get_call_mode** **(** **)** const + +.. _class_VisualScriptFunctionCall_get_function: + +- :ref:`String` **get_function** **(** **)** const + +.. _class_VisualScriptFunctionCall_get_rpc_call_mode: + +- :ref:`int` **get_rpc_call_mode** **(** **)** const + +.. _class_VisualScriptFunctionCall_get_singleton: + +- :ref:`String` **get_singleton** **(** **)** const + +.. _class_VisualScriptFunctionCall_get_use_default_args: + +- :ref:`int` **get_use_default_args** **(** **)** const + +.. _class_VisualScriptFunctionCall_get_validate: + +- :ref:`bool` **get_validate** **(** **)** const + +.. _class_VisualScriptFunctionCall_set_base_path: + +- void **set_base_path** **(** :ref:`NodePath` base_path **)** + +.. _class_VisualScriptFunctionCall_set_base_script: + +- void **set_base_script** **(** :ref:`String` base_script **)** + +.. _class_VisualScriptFunctionCall_set_base_type: + +- void **set_base_type** **(** :ref:`String` base_type **)** + +.. _class_VisualScriptFunctionCall_set_basic_type: + +- void **set_basic_type** **(** :ref:`int` basic_type **)** + +.. _class_VisualScriptFunctionCall_set_call_mode: + +- void **set_call_mode** **(** :ref:`int` mode **)** + +.. _class_VisualScriptFunctionCall_set_function: + +- void **set_function** **(** :ref:`String` function **)** + +.. _class_VisualScriptFunctionCall_set_rpc_call_mode: + +- void **set_rpc_call_mode** **(** :ref:`int` mode **)** + +.. _class_VisualScriptFunctionCall_set_singleton: + +- void **set_singleton** **(** :ref:`String` singleton **)** + +.. _class_VisualScriptFunctionCall_set_use_default_args: + +- void **set_use_default_args** **(** :ref:`int` amount **)** + +.. _class_VisualScriptFunctionCall_set_validate: + +- void **set_validate** **(** :ref:`bool` enable **)** + + diff --git a/classes/class_visualscriptfunctionstate.rst b/classes/class_visualscriptfunctionstate.rst new file mode 100644 index 000000000..ee2f85a8d --- /dev/null +++ b/classes/class_visualscriptfunctionstate.rst @@ -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` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_to_signal` **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`resume` **(** :ref:`Array` args=NULL **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptFunctionState_connect_to_signal: + +- void **connect_to_signal** **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** + +.. _class_VisualScriptFunctionState_is_valid: + +- :ref:`bool` **is_valid** **(** **)** const + +.. _class_VisualScriptFunctionState_resume: + +- :ref:`Array` **resume** **(** :ref:`Array` args=NULL **)** + + diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst new file mode 100644 index 000000000..76cf8adbf --- /dev/null +++ b/classes/class_visualscriptglobalconstant.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_global_constant` **(** **)** | ++------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_constant` **(** :ref:`int` index **)** | ++------------------------+----------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptGlobalConstant_get_global_constant: + +- :ref:`int` **get_global_constant** **(** **)** + +.. _class_VisualScriptGlobalConstant_set_global_constant: + +- void **set_global_constant** **(** :ref:`int` index **)** + + diff --git a/classes/class_visualscriptindexget.rst b/classes/class_visualscriptindexget.rst new file mode 100644 index 000000000..6ca2ebfc8 --- /dev/null +++ b/classes/class_visualscriptindexget.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualscriptindexset.rst b/classes/class_visualscriptindexset.rst new file mode 100644 index 000000000..0a9c022e8 --- /dev/null +++ b/classes/class_visualscriptindexset.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst new file mode 100644 index 000000000..40f977b20 --- /dev/null +++ b/classes/class_visualscriptinputaction.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_action_mode` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_action_name` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_action_mode` **(** :ref:`int` mode **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_action_name` **(** :ref:`String` name **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptInputAction_get_action_mode: + +- :ref:`int` **get_action_mode** **(** **)** const + +.. _class_VisualScriptInputAction_get_action_name: + +- :ref:`String` **get_action_name** **(** **)** const + +.. _class_VisualScriptInputAction_set_action_mode: + +- void **set_action_mode** **(** :ref:`int` mode **)** + +.. _class_VisualScriptInputAction_set_action_name: + +- void **set_action_name** **(** :ref:`String` name **)** + + diff --git a/classes/class_visualscriptinputfilter.rst b/classes/class_visualscriptinputfilter.rst new file mode 100644 index 000000000..ecba76f4c --- /dev/null +++ b/classes/class_visualscriptinputfilter.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualscriptiterator.rst b/classes/class_visualscriptiterator.rst new file mode 100644 index 000000000..0585883bc --- /dev/null +++ b/classes/class_visualscriptiterator.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst new file mode 100644 index 000000000..6aaec4c5a --- /dev/null +++ b/classes/class_visualscriptlocalvar.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_var_name` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_var_type` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_var_name` **(** :ref:`String` name **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_var_type` **(** :ref:`int` type **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptLocalVar_get_var_name: + +- :ref:`String` **get_var_name** **(** **)** const + +.. _class_VisualScriptLocalVar_get_var_type: + +- :ref:`int` **get_var_type** **(** **)** const + +.. _class_VisualScriptLocalVar_set_var_name: + +- void **set_var_name** **(** :ref:`String` name **)** + +.. _class_VisualScriptLocalVar_set_var_type: + +- void **set_var_type** **(** :ref:`int` type **)** + + diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst new file mode 100644 index 000000000..7eec10f30 --- /dev/null +++ b/classes/class_visualscriptlocalvarset.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_var_name` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_var_type` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_var_name` **(** :ref:`String` name **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_var_type` **(** :ref:`int` type **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptLocalVarSet_get_var_name: + +- :ref:`String` **get_var_name** **(** **)** const + +.. _class_VisualScriptLocalVarSet_get_var_type: + +- :ref:`int` **get_var_type** **(** **)** const + +.. _class_VisualScriptLocalVarSet_set_var_name: + +- void **set_var_name** **(** :ref:`String` name **)** + +.. _class_VisualScriptLocalVarSet_set_var_type: + +- void **set_var_type** **(** :ref:`int` type **)** + + diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst new file mode 100644 index 000000000..8dad8519a --- /dev/null +++ b/classes/class_visualscriptmathconstant.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_math_constant` **(** **)** | ++------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_math_constant` **(** :ref:`int` which **)** | ++------------------------+----------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptMathConstant_get_math_constant: + +- :ref:`int` **get_math_constant** **(** **)** + +.. _class_VisualScriptMathConstant_set_math_constant: + +- void **set_math_constant** **(** :ref:`int` which **)** + + diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst new file mode 100644 index 000000000..3b4a875c1 --- /dev/null +++ b/classes/class_visualscriptnode.rst @@ -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` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptSequence`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptPreload`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptInputFilter` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_default_input_value` **(** :ref:`int` port_idx **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VisualScript` | :ref:`get_visual_script` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_input_value` **(** :ref:`int` port_idx, :ref:`Variant` value **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **ports_changed** **(** **)** + +Member Function Description +--------------------------- + +.. _class_VisualScriptNode_get_default_input_value: + +- :ref:`Variant` **get_default_input_value** **(** :ref:`int` port_idx **)** const + +.. _class_VisualScriptNode_get_visual_script: + +- :ref:`VisualScript` **get_visual_script** **(** **)** const + +.. _class_VisualScriptNode_set_default_input_value: + +- void **set_default_input_value** **(** :ref:`int` port_idx, :ref:`Variant` value **)** + + diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst new file mode 100644 index 000000000..32797aeb9 --- /dev/null +++ b/classes/class_visualscriptoperator.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_operator` **(** **)** const | ++------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_typed` **(** **)** const | ++------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_operator` **(** :ref:`int` op **)** | ++------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_typed` **(** :ref:`int` type **)** | ++------------------------+-----------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptOperator_get_operator: + +- :ref:`int` **get_operator** **(** **)** const + +.. _class_VisualScriptOperator_get_typed: + +- :ref:`int` **get_typed** **(** **)** const + +.. _class_VisualScriptOperator_set_operator: + +- void **set_operator** **(** :ref:`int` op **)** + +.. _class_VisualScriptOperator_set_typed: + +- void **set_typed** **(** :ref:`int` type **)** + + diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst new file mode 100644 index 000000000..2856131fb --- /dev/null +++ b/classes/class_visualscriptpreload.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_preload` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_preload` **(** :ref:`Object` resource **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptPreload_get_preload: + +- :ref:`Object` **get_preload** **(** **)** const + +.. _class_VisualScriptPreload_set_preload: + +- void **set_preload** **(** :ref:`Object` resource **)** + + diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst new file mode 100644 index 000000000..821b8bbb7 --- /dev/null +++ b/classes/class_visualscriptpropertyget.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_script` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_basic_type` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_call_mode` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_event_type` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_property` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_event_type` **(** :ref:`int` event_type **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_property` **(** :ref:`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` **get_base_path** **(** **)** const + +.. _class_VisualScriptPropertyGet_get_base_script: + +- :ref:`String` **get_base_script** **(** **)** const + +.. _class_VisualScriptPropertyGet_get_base_type: + +- :ref:`String` **get_base_type** **(** **)** const + +.. _class_VisualScriptPropertyGet_get_basic_type: + +- :ref:`int` **get_basic_type** **(** **)** const + +.. _class_VisualScriptPropertyGet_get_call_mode: + +- :ref:`int` **get_call_mode** **(** **)** const + +.. _class_VisualScriptPropertyGet_get_event_type: + +- :ref:`int` **get_event_type** **(** **)** const + +.. _class_VisualScriptPropertyGet_get_property: + +- :ref:`String` **get_property** **(** **)** const + +.. _class_VisualScriptPropertyGet_set_base_path: + +- void **set_base_path** **(** :ref:`NodePath` base_path **)** + +.. _class_VisualScriptPropertyGet_set_base_script: + +- void **set_base_script** **(** :ref:`String` base_script **)** + +.. _class_VisualScriptPropertyGet_set_base_type: + +- void **set_base_type** **(** :ref:`String` base_type **)** + +.. _class_VisualScriptPropertyGet_set_basic_type: + +- void **set_basic_type** **(** :ref:`int` basic_type **)** + +.. _class_VisualScriptPropertyGet_set_call_mode: + +- void **set_call_mode** **(** :ref:`int` mode **)** + +.. _class_VisualScriptPropertyGet_set_event_type: + +- void **set_event_type** **(** :ref:`int` event_type **)** + +.. _class_VisualScriptPropertyGet_set_property: + +- void **set_property** **(** :ref:`String` property **)** + + diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst new file mode 100644 index 000000000..5fda22f30 --- /dev/null +++ b/classes/class_visualscriptpropertyset.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_script` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_basic_type` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_call_mode` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_event_type` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_property` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_basic_type` **(** :ref:`int` basic_type **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_event_type` **(** :ref:`int` event_type **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_property` **(** :ref:`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` **get_base_path** **(** **)** const + +.. _class_VisualScriptPropertySet_get_base_script: + +- :ref:`String` **get_base_script** **(** **)** const + +.. _class_VisualScriptPropertySet_get_base_type: + +- :ref:`String` **get_base_type** **(** **)** const + +.. _class_VisualScriptPropertySet_get_basic_type: + +- :ref:`int` **get_basic_type** **(** **)** const + +.. _class_VisualScriptPropertySet_get_call_mode: + +- :ref:`int` **get_call_mode** **(** **)** const + +.. _class_VisualScriptPropertySet_get_event_type: + +- :ref:`int` **get_event_type** **(** **)** const + +.. _class_VisualScriptPropertySet_get_property: + +- :ref:`String` **get_property** **(** **)** const + +.. _class_VisualScriptPropertySet_set_base_path: + +- void **set_base_path** **(** :ref:`NodePath` base_path **)** + +.. _class_VisualScriptPropertySet_set_base_script: + +- void **set_base_script** **(** :ref:`String` base_script **)** + +.. _class_VisualScriptPropertySet_set_base_type: + +- void **set_base_type** **(** :ref:`String` base_type **)** + +.. _class_VisualScriptPropertySet_set_basic_type: + +- void **set_basic_type** **(** :ref:`int` basic_type **)** + +.. _class_VisualScriptPropertySet_set_call_mode: + +- void **set_call_mode** **(** :ref:`int` mode **)** + +.. _class_VisualScriptPropertySet_set_event_type: + +- void **set_event_type** **(** :ref:`int` event_type **)** + +.. _class_VisualScriptPropertySet_set_property: + +- void **set_property** **(** :ref:`String` property **)** + + diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst new file mode 100644 index 000000000..c42e01766 --- /dev/null +++ b/classes/class_visualscriptresourcepath.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resource_path` **(** **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_resource_path` **(** :ref:`String` path **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptResourcePath_get_resource_path: + +- :ref:`String` **get_resource_path** **(** **)** + +.. _class_VisualScriptResourcePath_set_resource_path: + +- void **set_resource_path** **(** :ref:`String` path **)** + + diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst new file mode 100644 index 000000000..f0b16825f --- /dev/null +++ b/classes/class_visualscriptreturn.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_return_type` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_return_value_enabled` **(** **)** const | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_return_value` **(** :ref:`bool` enable **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_return_type` **(** :ref:`int` type **)** | ++--------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptReturn_get_return_type: + +- :ref:`int` **get_return_type** **(** **)** const + +.. _class_VisualScriptReturn_is_return_value_enabled: + +- :ref:`bool` **is_return_value_enabled** **(** **)** const + +.. _class_VisualScriptReturn_set_enable_return_value: + +- void **set_enable_return_value** **(** :ref:`bool` enable **)** + +.. _class_VisualScriptReturn_set_return_type: + +- void **set_return_type** **(** :ref:`int` type **)** + + diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst new file mode 100644 index 000000000..bd7c12e57 --- /dev/null +++ b/classes/class_visualscriptscenenode.rst @@ -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_VisualScriptSceneNode: + +VisualScriptSceneNode +===================== + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_path` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_path` **(** :ref:`NodePath` path **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptSceneNode_get_node_path: + +- :ref:`NodePath` **get_node_path** **(** **)** + +.. _class_VisualScriptSceneNode_set_node_path: + +- void **set_node_path** **(** :ref:`NodePath` path **)** + + diff --git a/classes/class_visualscriptscenetree.rst b/classes/class_visualscriptscenetree.rst new file mode 100644 index 000000000..3de0ada39 --- /dev/null +++ b/classes/class_visualscriptscenetree.rst @@ -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_VisualScriptSceneTree: + +VisualScriptSceneTree +===================== + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualscriptself.rst b/classes/class_visualscriptself.rst new file mode 100644 index 000000000..8acb75180 --- /dev/null +++ b/classes/class_visualscriptself.rst @@ -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_VisualScriptSelf: + +VisualScriptSelf +================ + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst new file mode 100644 index 000000000..0c3d1407d --- /dev/null +++ b/classes/class_visualscriptsequence.rst @@ -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_VisualScriptSequence: + +VisualScriptSequence +==================== + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_steps` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------+ +| void | :ref:`set_steps` **(** :ref:`int` steps **)** | ++------------------------+--------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptSequence_get_steps: + +- :ref:`int` **get_steps** **(** **)** const + +.. _class_VisualScriptSequence_set_steps: + +- void **set_steps** **(** :ref:`int` steps **)** + + diff --git a/classes/class_visualscriptsubcall.rst b/classes/class_visualscriptsubcall.rst new file mode 100644 index 000000000..2707239ae --- /dev/null +++ b/classes/class_visualscriptsubcall.rst @@ -0,0 +1,32 @@ +.. 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_VisualScriptSubCall: + +VisualScriptSubCall +=================== + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++-------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_subcall` **(** :ref:`Variant` arguments **)** virtual | ++-------+-------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptSubCall__subcall: + +- void **_subcall** **(** :ref:`Variant` arguments **)** virtual + + diff --git a/classes/class_visualscriptswitch.rst b/classes/class_visualscriptswitch.rst new file mode 100644 index 000000000..e56b3bd8b --- /dev/null +++ b/classes/class_visualscriptswitch.rst @@ -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_VisualScriptSwitch: + +VisualScriptSwitch +================== + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst new file mode 100644 index 000000000..5ef3c3295 --- /dev/null +++ b/classes/class_visualscripttypecast.rst @@ -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_VisualScriptTypeCast: + +VisualScriptTypeCast +==================== + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_script` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_script` **(** :ref:`String` path **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` type **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptTypeCast_get_base_script: + +- :ref:`String` **get_base_script** **(** **)** const + +.. _class_VisualScriptTypeCast_get_base_type: + +- :ref:`String` **get_base_type** **(** **)** const + +.. _class_VisualScriptTypeCast_set_base_script: + +- void **set_base_script** **(** :ref:`String` path **)** + +.. _class_VisualScriptTypeCast_set_base_type: + +- void **set_base_type** **(** :ref:`String` type **)** + + diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst new file mode 100644 index 000000000..0508d40cc --- /dev/null +++ b/classes/class_visualscriptvariableget.rst @@ -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_VisualScriptVariableGet: + +VisualScriptVariableGet +======================= + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_variable` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable` **(** :ref:`String` name **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptVariableGet_get_variable: + +- :ref:`String` **get_variable** **(** **)** const + +.. _class_VisualScriptVariableGet_set_variable: + +- void **set_variable** **(** :ref:`String` name **)** + + diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst new file mode 100644 index 000000000..a6f02b8e3 --- /dev/null +++ b/classes/class_visualscriptvariableset.rst @@ -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_VisualScriptVariableSet: + +VisualScriptVariableSet +======================= + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_variable` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable` **(** :ref:`String` name **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_VisualScriptVariableSet_get_variable: + +- :ref:`String` **get_variable** **(** **)** const + +.. _class_VisualScriptVariableSet_set_variable: + +- void **set_variable** **(** :ref:`String` name **)** + + diff --git a/classes/class_visualscriptwhile.rst b/classes/class_visualscriptwhile.rst new file mode 100644 index 000000000..e5cc1d21c --- /dev/null +++ b/classes/class_visualscriptwhile.rst @@ -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_VisualScriptWhile: + +VisualScriptWhile +================= + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst new file mode 100644 index 000000000..fee53ce5d --- /dev/null +++ b/classes/class_visualscriptyield.rst @@ -0,0 +1,57 @@ +.. 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_VisualScriptYield: + +VisualScriptYield +================= + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_wait_time` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_yield_mode` **(** **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_wait_time` **(** :ref:`float` sec **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_yield_mode` **(** :ref:`int` mode **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------+ + +Numeric Constants +----------------- + +- **YIELD_FRAME** = **1** +- **YIELD_FIXED_FRAME** = **2** +- **YIELD_WAIT** = **3** + +Member Function Description +--------------------------- + +.. _class_VisualScriptYield_get_wait_time: + +- :ref:`float` **get_wait_time** **(** **)** + +.. _class_VisualScriptYield_get_yield_mode: + +- :ref:`int` **get_yield_mode** **(** **)** + +.. _class_VisualScriptYield_set_wait_time: + +- void **set_wait_time** **(** :ref:`float` sec **)** + +.. _class_VisualScriptYield_set_yield_mode: + +- void **set_yield_mode** **(** :ref:`int` mode **)** + + diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst new file mode 100644 index 000000000..66a9bb6bb --- /dev/null +++ b/classes/class_visualscriptyieldsignal.rst @@ -0,0 +1,81 @@ +.. 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_VisualScriptYieldSignal: + +VisualScriptYieldSignal +======================= + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_type` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_call_mode` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_signal` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base_type` **(** :ref:`String` base_type **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_signal` **(** :ref:`String` signal **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ + +Numeric Constants +----------------- + +- **CALL_MODE_SELF** = **0** +- **CALL_MODE_NODE_PATH** = **1** +- **CALL_MODE_INSTANCE** = **2** + +Member Function Description +--------------------------- + +.. _class_VisualScriptYieldSignal_get_base_path: + +- :ref:`NodePath` **get_base_path** **(** **)** const + +.. _class_VisualScriptYieldSignal_get_base_type: + +- :ref:`String` **get_base_type** **(** **)** const + +.. _class_VisualScriptYieldSignal_get_call_mode: + +- :ref:`int` **get_call_mode** **(** **)** const + +.. _class_VisualScriptYieldSignal_get_signal: + +- :ref:`String` **get_signal** **(** **)** const + +.. _class_VisualScriptYieldSignal_set_base_path: + +- void **set_base_path** **(** :ref:`NodePath` base_path **)** + +.. _class_VisualScriptYieldSignal_set_base_type: + +- void **set_base_type** **(** :ref:`String` base_type **)** + +.. _class_VisualScriptYieldSignal_set_call_mode: + +- void **set_call_mode** **(** :ref:`int` mode **)** + +.. _class_VisualScriptYieldSignal_set_signal: + +- void **set_signal** **(** :ref:`String` signal **)** + + diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 2c8841cbc..d5af591ac 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -35,7 +35,7 @@ Member Functions +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_circle` **(** :ref:`RID` arg0, :ref:`Vector2` arg1, :ref:`float` arg2, :ref:`Color` arg3 **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_line` **(** :ref:`RID` arg0, :ref:`Vector2` arg1, :ref:`Vector2` arg2, :ref:`Color` arg3, :ref:`float` arg4=1 **)** | +| void | :ref:`canvas_item_add_line` **(** :ref:`RID` arg0, :ref:`Vector2` arg1, :ref:`Vector2` arg2, :ref:`Color` arg3, :ref:`float` arg4=1, :ref:`bool` arg5=false **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_rect` **(** :ref:`RID` arg0, :ref:`Rect2` arg1, :ref:`Color` arg2 **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -504,7 +504,7 @@ Member Function Description .. _class_VisualServer_canvas_item_add_line: -- void **canvas_item_add_line** **(** :ref:`RID` arg0, :ref:`Vector2` arg1, :ref:`Vector2` arg2, :ref:`Color` arg3, :ref:`float` arg4=1 **)** +- void **canvas_item_add_line** **(** :ref:`RID` arg0, :ref:`Vector2` arg1, :ref:`Vector2` arg2, :ref:`Color` arg3, :ref:`float` arg4=1, :ref:`bool` arg5=false **)** .. _class_VisualServer_canvas_item_add_rect: diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index 087c573ab..1b8b18188 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -13,7 +13,7 @@ XMLParser Brief Description ----------------- - +Low-level class for creating parsers for XML files. Member Functions ---------------- @@ -57,13 +57,18 @@ Member Functions Numeric Constants ----------------- -- **NODE_NONE** = **0** -- **NODE_ELEMENT** = **1** -- **NODE_ELEMENT_END** = **2** -- **NODE_TEXT** = **3** -- **NODE_COMMENT** = **4** -- **NODE_CDATA** = **5** -- **NODE_UNKNOWN** = **6** +- **NODE_NONE** = **0** --- There's no node (no file or buffer opened) +- **NODE_ELEMENT** = **1** --- Element (tag) +- **NODE_ELEMENT_END** = **2** --- End of element +- **NODE_TEXT** = **3** --- Text node +- **NODE_COMMENT** = **4** --- Comment node +- **NODE_CDATA** = **5** --- CDATA content +- **NODE_UNKNOWN** = **6** --- Unknown node + +Description +----------- + +This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low level so it can be applied to any possible schema. Member Function Description --------------------------- @@ -72,68 +77,102 @@ Member Function Description - :ref:`int` **get_attribute_count** **(** **)** const +Get the amount of attributes in the current element. + .. _class_XMLParser_get_attribute_name: - :ref:`String` **get_attribute_name** **(** :ref:`int` idx **)** const +Get the name of the attribute specified by the index in ``idx`` argument. + .. _class_XMLParser_get_attribute_value: - :ref:`String` **get_attribute_value** **(** :ref:`int` idx **)** const +Get the value of the attribute specified by the index in ``idx`` argument. + .. _class_XMLParser_get_current_line: - :ref:`int` **get_current_line** **(** **)** const +Get the current line in the parsed file (currently not implemented). + .. _class_XMLParser_get_named_attribute_value: - :ref:`String` **get_named_attribute_value** **(** :ref:`String` name **)** const +Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. + .. _class_XMLParser_get_named_attribute_value_safe: - :ref:`String` **get_named_attribute_value_safe** **(** :ref:`String` name **)** const +Get the value of a certain attribute of the current element by name. This will return an empty :ref:`String` if the attribute is not found. + .. _class_XMLParser_get_node_data: - :ref:`String` **get_node_data** **(** **)** const +Get the contents of a text node. This will raise an error in any other type of node. + .. _class_XMLParser_get_node_name: - :ref:`String` **get_node_name** **(** **)** const +Get the name of the current element node. This will raise an error if the current node type is not ``NODE_ELEMENT`` nor ``NODE_ELEMENT_END`` + .. _class_XMLParser_get_node_offset: - :ref:`int` **get_node_offset** **(** **)** const +Get the byte offset of the current node since the beginning of the file or buffer. + .. _class_XMLParser_get_node_type: - :ref:`int` **get_node_type** **(** **)** +Get the type of the current node. Compare with ``NODE\_\*`` constants. + .. _class_XMLParser_has_attribute: - :ref:`bool` **has_attribute** **(** :ref:`String` name **)** const +Check whether or not the current element has a certain attribute. + .. _class_XMLParser_is_empty: - :ref:`bool` **is_empty** **(** **)** const +Check whether the current element is empty (this only works for completely empty tags, e.g. ). + .. _class_XMLParser_open: - :ref:`int` **open** **(** :ref:`String` file **)** +Open a XML file for parsing. This returns an error code. + .. _class_XMLParser_open_buffer: - :ref:`int` **open_buffer** **(** :ref:`RawArray` buffer **)** +Open a XML raw buffer for parsing. This returns an error code. + .. _class_XMLParser_read: - :ref:`int` **read** **(** **)** +Read the next node of the file. This returns an error code. + .. _class_XMLParser_seek: - :ref:`int` **seek** **(** :ref:`int` pos **)** +Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. + .. _class_XMLParser_skip_section: - void **skip_section** **(** **)** +Skips the current section. If the node contains other elements, they will be ignored and the cursor will go to the closing of the current element. +