mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
Sync classref with current source
This commit is contained in:
@@ -1149,7 +1149,12 @@ Returns the position of the first non-zero digit, after the decimal point. Note
|
||||
|
||||
- :ref:`float<class_float>` **stepify** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)**
|
||||
|
||||
Snaps float value ``s`` to a given ``step``.
|
||||
Snaps float value ``s`` to a given ``step``. This can also be used to round a floating point number to an arbitrary number of decimals.
|
||||
|
||||
::
|
||||
|
||||
stepify(100, 32) # Returns 96
|
||||
stepify(3.14159, 0.01) # Returns 3.14
|
||||
|
||||
.. _class_@GDScript_method_str:
|
||||
|
||||
|
||||
@@ -44,8 +44,12 @@ Methods
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_id_path<class_AStar_method_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_capacity<class_AStar_method_get_point_capacity>` **(** **)** const |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_point_connections<class_AStar_method_get_point_connections>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_AStar_method_get_point_count>` **(** **)** const |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_point_path<class_AStar_method_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_position<class_AStar_method_get_point_position>` **(** :ref:`int<class_int>` id **)** const |
|
||||
@@ -60,6 +64,8 @@ Methods
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_AStar_method_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reserve_space<class_AStar_method_reserve_space>` **(** :ref:`int<class_int>` num_nodes **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_disabled<class_AStar_method_set_point_disabled>` **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` disabled=true **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_AStar_method_set_point_position>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position **)** |
|
||||
@@ -184,6 +190,12 @@ Returns an array with the IDs of the points that form the path found by AStar be
|
||||
|
||||
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_AStar_method_get_point_capacity:
|
||||
|
||||
- :ref:`int<class_int>` **get_point_capacity** **(** **)** const
|
||||
|
||||
Returns the capacity of the structure backing the points, useful in conjunction with ``reserve_space``.
|
||||
|
||||
.. _class_AStar_method_get_point_connections:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **get_point_connections** **(** :ref:`int<class_int>` id **)**
|
||||
@@ -203,6 +215,12 @@ Returns an array with the IDs of the points that form the connection with the gi
|
||||
|
||||
var neighbors = astar.get_point_connections(1) # Returns [2, 3]
|
||||
|
||||
.. _class_AStar_method_get_point_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_point_count** **(** **)** const
|
||||
|
||||
Returns the number of points currently in the points pool.
|
||||
|
||||
.. _class_AStar_method_get_point_path:
|
||||
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
@@ -245,6 +263,12 @@ Returns whether a point is disabled or not for pathfinding. By default, all poin
|
||||
|
||||
Removes the point associated with the given ``id`` from the points pool.
|
||||
|
||||
.. _class_AStar_method_reserve_space:
|
||||
|
||||
- void **reserve_space** **(** :ref:`int<class_int>` num_nodes **)**
|
||||
|
||||
Reserves space internally for ``num_nodes`` points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity.
|
||||
|
||||
.. _class_AStar_method_set_point_disabled:
|
||||
|
||||
- void **set_point_disabled** **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` disabled=true **)**
|
||||
|
||||
@@ -40,8 +40,12 @@ Methods
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`int<class_int>` | :ref:`get_point_capacity<class_AStar2D_method_get_point_capacity>` **(** **)** const |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_point_connections<class_AStar2D_method_get_point_connections>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_AStar2D_method_get_point_count>` **(** **)** const |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 |
|
||||
@@ -56,6 +60,8 @@ Methods
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_AStar2D_method_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reserve_space<class_AStar2D_method_reserve_space>` **(** :ref:`int<class_int>` num_nodes **)** |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 **)** |
|
||||
@@ -166,6 +172,12 @@ Returns an array with the IDs of the points that form the path found by AStar2D
|
||||
|
||||
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_capacity:
|
||||
|
||||
- :ref:`int<class_int>` **get_point_capacity** **(** **)** const
|
||||
|
||||
Returns the capacity of the structure backing the points, useful in conjunction with ``reserve_space``.
|
||||
|
||||
.. _class_AStar2D_method_get_point_connections:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **get_point_connections** **(** :ref:`int<class_int>` id **)**
|
||||
@@ -185,6 +197,12 @@ Returns an array with the IDs of the points that form the connection with the gi
|
||||
|
||||
var neighbors = astar.get_point_connections(1) # Returns [2, 3]
|
||||
|
||||
.. _class_AStar2D_method_get_point_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_point_count** **(** **)** const
|
||||
|
||||
Returns the number of points currently in the points pool.
|
||||
|
||||
.. _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 **)**
|
||||
@@ -227,6 +245,12 @@ Returns whether a point is disabled or not for pathfinding. By default, all poin
|
||||
|
||||
Removes the point associated with the given ``id`` from the points pool.
|
||||
|
||||
.. _class_AStar2D_method_reserve_space:
|
||||
|
||||
- void **reserve_space** **(** :ref:`int<class_int>` num_nodes **)**
|
||||
|
||||
Reserves space internally for ``num_nodes`` points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity.
|
||||
|
||||
.. _class_AStar2D_method_set_point_disabled:
|
||||
|
||||
- void **set_point_disabled** **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` disabled=true **)**
|
||||
|
||||
@@ -27,6 +27,11 @@ Properties
|
||||
| :ref:`float<class_float>` | :ref:`mix_rate<class_AudioStreamGenerator_property_mix_rate>` | 44100.0 |
|
||||
+---------------------------+-------------------------------------------------------------------------+---------+
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- `https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator <https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator>`_
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
|
||||
@@ -35,6 +35,11 @@ Methods
|
||||
| :ref:`bool<class_bool>` | :ref:`push_frame<class_AudioStreamGeneratorPlayback_method_push_frame>` **(** :ref:`Vector2<class_Vector2>` frame **)** |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- `https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator <https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator>`_
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
|
||||
@@ -107,6 +107,8 @@ Property Descriptions
|
||||
|
||||
Contains the audio data in bytes.
|
||||
|
||||
**Note:** This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte.
|
||||
|
||||
.. _class_AudioStreamSample_property_format:
|
||||
|
||||
- :ref:`Format<enum_AudioStreamSample_Format>` **format**
|
||||
|
||||
@@ -115,7 +115,7 @@ Text alignment policy for the button's text, use one of the ``ALIGN_*`` constant
|
||||
| *Getter* | get_clip_text() |
|
||||
+-----------+----------------------+
|
||||
|
||||
When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default.
|
||||
When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text.
|
||||
|
||||
.. _class_Button_property_flat:
|
||||
|
||||
|
||||
@@ -133,7 +133,7 @@ Methods
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`CursorShape<enum_Control_CursorShape>` | :ref:`get_cursor_shape<class_Control_method_get_cursor_shape>` **(** :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`get_drag_data<class_Control_method_get_drag_data>` **(** :ref:`Vector2<class_Vector2>` position **)** virtual |
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_drag_data<class_Control_method_get_drag_data>` **(** :ref:`Vector2<class_Vector2>` position **)** virtual |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_end<class_Control_method_get_end>` **(** **)** const |
|
||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -1240,7 +1240,7 @@ Returns the mouse cursor shape the control displays on mouse hover. See :ref:`Cu
|
||||
|
||||
.. _class_Control_method_get_drag_data:
|
||||
|
||||
- :ref:`Object<class_Object>` **get_drag_data** **(** :ref:`Vector2<class_Vector2>` position **)** virtual
|
||||
- :ref:`Variant<class_Variant>` **get_drag_data** **(** :ref:`Vector2<class_Vector2>` position **)** virtual
|
||||
|
||||
Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns ``null`` if there is no data to drag. Controls that want to receive drop data should implement :ref:`can_drop_data<class_Control_method_can_drop_data>` and :ref:`drop_data<class_Control_method_drop_data>`. ``position`` is local to this control. Drag may be forced with :ref:`force_drag<class_Control_method_force_drag>`.
|
||||
|
||||
|
||||
@@ -96,7 +96,7 @@ Properties
|
||||
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`fog_depth_enabled<class_Environment_property_fog_depth_enabled>` | true |
|
||||
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fog_depth_end<class_Environment_property_fog_depth_end>` | 0.0 |
|
||||
| :ref:`float<class_float>` | :ref:`fog_depth_end<class_Environment_property_fog_depth_end>` | 100.0 |
|
||||
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`fog_enabled<class_Environment_property_fog_enabled>` | false |
|
||||
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+
|
||||
@@ -873,13 +873,15 @@ Enables the fog depth.
|
||||
- :ref:`float<class_float>` **fog_depth_end**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | 100.0 |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_fog_depth_end(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_fog_depth_end() |
|
||||
+-----------+--------------------------+
|
||||
|
||||
Fog's depth end distance from the camera. If this value is set to 0, it will be equal to the current camera's :ref:`Camera.far<class_Camera_property_far>` value.
|
||||
|
||||
.. _class_Environment_property_fog_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **fog_enabled**
|
||||
@@ -892,7 +894,7 @@ Enables the fog depth.
|
||||
| *Getter* | is_fog_enabled() |
|
||||
+-----------+------------------------+
|
||||
|
||||
Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog.
|
||||
Enables the fog. Needs :ref:`fog_height_enabled<class_Environment_property_fog_height_enabled>` and/or :ref:`fog_depth_enabled<class_Environment_property_fog_depth_enabled>` to actually display fog.
|
||||
|
||||
.. _class_Environment_property_fog_height_curve:
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@ Methods
|
||||
+-------------------------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`get_as_byte_code<class_GDScript_method_get_as_byte_code>` **(** **)** const |
|
||||
+-------------------------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`new<class_GDScript_method_new>` **(** ... **)** vararg |
|
||||
| :ref:`Variant<class_Variant>` | :ref:`new<class_GDScript_method_new>` **(** ... **)** vararg |
|
||||
+-------------------------------------------+-----------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
@@ -50,7 +50,7 @@ Returns byte code for the script source code.
|
||||
|
||||
.. _class_GDScript_method_new:
|
||||
|
||||
- :ref:`Object<class_Object>` **new** **(** ... **)** vararg
|
||||
- :ref:`Variant<class_Variant>` **new** **(** ... **)** vararg
|
||||
|
||||
Returns a new instance of the script.
|
||||
|
||||
|
||||
@@ -56,6 +56,8 @@ Methods
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`intersect_polyline_with_polygon_2d<class_Geometry_method_intersect_polyline_with_polygon_2d>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` polyline, :ref:`PoolVector2Array<class_PoolVector2Array>` polygon **)** |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_point_in_circle<class_Geometry_method_is_point_in_circle>` **(** :ref:`Vector2<class_Vector2>` point, :ref:`Vector2<class_Vector2>` circle_position, :ref:`float<class_float>` circle_radius **)** |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_point_in_polygon<class_Geometry_method_is_point_in_polygon>` **(** :ref:`Vector2<class_Vector2>` point, :ref:`PoolVector2Array<class_PoolVector2Array>` polygon **)** |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_polygon_clockwise<class_Geometry_method_is_polygon_clockwise>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` polygon **)** |
|
||||
@@ -86,8 +88,6 @@ Methods
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`segment_intersects_triangle<class_Geometry_method_segment_intersects_triangle>` **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`Vector3<class_Vector3>` a, :ref:`Vector3<class_Vector3>` b, :ref:`Vector3<class_Vector3>` c **)** |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`transform_points_2d<class_Geometry_method_transform_points_2d>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`triangulate_delaunay_2d<class_Geometry_method_triangulate_delaunay_2d>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points **)** |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`triangulate_polygon<class_Geometry_method_triangulate_polygon>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` polygon **)** |
|
||||
@@ -265,6 +265,12 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole)
|
||||
|
||||
Intersects ``polyline`` with ``polygon`` and returns an array of intersected polylines. This performs :ref:`OPERATION_INTERSECTION<class_Geometry_constant_OPERATION_INTERSECTION>` between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape.
|
||||
|
||||
.. _class_Geometry_method_is_point_in_circle:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_point_in_circle** **(** :ref:`Vector2<class_Vector2>` point, :ref:`Vector2<class_Vector2>` circle_position, :ref:`float<class_float>` circle_radius **)**
|
||||
|
||||
Returns ``true`` if ``point`` is inside the circle or if it's located exactly *on* the circle's boundary, otherwise returns ``false``.
|
||||
|
||||
.. _class_Geometry_method_is_point_in_polygon:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_point_in_polygon** **(** :ref:`Vector2<class_Vector2>` point, :ref:`PoolVector2Array<class_PoolVector2Array>` polygon **)**
|
||||
@@ -369,14 +375,6 @@ Checks if the segment (``from``, ``to``) intersects the sphere that is located a
|
||||
|
||||
Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, ``c``. If yes, returns the point of intersection as :ref:`Vector3<class_Vector3>`. If no intersection takes place, an empty :ref:`Variant<class_Variant>` is returned.
|
||||
|
||||
.. _class_Geometry_method_transform_points_2d:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **transform_points_2d** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Transform2D<class_Transform2D>` transform **)**
|
||||
|
||||
Transforms an array of points by ``transform`` and returns the result.
|
||||
|
||||
Can be useful in conjunction with performing polygon boolean operations in a CSG-like manner, see :ref:`merge_polygons_2d<class_Geometry_method_merge_polygons_2d>`, :ref:`clip_polygons_2d<class_Geometry_method_clip_polygons_2d>`, :ref:`intersect_polygons_2d<class_Geometry_method_intersect_polygons_2d>`, :ref:`exclude_polygons_2d<class_Geometry_method_exclude_polygons_2d>`.
|
||||
|
||||
.. _class_Geometry_method_triangulate_delaunay_2d:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **triangulate_delaunay_2d** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points **)**
|
||||
|
||||
@@ -106,6 +106,8 @@ Theme Properties
|
||||
+---------------------------------+---------------+---------------------+
|
||||
| :ref:`Texture<class_Texture>` | resizer | |
|
||||
+---------------------------------+---------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | resizer_color | Color( 0, 0, 0, 1 ) |
|
||||
+---------------------------------+---------------+---------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | selectedframe | |
|
||||
+---------------------------------+---------------+---------------------+
|
||||
| :ref:`int<class_int>` | separation | 1 |
|
||||
|
||||
97
classes/class_jsonrpc.rst
Normal file
97
classes/class_jsonrpc.rst
Normal file
@@ -0,0 +1,97 @@
|
||||
:github_url: hide
|
||||
|
||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the JSONRPC.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
.. _class_JSONRPC:
|
||||
|
||||
JSONRPC
|
||||
=======
|
||||
|
||||
**Inherits:** :ref:`Object<class_Object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`make_notification<class_JSONRPC_method_make_notification>` **(** :ref:`String<class_String>` method, :ref:`Variant<class_Variant>` params **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`make_request<class_JSONRPC_method_make_request>` **(** :ref:`String<class_String>` method, :ref:`Variant<class_Variant>` params, :ref:`Variant<class_Variant>` id **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`make_response<class_JSONRPC_method_make_response>` **(** :ref:`Variant<class_Variant>` result, :ref:`Variant<class_Variant>` id **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`make_response_error<class_JSONRPC_method_make_response_error>` **(** :ref:`int<class_int>` code, :ref:`String<class_String>` message, :ref:`Variant<class_Variant>` id=null **)** const |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`process_action<class_JSONRPC_method_process_action>` **(** :ref:`Variant<class_Variant>` action, :ref:`bool<class_bool>` recurse=false **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`process_string<class_JSONRPC_method_process_string>` **(** :ref:`String<class_String>` action **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_scope<class_JSONRPC_method_set_scope>` **(** :ref:`String<class_String>` scope, :ref:`Object<class_Object>` target **)** |
|
||||
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_JSONRPC_ErrorCode:
|
||||
|
||||
.. _class_JSONRPC_constant_PARSE_ERROR:
|
||||
|
||||
.. _class_JSONRPC_constant_INVALID_REQUEST:
|
||||
|
||||
.. _class_JSONRPC_constant_METHOD_NOT_FOUND:
|
||||
|
||||
.. _class_JSONRPC_constant_INVALID_PARAMS:
|
||||
|
||||
.. _class_JSONRPC_constant_INTERNAL_ERROR:
|
||||
|
||||
enum **ErrorCode**:
|
||||
|
||||
- **PARSE_ERROR** = **-32700**
|
||||
|
||||
- **INVALID_REQUEST** = **-32600**
|
||||
|
||||
- **METHOD_NOT_FOUND** = **-32601**
|
||||
|
||||
- **INVALID_PARAMS** = **-32602**
|
||||
|
||||
- **INTERNAL_ERROR** = **-32603**
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_JSONRPC_method_make_notification:
|
||||
|
||||
- :ref:`Dictionary<class_Dictionary>` **make_notification** **(** :ref:`String<class_String>` method, :ref:`Variant<class_Variant>` params **)**
|
||||
|
||||
.. _class_JSONRPC_method_make_request:
|
||||
|
||||
- :ref:`Dictionary<class_Dictionary>` **make_request** **(** :ref:`String<class_String>` method, :ref:`Variant<class_Variant>` params, :ref:`Variant<class_Variant>` id **)**
|
||||
|
||||
.. _class_JSONRPC_method_make_response:
|
||||
|
||||
- :ref:`Dictionary<class_Dictionary>` **make_response** **(** :ref:`Variant<class_Variant>` result, :ref:`Variant<class_Variant>` id **)**
|
||||
|
||||
.. _class_JSONRPC_method_make_response_error:
|
||||
|
||||
- :ref:`Dictionary<class_Dictionary>` **make_response_error** **(** :ref:`int<class_int>` code, :ref:`String<class_String>` message, :ref:`Variant<class_Variant>` id=null **)** const
|
||||
|
||||
.. _class_JSONRPC_method_process_action:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **process_action** **(** :ref:`Variant<class_Variant>` action, :ref:`bool<class_bool>` recurse=false **)**
|
||||
|
||||
.. _class_JSONRPC_method_process_string:
|
||||
|
||||
- :ref:`String<class_String>` **process_string** **(** :ref:`String<class_String>` action **)**
|
||||
|
||||
.. _class_JSONRPC_method_set_scope:
|
||||
|
||||
- void **set_scope** **(** :ref:`String<class_String>` scope, :ref:`Object<class_Object>` target **)**
|
||||
|
||||
@@ -28,6 +28,8 @@ Methods
|
||||
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_finalize<class_MainLoop_method__finalize>` **(** **)** virtual |
|
||||
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_global_menu_action<class_MainLoop_method__global_menu_action>` **(** :ref:`Variant<class_Variant>` id, :ref:`Variant<class_Variant>` meta **)** virtual |
|
||||
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`_idle<class_MainLoop_method__idle>` **(** :ref:`float<class_float>` delta **)** virtual |
|
||||
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_initialize<class_MainLoop_method__initialize>` **(** **)** virtual |
|
||||
@@ -181,6 +183,10 @@ Called when files are dragged from the OS file manager and dropped in the game w
|
||||
|
||||
Called before the program exits.
|
||||
|
||||
.. _class_MainLoop_method__global_menu_action:
|
||||
|
||||
- void **_global_menu_action** **(** :ref:`Variant<class_Variant>` id, :ref:`Variant<class_Variant>` meta **)** virtual
|
||||
|
||||
.. _class_MainLoop_method__idle:
|
||||
|
||||
- :ref:`bool<class_bool>` **_idle** **(** :ref:`float<class_float>` delta **)** virtual
|
||||
|
||||
@@ -34,17 +34,17 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_class_documentation<class_NativeScript_method_get_class_documentation>` **(** **)** const |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_method_documentation<class_NativeScript_method_get_method_documentation>` **(** :ref:`String<class_String>` method **)** const |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_property_documentation<class_NativeScript_method_get_property_documentation>` **(** :ref:`String<class_String>` path **)** const |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_signal_documentation<class_NativeScript_method_get_signal_documentation>` **(** :ref:`String<class_String>` signal_name **)** const |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`new<class_NativeScript_method_new>` **(** ... **)** vararg |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_class_documentation<class_NativeScript_method_get_class_documentation>` **(** **)** const |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_method_documentation<class_NativeScript_method_get_method_documentation>` **(** :ref:`String<class_String>` method **)** const |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_property_documentation<class_NativeScript_method_get_property_documentation>` **(** :ref:`String<class_String>` path **)** const |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_signal_documentation<class_NativeScript_method_get_signal_documentation>` **(** :ref:`String<class_String>` signal_name **)** const |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`new<class_NativeScript_method_new>` **(** ... **)** vararg |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -124,7 +124,7 @@ Returns the documentation string that was previously set with ``godot_nativescri
|
||||
|
||||
.. _class_NativeScript_method_new:
|
||||
|
||||
- :ref:`Object<class_Object>` **new** **(** ... **)** vararg
|
||||
- :ref:`Variant<class_Variant>` **new** **(** ... **)** vararg
|
||||
|
||||
Constructs a new object of the base type with a script of this type already attached.
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
Object
|
||||
======
|
||||
|
||||
**Inherited By:** :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>`, :ref:`ARVRServer<class_ARVRServer>`, :ref:`AudioServer<class_AudioServer>`, :ref:`CameraServer<class_CameraServer>`, :ref:`ClassDB<class_ClassDB>`, :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>`, :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>`, :ref:`EditorSelection<class_EditorSelection>`, :ref:`Engine<class_Engine>`, :ref:`Geometry<class_Geometry>`, :ref:`GodotSharp<class_GodotSharp>`, :ref:`IP<class_IP>`, :ref:`Input<class_Input>`, :ref:`InputMap<class_InputMap>`, :ref:`JSON<class_JSON>`, :ref:`JavaScript<class_JavaScript>`, :ref:`MainLoop<class_MainLoop>`, :ref:`Node<class_Node>`, :ref:`OS<class_OS>`, :ref:`Performance<class_Performance>`, :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>`, :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>`, :ref:`Physics2DServer<class_Physics2DServer>`, :ref:`PhysicsDirectBodyState<class_PhysicsDirectBodyState>`, :ref:`PhysicsDirectSpaceState<class_PhysicsDirectSpaceState>`, :ref:`PhysicsServer<class_PhysicsServer>`, :ref:`ProjectSettings<class_ProjectSettings>`, :ref:`Reference<class_Reference>`, :ref:`ResourceLoader<class_ResourceLoader>`, :ref:`ResourceSaver<class_ResourceSaver>`, :ref:`TranslationServer<class_TranslationServer>`, :ref:`TreeItem<class_TreeItem>`, :ref:`UndoRedo<class_UndoRedo>`, :ref:`VisualScriptEditor<class_VisualScriptEditor>`, :ref:`VisualServer<class_VisualServer>`
|
||||
**Inherited By:** :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>`, :ref:`ARVRServer<class_ARVRServer>`, :ref:`AudioServer<class_AudioServer>`, :ref:`CameraServer<class_CameraServer>`, :ref:`ClassDB<class_ClassDB>`, :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>`, :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>`, :ref:`EditorSelection<class_EditorSelection>`, :ref:`Engine<class_Engine>`, :ref:`Geometry<class_Geometry>`, :ref:`GodotSharp<class_GodotSharp>`, :ref:`IP<class_IP>`, :ref:`Input<class_Input>`, :ref:`InputMap<class_InputMap>`, :ref:`JSON<class_JSON>`, :ref:`JSONRPC<class_JSONRPC>`, :ref:`JavaScript<class_JavaScript>`, :ref:`MainLoop<class_MainLoop>`, :ref:`Node<class_Node>`, :ref:`OS<class_OS>`, :ref:`Performance<class_Performance>`, :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>`, :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>`, :ref:`Physics2DServer<class_Physics2DServer>`, :ref:`PhysicsDirectBodyState<class_PhysicsDirectBodyState>`, :ref:`PhysicsDirectSpaceState<class_PhysicsDirectSpaceState>`, :ref:`PhysicsServer<class_PhysicsServer>`, :ref:`ProjectSettings<class_ProjectSettings>`, :ref:`Reference<class_Reference>`, :ref:`ResourceLoader<class_ResourceLoader>`, :ref:`ResourceSaver<class_ResourceSaver>`, :ref:`TranslationServer<class_TranslationServer>`, :ref:`TreeItem<class_TreeItem>`, :ref:`UndoRedo<class_UndoRedo>`, :ref:`VisualScriptEditor<class_VisualScriptEditor>`, :ref:`VisualServer<class_VisualServer>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
|
||||
@@ -175,6 +175,14 @@ Methods
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`get_window_safe_area<class_OS_method_get_window_safe_area>` **(** **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`global_menu_add_item<class_OS_method_global_menu_add_item>` **(** :ref:`String<class_String>` menu, :ref:`String<class_String>` label, :ref:`Variant<class_Variant>` id, :ref:`Variant<class_Variant>` meta **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`global_menu_add_separator<class_OS_method_global_menu_add_separator>` **(** :ref:`String<class_String>` menu **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`global_menu_clear<class_OS_method_global_menu_clear>` **(** :ref:`String<class_String>` menu **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`global_menu_remove_item<class_OS_method_global_menu_remove_item>` **(** :ref:`String<class_String>` menu, :ref:`int<class_int>` idx **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_environment<class_OS_method_has_environment>` **(** :ref:`String<class_String>` environment **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_feature<class_OS_method_has_feature>` **(** :ref:`String<class_String>` tag_name **)** const |
|
||||
@@ -1098,6 +1106,30 @@ Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyb
|
||||
|
||||
Returns unobscured area of the window where interactive controls should be rendered.
|
||||
|
||||
.. _class_OS_method_global_menu_add_item:
|
||||
|
||||
- void **global_menu_add_item** **(** :ref:`String<class_String>` menu, :ref:`String<class_String>` label, :ref:`Variant<class_Variant>` id, :ref:`Variant<class_Variant>` meta **)**
|
||||
|
||||
Add a new item with text "label" to global menu. Use "_dock" menu to add item to the macOS dock icon menu.
|
||||
|
||||
.. _class_OS_method_global_menu_add_separator:
|
||||
|
||||
- void **global_menu_add_separator** **(** :ref:`String<class_String>` menu **)**
|
||||
|
||||
Add a separator between items. Separators also occupy an index.
|
||||
|
||||
.. _class_OS_method_global_menu_clear:
|
||||
|
||||
- void **global_menu_clear** **(** :ref:`String<class_String>` menu **)**
|
||||
|
||||
Clear the global menu, in effect removing all items.
|
||||
|
||||
.. _class_OS_method_global_menu_remove_item:
|
||||
|
||||
- void **global_menu_remove_item** **(** :ref:`String<class_String>` menu, :ref:`int<class_int>` idx **)**
|
||||
|
||||
Removes the item at index "idx" from the global menu. Note that the indexes of items after the removed item are going to be shifted by one.
|
||||
|
||||
.. _class_OS_method_has_environment:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_environment** **(** :ref:`String<class_String>` environment **)** const
|
||||
|
||||
@@ -21,16 +21,16 @@ Brief Description
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------+------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`new<class_PluginScript_method_new>` **(** ... **)** vararg |
|
||||
+-----------------------------+------------------------------------------------------------------+
|
||||
+-------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`new<class_PluginScript_method_new>` **(** ... **)** vararg |
|
||||
+-------------------------------+------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_PluginScript_method_new:
|
||||
|
||||
- :ref:`Object<class_Object>` **new** **(** ... **)** vararg
|
||||
- :ref:`Variant<class_Variant>` **new** **(** ... **)** vararg
|
||||
|
||||
Returns a new instance of the script.
|
||||
|
||||
|
||||
@@ -34,6 +34,8 @@ Properties
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`application/config/custom_user_dir_name<class_ProjectSettings_property_application/config/custom_user_dir_name>` | "" |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`application/config/description<class_ProjectSettings_property_application/config/description>` | "" |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`application/config/icon<class_ProjectSettings_property_application/config/icon>` | "" |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`application/config/macos_native_icon<class_ProjectSettings_property_application/config/macos_native_icon>` | "" |
|
||||
@@ -192,6 +194,8 @@ Properties
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor/active<class_ProjectSettings_property_editor/active>` | false |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`editor/script_templates_search_path<class_ProjectSettings_property_editor/script_templates_search_path>` | "res://script_templates" |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`editor/search_in_file_extensions<class_ProjectSettings_property_editor/search_in_file_extensions>` | PoolStringArray( "gd", "shader" ) |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`gui/common/default_scroll_deadzone<class_ProjectSettings_property_gui/common/default_scroll_deadzone>` | 0 |
|
||||
@@ -676,6 +680,16 @@ This user directory is used for storing persistent data (``user://`` filesystem)
|
||||
|
||||
The :ref:`application/config/use_custom_user_dir<class_ProjectSettings_property_application/config/use_custom_user_dir>` setting must be enabled for this to take effect.
|
||||
|
||||
.. _class_ProjectSettings_property_application/config/description:
|
||||
|
||||
- :ref:`String<class_String>` **application/config/description**
|
||||
|
||||
+-----------+----+
|
||||
| *Default* | "" |
|
||||
+-----------+----+
|
||||
|
||||
The project's description, displayed as a tooltip in the Project Manager when hovering the project.
|
||||
|
||||
.. _class_ProjectSettings_property_application/config/icon:
|
||||
|
||||
- :ref:`String<class_String>` **application/config/icon**
|
||||
@@ -1456,6 +1470,14 @@ If ``true``, enables vertical synchronization. This eliminates tearing that may
|
||||
|
||||
Internal editor setting, don't touch.
|
||||
|
||||
.. _class_ProjectSettings_property_editor/script_templates_search_path:
|
||||
|
||||
- :ref:`String<class_String>` **editor/script_templates_search_path**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | "res://script_templates" |
|
||||
+-----------+--------------------------+
|
||||
|
||||
.. _class_ProjectSettings_property_editor/search_in_file_extensions:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **editor/search_in_file_extensions**
|
||||
|
||||
@@ -356,7 +356,7 @@ Multiplies the gravity applied to the body. The body's gravity is calculated fro
|
||||
| *Getter* | get_inertia() |
|
||||
+----------+--------------------+
|
||||
|
||||
The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it.
|
||||
The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 inertia to return to automatically computing it.
|
||||
|
||||
.. _class_RigidBody2D_property_linear_damp:
|
||||
|
||||
|
||||
@@ -123,6 +123,12 @@ Emitted whenever this ``SceneTree``'s :ref:`network_peer<class_SceneTree_propert
|
||||
|
||||
Emitted when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated.
|
||||
|
||||
.. _class_SceneTree_signal_global_menu_action:
|
||||
|
||||
- **global_menu_action** **(** :ref:`Nil<class_Nil>` id, :ref:`Nil<class_Nil>` meta **)**
|
||||
|
||||
Emitted whenever global menu item is clicked.
|
||||
|
||||
.. _class_SceneTree_signal_idle_frame:
|
||||
|
||||
- **idle_frame** **(** **)**
|
||||
|
||||
@@ -23,31 +23,33 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`AlphaCutMode<enum_SpriteBase3D_AlphaCutMode>` | :ref:`alpha_cut<class_SpriteBase3D_property_alpha_cut>` | 0 |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| Vector3.Axis | :ref:`axis<class_SpriteBase3D_property_axis>` | 2 |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`centered<class_SpriteBase3D_property_centered>` | true |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`double_sided<class_SpriteBase3D_property_double_sided>` | true |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_h<class_SpriteBase3D_property_flip_h>` | false |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_v<class_SpriteBase3D_property_flip_v>` | false |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`modulate<class_SpriteBase3D_property_modulate>` | Color( 1, 1, 1, 1 ) |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_SpriteBase3D_property_offset>` | Vector2( 0, 0 ) |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`opacity<class_SpriteBase3D_property_opacity>` | 1.0 |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pixel_size<class_SpriteBase3D_property_pixel_size>` | 0.01 |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shaded<class_SpriteBase3D_property_shaded>` | false |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`transparent<class_SpriteBase3D_property_transparent>` | true |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`AlphaCutMode<enum_SpriteBase3D_AlphaCutMode>` | :ref:`alpha_cut<class_SpriteBase3D_property_alpha_cut>` | 0 |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| Vector3.Axis | :ref:`axis<class_SpriteBase3D_property_axis>` | 2 |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`BillboardMode<enum_SpatialMaterial_BillboardMode>` | :ref:`billboard<class_SpriteBase3D_property_billboard>` | 0 |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`centered<class_SpriteBase3D_property_centered>` | true |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`double_sided<class_SpriteBase3D_property_double_sided>` | true |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_h<class_SpriteBase3D_property_flip_h>` | false |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_v<class_SpriteBase3D_property_flip_v>` | false |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`modulate<class_SpriteBase3D_property_modulate>` | Color( 1, 1, 1, 1 ) |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_SpriteBase3D_property_offset>` | Vector2( 0, 0 ) |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`opacity<class_SpriteBase3D_property_opacity>` | 1.0 |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pixel_size<class_SpriteBase3D_property_pixel_size>` | 0.01 |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shaded<class_SpriteBase3D_property_shaded>` | false |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`transparent<class_SpriteBase3D_property_transparent>` | true |
|
||||
+----------------------------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -135,6 +137,18 @@ Property Descriptions
|
||||
|
||||
The direction in which the front of the texture faces.
|
||||
|
||||
.. _class_SpriteBase3D_property_billboard:
|
||||
|
||||
- :ref:`BillboardMode<enum_SpatialMaterial_BillboardMode>` **billboard**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 0 |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_billboard_mode(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | get_billboard_mode() |
|
||||
+-----------+---------------------------+
|
||||
|
||||
.. _class_SpriteBase3D_property_centered:
|
||||
|
||||
- :ref:`bool<class_bool>` **centered**
|
||||
|
||||
@@ -21,15 +21,17 @@ Tabbed container.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------------+-----------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`int<class_int>` | :ref:`current_tab<class_TabContainer_property_current_tab>` | 0 |
|
||||
+---------------------------------------------+-----------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_to_rearrange_enabled<class_TabContainer_property_drag_to_rearrange_enabled>` | false |
|
||||
+---------------------------------------------+-----------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`TabAlign<enum_TabContainer_TabAlign>` | :ref:`tab_align<class_TabContainer_property_tab_align>` | 1 |
|
||||
+---------------------------------------------+-----------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`tabs_visible<class_TabContainer_property_tabs_visible>` | true |
|
||||
+---------------------------------------------+-----------------------------------------------------------------------------------------+-------+
|
||||
+---------------------------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`int<class_int>` | :ref:`current_tab<class_TabContainer_property_current_tab>` | 0 |
|
||||
+---------------------------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_to_rearrange_enabled<class_TabContainer_property_drag_to_rearrange_enabled>` | false |
|
||||
+---------------------------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`TabAlign<enum_TabContainer_TabAlign>` | :ref:`tab_align<class_TabContainer_property_tab_align>` | 1 |
|
||||
+---------------------------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`tabs_visible<class_TabContainer_property_tabs_visible>` | true |
|
||||
+---------------------------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`use_hidden_tabs_for_min_size<class_TabContainer_property_use_hidden_tabs_for_min_size>` | false |
|
||||
+---------------------------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -217,6 +219,18 @@ The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants fo
|
||||
|
||||
If ``true``, tabs are visible. If ``false``, tabs' content and titles are hidden.
|
||||
|
||||
.. _class_TabContainer_property_use_hidden_tabs_for_min_size:
|
||||
|
||||
- :ref:`bool<class_bool>` **use_hidden_tabs_for_min_size**
|
||||
|
||||
+-----------+-----------------------------------------+
|
||||
| *Default* | false |
|
||||
+-----------+-----------------------------------------+
|
||||
| *Setter* | set_use_hidden_tabs_for_min_size(value) |
|
||||
+-----------+-----------------------------------------+
|
||||
| *Getter* | get_use_hidden_tabs_for_min_size() |
|
||||
+-----------+-----------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
|
||||
@@ -195,11 +195,11 @@ Translates the transform by the specified offset.
|
||||
|
||||
- :ref:`Variant<class_Variant>` **xform** **(** :ref:`Variant<class_Variant>` v **)**
|
||||
|
||||
Transforms the given :ref:`Vector3<class_Vector3>`, :ref:`Plane<class_Plane>`, or :ref:`AABB<class_AABB>` by this transform.
|
||||
Transforms the given :ref:`Vector3<class_Vector3>`, :ref:`Plane<class_Plane>`, :ref:`AABB<class_AABB>`, or :ref:`PoolVector3Array<class_PoolVector3Array>` by this transform.
|
||||
|
||||
.. _class_Transform_method_xform_inv:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **xform_inv** **(** :ref:`Variant<class_Variant>` v **)**
|
||||
|
||||
Inverse-transforms the given :ref:`Vector3<class_Vector3>`, :ref:`Plane<class_Plane>`, or :ref:`AABB<class_AABB>` by this transform.
|
||||
Inverse-transforms the given :ref:`Vector3<class_Vector3>`, :ref:`Plane<class_Plane>`, :ref:`AABB<class_AABB>`, or :ref:`PoolVector3Array<class_PoolVector3Array>` by this transform.
|
||||
|
||||
|
||||
@@ -212,11 +212,11 @@ Translates the transform by the given offset.
|
||||
|
||||
- :ref:`Variant<class_Variant>` **xform** **(** :ref:`Variant<class_Variant>` v **)**
|
||||
|
||||
Transforms the given :ref:`Vector2<class_Vector2>` or :ref:`Rect2<class_Rect2>` by this transform.
|
||||
Transforms the given :ref:`Vector2<class_Vector2>`, :ref:`Rect2<class_Rect2>`, or :ref:`PoolVector2Array<class_PoolVector2Array>` by this transform.
|
||||
|
||||
.. _class_Transform2D_method_xform_inv:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **xform_inv** **(** :ref:`Variant<class_Variant>` v **)**
|
||||
|
||||
Inverse-transforms the given :ref:`Vector2<class_Vector2>` or :ref:`Rect2<class_Rect2>` by this transform.
|
||||
Inverse-transforms the given :ref:`Vector2<class_Vector2>`, :ref:`Rect2<class_Rect2>`, or :ref:`PoolVector2Array<class_PoolVector2Array>` by this transform.
|
||||
|
||||
|
||||
@@ -59,6 +59,8 @@ Methods
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_icon_max_width<class_TreeItem_method_get_icon_max_width>` **(** :ref:`int<class_int>` column **)** const |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`get_icon_modulate<class_TreeItem_method_get_icon_modulate>` **(** :ref:`int<class_int>` column **)** const |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`get_icon_region<class_TreeItem_method_get_icon_region>` **(** :ref:`int<class_int>` column **)** const |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_metadata<class_TreeItem_method_get_metadata>` **(** :ref:`int<class_int>` column **)** const |
|
||||
@@ -127,6 +129,8 @@ Methods
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_icon_max_width<class_TreeItem_method_set_icon_max_width>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` width **)** |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_icon_modulate<class_TreeItem_method_set_icon_modulate>` **(** :ref:`int<class_int>` column, :ref:`Color<class_Color>` modulate **)** |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_icon_region<class_TreeItem_method_set_icon_region>` **(** :ref:`int<class_int>` column, :ref:`Rect2<class_Rect2>` region **)** |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_metadata<class_TreeItem_method_set_metadata>` **(** :ref:`int<class_int>` column, :ref:`Variant<class_Variant>` meta **)** |
|
||||
@@ -312,6 +316,12 @@ Returns the given column's icon :ref:`Texture<class_Texture>`. Error if no icon
|
||||
|
||||
Returns the column's icon's maximum width.
|
||||
|
||||
.. _class_TreeItem_method_get_icon_modulate:
|
||||
|
||||
- :ref:`Color<class_Color>` **get_icon_modulate** **(** :ref:`int<class_int>` column **)** const
|
||||
|
||||
Returns the :ref:`Color<class_Color>` modulating the column's icon.
|
||||
|
||||
.. _class_TreeItem_method_get_icon_region:
|
||||
|
||||
- :ref:`Rect2<class_Rect2>` **get_icon_region** **(** :ref:`int<class_int>` column **)** const
|
||||
@@ -512,6 +522,12 @@ Sets the given column's icon :ref:`Texture<class_Texture>`.
|
||||
|
||||
Sets the given column's icon's maximum width.
|
||||
|
||||
.. _class_TreeItem_method_set_icon_modulate:
|
||||
|
||||
- void **set_icon_modulate** **(** :ref:`int<class_int>` column, :ref:`Color<class_Color>` modulate **)**
|
||||
|
||||
Modulates the given column's icon with ``modulate``.
|
||||
|
||||
.. _class_TreeItem_method_set_icon_region:
|
||||
|
||||
- void **set_icon_region** **(** :ref:`int<class_int>` column, :ref:`Rect2<class_Rect2>` region **)**
|
||||
|
||||
@@ -73,6 +73,10 @@ Methods
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`normalized<class_Vector2_method_normalized>` **(** **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`posmod<class_Vector2_method_posmod>` **(** :ref:`float<class_float>` mod **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`posmodv<class_Vector2_method_posmodv>` **(** :ref:`Vector2<class_Vector2>` modv **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`project<class_Vector2_method_project>` **(** :ref:`Vector2<class_Vector2>` b **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`reflect<class_Vector2_method_reflect>` **(** :ref:`Vector2<class_Vector2>` n **)** |
|
||||
@@ -81,6 +85,8 @@ Methods
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`round<class_Vector2_method_round>` **(** **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`sign<class_Vector2_method_sign>` **(** **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`slerp<class_Vector2_method_slerp>` **(** :ref:`Vector2<class_Vector2>` b, :ref:`float<class_float>` t **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`slide<class_Vector2_method_slide>` **(** :ref:`Vector2<class_Vector2>` n **)** |
|
||||
@@ -93,6 +99,10 @@ Methods
|
||||
Constants
|
||||
---------
|
||||
|
||||
.. _class_Vector2_constant_AXIS_X:
|
||||
|
||||
.. _class_Vector2_constant_AXIS_Y:
|
||||
|
||||
.. _class_Vector2_constant_ZERO:
|
||||
|
||||
.. _class_Vector2_constant_ONE:
|
||||
@@ -107,11 +117,15 @@ Constants
|
||||
|
||||
.. _class_Vector2_constant_DOWN:
|
||||
|
||||
- **AXIS_X** = **0** --- Enumerated value for the X axis.
|
||||
|
||||
- **AXIS_Y** = **1** --- Enumerated value for the Y axis.
|
||||
|
||||
- **ZERO** = **Vector2( 0, 0 )** --- Zero vector.
|
||||
|
||||
- **ONE** = **Vector2( 1, 1 )** --- One vector.
|
||||
|
||||
- **INF** = **Vector2( inf, inf )** --- Infinite vector.
|
||||
- **INF** = **Vector2( inf, inf )** --- Infinity vector.
|
||||
|
||||
- **LEFT** = **Vector2( -1, 0 )** --- Left unit vector.
|
||||
|
||||
@@ -291,6 +305,18 @@ Moves the vector toward ``to`` by the fixed ``delta`` amount.
|
||||
|
||||
Returns the vector scaled to unit length. Equivalent to ``v / v.length()``.
|
||||
|
||||
.. _class_Vector2_method_posmod:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **posmod** **(** :ref:`float<class_float>` mod **)**
|
||||
|
||||
Returns a vector composed of the ``fposmod`` of this vector's components and ``mod``.
|
||||
|
||||
.. _class_Vector2_method_posmodv:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **posmodv** **(** :ref:`Vector2<class_Vector2>` modv **)**
|
||||
|
||||
Returns a vector composed of the ``fposmod`` of this vector's components and ``modv``'s components.
|
||||
|
||||
.. _class_Vector2_method_project:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **project** **(** :ref:`Vector2<class_Vector2>` b **)**
|
||||
@@ -315,6 +341,12 @@ Returns the vector rotated by ``phi`` radians. See also :ref:`@GDScript.deg2rad<
|
||||
|
||||
Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.
|
||||
|
||||
.. _class_Vector2_method_sign:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **sign** **(** **)**
|
||||
|
||||
Returns the vector with each component set to one or negative one, depending on the signs of the components.
|
||||
|
||||
.. _class_Vector2_method_slerp:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **slerp** **(** :ref:`Vector2<class_Vector2>` b, :ref:`float<class_float>` t **)**
|
||||
|
||||
@@ -14,7 +14,7 @@ Vector3
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Vector class, which performs basic 3D vector math operations.
|
||||
Vector used for 3D math.
|
||||
|
||||
Properties
|
||||
----------
|
||||
@@ -75,6 +75,10 @@ Methods
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`outer<class_Vector3_method_outer>` **(** :ref:`Vector3<class_Vector3>` b **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`posmod<class_Vector3_method_posmod>` **(** :ref:`float<class_float>` mod **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`posmodv<class_Vector3_method_posmodv>` **(** :ref:`Vector3<class_Vector3>` modv **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`project<class_Vector3_method_project>` **(** :ref:`Vector3<class_Vector3>` b **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`reflect<class_Vector3_method_reflect>` **(** :ref:`Vector3<class_Vector3>` n **)** |
|
||||
@@ -83,6 +87,8 @@ Methods
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`round<class_Vector3_method_round>` **(** **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`sign<class_Vector3_method_sign>` **(** **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`slerp<class_Vector3_method_slerp>` **(** :ref:`Vector3<class_Vector3>` b, :ref:`float<class_float>` t **)** |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`slide<class_Vector3_method_slide>` **(** :ref:`Vector3<class_Vector3>` n **)** |
|
||||
@@ -121,15 +127,15 @@ Constants
|
||||
|
||||
- **AXIS_X** = **0** --- Enumerated value for the X axis. Returned by :ref:`max_axis<class_Vector3_method_max_axis>` and :ref:`min_axis<class_Vector3_method_min_axis>`.
|
||||
|
||||
- **AXIS_Y** = **1** --- Enumerated value for the Y axis.
|
||||
- **AXIS_Y** = **1** --- Enumerated value for the Y axis. Returned by :ref:`max_axis<class_Vector3_method_max_axis>` and :ref:`min_axis<class_Vector3_method_min_axis>`.
|
||||
|
||||
- **AXIS_Z** = **2** --- Enumerated value for the Z axis.
|
||||
- **AXIS_Z** = **2** --- Enumerated value for the Z axis. Returned by :ref:`max_axis<class_Vector3_method_max_axis>` and :ref:`min_axis<class_Vector3_method_min_axis>`.
|
||||
|
||||
- **ZERO** = **Vector3( 0, 0, 0 )** --- Zero vector.
|
||||
|
||||
- **ONE** = **Vector3( 1, 1, 1 )** --- One vector.
|
||||
|
||||
- **INF** = **Vector3( inf, inf, inf )** --- Infinite vector.
|
||||
- **INF** = **Vector3( inf, inf, inf )** --- Infinity vector.
|
||||
|
||||
- **LEFT** = **Vector3( -1, 0, 0 )** --- Left unit vector.
|
||||
|
||||
@@ -146,7 +152,7 @@ Constants
|
||||
Description
|
||||
-----------
|
||||
|
||||
Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations.
|
||||
3-element structure that can be used to represent positions in 3D space or any other pair of numeric values.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
@@ -321,6 +327,18 @@ Returns the vector scaled to unit length. Equivalent to ``v / v.length()``.
|
||||
|
||||
Returns the outer product with ``b``.
|
||||
|
||||
.. _class_Vector3_method_posmod:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **posmod** **(** :ref:`float<class_float>` mod **)**
|
||||
|
||||
Returns a vector composed of the ``fposmod`` of this vector's components and ``mod``.
|
||||
|
||||
.. _class_Vector3_method_posmodv:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **posmodv** **(** :ref:`Vector3<class_Vector3>` modv **)**
|
||||
|
||||
Returns a vector composed of the ``fposmod`` of this vector's components and ``modv``'s components.
|
||||
|
||||
.. _class_Vector3_method_project:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **project** **(** :ref:`Vector3<class_Vector3>` b **)**
|
||||
@@ -345,6 +363,12 @@ Rotates the vector around a given axis by ``phi`` radians. The axis must be a no
|
||||
|
||||
Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.
|
||||
|
||||
.. _class_Vector3_method_sign:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **sign** **(** **)**
|
||||
|
||||
Returns the vector with each component set to one or negative one, depending on the signs of the components.
|
||||
|
||||
.. _class_Vector3_method_slerp:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **slerp** **(** :ref:`Vector3<class_Vector3>` b, :ref:`float<class_float>` t **)**
|
||||
|
||||
@@ -62,6 +62,11 @@ In order for the node to be registered as an editor addon, you must use the ``to
|
||||
extends VisualShaderNodeCustom
|
||||
class_name VisualShaderNodeNoise
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- :doc:`../tutorials/plugins/editor/visual_shader_plugins`
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user