From f94046b723d200811b8c758211576b78f7c884aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 24 Jun 2019 23:09:46 +0200 Subject: [PATCH] Sync classref with current source --- classes/class_acceptdialog.rst | 16 +- classes/class_animationplayer.rst | 68 +++-- classes/class_area.rst | 20 +- classes/class_area2d.rst | 28 +- classes/class_astar.rst | 2 +- classes/class_astar2d.rst | 246 ++++++++++++++++++ classes/class_audioeffectpitchshift.rst | 61 ++++- classes/class_camerafeed.rst | 8 +- classes/class_cameraserver.rst | 8 +- classes/class_colorpicker.rst | 18 ++ classes/class_engine.rst | 20 +- classes/class_file.rst | 4 +- .../class_gdnativelibraryresourceloader.rst | 18 -- .../class_gdnativelibraryresourcesaver.rst | 18 -- classes/class_ip.rst | 19 ++ classes/class_object.rst | 2 + classes/class_packetpeerudp.rst | 48 ++-- classes/class_reference.rst | 2 +- classes/class_referencerect.rst | 4 +- classes/class_resource.rst | 14 +- classes/class_resourceformatdds.rst | 18 -- classes/class_resourceformatimporter.rst | 18 -- classes/class_resourceformatloader.rst | 16 +- classes/class_resourceformatloaderbinary.rst | 18 -- classes/class_resourceformatloaderbmfont.rst | 18 -- .../class_resourceformatloaderdynamicfont.rst | 18 -- .../class_resourceformatloadergdscript.rst | 18 -- classes/class_resourceformatloaderimage.rst | 18 -- ...class_resourceformatloadernativescript.rst | 18 -- classes/class_resourceformatloadershader.rst | 18 -- ...lass_resourceformatloaderstreamtexture.rst | 18 -- classes/class_resourceformatloadertext.rst | 18 -- ...ass_resourceformatloadertexturelayered.rst | 18 -- classes/class_resourceformatloadertheora.rst | 18 -- ...esourceformatloadervideostreamgdnative.rst | 18 -- classes/class_resourceformatloaderwebm.rst | 18 -- classes/class_resourceformatpkm.rst | 18 -- classes/class_resourceformatpvr.rst | 18 -- classes/class_resourceformatsaver.rst | 14 +- classes/class_resourceformatsaverbinary.rst | 18 -- classes/class_resourceformatsavergdscript.rst | 18 -- .../class_resourceformatsavernativescript.rst | 18 -- classes/class_resourceformatsavershader.rst | 18 -- classes/class_resourceformatsavertext.rst | 18 -- classes/class_resourceimporter.rst | 20 -- classes/class_resourceimporteroggvorbis.rst | 18 -- classes/class_resourceinteractiveloader.rst | 22 +- classes/class_resourceloader.rst | 34 ++- classes/class_resourcepreloader.rst | 2 + classes/class_resourcesaver.rst | 26 +- classes/class_resourcesaverpng.rst | 18 -- classes/class_sprite.rst | 4 + classes/class_string.rst | 18 +- classes/class_textedit.rst | 6 + classes/class_translationloaderpo.rst | 18 -- classes/class_visualshadernodegroupbase.rst | 6 + 56 files changed, 623 insertions(+), 619 deletions(-) create mode 100644 classes/class_astar2d.rst delete mode 100644 classes/class_gdnativelibraryresourceloader.rst delete mode 100644 classes/class_gdnativelibraryresourcesaver.rst delete mode 100644 classes/class_resourceformatdds.rst delete mode 100644 classes/class_resourceformatimporter.rst delete mode 100644 classes/class_resourceformatloaderbinary.rst delete mode 100644 classes/class_resourceformatloaderbmfont.rst delete mode 100644 classes/class_resourceformatloaderdynamicfont.rst delete mode 100644 classes/class_resourceformatloadergdscript.rst delete mode 100644 classes/class_resourceformatloaderimage.rst delete mode 100644 classes/class_resourceformatloadernativescript.rst delete mode 100644 classes/class_resourceformatloadershader.rst delete mode 100644 classes/class_resourceformatloaderstreamtexture.rst delete mode 100644 classes/class_resourceformatloadertext.rst delete mode 100644 classes/class_resourceformatloadertexturelayered.rst delete mode 100644 classes/class_resourceformatloadertheora.rst delete mode 100644 classes/class_resourceformatloadervideostreamgdnative.rst delete mode 100644 classes/class_resourceformatloaderwebm.rst delete mode 100644 classes/class_resourceformatpkm.rst delete mode 100644 classes/class_resourceformatpvr.rst delete mode 100644 classes/class_resourceformatsaverbinary.rst delete mode 100644 classes/class_resourceformatsavergdscript.rst delete mode 100644 classes/class_resourceformatsavernativescript.rst delete mode 100644 classes/class_resourceformatsavershader.rst delete mode 100644 classes/class_resourceformatsavertext.rst delete mode 100644 classes/class_resourceimporter.rst delete mode 100644 classes/class_resourceimporteroggvorbis.rst delete mode 100644 classes/class_resourcesaverpng.rst delete mode 100644 classes/class_translationloaderpo.rst diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 64038b0be..da793dc67 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -21,6 +21,8 @@ Base dialog for user notification. Properties ---------- ++-----------------------------+-------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`dialog_autowrap` | +-----------------------------+-------------------------------------------------------------------------+ | :ref:`bool` | :ref:`dialog_hide_on_ok` | +-----------------------------+-------------------------------------------------------------------------+ @@ -65,6 +67,18 @@ This dialog is useful for small notifications to the user about an event. It can Property Descriptions --------------------- +.. _class_AcceptDialog_property_dialog_autowrap: + +- :ref:`bool` **dialog_autowrap** + ++----------+---------------------+ +| *Setter* | set_autowrap(value) | ++----------+---------------------+ +| *Getter* | has_autowrap() | ++----------+---------------------+ + +Sets autowrapping for the text in the dialog. + .. _class_AcceptDialog_property_dialog_hide_on_ok: - :ref:`bool` **dialog_hide_on_ok** @@ -89,7 +103,7 @@ Note: Some nodes derived from this class can have a different default value, and | *Getter* | get_text() | +----------+-----------------+ -The text displayed by this dialog. +The text displayed by the dialog. Method Descriptions ------------------- diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 2611391d9..f4e93d8dc 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -19,27 +19,29 @@ Container and player of :ref:`Animation` resources. Properties ---------- -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`assigned_animation` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`autoplay` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_animation` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`current_animation_length` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`current_animation_position` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`playback_active` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`playback_default_blend_time` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`AnimationProcessMode` | :ref:`playback_process_mode` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`playback_speed` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`root_node` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`assigned_animation` | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`autoplay` | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`current_animation` | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`current_animation_length` | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`current_animation_position` | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`AnimationMethodCallMode` | :ref:`method_call_mode` | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`playback_active` | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`playback_default_blend_time` | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`AnimationProcessMode` | :ref:`playback_process_mode` | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`playback_speed` | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`root_node` | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ Methods ------- @@ -134,6 +136,18 @@ enum **AnimationProcessMode**: - **ANIMATION_PROCESS_MANUAL** = **2** --- Do not process animation. Use the 'advance' method to process the animation manually. +.. _enum_AnimationPlayer_AnimationMethodCallMode: + +.. _class_AnimationPlayer_constant_ANIMATION_METHOD_CALL_DEFERRED: + +.. _class_AnimationPlayer_constant_ANIMATION_METHOD_CALL_IMMEDIATE: + +enum **AnimationMethodCallMode**: + +- **ANIMATION_METHOD_CALL_DEFERRED** = **0** --- Batch method calls during the animation process, then do the calls after events are processed. This avoids bugs involving deleting nodes or modifying the AnimationPlayer while playing. + +- **ANIMATION_METHOD_CALL_IMMEDIATE** = **1** --- Make method calls immediately when reached in the animation. + Description ----------- @@ -205,6 +219,18 @@ The length (in seconds) of the currently being played animation. The position (in seconds) of the currently playing animation. +.. _class_AnimationPlayer_property_method_call_mode: + +- :ref:`AnimationMethodCallMode` **method_call_mode** + ++----------+-----------------------------+ +| *Setter* | set_method_call_mode(value) | ++----------+-----------------------------+ +| *Getter* | get_method_call_mode() | ++----------+-----------------------------+ + +The call mode to use for Call Method tracks. Default value: ``ANIMATION_METHOD_CALL_DEFERRED``. + .. _class_AnimationPlayer_property_playback_active: - :ref:`bool` **playback_active** diff --git a/classes/class_area.rst b/classes/class_area.rst index 7c1712b1c..4f3421bd4 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -109,25 +109,33 @@ Emitted when another area exits, reporting which areas were overlapping. - **body_entered** **(** :ref:`Node` body **)** -Emitted when a :ref:`PhysicsBody` object enters. +Emitted when a physics body enters. + +The ``body`` argument can either be a :ref:`PhysicsBody` or a :ref:`GridMap` instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). .. _class_Area_signal_body_exited: - **body_exited** **(** :ref:`Node` body **)** -Emitted when a :ref:`PhysicsBody` object exits. +Emitted when a physics body exits. + +The ``body`` argument can either be a :ref:`PhysicsBody` or a :ref:`GridMap` instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). .. _class_Area_signal_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** -Emitted when a :ref:`PhysicsBody` object enters, reporting which shapes overlapped. +Emitted when a physics body enters, reporting which shapes overlapped. + +The ``body`` argument can either be a :ref:`PhysicsBody` or a :ref:`GridMap` instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). .. _class_Area_signal_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** -Emitted when a :ref:`PhysicsBody` object exits, reporting which shapes were overlapping. +Emitted when a physics body exits, reporting which shapes were overlapping. + +The ``body`` argument can either be a :ref:`PhysicsBody` or a :ref:`GridMap` instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). Enumerations ------------ @@ -417,7 +425,9 @@ If ``true``, the given area overlaps the Area. Note that the result of this test - :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const -If ``true``, the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. +If ``true``, the given physics body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. + +The ``body`` argument can either be a :ref:`PhysicsBody` or a :ref:`GridMap` instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). .. _class_Area_method_set_collision_layer_bit: diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 6c01634cc..12d1b426a 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -99,27 +99,35 @@ Emitted when another area exits, reporting which shapes were overlapping. .. _class_Area2D_signal_body_entered: -- **body_entered** **(** :ref:`PhysicsBody2D` body **)** +- **body_entered** **(** :ref:`Node` body **)** -Emitted when a :ref:`PhysicsBody2D` object enters. +Emitted when a physics body enters. + +The ``body`` argument can either be a :ref:`PhysicsBody2D` or a :ref:`TileMap` instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). .. _class_Area2D_signal_body_exited: -- **body_exited** **(** :ref:`PhysicsBody2D` body **)** +- **body_exited** **(** :ref:`Node` body **)** -Emitted when a :ref:`PhysicsBody2D` object exits. +Emitted when a physics body exits. + +The ``body`` argument can either be a :ref:`PhysicsBody2D` or a :ref:`TileMap` instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). .. _class_Area2D_signal_body_shape_entered: -- **body_shape_entered** **(** :ref:`int` body_id, :ref:`PhysicsBody2D` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** -Emitted when a :ref:`PhysicsBody2D` object enters, reporting which shapes overlapped. +Emitted when a physics body enters, reporting which shapes overlapped. + +The ``body`` argument can either be a :ref:`PhysicsBody2D` or a :ref:`TileMap` instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). .. _class_Area2D_signal_body_shape_exited: -- **body_shape_exited** **(** :ref:`int` body_id, :ref:`PhysicsBody2D` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** -Emitted when a :ref:`PhysicsBody2D` object exits, reporting which shapes were overlapping. +Emitted when a physics body exits, reporting which shapes were overlapping. + +The ``body`` argument can either be a :ref:`PhysicsBody2D` or a :ref:`TileMap` instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). Enumerations ------------ @@ -361,7 +369,9 @@ If ``true``, the given area overlaps the Area2D. Note that the result of this te - :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const -If ``true``, the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. +If ``true``, the given physics body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. + +The ``body`` argument can either be a :ref:`PhysicsBody2D` or a :ref:`TileMap` instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). .. _class_Area2D_method_set_collision_layer_bit: diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 671873f8e..b6278b30a 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -14,7 +14,7 @@ AStar Brief Description ----------------- -AStar class representation that uses vectors as edges. +AStar class representation that uses 3d-vectors as edges. Methods ------- diff --git a/classes/class_astar2d.rst b/classes/class_astar2d.rst new file mode 100644 index 000000000..6d6c0873c --- /dev/null +++ b/classes/class_astar2d.rst @@ -0,0 +1,246 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AStar2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AStar2D: + +AStar2D +======= + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +AStar class representation that uses 2d-vectors as edges. + +Methods +------- + ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector2` position, :ref:`float` weight_scale=1.0 **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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, :ref:`bool` bidirectional=true **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`Vector2` to_position **)** const | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector2` to_position **)** const | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` id **)** const | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_points` **(** **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** const | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector2` position **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +This is a wrapper for the :ref:`AStar` class which uses 2D vectors instead of 3D vectors. + +Method Descriptions +------------------- + +.. _class_AStar2D_method_add_point: + +- void **add_point** **(** :ref:`int` id, :ref:`Vector2` position, :ref:`float` weight_scale=1.0 **)** + +Adds a new point at the given position with the given identifier. The algorithm prefers points with lower ``weight_scale`` to form a path. The ``id`` must be 0 or larger, and the ``weight_scale`` must be 1 or larger. + +:: + + var as = AStar2D.new() + as.add_point(1, Vector2(1, 0), 4) # Adds the point (1, 0) with weight_scale 4 and id 1 + +If there already exists a point for the given id, its position and weight scale are updated to the given values. + +.. _class_AStar2D_method_are_points_connected: + +- :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** const + +Returns whether there is a connection/segment between the given points. + +.. _class_AStar2D_method_clear: + +- void **clear** **(** **)** + +Clears all the points and segments. + +.. _class_AStar2D_method_connect_points: + +- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** + +Creates a segment between the given points. If ``bidirectional`` is ``false``, only movement from ``id`` to ``to_id`` is allowed, not the reverse direction. + +:: + + var as = AStar2D.new() + as.add_point(1, Vector2(1, 1)) + as.add_point(2, Vector2(0, 5)) + as.connect_points(1, 2, false) + +.. _class_AStar2D_method_disconnect_points: + +- void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id **)** + +Deletes the segment between the given points. + +.. _class_AStar2D_method_get_available_point_id: + +- :ref:`int` **get_available_point_id** **(** **)** const + +Returns the next available point id with no point associated to it. + +.. _class_AStar2D_method_get_closest_point: + +- :ref:`int` **get_closest_point** **(** :ref:`Vector2` to_position **)** const + +Returns the id of the closest point to ``to_position``. Returns -1 if there are no points in the points pool. + +.. _class_AStar2D_method_get_closest_position_in_segment: + +- :ref:`Vector2` **get_closest_position_in_segment** **(** :ref:`Vector2` to_position **)** const + +Returns the closest position to ``to_position`` that resides inside a segment between two connected points. + +:: + + var as = AStar2D.new() + as.add_point(1, Vector2(0, 0)) + as.add_point(2, Vector2(0, 5)) + as.connect_points(1, 2) + var res = as.get_closest_position_in_segment(Vector2(3, 3)) # returns (0, 3) + +The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the closest position in the segment to the given point. + +.. _class_AStar2D_method_get_id_path: + +- :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** + +Returns an array with the ids of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. + +:: + + var as = AStar2D.new() + as.add_point(1, Vector2(0, 0)) + as.add_point(2, Vector2(0, 1), 1) # default weight is 1 + as.add_point(3, Vector2(1, 1)) + as.add_point(4, Vector2(2, 0)) + + as.connect_points(1, 2, false) + as.connect_points(2, 3, false) + as.connect_points(4, 3, false) + as.connect_points(1, 4, false) + as.connect_points(5, 4, false) + + var res = as.get_id_path(1, 3) # returns [1, 2, 3] + +If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. + +.. _class_AStar2D_method_get_point_connections: + +- :ref:`PoolIntArray` **get_point_connections** **(** :ref:`int` id **)** + +Returns an array with the ids of the points that form the connect with the given point. + +:: + + var as = AStar2D.new() + as.add_point(1, Vector2(0, 0)) + as.add_point(2, Vector2(0, 1)) + as.add_point(3, Vector2(1, 1)) + as.add_point(4, Vector2(2, 0)) + + as.connect_points(1, 2, true) + as.connect_points(1, 3, true) + + var neighbors = as.get_point_connections(1) # returns [2, 3] + +.. _class_AStar2D_method_get_point_path: + +- :ref:`PoolVector2Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** + +Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. + +.. _class_AStar2D_method_get_point_position: + +- :ref:`Vector2` **get_point_position** **(** :ref:`int` id **)** const + +Returns the position of the point associated with the given id. + +.. _class_AStar2D_method_get_point_weight_scale: + +- :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** const + +Returns the weight scale of the point associated with the given id. + +.. _class_AStar2D_method_get_points: + +- :ref:`Array` **get_points** **(** **)** + +Returns an array of all points. + +.. _class_AStar2D_method_has_point: + +- :ref:`bool` **has_point** **(** :ref:`int` id **)** const + +Returns whether a point associated with the given id exists. + +.. _class_AStar2D_method_is_point_disabled: + +- :ref:`bool` **is_point_disabled** **(** :ref:`int` id **)** const + +Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. + +.. _class_AStar2D_method_remove_point: + +- void **remove_point** **(** :ref:`int` id **)** + +Removes the point associated with the given id from the points pool. + +.. _class_AStar2D_method_set_point_disabled: + +- void **set_point_disabled** **(** :ref:`int` id, :ref:`bool` disabled=true **)** + +Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. + +.. _class_AStar2D_method_set_point_position: + +- void **set_point_position** **(** :ref:`int` id, :ref:`Vector2` position **)** + +Sets the position for the point with the given id. + +.. _class_AStar2D_method_set_point_weight_scale: + +- void **set_point_weight_scale** **(** :ref:`int` id, :ref:`float` weight_scale **)** + +Sets the ``weight_scale`` for the point with the given id. + diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 4f299e807..54e4f46a8 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -21,9 +21,44 @@ Raises or lowers the pitch of original sound. Properties ---------- -+---------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`pitch_scale` | -+---------------------------+----------------------------------------------------------------------+ ++------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`FFT_Size` | :ref:`fft_size` | ++------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`int` | :ref:`oversampling` | ++------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pitch_scale` | ++------------------------------------------------------+------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_AudioEffectPitchShift_FFT_Size: + +.. _class_AudioEffectPitchShift_constant_FFT_SIZE_256: + +.. _class_AudioEffectPitchShift_constant_FFT_SIZE_512: + +.. _class_AudioEffectPitchShift_constant_FFT_SIZE_1024: + +.. _class_AudioEffectPitchShift_constant_FFT_SIZE_2048: + +.. _class_AudioEffectPitchShift_constant_FFT_SIZE_4096: + +.. _class_AudioEffectPitchShift_constant_FFT_SIZE_MAX: + +enum **FFT_Size**: + +- **FFT_SIZE_256** = **0** + +- **FFT_SIZE_512** = **1** + +- **FFT_SIZE_1024** = **2** + +- **FFT_SIZE_2048** = **3** + +- **FFT_SIZE_4096** = **4** + +- **FFT_SIZE_MAX** = **5** Description ----------- @@ -33,6 +68,26 @@ Allows modulation of pitch independently of tempo. All frequencies can be increa Property Descriptions --------------------- +.. _class_AudioEffectPitchShift_property_fft_size: + +- :ref:`FFT_Size` **fft_size** + ++----------+---------------------+ +| *Setter* | set_fft_size(value) | ++----------+---------------------+ +| *Getter* | get_fft_size() | ++----------+---------------------+ + +.. _class_AudioEffectPitchShift_property_oversampling: + +- :ref:`int` **oversampling** + ++----------+-------------------------+ +| *Setter* | set_oversampling(value) | ++----------+-------------------------+ +| *Getter* | get_oversampling() | ++----------+-------------------------+ + .. _class_AudioEffectPitchShift_property_pitch_scale: - :ref:`float` **pitch_scale** diff --git a/classes/class_camerafeed.rst b/classes/class_camerafeed.rst index 6eb2797e8..59d1e5df9 100644 --- a/classes/class_camerafeed.rst +++ b/classes/class_camerafeed.rst @@ -45,9 +45,9 @@ Enumerations .. _class_CameraFeed_constant_FEED_RGB: -.. _class_CameraFeed_constant_FEED_YCbCr: +.. _class_CameraFeed_constant_FEED_YCBCR: -.. _class_CameraFeed_constant_FEED_YCbCr_Sep: +.. _class_CameraFeed_constant_FEED_YCBCR_SEP: enum **FeedDataType**: @@ -55,9 +55,9 @@ enum **FeedDataType**: - **FEED_RGB** = **1** --- Feed supplies RGB images. -- **FEED_YCbCr** = **2** --- Feed supplies YCbCr images that need to be converted to RGB. +- **FEED_YCBCR** = **2** --- Feed supplies YCbCr images that need to be converted to RGB. -- **FEED_YCbCr_Sep** = **3** --- Feed supplies separate Y and CbCr images that need to be combined and converted to RGB. +- **FEED_YCBCR_SEP** = **3** --- Feed supplies separate Y and CbCr images that need to be combined and converted to RGB. .. _enum_CameraFeed_FeedPosition: diff --git a/classes/class_cameraserver.rst b/classes/class_cameraserver.rst index cd871ccee..07e173e43 100644 --- a/classes/class_cameraserver.rst +++ b/classes/class_cameraserver.rst @@ -53,21 +53,21 @@ Enumerations .. _class_CameraServer_constant_FEED_RGBA_IMAGE: -.. _class_CameraServer_constant_FEED_YCbCr_IMAGE: +.. _class_CameraServer_constant_FEED_YCBCR_IMAGE: .. _class_CameraServer_constant_FEED_Y_IMAGE: -.. _class_CameraServer_constant_FEED_CbCr_IMAGE: +.. _class_CameraServer_constant_FEED_CBCR_IMAGE: enum **FeedImage**: - **FEED_RGBA_IMAGE** = **0** --- The RGBA camera image. -- **FEED_YCbCr_IMAGE** = **0** --- The YCbCr camera image. +- **FEED_YCBCR_IMAGE** = **0** --- The YCbCr camera image. - **FEED_Y_IMAGE** = **0** --- The Y component camera image. -- **FEED_CbCr_IMAGE** = **1** --- The CbCr component camera image. +- **FEED_CBCR_IMAGE** = **1** --- The CbCr component camera image. Method Descriptions ------------------- diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index fc15c9b93..fba3992b0 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -26,6 +26,8 @@ Properties +---------------------------+--------------------------------------------------------------------+ | :ref:`bool` | :ref:`edit_alpha` | +---------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`hsv_mode` | ++---------------------------+--------------------------------------------------------------------+ | :ref:`bool` | :ref:`presets_enabled` | +---------------------------+--------------------------------------------------------------------+ | :ref:`bool` | :ref:`presets_visible` | @@ -134,6 +136,20 @@ If ``true``, the color will apply only after the user releases the mouse button, If ``true``, shows an alpha channel slider (transparency). +.. _class_ColorPicker_property_hsv_mode: + +- :ref:`bool` **hsv_mode** + ++----------+---------------------+ +| *Setter* | set_hsv_mode(value) | ++----------+---------------------+ +| *Getter* | is_hsv_mode() | ++----------+---------------------+ + +If ``true``, allows to edit color with Hue/Saturation/Value sliders. + +**Note:** Cannot be enabled if raw mode is on. + .. _class_ColorPicker_property_presets_enabled: - :ref:`bool` **presets_enabled** @@ -166,6 +182,8 @@ If ``true``, shows an alpha channel slider (transparency). If ``true``, allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). +**Note:** Cannot be enabled if hsv mode is on. + Method Descriptions ------------------- diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 49f2cc0eb..7c7bb4b7b 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -201,21 +201,25 @@ Returns the main loop object (see :ref:`MainLoop` and :ref:`Scen Returns the current engine version information in a Dictionary. -"major" - Holds the major version number as an int +``major`` - Holds the major version number as an int -"minor" - Holds the minor version number as an int +``minor`` - Holds the minor version number as an int -"patch" - Holds the patch version number as an int +``patch`` - Holds the patch version number as an int -"hex" - Holds the full version number encoded as an hexadecimal int with one byte (2 places) per number (see example below) +``hex`` - Holds the full version number encoded as an hexadecimal int with one byte (2 places) per number (see example below) -"status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String +``status`` - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String -"build" - Holds the build name (e.g. "custom-build") as a String +``build`` - Holds the build name (e.g. "custom_build") as a String -"string" - major + minor + patch + status + build in a single String +``hash`` - Holds the full Git commit hash as a String -The "hex" value is encoded as follows, from left to right: one byte for the major, one byte for the minor, one byte for the patch version. For example, "3.1.12" would be ``0x03010C``. Note that it's still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for easy version comparisons from code: +``year`` - Holds the year the version was released in as an int + +``string`` - ``major`` + ``minor`` + ``patch`` + ``status`` + ``build`` in a single String + +The ``hex`` value is encoded as follows, from left to right: one byte for the major, one byte for the minor, one byte for the patch version. For example, "3.1.12" would be ``0x03010C``. Note that it's still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for easy version comparisons from code: :: diff --git a/classes/class_file.rst b/classes/class_file.rst index fdcc319ed..cdc44e9dd 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -282,7 +282,7 @@ Returns the next 64 bits from the file as a floating point number. - :ref:`Error` **get_error** **(** **)** const -Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`@GlobalScope`. +Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`Error`. .. _class_File_method_get_float: @@ -378,7 +378,7 @@ Opens the file for writing or reading, depending on the flags. - :ref:`Error` **open_compressed** **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`CompressionMode` compression_mode=0 **)** -Opens a compressed file for reading or writing. Use COMPRESSION\_\* constants to set ``compression_mode``. +Opens a compressed file for reading or writing. Use :ref:`CompressionMode` constants to set ``compression_mode``. .. _class_File_method_open_encrypted: diff --git a/classes/class_gdnativelibraryresourceloader.rst b/classes/class_gdnativelibraryresourceloader.rst deleted file mode 100644 index 785460a22..000000000 --- a/classes/class_gdnativelibraryresourceloader.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the GDNativeLibraryResourceLoader.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_GDNativeLibraryResourceLoader: - -GDNativeLibraryResourceLoader -============================= - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_gdnativelibraryresourcesaver.rst b/classes/class_gdnativelibraryresourcesaver.rst deleted file mode 100644 index 4cb716f03..000000000 --- a/classes/class_gdnativelibraryresourcesaver.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the GDNativeLibraryResourceSaver.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_GDNativeLibraryResourceSaver: - -GDNativeLibraryResourceSaver -============================ - -**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 2d529780a..2e2fdd270 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -28,6 +28,8 @@ Methods +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_local_interfaces` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ResolverStatus` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | @@ -117,6 +119,23 @@ Removes a given item "id" from the queue. This should be used to free a queue af Returns all of the user's current IPv4 and IPv6 addresses as an array. +.. _class_IP_method_get_local_interfaces: + +- :ref:`Array` **get_local_interfaces** **(** **)** const + +Returns all network adapters as an array. + +Each adapter is a dictionary of the form: + +:: + + { + "index": "1", # Interface index. + "name": "eth0", # Interface name. + "friendly": "Ethernet One", # A friendly name (might be empty). + "addresses": ["192.168.1.101"], # An array of IP addresses associated to this interface. + } + .. _class_IP_method_get_resolve_item_address: - :ref:`String` **get_resolve_item_address** **(** :ref:`int` id **)** const diff --git a/classes/class_object.rst b/classes/class_object.rst index 3ca7965a5..bad84fbf3 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -426,6 +426,8 @@ If set to ``true``, signal emission is blocked. - void **set_deferred** **(** :ref:`String` property, :ref:`Variant` value **)** +Set property into the object, after the current frame's physics step. This is equivalent to calling :ref:`set` via :ref:`call_deferred`, i.e. ``call_deferred("set", [property, value])``. + .. _class_Object_method_set_indexed: - void **set_indexed** **(** :ref:`NodePath` property, :ref:`Variant` value **)** diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index dcfb8211f..e96a7dc92 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -19,21 +19,25 @@ UDP packet peer. Methods ------- -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_port` **(** **)** const | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`wait` **(** **)** | -+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_port` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_listening` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`join_multicast_group` **(** :ref:`String` multicast_address, :ref:`String` interface_name **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`leave_multicast_group` **(** :ref:`String` multicast_address, :ref:`String` interface_name **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`wait` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -67,6 +71,20 @@ Returns the port of the remote peer that sent the last packet(that was received Returns whether this ``PacketPeerUDP`` is listening. +.. _class_PacketPeerUDP_method_join_multicast_group: + +- :ref:`Error` **join_multicast_group** **(** :ref:`String` multicast_address, :ref:`String` interface_name **)** + +Join the multicast group specified by ``multicast_address`` using the interface identified by ``interface_name``. + +You can join the same multicast group with multiple interfaces. Use :ref:`IP.get_local_interfaces` to know which are available. + +.. _class_PacketPeerUDP_method_leave_multicast_group: + +- :ref:`Error` **leave_multicast_group** **(** :ref:`String` multicast_address, :ref:`String` interface_name **)** + +Remove the interface identified by ``interface_name`` from the multicast group specified by ``multicast_address``. + .. _class_PacketPeerUDP_method_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** diff --git a/classes/class_reference.rst b/classes/class_reference.rst index a8baf36c6..7b164cfab 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -9,7 +9,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`ARVRInterface`, :ref:`AStar`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`ConfigFile`, :ref:`Directory`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorImportPlugin`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`FuncRef`, :ref:`GDNative`, :ref:`GDScriptFunctionState`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`JSONParseResult`, :ref:`KinematicCollision`, :ref:`KinematicCollision2D`, :ref:`Marshalls`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`Physics2DShapeQueryParameters`, :ref:`Physics2DShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`PhysicsShapeQueryParameters`, :ref:`PhysicsShapeQueryResult`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`ResourceInteractiveLoader`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SpatialGizmo`, :ref:`SpatialVelocityTracker`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCP_Server`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser` +**Inherited By:** :ref:`ARVRInterface`, :ref:`AStar`, :ref:`AStar2D`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`ConfigFile`, :ref:`Directory`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorImportPlugin`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`FuncRef`, :ref:`GDNative`, :ref:`GDScriptFunctionState`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`JSONParseResult`, :ref:`KinematicCollision`, :ref:`KinematicCollision2D`, :ref:`Marshalls`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`Physics2DShapeQueryParameters`, :ref:`Physics2DShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`PhysicsShapeQueryParameters`, :ref:`PhysicsShapeQueryResult`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceInteractiveLoader`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SpatialGizmo`, :ref:`SpatialVelocityTracker`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCP_Server`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser` **Category:** Core diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index 6b50734de..57af07d9c 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -26,7 +26,7 @@ Properties Description ----------- -Reference frame for GUI. It's just like an empty control, except a red box is displayed while editing around its size at all times. +Reference frame for GUI. It's just like an empty control, except an outline border :ref:`border_color` is displayed while editing around its size at all times. Property Descriptions --------------------- @@ -41,3 +41,5 @@ Property Descriptions | *Getter* | get_border_color() | +----------+-------------------------+ +Determines the border :ref:`Color` of the ``ReferenceRect``. + diff --git a/classes/class_resource.rst b/classes/class_resource.rst index fa9e3a38e..7898fcb74 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -56,7 +56,7 @@ Signals Description ----------- -Resource is the base class for all resource types, serving primarily as data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a :ref:`Node`, which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a :ref:`Node` or another resource. +Resource is the base class for all Godot-specific resource types, serving primarily as data containers. They are reference counted and freed when no longer in use. They are also cached once loaded from disk, so that any further attempts to load a resource from a given path will return the same reference (all this in contrast to a :ref:`Node`, which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a :ref:`Node` or another resource. Tutorials --------- @@ -76,6 +76,8 @@ Property Descriptions | *Getter* | is_local_to_scene() | +----------+---------------------------+ +If ``true``, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene. + .. _class_Resource_property_resource_name: - :ref:`String` **resource_name** @@ -107,6 +109,8 @@ Method Descriptions - void **_setup_local_to_scene** **(** **)** virtual +Virtual function which can be overridden to customize the behavior value of :ref:`setup_local_to_scene`. + .. _class_Resource_method_duplicate: - :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** const @@ -117,6 +121,8 @@ Duplicates the resource, returning a new resource. By default, sub-resources are - :ref:`Node` **get_local_scene** **(** **)** const +If :ref:`resource_local_to_scene` is enabled and the resource was loaded from a :ref:`PackedScene` instantiation, returns the local scene where this resource's unique copy is in use. Otherwise, returns ``null``. + .. _class_Resource_method_get_rid: - :ref:`RID` **get_rid** **(** **)** const @@ -127,9 +133,13 @@ Returns the RID of the resource (or an empty RID). Many resources (such as :ref: - void **setup_local_to_scene** **(** **)** +This method is called when a resource with :ref:`resource_local_to_scene` enabled is loaded from a :ref:`PackedScene` instantiation. Its behavior can be customized by overriding :ref:`_setup_local_to_scene` from script. + +For most resources, this method performs no base logic. :ref:`ViewportTexture` performs custom logic to properly set the proxy texture and flags in the local viewport. + .. _class_Resource_method_take_over_path: - void **take_over_path** **(** :ref:`String` path **)** -Sets the path of the resource. Differs from ``set_path()``, if another ``Resource`` exists with "path" it over-takes it, instead of failing. +Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting :ref:`resource_path`, as the latter would error out if another resource was already cached for the given path. diff --git a/classes/class_resourceformatdds.rst b/classes/class_resourceformatdds.rst deleted file mode 100644 index 8181b2277..000000000 --- a/classes/class_resourceformatdds.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatDDS.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatDDS: - -ResourceFormatDDS -================= - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatimporter.rst b/classes/class_resourceformatimporter.rst deleted file mode 100644 index 1ebb7b6fa..000000000 --- a/classes/class_resourceformatimporter.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatImporter.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatImporter: - -ResourceFormatImporter -====================== - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index c1a59525d..45ad6a9f7 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -9,8 +9,6 @@ ResourceFormatLoader **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`GDNativeLibraryResourceLoader`, :ref:`ResourceFormatDDS`, :ref:`ResourceFormatImporter`, :ref:`ResourceFormatLoaderBMFont`, :ref:`ResourceFormatLoaderBinary`, :ref:`ResourceFormatLoaderDynamicFont`, :ref:`ResourceFormatLoaderGDScript`, :ref:`ResourceFormatLoaderImage`, :ref:`ResourceFormatLoaderNativeScript`, :ref:`ResourceFormatLoaderShader`, :ref:`ResourceFormatLoaderStreamTexture`, :ref:`ResourceFormatLoaderText`, :ref:`ResourceFormatLoaderTextureLayered`, :ref:`ResourceFormatLoaderTheora`, :ref:`ResourceFormatLoaderVideoStreamGDNative`, :ref:`ResourceFormatLoaderWebm`, :ref:`ResourceFormatPKM`, :ref:`ResourceFormatPVR`, :ref:`TranslationLoaderPO` - **Category:** Core Brief Description @@ -38,11 +36,11 @@ Methods Description ----------- -Godot loads resources in the editor or in exported games using ResourceFormatLoaders. They get queried when you call ``load``, or when a resource with internal dependencies is loaded. Each file type may load as a different resource type, so multiple ResourceFormatLoader are registered in the engine. +Godot loads resources in the editor or in exported games using ResourceFormatLoaders. They are queried automatically via the :ref:`ResourceLoader` singleton, or when a resource with internal dependencies is loaded. Each file type may load as a different resource type, so multiple ResourceFormatLoaders are registered in the engine. -Extending this class allows you to define your own. You should give it a global class name with ``class_name`` for it to be registered. You may as well implement a :ref:`ResourceFormatSaver`. +Extending this class allows you to define your own loader. Be sure to respect the documented return types and values. You should give it a global class name with ``class_name`` for it to be registered. Like built-in ResourceFormatLoaders, it will be called automatically when loading resources of its handled type(s). You may also implement a :ref:`ResourceFormatSaver`. -Note: You can also extend :ref:`EditorImportPlugin` if the resource type you need exists but Godot is unable to load its format. Choosing one way over another depends if the format is suitable or not for the final exported game. Example: it's better to import .PNG textures as .STEX first, so they can be loaded with better efficiency on the graphics card. +Note: You can also extend :ref:`EditorImportPlugin` if the resource type you need exists but Godot is unable to load its format. Choosing one way over another depends if the format is suitable or not for the final exported game. For example, it's better to import ``.png`` textures as ``.stex`` (:ref:`StreamTexture`) first, so they can be loaded with better efficiency on the graphics card. Method Descriptions ------------------- @@ -51,7 +49,7 @@ Method Descriptions - void **get_dependencies** **(** :ref:`String` path, :ref:`String` add_types **)** virtual -If implemented, gets the dependencies of a given resource. If ``add_types`` is ``true``, paths should be appended ``::TypeName``, where ``TypeName`` is the class name of the dependency. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB`, so you might just return ``Resource`` for them. +If implemented, gets the dependencies of a given resource. If ``add_types`` is ``true``, paths should be appended ``::TypeName``, where ``TypeName`` is the class name of the dependency. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB`, so you might just return ``"Resource"`` for them. .. _class_ResourceFormatLoader_method_get_recognized_extensions: @@ -75,11 +73,13 @@ Tells which resource class this loader can load. Note that custom resource types - :ref:`Variant` **load** **(** :ref:`String` path, :ref:`String` original_path **)** virtual -Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, ``original_path`` will target the source file. Returns a resource object if succeeded, or an ``ERR_*`` constant listed in :ref:`@GlobalScope` if it failed. +Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, ``original_path`` will target the source file. Returns a :ref:`Resource` object on success, or an :ref:`Error` constant in case of failure. .. _class_ResourceFormatLoader_method_rename_dependencies: - :ref:`int` **rename_dependencies** **(** :ref:`String` path, :ref:`String` renames **)** virtual -If implemented, renames dependencies within the given resource and saves it. ``renames`` is a dictionary ``{ String => String }`` mapping old dependency paths to new paths. Returns ``OK`` on success, or an ``ERR_*`` constant listed in :ref:`@GlobalScope` in case of failure. +If implemented, renames dependencies within the given resource and saves it. ``renames`` is a dictionary ``{ String => String }`` mapping old dependency paths to new paths. + +Returns :ref:`@GlobalScope.OK` on success, or an :ref:`Error` constant in case of failure. diff --git a/classes/class_resourceformatloaderbinary.rst b/classes/class_resourceformatloaderbinary.rst deleted file mode 100644 index 2c21ec603..000000000 --- a/classes/class_resourceformatloaderbinary.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderBinary.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderBinary: - -ResourceFormatLoaderBinary -========================== - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloaderbmfont.rst b/classes/class_resourceformatloaderbmfont.rst deleted file mode 100644 index e7df15722..000000000 --- a/classes/class_resourceformatloaderbmfont.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderBMFont.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderBMFont: - -ResourceFormatLoaderBMFont -========================== - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloaderdynamicfont.rst b/classes/class_resourceformatloaderdynamicfont.rst deleted file mode 100644 index 8c4dbc2f7..000000000 --- a/classes/class_resourceformatloaderdynamicfont.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderDynamicFont.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderDynamicFont: - -ResourceFormatLoaderDynamicFont -=============================== - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloadergdscript.rst b/classes/class_resourceformatloadergdscript.rst deleted file mode 100644 index 568fa1c7b..000000000 --- a/classes/class_resourceformatloadergdscript.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderGDScript.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderGDScript: - -ResourceFormatLoaderGDScript -============================ - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloaderimage.rst b/classes/class_resourceformatloaderimage.rst deleted file mode 100644 index fe09aa7cb..000000000 --- a/classes/class_resourceformatloaderimage.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderImage.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderImage: - -ResourceFormatLoaderImage -========================= - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloadernativescript.rst b/classes/class_resourceformatloadernativescript.rst deleted file mode 100644 index e1a6414df..000000000 --- a/classes/class_resourceformatloadernativescript.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderNativeScript.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderNativeScript: - -ResourceFormatLoaderNativeScript -================================ - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloadershader.rst b/classes/class_resourceformatloadershader.rst deleted file mode 100644 index 500efe0eb..000000000 --- a/classes/class_resourceformatloadershader.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderShader.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderShader: - -ResourceFormatLoaderShader -========================== - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloaderstreamtexture.rst b/classes/class_resourceformatloaderstreamtexture.rst deleted file mode 100644 index 1835601ef..000000000 --- a/classes/class_resourceformatloaderstreamtexture.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderStreamTexture.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderStreamTexture: - -ResourceFormatLoaderStreamTexture -================================= - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloadertext.rst b/classes/class_resourceformatloadertext.rst deleted file mode 100644 index 877027091..000000000 --- a/classes/class_resourceformatloadertext.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderText.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderText: - -ResourceFormatLoaderText -======================== - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloadertexturelayered.rst b/classes/class_resourceformatloadertexturelayered.rst deleted file mode 100644 index e758f18a4..000000000 --- a/classes/class_resourceformatloadertexturelayered.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderTextureLayered.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderTextureLayered: - -ResourceFormatLoaderTextureLayered -================================== - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloadertheora.rst b/classes/class_resourceformatloadertheora.rst deleted file mode 100644 index 72b93c1e8..000000000 --- a/classes/class_resourceformatloadertheora.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderTheora.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderTheora: - -ResourceFormatLoaderTheora -========================== - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloadervideostreamgdnative.rst b/classes/class_resourceformatloadervideostreamgdnative.rst deleted file mode 100644 index 1241208f6..000000000 --- a/classes/class_resourceformatloadervideostreamgdnative.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderVideoStreamGDNative.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderVideoStreamGDNative: - -ResourceFormatLoaderVideoStreamGDNative -======================================= - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatloaderwebm.rst b/classes/class_resourceformatloaderwebm.rst deleted file mode 100644 index f6f1bdc3a..000000000 --- a/classes/class_resourceformatloaderwebm.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderWebm.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatLoaderWebm: - -ResourceFormatLoaderWebm -======================== - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatpkm.rst b/classes/class_resourceformatpkm.rst deleted file mode 100644 index 316db0aad..000000000 --- a/classes/class_resourceformatpkm.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatPKM.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatPKM: - -ResourceFormatPKM -================= - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatpvr.rst b/classes/class_resourceformatpvr.rst deleted file mode 100644 index 76d986601..000000000 --- a/classes/class_resourceformatpvr.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatPVR.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatPVR: - -ResourceFormatPVR -================= - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index d75364224..5ea1eb8f9 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -9,8 +9,6 @@ ResourceFormatSaver **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`GDNativeLibraryResourceSaver`, :ref:`ResourceFormatSaverBinary`, :ref:`ResourceFormatSaverGDScript`, :ref:`ResourceFormatSaverNativeScript`, :ref:`ResourceFormatSaverShader`, :ref:`ResourceFormatSaverText`, :ref:`ResourceSaverPNG` - **Category:** Core Brief Description @@ -32,9 +30,9 @@ Methods Description ----------- -The engine can save resources when you do it from the editor, or when you call :ref:`ResourceSaver.save`. This is accomplished with multiple ``ResourceFormatSaver``\ s, each handling its own format. +The engine can save resources when you do it from the editor, or when you use the :ref:`ResourceSaver` singleton. This is accomplished thanks to multiple ``ResourceFormatSaver``\ s, each handling its own format and called automatically by the engine. -By default, Godot saves resources as ``.tres``, ``.res`` or another built-in format, but you can choose to create your own format by extending this class. You should give it a global class name with ``class_name`` for it to be registered. You may as well implement a :ref:`ResourceFormatLoader`. +By default, Godot saves resources as ``.tres`` (text-based), ``.res`` (binary) or another built-in format, but you can choose to create your own format by extending this class. Be sure to respect the documented return types and values. You should give it a global class name with ``class_name`` for it to be registered. Like built-in ResourceFormatSavers, it will be called automatically when saving resources of its recognized type(s). You may also implement a :ref:`ResourceFormatLoader`. Method Descriptions ------------------- @@ -43,17 +41,19 @@ Method Descriptions - :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` resource **)** virtual -Gets the list of extensions for files this saver is able to write. +Returns the list of extensions available for saving the resource object, provided it is recognized (see :ref:`recognize`). .. _class_ResourceFormatSaver_method_recognize: - :ref:`bool` **recognize** **(** :ref:`Resource` resource **)** virtual -Returns ``true`` if the given resource object can be saved by this saver. +Returns whether the given resource object can be saved by this saver. .. _class_ResourceFormatSaver_method_save: - :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags **)** virtual -Saves the given resource object to a file. ``flags`` is a bitmask composed with ``FLAG_*`` constants defined in :ref:`ResourceSaver`. Returns ``OK`` on success, or an ``ERR_*`` constant listed in :ref:`@GlobalScope` if it failed. +Saves the given resource object to a file at the target ``path``. ``flags`` is a bitmask composed with :ref:`SaverFlags` constants. + +Returns :ref:`@GlobalScope.OK` on success, or an :ref:`Error` constant in case of failure. diff --git a/classes/class_resourceformatsaverbinary.rst b/classes/class_resourceformatsaverbinary.rst deleted file mode 100644 index 6a2a608aa..000000000 --- a/classes/class_resourceformatsaverbinary.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatSaverBinary.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatSaverBinary: - -ResourceFormatSaverBinary -========================= - -**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatsavergdscript.rst b/classes/class_resourceformatsavergdscript.rst deleted file mode 100644 index 03d309ffc..000000000 --- a/classes/class_resourceformatsavergdscript.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatSaverGDScript.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatSaverGDScript: - -ResourceFormatSaverGDScript -=========================== - -**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatsavernativescript.rst b/classes/class_resourceformatsavernativescript.rst deleted file mode 100644 index 786d930f6..000000000 --- a/classes/class_resourceformatsavernativescript.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatSaverNativeScript.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatSaverNativeScript: - -ResourceFormatSaverNativeScript -=============================== - -**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatsavershader.rst b/classes/class_resourceformatsavershader.rst deleted file mode 100644 index 186305147..000000000 --- a/classes/class_resourceformatsavershader.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatSaverShader.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatSaverShader: - -ResourceFormatSaverShader -========================= - -**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceformatsavertext.rst b/classes/class_resourceformatsavertext.rst deleted file mode 100644 index ee7126928..000000000 --- a/classes/class_resourceformatsavertext.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceFormatSaverText.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceFormatSaverText: - -ResourceFormatSaverText -======================= - -**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst deleted file mode 100644 index b00d8b7d6..000000000 --- a/classes/class_resourceimporter.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceImporter.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceImporter: - -ResourceImporter -================ - -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`ResourceImporterOGGVorbis` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceimporteroggvorbis.rst b/classes/class_resourceimporteroggvorbis.rst deleted file mode 100644 index 51015b364..000000000 --- a/classes/class_resourceimporteroggvorbis.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceImporterOGGVorbis.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceImporterOGGVorbis: - -ResourceImporterOGGVorbis -========================= - -**Inherits:** :ref:`ResourceImporter` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index d0de78bd9..b01c18027 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -14,7 +14,7 @@ ResourceInteractiveLoader Brief Description ----------------- -Interactive Resource Loader. +Interactive :ref:`Resource` loader. Methods ------- @@ -34,7 +34,7 @@ Methods Description ----------- -Interactive Resource Loader. This object is returned by ResourceLoader when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying load bars/percentages. +Interactive :ref:`Resource` loader. This object is returned by :ref:`ResourceLoader` when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying loading bars/percentages. Method Descriptions ------------------- @@ -43,13 +43,13 @@ Method Descriptions - :ref:`Resource` **get_resource** **(** **)** -Returns the loaded resource (only if loaded). Otherwise, returns null. +Returns the loaded resource if the load operation completed successfully, ``null`` otherwise. .. _class_ResourceInteractiveLoader_method_get_stage: - :ref:`int` **get_stage** **(** **)** const -Returns the load stage. The total amount of stages can be queried with :ref:`get_stage_count` +Returns the load stage. The total amount of stages can be queried with :ref:`get_stage_count`. .. _class_ResourceInteractiveLoader_method_get_stage_count: @@ -61,9 +61,21 @@ Returns the total amount of stages (calls to :ref:`poll` **poll** **(** **)** -Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling :ref:`get_resource`. +Polls the loading operation, i.e. loads a data chunk up to the next stage. + +Returns :ref:`@GlobalScope.OK` if the poll is successful but the load operation has not finished yet (intermediate stage). This means :ref:`poll` will have to be called again until the last stage is completed. + +Returns :ref:`@GlobalScope.ERR_FILE_EOF` if the load operation has completed successfully. The loaded resource can be obtained by calling :ref:`get_resource`. + +Returns another :ref:`Error` code if the poll has failed. .. _class_ResourceInteractiveLoader_method_wait: - :ref:`Error` **wait** **(** **)** +Polls the loading operation successively until the resource is completely loaded or a :ref:`poll` fails. + +Returns :ref:`@GlobalScope.ERR_FILE_EOF` if the load operation has completed successfully. The loaded resource can be obtained by calling :ref:`get_resource`. + +Returns another :ref:`Error` code if a poll has failed, aborting the operation. + diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 1a2e79564..ee7b6d082 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -14,7 +14,7 @@ ResourceLoader Brief Description ----------------- -Resource Loader. +Singleton used to load resource files. Methods ------- @@ -40,7 +40,11 @@ Methods Description ----------- -Resource Loader. This is a static object accessible as ``ResourceLoader``. GDScript has a simplified load() function, though. +Singleton used to load resource files from the filesystem. + +It uses the many :ref:`ResourceFormatLoader` classes registered in the engine (either built-in or from a plugin) to load files into memory and convert them to a format that can be used by the engine. + +GDScript has a simplified :ref:`@GDScript.load` built-in method which can be used in most situations, leaving the use of ``ResourceLoader`` for more advanced scenarios. Method Descriptions ------------------- @@ -49,10 +53,16 @@ Method Descriptions - :ref:`bool` **exists** **(** :ref:`String` path, :ref:`String` type_hint="" **)** +Returns whether a recognized resource exists for the given ``path``. + +An optional ``type_hint`` can be used to further specify the :ref:`Resource` type that should be handled by the :ref:`ResourceFormatLoader`. + .. _class_ResourceLoader_method_get_dependencies: - :ref:`PoolStringArray` **get_dependencies** **(** :ref:`String` path **)** +Returns the dependencies for the resource at the given ``path``. + .. _class_ResourceLoader_method_get_recognized_extensions_for_type: - :ref:`PoolStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** @@ -63,19 +73,37 @@ Returns the list of recognized extensions for a resource type. - :ref:`bool` **has** **(** :ref:`String` path **)** +Deprecated method. Use :ref:`has_cached` or :ref:`exists` instead. + .. _class_ResourceLoader_method_has_cached: - :ref:`bool` **has_cached** **(** :ref:`String` path **)** +Returns whether a cached resource is available for the given ``path``. + +Once a resource has been loaded by the engine, it is cached in memory for faster access, and future calls to the :ref:`load` or :ref:`load_interactive` methods will use the cached version. The cached resource can be overridden by using :ref:`Resource.take_over_path` on a new resource for that same path. + .. _class_ResourceLoader_method_load: - :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` no_cache=false **)** +Loads a resource at the given ``path``, caching the result for further access. + +The registered :ref:`ResourceFormatLoader`\ s are queried sequentially to find the first one which can handle the file's extension, and then attempt loading. If loading fails, the remaining ResourceFormatLoaders are also attempted. + +An optional ``type_hint`` can be used to further specify the :ref:`Resource` type that should be handled by the :ref:`ResourceFormatLoader`. + +If ``no_cache`` is ``true``, the resource cache will be bypassed and the resource will be loaded anew. Otherwise, the cached resource will be returned if it exists. + +Returns an empty resource if no ResourceFormatLoader could handle the file. + .. _class_ResourceLoader_method_load_interactive: - :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** -Load a resource interactively, the returned object allows to load with high granularity. +Starts loading a resource interactively. The returned :ref:`ResourceInteractiveLoader` object allows to load with high granularity, calling its :ref:`ResourceInteractiveLoader.poll` method successively to load chunks. + +An optional ``type_hint`` can be used to further specify the :ref:`Resource` type that should be handled by the :ref:`ResourceFormatLoader`. .. _class_ResourceLoader_method_set_abort_on_missing_resources: diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index 80f5593da..03785b40f 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -38,6 +38,8 @@ Description This node is used to preload sub-resources inside a scene, so when the scene is loaded, all the resources are ready to use and can be retrieved from the preloader. +GDScript has a simplified :ref:`@GDScript.preload` built-in method which can be used in most situations, leaving the use of ``ResourcePreloader`` for more advanced scenarios. + Method Descriptions ------------------- diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 3dfffff44..16e671501 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -14,7 +14,7 @@ ResourceSaver Brief Description ----------------- -Resource saving interface. +Singleton for saving Godot-specific resource types. Methods ------- @@ -46,24 +46,26 @@ Enumerations enum **SaverFlags**: -- **FLAG_RELATIVE_PATHS** = **1** +- **FLAG_RELATIVE_PATHS** = **1** --- Save the resource with a path relative to the scene which uses it. -- **FLAG_BUNDLE_RESOURCES** = **2** +- **FLAG_BUNDLE_RESOURCES** = **2** --- Bundles external resources. -- **FLAG_CHANGE_PATH** = **4** +- **FLAG_CHANGE_PATH** = **4** --- Change the :ref:`Resource.resource_path` of the saved resource to match its new location. -- **FLAG_OMIT_EDITOR_PROPERTIES** = **8** +- **FLAG_OMIT_EDITOR_PROPERTIES** = **8** --- Do not save editor-specific metadata (identified by their ``__editor`` prefix). -- **FLAG_SAVE_BIG_ENDIAN** = **16** +- **FLAG_SAVE_BIG_ENDIAN** = **16** --- Save as big endian (see :ref:`File.endian_swap`). -- **FLAG_COMPRESS** = **32** +- **FLAG_COMPRESS** = **32** --- Compress the resource on save using :ref:`File.COMPRESSION_ZSTD`. Only available for binary resource types. -- **FLAG_REPLACE_SUBRESOURCE_PATHS** = **64** +- **FLAG_REPLACE_SUBRESOURCE_PATHS** = **64** --- Take over the paths of the saved subresources (see :ref:`Resource.take_over_path`). Description ----------- -Resource saving interface, used for saving resources to disk. +Singleton for saving Godot-specific resource types to the filesystem. + +It uses the many :ref:`ResourceFormatSaver` classes registered in the engine (either built-in or from a plugin) to save engine-specific resource data to text-based (e.g. ``.tres`` or ``.tscn``) or binary files (e.g. ``.res`` or ``.scn``). Method Descriptions ------------------- @@ -78,5 +80,9 @@ Returns the list of extensions available for saving a resource of a given type. - :ref:`Error` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`SaverFlags` flags=0 **)** -Saves a resource to disk. +Saves a resource to disk to the given path, using a :ref:`ResourceFormatSaver` that recognizes the resource object. + +The ``flags`` bitmask can be specified to customize the save behavior. + +Returns :ref:`@GlobalScope.OK` on success. diff --git a/classes/class_resourcesaverpng.rst b/classes/class_resourcesaverpng.rst deleted file mode 100644 index ce1866581..000000000 --- a/classes/class_resourcesaverpng.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceSaverPNG.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceSaverPNG: - -ResourceSaverPNG -================ - -**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index efc570673..07cdc42f6 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -241,3 +241,7 @@ Returns a :ref:`Rect2` representing the Sprite's boundary in local - :ref:`bool` **is_pixel_opaque** **(** :ref:`Vector2` pos **)** const +Returns ``true``, if the pixel at the given position is opaque and ``false`` in other case. + +Note: It also returns ``false``, if the sprite's texture is null or if the given position is invalid. + diff --git a/classes/class_string.rst b/classes/class_string.rst index f97895bfd..27286d97b 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -106,6 +106,10 @@ Methods +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hex_to_int` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`http_escape` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`http_unescape` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_abs_path` **(** **)** | @@ -188,7 +192,7 @@ Methods +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`strip_escapes` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len **)** | +| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len=-1 **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`to_ascii` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -442,6 +446,14 @@ Hashes the string and returns a 32-bit integer. Converts a string containing a hexadecimal number into an integer. +.. _class_String_method_http_escape: + +- :ref:`String` **http_escape** **(** **)** + +.. _class_String_method_http_unescape: + +- :ref:`String` **http_unescape** **(** **)** + .. _class_String_method_insert: - :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** @@ -704,9 +716,9 @@ Returns a copy of the string stripped of any escape character. These include all .. _class_String_method_substr: -- :ref:`String` **substr** **(** :ref:`int` from, :ref:`int` len **)** +- :ref:`String` **substr** **(** :ref:`int` from, :ref:`int` len=-1 **)** -Returns part of the string from the position ``from`` with length ``len``. +Returns part of the string from the position ``from`` with length ``len``. Argument ``len`` is optional and using -1 will return remaining characters from given position. .. _class_String_method_to_ascii: diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 2951112f5..8629525d9 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -71,6 +71,8 @@ Methods +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_fold` **(** :ref:`int` line **)** const | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_viewport_to_cursor` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_colors` **(** **)** | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_undo_history` **(** **)** | @@ -592,6 +594,10 @@ Add a ``keyword`` and its :ref:`Color`. Returns if the given line is foldable, that is, it has indented lines right below it. +.. _class_TextEdit_method_center_viewport_to_cursor: + +- void **center_viewport_to_cursor** **(** **)** + .. _class_TextEdit_method_clear_colors: - void **clear_colors** **(** **)** diff --git a/classes/class_translationloaderpo.rst b/classes/class_translationloaderpo.rst deleted file mode 100644 index dba29221d..000000000 --- a/classes/class_translationloaderpo.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the TranslationLoaderPO.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_TranslationLoaderPO: - -TranslationLoaderPO -=================== - -**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_visualshadernodegroupbase.rst b/classes/class_visualshadernodegroupbase.rst index 899661b2b..4cd4abce8 100644 --- a/classes/class_visualshadernodegroupbase.rst +++ b/classes/class_visualshadernodegroupbase.rst @@ -50,6 +50,8 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_output_port` **(** :ref:`int` id **)** const | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_port_name` **(** :ref:`String` name **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_input_port` **(** :ref:`int` id **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_output_port` **(** :ref:`int` id **)** | @@ -130,6 +132,10 @@ Method Descriptions - :ref:`bool` **has_output_port** **(** :ref:`int` id **)** const +.. _class_VisualShaderNodeGroupBase_method_is_valid_port_name: + +- :ref:`bool` **is_valid_port_name** **(** :ref:`String` name **)** const + .. _class_VisualShaderNodeGroupBase_method_remove_input_port: - void **remove_input_port** **(** :ref:`int` id **)**