godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-06-24 23:09:46 +02:00
parent c9f8aa1ddc
commit f94046b723
56 changed files with 623 additions and 619 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
classes/class_acceptdialog.rst
View File

@@ -21,6 +21,8 @@ Base dialog for user notification.
Properties
----------
+-----------------------------+-------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`dialog_autowrap<class_AcceptDialog_property_dialog_autowrap>` |
+-----------------------------+-------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`dialog_hide_on_ok<class_AcceptDialog_property_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<class_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<class_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
-------------------

68
classes/class_animationplayer.rst
View File

@@ -19,27 +19,29 @@ Container and player of :ref:`Animation<class_Animation>` resources.
Properties
----------
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`assigned_animation<class_AnimationPlayer_property_assigned_animation>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`autoplay<class_AnimationPlayer_property_autoplay>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`current_animation<class_AnimationPlayer_property_current_animation>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`current_animation_length<class_AnimationPlayer_property_current_animation_length>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`current_animation_position<class_AnimationPlayer_property_current_animation_position>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`playback_active<class_AnimationPlayer_property_playback_active>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`playback_default_blend_time<class_AnimationPlayer_property_playback_default_blend_time>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationPlayer_property_playback_process_mode>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`playback_speed<class_AnimationPlayer_property_playback_speed>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`root_node<class_AnimationPlayer_property_root_node>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`assigned_animation<class_AnimationPlayer_property_assigned_animation>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`autoplay<class_AnimationPlayer_property_autoplay>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`current_animation<class_AnimationPlayer_property_current_animation>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`current_animation_length<class_AnimationPlayer_property_current_animation_length>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`current_animation_position<class_AnimationPlayer_property_current_animation_position>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`AnimationMethodCallMode<enum_AnimationPlayer_AnimationMethodCallMode>` | :ref:`method_call_mode<class_AnimationPlayer_property_method_call_mode>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`playback_active<class_AnimationPlayer_property_playback_active>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`playback_default_blend_time<class_AnimationPlayer_property_playback_default_blend_time>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationPlayer_property_playback_process_mode>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`playback_speed<class_AnimationPlayer_property_playback_speed>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`root_node<class_AnimationPlayer_property_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<enum_AnimationPlayer_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<class_bool>` **playback_active**

20
classes/class_area.rst
View File

@@ -109,25 +109,33 @@ Emitted when another area exits, reporting which areas were overlapping.
- **body_entered** **(** :ref:`Node<class_Node>` body **)**
Emitted when a :ref:`PhysicsBody<class_PhysicsBody>` object enters.
Emitted when a physics body enters.
The ``body`` argument can either be a :ref:`PhysicsBody<class_PhysicsBody>` or a :ref:`GridMap<class_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<class_Node>` body **)**
Emitted when a :ref:`PhysicsBody<class_PhysicsBody>` object exits.
Emitted when a physics body exits.
The ``body`` argument can either be a :ref:`PhysicsBody<class_PhysicsBody>` or a :ref:`GridMap<class_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<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a :ref:`PhysicsBody<class_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<class_PhysicsBody>` or a :ref:`GridMap<class_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<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a :ref:`PhysicsBody<class_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<class_PhysicsBody>` or a :ref:`GridMap<class_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<class_bool>` **overlaps_body** **(** :ref:`Node<class_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<class_PhysicsBody>` or a :ref:`GridMap<class_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:

28
classes/class_area2d.rst
View File

@@ -99,27 +99,35 @@ Emitted when another area exits, reporting which shapes were overlapping.
.. _class_Area2D_signal_body_entered:
- **body_entered** **(** :ref:`PhysicsBody2D<class_PhysicsBody2D>` body **)**
- **body_entered** **(** :ref:`Node<class_Node>` body **)**
Emitted when a :ref:`PhysicsBody2D<class_PhysicsBody2D>` object enters.
Emitted when a physics body enters.
The ``body`` argument can either be a :ref:`PhysicsBody2D<class_PhysicsBody2D>` or a :ref:`TileMap<class_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<class_PhysicsBody2D>` body **)**
- **body_exited** **(** :ref:`Node<class_Node>` body **)**
Emitted when a :ref:`PhysicsBody2D<class_PhysicsBody2D>` object exits.
Emitted when a physics body exits.
The ``body`` argument can either be a :ref:`PhysicsBody2D<class_PhysicsBody2D>` or a :ref:`TileMap<class_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<class_int>` body_id, :ref:`PhysicsBody2D<class_PhysicsBody2D>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a :ref:`PhysicsBody2D<class_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<class_PhysicsBody2D>` or a :ref:`TileMap<class_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<class_int>` body_id, :ref:`PhysicsBody2D<class_PhysicsBody2D>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a :ref:`PhysicsBody2D<class_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<class_PhysicsBody2D>` or a :ref:`TileMap<class_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<class_bool>` **overlaps_body** **(** :ref:`Node<class_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<class_PhysicsBody2D>` or a :ref:`TileMap<class_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:

2
classes/class_astar.rst
View File

@@ -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
-------

246
classes/class_astar2d.rst Normal file
View File

@@ -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/<name>/doc_classes.
.. _class_AStar2D:
AStar2D
=======
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
AStar class representation that uses 2d-vectors as edges.
Methods
-------
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_AStar2D_method_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` weight_scale=1.0 **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar2D_method_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_AStar2D_method_clear>` **(** **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`connect_points<class_AStar2D_method_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_points<class_AStar2D_method_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar2D_method_get_available_point_id>` **(** **)** const |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar2D_method_get_closest_point>` **(** :ref:`Vector2<class_Vector2>` to_position **)** const |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_closest_position_in_segment<class_AStar2D_method_get_closest_position_in_segment>` **(** :ref:`Vector2<class_Vector2>` to_position **)** const |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_id_path<class_AStar2D_method_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_point_connections<class_AStar2D_method_get_point_connections>` **(** :ref:`int<class_int>` id **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`get_point_path<class_AStar2D_method_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_point_position<class_AStar2D_method_get_point_position>` **(** :ref:`int<class_int>` id **)** const |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar2D_method_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_points<class_AStar2D_method_get_points>` **(** **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_point<class_AStar2D_method_has_point>` **(** :ref:`int<class_int>` id **)** const |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_point_disabled<class_AStar2D_method_is_point_disabled>` **(** :ref:`int<class_int>` id **)** const |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_AStar2D_method_remove_point>` **(** :ref:`int<class_int>` id **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_disabled<class_AStar2D_method_set_point_disabled>` **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` disabled=true **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_position<class_AStar2D_method_set_point_position>` **(** :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_weight_scale<class_AStar2D_method_set_point_weight_scale>` **(** :ref:`int<class_int>` id, :ref:`float<class_float>` weight_scale **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
This is a wrapper for the :ref:`AStar<class_AStar>` class which uses 2D vectors instead of 3D vectors.
Method Descriptions
-------------------
.. _class_AStar2D_method_add_point:
- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position, :ref:`float<class_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<class_bool>` **are_points_connected** **(** :ref:`int<class_int>` id, :ref:`int<class_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<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_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<class_int>` id, :ref:`int<class_int>` to_id **)**
Deletes the segment between the given points.
.. _class_AStar2D_method_get_available_point_id:
- :ref:`int<class_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<class_int>` **get_closest_point** **(** :ref:`Vector2<class_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<class_Vector2>` **get_closest_position_in_segment** **(** :ref:`Vector2<class_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<class_PoolIntArray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_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<class_PoolIntArray>` **get_point_connections** **(** :ref:`int<class_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<class_PoolVector2Array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_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<class_Vector2>` **get_point_position** **(** :ref:`int<class_int>` id **)** const
Returns the position of the point associated with the given id.
.. _class_AStar2D_method_get_point_weight_scale:
- :ref:`float<class_float>` **get_point_weight_scale** **(** :ref:`int<class_int>` id **)** const
Returns the weight scale of the point associated with the given id.
.. _class_AStar2D_method_get_points:
- :ref:`Array<class_Array>` **get_points** **(** **)**
Returns an array of all points.
.. _class_AStar2D_method_has_point:
- :ref:`bool<class_bool>` **has_point** **(** :ref:`int<class_int>` id **)** const
Returns whether a point associated with the given id exists.
.. _class_AStar2D_method_is_point_disabled:
- :ref:`bool<class_bool>` **is_point_disabled** **(** :ref:`int<class_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<class_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<class_int>` id, :ref:`bool<class_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<class_int>` id, :ref:`Vector2<class_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<class_int>` id, :ref:`float<class_float>` weight_scale **)**
Sets the ``weight_scale`` for the point with the given id.

61
classes/class_audioeffectpitchshift.rst
View File

@@ -21,9 +21,44 @@ Raises or lowers the pitch of original sound.
Properties
----------
+---------------------------+----------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` |
+---------------------------+----------------------------------------------------------------------+
+------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` | :ref:`fft_size<class_AudioEffectPitchShift_property_fft_size>` |
+------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`oversampling<class_AudioEffectPitchShift_property_oversampling>` |
+------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioEffectPitchShift_property_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<enum_AudioEffectPitchShift_FFT_Size>` **fft_size**
+----------+---------------------+
| *Setter* | set_fft_size(value) |
+----------+---------------------+
| *Getter* | get_fft_size() |
+----------+---------------------+
.. _class_AudioEffectPitchShift_property_oversampling:
- :ref:`int<class_int>` **oversampling**
+----------+-------------------------+
| *Setter* | set_oversampling(value) |
+----------+-------------------------+
| *Getter* | get_oversampling() |
+----------+-------------------------+
.. _class_AudioEffectPitchShift_property_pitch_scale:
- :ref:`float<class_float>` **pitch_scale**

8
classes/class_camerafeed.rst
View File

@@ -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:

8
classes/class_cameraserver.rst
View File

@@ -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
-------------------

18
classes/class_colorpicker.rst
View File

@@ -26,6 +26,8 @@ Properties
+---------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPicker_property_edit_alpha>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`hsv_mode<class_ColorPicker_property_hsv_mode>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`presets_enabled<class_ColorPicker_property_presets_enabled>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`presets_visible<class_ColorPicker_property_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<class_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<class_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
-------------------

20
classes/class_engine.rst
View File

@@ -201,21 +201,25 @@ Returns the main loop object (see :ref:`MainLoop<class_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:
::

4
classes/class_file.rst
View File

@@ -282,7 +282,7 @@ Returns the next 64 bits from the file as a floating point number.
- :ref:`Error<enum_@GlobalScope_Error>` **get_error** **(** **)** const
Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`@GlobalScope<class_@GlobalScope>`.
Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`Error<enum_@GlobalScope_Error>`.
.. _class_File_method_get_float:
@@ -378,7 +378,7 @@ Opens the file for writing or reading, depending on the flags.
- :ref:`Error<enum_@GlobalScope_Error>` **open_compressed** **(** :ref:`String<class_String>` path, :ref:`ModeFlags<enum_File_ModeFlags>` mode_flags, :ref:`CompressionMode<enum_File_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<enum_File_CompressionMode>` constants to set ``compression_mode``.
.. _class_File_method_open_encrypted:

18
classes/class_gdnativelibraryresourceloader.rst
View File

@@ -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/<name>/doc_classes.
.. _class_GDNativeLibraryResourceLoader:
GDNativeLibraryResourceLoader
=============================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_gdnativelibraryresourcesaver.rst
View File

@@ -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/<name>/doc_classes.
.. _class_GDNativeLibraryResourceSaver:
GDNativeLibraryResourceSaver
============================
**Inherits:** :ref:`ResourceFormatSaver<class_ResourceFormatSaver>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

19
classes/class_ip.rst
View File

@@ -28,6 +28,8 @@ Methods
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_local_addresses<class_IP_method_get_local_addresses>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_local_interfaces<class_IP_method_get_local_interfaces>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_resolve_item_address<class_IP_method_get_resolve_item_address>` **(** :ref:`int<class_int>` id **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ResolverStatus<enum_IP_ResolverStatus>` | :ref:`get_resolve_item_status<class_IP_method_get_resolve_item_status>` **(** :ref:`int<class_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<class_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<class_String>` **get_resolve_item_address** **(** :ref:`int<class_int>` id **)** const

2
classes/class_object.rst
View File

@@ -426,6 +426,8 @@ If set to ``true``, signal emission is blocked.
- void **set_deferred** **(** :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)**
Set property into the object, after the current frame's physics step. This is equivalent to calling :ref:`set<class_Object_method_set>` via :ref:`call_deferred<class_Object_method_call_deferred>`, i.e. ``call_deferred("set", [property, value])``.
.. _class_Object_method_set_indexed:
- void **set_indexed** **(** :ref:`NodePath<class_NodePath>` property, :ref:`Variant<class_Variant>` value **)**

48
classes/class_packetpeerudp.rst
View File

@@ -19,21 +19,25 @@ UDP packet peer.
Methods
-------
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`close<class_PacketPeerUDP_method_close>` **(** **)** |
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_packet_ip<class_PacketPeerUDP_method_get_packet_ip>` **(** **)** const |
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_packet_port<class_PacketPeerUDP_method_get_packet_port>` **(** **)** const |
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_listening<class_PacketPeerUDP_method_is_listening>` **(** **)** const |
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`listen<class_PacketPeerUDP_method_listen>` **(** :ref:`int<class_int>` port, :ref:`String<class_String>` bind_address="*", :ref:`int<class_int>` recv_buf_size=65536 **)** |
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`set_dest_address<class_PacketPeerUDP_method_set_dest_address>` **(** :ref:`String<class_String>` host, :ref:`int<class_int>` port **)** |
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`wait<class_PacketPeerUDP_method_wait>` **(** **)** |
+---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`close<class_PacketPeerUDP_method_close>` **(** **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_packet_ip<class_PacketPeerUDP_method_get_packet_ip>` **(** **)** const |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_packet_port<class_PacketPeerUDP_method_get_packet_port>` **(** **)** const |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_listening<class_PacketPeerUDP_method_is_listening>` **(** **)** const |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`join_multicast_group<class_PacketPeerUDP_method_join_multicast_group>` **(** :ref:`String<class_String>` multicast_address, :ref:`String<class_String>` interface_name **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`leave_multicast_group<class_PacketPeerUDP_method_leave_multicast_group>` **(** :ref:`String<class_String>` multicast_address, :ref:`String<class_String>` interface_name **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`listen<class_PacketPeerUDP_method_listen>` **(** :ref:`int<class_int>` port, :ref:`String<class_String>` bind_address="*", :ref:`int<class_int>` recv_buf_size=65536 **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`set_dest_address<class_PacketPeerUDP_method_set_dest_address>` **(** :ref:`String<class_String>` host, :ref:`int<class_int>` port **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`wait<class_PacketPeerUDP_method_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<enum_@GlobalScope_Error>` **join_multicast_group** **(** :ref:`String<class_String>` multicast_address, :ref:`String<class_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<class_IP_method_get_local_interfaces>` to know which are available.
.. _class_PacketPeerUDP_method_leave_multicast_group:
- :ref:`Error<enum_@GlobalScope_Error>` **leave_multicast_group** **(** :ref:`String<class_String>` multicast_address, :ref:`String<class_String>` interface_name **)**
Remove the interface identified by ``interface_name`` from the multicast group specified by ``multicast_address``.
.. _class_PacketPeerUDP_method_listen:
- :ref:`Error<enum_@GlobalScope_Error>` **listen** **(** :ref:`int<class_int>` port, :ref:`String<class_String>` bind_address="*", :ref:`int<class_int>` recv_buf_size=65536 **)**

2
classes/class_reference.rst
View File

@@ -9,7 +9,7 @@ Reference
**Inherits:** :ref:`Object<class_Object>`
**Inherited By:** :ref:`ARVRInterface<class_ARVRInterface>`, :ref:`AStar<class_AStar>`, :ref:`AnimationTrackEditPlugin<class_AnimationTrackEditPlugin>`, :ref:`AudioEffectInstance<class_AudioEffectInstance>`, :ref:`AudioStreamPlayback<class_AudioStreamPlayback>`, :ref:`CameraFeed<class_CameraFeed>`, :ref:`ConfigFile<class_ConfigFile>`, :ref:`Directory<class_Directory>`, :ref:`EditorExportPlugin<class_EditorExportPlugin>`, :ref:`EditorFeatureProfile<class_EditorFeatureProfile>`, :ref:`EditorImportPlugin<class_EditorImportPlugin>`, :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>`, :ref:`EditorResourceConversionPlugin<class_EditorResourceConversionPlugin>`, :ref:`EditorResourcePreviewGenerator<class_EditorResourcePreviewGenerator>`, :ref:`EditorSceneImporter<class_EditorSceneImporter>`, :ref:`EditorScenePostImport<class_EditorScenePostImport>`, :ref:`EditorScript<class_EditorScript>`, :ref:`EncodedObjectAsID<class_EncodedObjectAsID>`, :ref:`Expression<class_Expression>`, :ref:`File<class_File>`, :ref:`FuncRef<class_FuncRef>`, :ref:`GDNative<class_GDNative>`, :ref:`GDScriptFunctionState<class_GDScriptFunctionState>`, :ref:`GDScriptNativeClass<class_GDScriptNativeClass>`, :ref:`HTTPClient<class_HTTPClient>`, :ref:`JSONParseResult<class_JSONParseResult>`, :ref:`KinematicCollision<class_KinematicCollision>`, :ref:`KinematicCollision2D<class_KinematicCollision2D>`, :ref:`Marshalls<class_Marshalls>`, :ref:`MeshDataTool<class_MeshDataTool>`, :ref:`MultiplayerAPI<class_MultiplayerAPI>`, :ref:`Mutex<class_Mutex>`, :ref:`PCKPacker<class_PCKPacker>`, :ref:`PackedDataContainerRef<class_PackedDataContainerRef>`, :ref:`PacketPeer<class_PacketPeer>`, :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>`, :ref:`Physics2DShapeQueryResult<class_Physics2DShapeQueryResult>`, :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>`, :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>`, :ref:`PhysicsShapeQueryResult<class_PhysicsShapeQueryResult>`, :ref:`RandomNumberGenerator<class_RandomNumberGenerator>`, :ref:`RegEx<class_RegEx>`, :ref:`RegExMatch<class_RegExMatch>`, :ref:`Resource<class_Resource>`, :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`, :ref:`ResourceFormatSaver<class_ResourceFormatSaver>`, :ref:`ResourceImporter<class_ResourceImporter>`, :ref:`ResourceInteractiveLoader<class_ResourceInteractiveLoader>`, :ref:`SceneState<class_SceneState>`, :ref:`SceneTreeTimer<class_SceneTreeTimer>`, :ref:`Semaphore<class_Semaphore>`, :ref:`SpatialGizmo<class_SpatialGizmo>`, :ref:`SpatialVelocityTracker<class_SpatialVelocityTracker>`, :ref:`StreamPeer<class_StreamPeer>`, :ref:`SurfaceTool<class_SurfaceTool>`, :ref:`TCP_Server<class_TCP_Server>`, :ref:`Thread<class_Thread>`, :ref:`TriangleMesh<class_TriangleMesh>`, :ref:`UPNP<class_UPNP>`, :ref:`UPNPDevice<class_UPNPDevice>`, :ref:`VisualScriptFunctionState<class_VisualScriptFunctionState>`, :ref:`WeakRef<class_WeakRef>`, :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>`, :ref:`XMLParser<class_XMLParser>`
**Inherited By:** :ref:`ARVRInterface<class_ARVRInterface>`, :ref:`AStar<class_AStar>`, :ref:`AStar2D<class_AStar2D>`, :ref:`AnimationTrackEditPlugin<class_AnimationTrackEditPlugin>`, :ref:`AudioEffectInstance<class_AudioEffectInstance>`, :ref:`AudioStreamPlayback<class_AudioStreamPlayback>`, :ref:`CameraFeed<class_CameraFeed>`, :ref:`ConfigFile<class_ConfigFile>`, :ref:`Directory<class_Directory>`, :ref:`EditorExportPlugin<class_EditorExportPlugin>`, :ref:`EditorFeatureProfile<class_EditorFeatureProfile>`, :ref:`EditorImportPlugin<class_EditorImportPlugin>`, :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>`, :ref:`EditorResourceConversionPlugin<class_EditorResourceConversionPlugin>`, :ref:`EditorResourcePreviewGenerator<class_EditorResourcePreviewGenerator>`, :ref:`EditorSceneImporter<class_EditorSceneImporter>`, :ref:`EditorScenePostImport<class_EditorScenePostImport>`, :ref:`EditorScript<class_EditorScript>`, :ref:`EncodedObjectAsID<class_EncodedObjectAsID>`, :ref:`Expression<class_Expression>`, :ref:`File<class_File>`, :ref:`FuncRef<class_FuncRef>`, :ref:`GDNative<class_GDNative>`, :ref:`GDScriptFunctionState<class_GDScriptFunctionState>`, :ref:`GDScriptNativeClass<class_GDScriptNativeClass>`, :ref:`HTTPClient<class_HTTPClient>`, :ref:`JSONParseResult<class_JSONParseResult>`, :ref:`KinematicCollision<class_KinematicCollision>`, :ref:`KinematicCollision2D<class_KinematicCollision2D>`, :ref:`Marshalls<class_Marshalls>`, :ref:`MeshDataTool<class_MeshDataTool>`, :ref:`MultiplayerAPI<class_MultiplayerAPI>`, :ref:`Mutex<class_Mutex>`, :ref:`PCKPacker<class_PCKPacker>`, :ref:`PackedDataContainerRef<class_PackedDataContainerRef>`, :ref:`PacketPeer<class_PacketPeer>`, :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>`, :ref:`Physics2DShapeQueryResult<class_Physics2DShapeQueryResult>`, :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>`, :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>`, :ref:`PhysicsShapeQueryResult<class_PhysicsShapeQueryResult>`, :ref:`RandomNumberGenerator<class_RandomNumberGenerator>`, :ref:`RegEx<class_RegEx>`, :ref:`RegExMatch<class_RegExMatch>`, :ref:`Resource<class_Resource>`, :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`, :ref:`ResourceFormatSaver<class_ResourceFormatSaver>`, :ref:`ResourceInteractiveLoader<class_ResourceInteractiveLoader>`, :ref:`SceneState<class_SceneState>`, :ref:`SceneTreeTimer<class_SceneTreeTimer>`, :ref:`Semaphore<class_Semaphore>`, :ref:`SpatialGizmo<class_SpatialGizmo>`, :ref:`SpatialVelocityTracker<class_SpatialVelocityTracker>`, :ref:`StreamPeer<class_StreamPeer>`, :ref:`SurfaceTool<class_SurfaceTool>`, :ref:`TCP_Server<class_TCP_Server>`, :ref:`Thread<class_Thread>`, :ref:`TriangleMesh<class_TriangleMesh>`, :ref:`UPNP<class_UPNP>`, :ref:`UPNPDevice<class_UPNPDevice>`, :ref:`VisualScriptFunctionState<class_VisualScriptFunctionState>`, :ref:`WeakRef<class_WeakRef>`, :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>`, :ref:`XMLParser<class_XMLParser>`
**Category:** Core

4
classes/class_referencerect.rst
View File

@@ -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<class_ReferenceRect_property_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<class_Color>` of the ``ReferenceRect``.

14
classes/class_resource.rst
View File

@@ -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<class_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<class_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<class_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<class_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<class_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_setup_local_to_scene>`.
.. _class_Resource_method_duplicate:
- :ref:`Resource<class_Resource>` **duplicate** **(** :ref:`bool<class_bool>` subresources=false **)** const
@@ -117,6 +121,8 @@ Duplicates the resource, returning a new resource. By default, sub-resources are
- :ref:`Node<class_Node>` **get_local_scene** **(** **)** const
If :ref:`resource_local_to_scene<class_Resource_property_resource_local_to_scene>` is enabled and the resource was loaded from a :ref:`PackedScene<class_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<class_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<class_Resource_property_resource_local_to_scene>` enabled is loaded from a :ref:`PackedScene<class_PackedScene>` instantiation. Its behavior can be customized by overriding :ref:`_setup_local_to_scene<class_Resource_method__setup_local_to_scene>` from script.
For most resources, this method performs no base logic. :ref:`ViewportTexture<class_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<class_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<class_Resource_property_resource_path>`, as the latter would error out if another resource was already cached for the given path.

18
classes/class_resourceformatdds.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatDDS:
ResourceFormatDDS
=================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatimporter.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatImporter:
ResourceFormatImporter
======================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

16
classes/class_resourceformatloader.rst
View File

@@ -9,8 +9,6 @@ ResourceFormatLoader
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`GDNativeLibraryResourceLoader<class_GDNativeLibraryResourceLoader>`, :ref:`ResourceFormatDDS<class_ResourceFormatDDS>`, :ref:`ResourceFormatImporter<class_ResourceFormatImporter>`, :ref:`ResourceFormatLoaderBMFont<class_ResourceFormatLoaderBMFont>`, :ref:`ResourceFormatLoaderBinary<class_ResourceFormatLoaderBinary>`, :ref:`ResourceFormatLoaderDynamicFont<class_ResourceFormatLoaderDynamicFont>`, :ref:`ResourceFormatLoaderGDScript<class_ResourceFormatLoaderGDScript>`, :ref:`ResourceFormatLoaderImage<class_ResourceFormatLoaderImage>`, :ref:`ResourceFormatLoaderNativeScript<class_ResourceFormatLoaderNativeScript>`, :ref:`ResourceFormatLoaderShader<class_ResourceFormatLoaderShader>`, :ref:`ResourceFormatLoaderStreamTexture<class_ResourceFormatLoaderStreamTexture>`, :ref:`ResourceFormatLoaderText<class_ResourceFormatLoaderText>`, :ref:`ResourceFormatLoaderTextureLayered<class_ResourceFormatLoaderTextureLayered>`, :ref:`ResourceFormatLoaderTheora<class_ResourceFormatLoaderTheora>`, :ref:`ResourceFormatLoaderVideoStreamGDNative<class_ResourceFormatLoaderVideoStreamGDNative>`, :ref:`ResourceFormatLoaderWebm<class_ResourceFormatLoaderWebm>`, :ref:`ResourceFormatPKM<class_ResourceFormatPKM>`, :ref:`ResourceFormatPVR<class_ResourceFormatPVR>`, :ref:`TranslationLoaderPO<class_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<class_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<class_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<class_ResourceFormatSaver>`.
Note: You can also extend :ref:`EditorImportPlugin<class_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<class_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<class_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<class_String>` path, :ref:`String<class_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<class_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<class_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<class_Variant>` **load** **(** :ref:`String<class_String>` path, :ref:`String<class_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<class_@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<class_Resource>` object on success, or an :ref:`Error<enum_@GlobalScope_Error>` constant in case of failure.
.. _class_ResourceFormatLoader_method_rename_dependencies:
- :ref:`int<class_int>` **rename_dependencies** **(** :ref:`String<class_String>` path, :ref:`String<class_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<class_@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<class_@GlobalScope_constant_OK>` on success, or an :ref:`Error<enum_@GlobalScope_Error>` constant in case of failure.

18
classes/class_resourceformatloaderbinary.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderBinary:
ResourceFormatLoaderBinary
==========================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloaderbmfont.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderBMFont:
ResourceFormatLoaderBMFont
==========================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloaderdynamicfont.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderDynamicFont:
ResourceFormatLoaderDynamicFont
===============================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloadergdscript.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderGDScript:
ResourceFormatLoaderGDScript
============================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloaderimage.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderImage:
ResourceFormatLoaderImage
=========================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloadernativescript.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderNativeScript:
ResourceFormatLoaderNativeScript
================================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloadershader.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderShader:
ResourceFormatLoaderShader
==========================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloaderstreamtexture.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderStreamTexture:
ResourceFormatLoaderStreamTexture
=================================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloadertext.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderText:
ResourceFormatLoaderText
========================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloadertexturelayered.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderTextureLayered:
ResourceFormatLoaderTextureLayered
==================================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloadertheora.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderTheora:
ResourceFormatLoaderTheora
==========================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloadervideostreamgdnative.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderVideoStreamGDNative:
ResourceFormatLoaderVideoStreamGDNative
=======================================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatloaderwebm.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatLoaderWebm:
ResourceFormatLoaderWebm
========================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatpkm.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatPKM:
ResourceFormatPKM
=================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatpvr.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatPVR:
ResourceFormatPVR
=================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

14
classes/class_resourceformatsaver.rst
View File

@@ -9,8 +9,6 @@ ResourceFormatSaver
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`GDNativeLibraryResourceSaver<class_GDNativeLibraryResourceSaver>`, :ref:`ResourceFormatSaverBinary<class_ResourceFormatSaverBinary>`, :ref:`ResourceFormatSaverGDScript<class_ResourceFormatSaverGDScript>`, :ref:`ResourceFormatSaverNativeScript<class_ResourceFormatSaverNativeScript>`, :ref:`ResourceFormatSaverShader<class_ResourceFormatSaverShader>`, :ref:`ResourceFormatSaverText<class_ResourceFormatSaverText>`, :ref:`ResourceSaverPNG<class_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<class_ResourceSaver_method_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<class_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<class_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<class_ResourceFormatLoader>`.
Method Descriptions
-------------------
@@ -43,17 +41,19 @@ Method Descriptions
- :ref:`PoolStringArray<class_PoolStringArray>` **get_recognized_extensions** **(** :ref:`Resource<class_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>`).
.. _class_ResourceFormatSaver_method_recognize:
- :ref:`bool<class_bool>` **recognize** **(** :ref:`Resource<class_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<class_int>` **save** **(** :ref:`String<class_String>` path, :ref:`Resource<class_Resource>` resource, :ref:`int<class_int>` flags **)** virtual
Saves the given resource object to a file. ``flags`` is a bitmask composed with ``FLAG_*`` constants defined in :ref:`ResourceSaver<class_ResourceSaver>`. Returns ``OK`` on success, or an ``ERR_*`` constant listed in :ref:`@GlobalScope<class_@GlobalScope>` if it failed.
Saves the given resource object to a file at the target ``path``. ``flags`` is a bitmask composed with :ref:`SaverFlags<enum_ResourceSaver_SaverFlags>` constants.
Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, or an :ref:`Error<enum_@GlobalScope_Error>` constant in case of failure.

18
classes/class_resourceformatsaverbinary.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatSaverBinary:
ResourceFormatSaverBinary
=========================
**Inherits:** :ref:`ResourceFormatSaver<class_ResourceFormatSaver>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatsavergdscript.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatSaverGDScript:
ResourceFormatSaverGDScript
===========================
**Inherits:** :ref:`ResourceFormatSaver<class_ResourceFormatSaver>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatsavernativescript.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatSaverNativeScript:
ResourceFormatSaverNativeScript
===============================
**Inherits:** :ref:`ResourceFormatSaver<class_ResourceFormatSaver>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatsavershader.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatSaverShader:
ResourceFormatSaverShader
=========================
**Inherits:** :ref:`ResourceFormatSaver<class_ResourceFormatSaver>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceformatsavertext.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceFormatSaverText:
ResourceFormatSaverText
=======================
**Inherits:** :ref:`ResourceFormatSaver<class_ResourceFormatSaver>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

20
classes/class_resourceimporter.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceImporter:
ResourceImporter
================
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`ResourceImporterOGGVorbis<class_ResourceImporterOGGVorbis>`
**Category:** Core
Brief Description
-----------------

18
classes/class_resourceimporteroggvorbis.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceImporterOGGVorbis:
ResourceImporterOGGVorbis
=========================
**Inherits:** :ref:`ResourceImporter<class_ResourceImporter>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

22
classes/class_resourceinteractiveloader.rst
View File

@@ -14,7 +14,7 @@ ResourceInteractiveLoader
Brief Description
-----------------
Interactive Resource Loader.
Interactive :ref:`Resource<class_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<class_Resource>` loader. This object is returned by :ref:`ResourceLoader<class_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<class_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<class_int>` **get_stage** **(** **)** const
Returns the load stage. The total amount of stages can be queried with :ref:`get_stage_count<class_ResourceInteractiveLoader_method_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>`.
.. _class_ResourceInteractiveLoader_method_get_stage_count:
@@ -61,9 +61,21 @@ Returns the total amount of stages (calls to :ref:`poll<class_ResourceInteractiv
- :ref:`Error<enum_@GlobalScope_Error>` **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<class_ResourceInteractiveLoader_method_get_resource>`.
Polls the loading operation, i.e. loads a data chunk up to the next stage.
Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the poll is successful but the load operation has not finished yet (intermediate stage). This means :ref:`poll<class_ResourceInteractiveLoader_method_poll>` will have to be called again until the last stage is completed.
Returns :ref:`@GlobalScope.ERR_FILE_EOF<class_@GlobalScope_constant_ERR_FILE_EOF>` if the load operation has completed successfully. The loaded resource can be obtained by calling :ref:`get_resource<class_ResourceInteractiveLoader_method_get_resource>`.
Returns another :ref:`Error<enum_@GlobalScope_Error>` code if the poll has failed.
.. _class_ResourceInteractiveLoader_method_wait:
- :ref:`Error<enum_@GlobalScope_Error>` **wait** **(** **)**
Polls the loading operation successively until the resource is completely loaded or a :ref:`poll<class_ResourceInteractiveLoader_method_poll>` fails.
Returns :ref:`@GlobalScope.ERR_FILE_EOF<class_@GlobalScope_constant_ERR_FILE_EOF>` if the load operation has completed successfully. The loaded resource can be obtained by calling :ref:`get_resource<class_ResourceInteractiveLoader_method_get_resource>`.
Returns another :ref:`Error<enum_@GlobalScope_Error>` code if a poll has failed, aborting the operation.

34
classes/class_resourceloader.rst
View File

@@ -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<class_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<class_@GDScript_method_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<class_bool>` **exists** **(** :ref:`String<class_String>` path, :ref:`String<class_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<class_Resource>` type that should be handled by the :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`.
.. _class_ResourceLoader_method_get_dependencies:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_dependencies** **(** :ref:`String<class_String>` path **)**
Returns the dependencies for the resource at the given ``path``.
.. _class_ResourceLoader_method_get_recognized_extensions_for_type:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_recognized_extensions_for_type** **(** :ref:`String<class_String>` type **)**
@@ -63,19 +73,37 @@ Returns the list of recognized extensions for a resource type.
- :ref:`bool<class_bool>` **has** **(** :ref:`String<class_String>` path **)**
Deprecated method. Use :ref:`has_cached<class_ResourceLoader_method_has_cached>` or :ref:`exists<class_ResourceLoader_method_exists>` instead.
.. _class_ResourceLoader_method_has_cached:
- :ref:`bool<class_bool>` **has_cached** **(** :ref:`String<class_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<class_ResourceLoader_method_load>` or :ref:`load_interactive<class_ResourceLoader_method_load_interactive>` methods will use the cached version. The cached resource can be overridden by using :ref:`Resource.take_over_path<class_Resource_method_take_over_path>` on a new resource for that same path.
.. _class_ResourceLoader_method_load:
- :ref:`Resource<class_Resource>` **load** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="", :ref:`bool<class_bool>` no_cache=false **)**
Loads a resource at the given ``path``, caching the result for further access.
The registered :ref:`ResourceFormatLoader<class_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<class_Resource>` type that should be handled by the :ref:`ResourceFormatLoader<class_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<class_ResourceInteractiveLoader>` **load_interactive** **(** :ref:`String<class_String>` path, :ref:`String<class_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<class_ResourceInteractiveLoader>` object allows to load with high granularity, calling its :ref:`ResourceInteractiveLoader.poll<class_ResourceInteractiveLoader_method_poll>` method successively to load chunks.
An optional ``type_hint`` can be used to further specify the :ref:`Resource<class_Resource>` type that should be handled by the :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`.
.. _class_ResourceLoader_method_set_abort_on_missing_resources:

2
classes/class_resourcepreloader.rst
View File

@@ -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<class_@GDScript_method_preload>` built-in method which can be used in most situations, leaving the use of ``ResourcePreloader`` for more advanced scenarios.
Method Descriptions
-------------------

26
classes/class_resourcesaver.rst
View File

@@ -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<class_Resource_property_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<class_File_property_endian_swap>`).
- **FLAG_COMPRESS** = **32**
- **FLAG_COMPRESS** = **32** --- Compress the resource on save using :ref:`File.COMPRESSION_ZSTD<class_File_constant_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<class_Resource_method_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<class_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<enum_@GlobalScope_Error>` **save** **(** :ref:`String<class_String>` path, :ref:`Resource<class_Resource>` resource, :ref:`SaverFlags<enum_ResourceSaver_SaverFlags>` flags=0 **)**
Saves a resource to disk.
Saves a resource to disk to the given path, using a :ref:`ResourceFormatSaver<class_ResourceFormatSaver>` that recognizes the resource object.
The ``flags`` bitmask can be specified to customize the save behavior.
Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success.

18
classes/class_resourcesaverpng.rst
View File

@@ -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/<name>/doc_classes.
.. _class_ResourceSaverPNG:
ResourceSaverPNG
================
**Inherits:** :ref:`ResourceFormatSaver<class_ResourceFormatSaver>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

4
classes/class_sprite.rst
View File

@@ -241,3 +241,7 @@ Returns a :ref:`Rect2<class_Rect2>` representing the Sprite's boundary in local
- :ref:`bool<class_bool>` **is_pixel_opaque** **(** :ref:`Vector2<class_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.

18
classes/class_string.rst
View File

@@ -106,6 +106,10 @@ Methods
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`hex_to_int<class_String_method_hex_to_int>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`http_escape<class_String_method_http_escape>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`http_unescape<class_String_method_http_unescape>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`insert<class_String_method_insert>` **(** :ref:`int<class_int>` position, :ref:`String<class_String>` what **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_abs_path<class_String_method_is_abs_path>` **(** **)** |
@@ -188,7 +192,7 @@ Methods
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`strip_escapes<class_String_method_strip_escapes>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`substr<class_String_method_substr>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` len **)** |
| :ref:`String<class_String>` | :ref:`substr<class_String_method_substr>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` len=-1 **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`to_ascii<class_String_method_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<class_String>` **http_escape** **(** **)**
.. _class_String_method_http_unescape:
- :ref:`String<class_String>` **http_unescape** **(** **)**
.. _class_String_method_insert:
- :ref:`String<class_String>` **insert** **(** :ref:`int<class_int>` position, :ref:`String<class_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<class_String>` **substr** **(** :ref:`int<class_int>` from, :ref:`int<class_int>` len **)**
- :ref:`String<class_String>` **substr** **(** :ref:`int<class_int>` from, :ref:`int<class_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:

6
classes/class_textedit.rst
View File

@@ -71,6 +71,8 @@ Methods
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_fold<class_TextEdit_method_can_fold>` **(** :ref:`int<class_int>` line **)** const |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`center_viewport_to_cursor<class_TextEdit_method_center_viewport_to_cursor>` **(** **)** |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_colors<class_TextEdit_method_clear_colors>` **(** **)** |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_undo_history<class_TextEdit_method_clear_undo_history>` **(** **)** |
@@ -592,6 +594,10 @@ Add a ``keyword`` and its :ref:`Color<class_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** **(** **)**

18
classes/class_translationloaderpo.rst
View File

@@ -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/<name>/doc_classes.
.. _class_TranslationLoaderPO:
TranslationLoaderPO
===================
**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------

6
classes/class_visualshadernodegroupbase.rst
View File

@@ -50,6 +50,8 @@ Methods
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_output_port<class_VisualShaderNodeGroupBase_method_has_output_port>` **(** :ref:`int<class_int>` id **)** const |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_valid_port_name<class_VisualShaderNodeGroupBase_method_is_valid_port_name>` **(** :ref:`String<class_String>` name **)** const |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_input_port<class_VisualShaderNodeGroupBase_method_remove_input_port>` **(** :ref:`int<class_int>` id **)** |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_output_port<class_VisualShaderNodeGroupBase_method_remove_output_port>` **(** :ref:`int<class_int>` id **)** |
@@ -130,6 +132,10 @@ Method Descriptions
- :ref:`bool<class_bool>` **has_output_port** **(** :ref:`int<class_int>` id **)** const
.. _class_VisualShaderNodeGroupBase_method_is_valid_port_name:
- :ref:`bool<class_bool>` **is_valid_port_name** **(** :ref:`String<class_String>` name **)** const
.. _class_VisualShaderNodeGroupBase_method_remove_input_port:
- void **remove_input_port** **(** :ref:`int<class_int>` id **)**