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

classref: Sync with current master branch

Browse Source
This commit is contained in:
Rémi Verschelde
2017-11-13 09:27:07 +01:00
parent 6d0d9ebe06
commit 8c8d5c2d43
30 changed files with 565 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
classes/class_@gdscript.rst
View File

@@ -178,7 +178,8 @@ Member Functions
Numeric Constants
-----------------
- **PI** = **3.141593** --- Constant that represents how many times the diameter of a circumference fits around its perimeter.
- **PI** = **3.141593** --- Constant that represents how many times the diameter of a circle fits around its perimeter.
- **TAU** = **6.283185** --- The circle constant, the circumference of the unit circle.
- **INF** = **inf** --- A positive infinity. (For negative infinity, use -INF).
- **NAN** = **nan** --- Macro constant that expands to an expression of type float that represents a NaN.

4
classes/class_@global scope.rst
View File

@@ -424,7 +424,9 @@ Numeric Constants
- **JOY_AXIS_5** = **5**
- **JOY_AXIS_6** = **6** --- Joypad Left Trigger Analog Axis
- **JOY_AXIS_7** = **7** --- Joypad Right Trigger Analog Axis
- **JOY_AXIS_MAX** = **8**
- **JOY_AXIS_8** = **8**
- **JOY_AXIS_9** = **9**
- **JOY_AXIS_MAX** = **10**
- **JOY_ANALOG_LX** = **0** --- Joypad Left Stick Horizontal Axis
- **JOY_ANALOG_LY** = **1** --- Joypad Left Stick Vertical Axis
- **JOY_ANALOG_RX** = **2** --- Joypad Right Stick Horizontal Axis

16
classes/class_array.rst
View File

@@ -34,7 +34,7 @@ Member Functions
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`append<class_Array_append>` **(** var value **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`back<class_Array_back>` **(** **)** |
| var | :ref:`back<class_Array_back>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Array_clear>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
@@ -50,7 +50,7 @@ Member Functions
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_last<class_Array_find_last>` **(** var value **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`front<class_Array_front>` **(** **)** |
| var | :ref:`front<class_Array_front>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_Array_has>` **(** var value **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
@@ -60,9 +60,9 @@ Member Functions
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`invert<class_Array_invert>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pop_back<class_Array_pop_back>` **(** **)** |
| var | :ref:`pop_back<class_Array_pop_back>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pop_front<class_Array_pop_front>` **(** **)** |
| var | :ref:`pop_front<class_Array_pop_front>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_back<class_Array_push_back>` **(** var value **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
@@ -139,7 +139,7 @@ Append an element at the end of the array (alias of :ref:`push_back<class_Array_
.. _class_Array_back:
- void **back** **(** **)**
- var **back** **(** **)**
Returns the last element of the array if the array is not empty (size>0).
@@ -187,7 +187,7 @@ Searches the array in reverse order for a value and returns its index or -1 if n
.. _class_Array_front:
- void **front** **(** **)**
- var **front** **(** **)**
Returns the first element of the array if the array is not empty (size>0).
@@ -224,13 +224,13 @@ Reverse the order of the elements in the array (so first element will now be the
.. _class_Array_pop_back:
- void **pop_back** **(** **)**
- var **pop_back** **(** **)**
Remove the last element of the array.
.. _class_Array_pop_front:
- void **pop_front** **(** **)**
- var **pop_front** **(** **)**
Remove the first element of the array.

16
classes/class_arvrcontroller.rst
View File

@@ -32,10 +32,14 @@ Member Functions
+------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joystick_id<class_ARVRController_get_joystick_id>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rumble<class_ARVRController_get_rumble>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`is_button_pressed<class_ARVRController_is_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_controller_id<class_ARVRController_set_controller_id>` **(** :ref:`int<class_int>` controller_id **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rumble<class_ARVRController_set_rumble>` **(** :ref:`float<class_float>` rumble **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -60,6 +64,10 @@ Member Variables
- :ref:`int<class_int>` **controller_id** - The controller's id. The first controller that the :ref:`ARVRServer<class_arvrserver>` detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off, it's slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off.
.. _class_ARVRController_rumble:
- :ref:`float<class_float>` **rumble**
Description
-----------
@@ -109,6 +117,10 @@ Returns the value of the given axis for things like triggers, touchpads, etc. th
Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry.
.. _class_ARVRController_get_rumble:
- :ref:`float<class_float>` **get_rumble** **(** **)** const
.. _class_ARVRController_is_button_pressed:
- :ref:`int<class_int>` **is_button_pressed** **(** :ref:`int<class_int>` button **)** const
@@ -121,4 +133,8 @@ Is the given button currently pressed?
Changes the id that identifies the controller bound to this node. The first controller that the ARVR Server detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off that slot is freed ensuring that controllers will keep the same id while it is turned on even when controllers with lower ids are turned off.
.. _class_ARVRController_set_rumble:
- void **set_rumble** **(** :ref:`float<class_float>` rumble **)**

20
classes/class_arvrpositionaltracker.rst
View File

@@ -30,6 +30,8 @@ Member Functions
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_position<class_ARVRPositionalTracker_get_position>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rumble<class_ARVRPositionalTracker_get_rumble>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_tracks_orientation<class_ARVRPositionalTracker_get_tracks_orientation>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_tracks_position<class_ARVRPositionalTracker_get_tracks_position>` **(** **)** const |
@@ -38,6 +40,16 @@ Member Functions
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_type<class_ARVRPositionalTracker_get_type>` **(** **)** const |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rumble<class_ARVRPositionalTracker_set_rumble>` **(** :ref:`float<class_float>` rumble **)** |
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_ARVRPositionalTracker_rumble:
- :ref:`float<class_float>` **rumble**
Numeric Constants
-----------------
@@ -88,6 +100,10 @@ Returns the orientation matrix of the controller.
Returns the position of the controller adjusted by world scale.
.. _class_ARVRPositionalTracker_get_rumble:
- :ref:`float<class_float>` **get_rumble** **(** **)** const
.. _class_ARVRPositionalTracker_get_tracks_orientation:
- :ref:`bool<class_bool>` **get_tracks_orientation** **(** **)** const
@@ -112,4 +128,8 @@ Returns the transform combining the orientation and position of this device.
Type of tracker.
.. _class_ARVRPositionalTracker_set_rumble:
- void **set_rumble** **(** :ref:`float<class_float>` rumble **)**

44
classes/class_astar.rst
View File

@@ -42,6 +42,8 @@ Member Functions
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_id_path<class_AStar_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_point_connections<class_AStar_get_point_connections>` **(** :ref:`int<class_int>` arg0 **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_point_path<class_AStar_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_position<class_AStar_get_point_position>` **(** :ref:`int<class_int>` id **)** const |
@@ -58,8 +60,6 @@ Member Functions
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_weight_scale<class_AStar_set_point_weight_scale>` **(** :ref:`int<class_int>` id, :ref:`float<class_float>` weight_scale **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_point_connections<class_AStar_get_point_connections>` **(** :ref:`int<class_int>` id **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -187,6 +187,26 @@ 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_get_point_connections:
- :ref:`PoolIntArray<class_poolintarray>` **get_point_connections** **(** :ref:`int<class_int>` arg0 **)**
Returns an array with the ids of the points that form the connect with the given point.
::
var as = AStar.new()
as.add_point(1, Vector3(0,0,0))
as.add_point(2, Vector3(0,1,0))
as.add_point(3, Vector3(1,1,0))
as.add_point(4, Vector3(2,0,0))
as.connect_points(1, 2, true)
as.connect_points(1, 3, true)
var neighbors = as.get_point_connections(1) # returns [2, 3]
.. _class_AStar_get_point_path:
- :ref:`PoolVector3Array<class_poolvector3array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
@@ -233,24 +253,4 @@ Sets the position for the point with the given id.
Sets the ``weight_scale`` for the point with the given id.
.. _class_AStar_get_point_connections:
- :ref:`PoolIntArray<class_poolintarray>` **get_point_connections** **(** :ref:`int<class_int>` id **)**
Returns an array with the ids of the points that form the connect with the given point.
::
var as = AStar.new()
as.add_point(1, Vector3(0,0,0))
as.add_point(2, Vector3(0,1,0))
as.add_point(3, Vector3(1,1,0))
as.add_point(4, Vector3(2,0,0))
as.connect_points(1, 2, true)
as.connect_points(1, 3, true)
var neighbors = as.get_point_connections(1) # returns [2, 3]

42
classes/class_atlastexture.rst
View File

@@ -19,19 +19,23 @@ Packs multiple small textures in a single, bigger one. Helps to optimize video m
Member Functions
----------------
+--------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_atlas<class_AtlasTexture_get_atlas>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_margin<class_AtlasTexture_get_margin>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_region<class_AtlasTexture_get_region>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------+
| void | :ref:`set_atlas<class_AtlasTexture_set_atlas>` **(** :ref:`Texture<class_texture>` atlas **)** |
+--------------------------------+------------------------------------------------------------------------------------------------+
| void | :ref:`set_margin<class_AtlasTexture_set_margin>` **(** :ref:`Rect2<class_rect2>` margin **)** |
+--------------------------------+------------------------------------------------------------------------------------------------+
| void | :ref:`set_region<class_AtlasTexture_set_region>` **(** :ref:`Rect2<class_rect2>` region **)** |
+--------------------------------+------------------------------------------------------------------------------------------------+
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_atlas<class_AtlasTexture_get_atlas>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_margin<class_AtlasTexture_get_margin>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_region<class_AtlasTexture_get_region>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_filter_clip<class_AtlasTexture_has_filter_clip>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_atlas<class_AtlasTexture_set_atlas>` **(** :ref:`Texture<class_texture>` atlas **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_filter_clip<class_AtlasTexture_set_filter_clip>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_margin<class_AtlasTexture_set_margin>` **(** :ref:`Rect2<class_rect2>` margin **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`set_region<class_AtlasTexture_set_region>` **(** :ref:`Rect2<class_rect2>` region **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -40,6 +44,10 @@ Member Variables
- :ref:`Texture<class_texture>` **atlas** - The texture that contains the atlas. Can be any :ref:`Texture<class_texture>` subtype.
.. _class_AtlasTexture_filter_clip:
- :ref:`bool<class_bool>` **filter_clip**
.. _class_AtlasTexture_margin:
- :ref:`Rect2<class_rect2>` **margin** - The margin around the region. The :ref:`Rect2<class_rect2>`'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin.
@@ -71,10 +79,18 @@ Member Function Description
- :ref:`Rect2<class_rect2>` **get_region** **(** **)** const
.. _class_AtlasTexture_has_filter_clip:
- :ref:`bool<class_bool>` **has_filter_clip** **(** **)** const
.. _class_AtlasTexture_set_atlas:
- void **set_atlas** **(** :ref:`Texture<class_texture>` atlas **)**
.. _class_AtlasTexture_set_filter_clip:
- void **set_filter_clip** **(** :ref:`bool<class_bool>` enable **)**
.. _class_AtlasTexture_set_margin:
- void **set_margin** **(** :ref:`Rect2<class_rect2>` margin **)**

8
classes/class_physicsdirectbodystatesw.rst → classes/class_bulletphysicsdirectbodystate.rst
View File

@@ -1,11 +1,11 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PhysicsDirectBodyStateSW.xml source instead.
.. DO NOT EDIT THIS FILE, but the BulletPhysicsDirectBodyState.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_PhysicsDirectBodyStateSW:
.. _class_BulletPhysicsDirectBodyState:
PhysicsDirectBodyStateSW
========================
BulletPhysicsDirectBodyState
============================
**Inherits:** :ref:`PhysicsDirectBodyState<class_physicsdirectbodystate>` **<** :ref:`Object<class_object>`

18
classes/class_bulletphysicsserver.rst Normal file
View File

@@ -0,0 +1,18 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the BulletPhysicsServer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_BulletPhysicsServer:
BulletPhysicsServer
===================
**Inherits:** :ref:`PhysicsServer<class_physicsserver>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------

12
classes/class_canvaslayer.rst
View File

@@ -30,7 +30,7 @@ Member Functions
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation<class_CanvasLayer_get_rotation>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotationd<class_CanvasLayer_get_rotationd>` **(** **)** const |
| :ref:`float<class_float>` | :ref:`get_rotation_degrees<class_CanvasLayer_get_rotation_degrees>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_CanvasLayer_get_scale>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
@@ -46,7 +46,7 @@ Member Functions
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_CanvasLayer_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotationd<class_CanvasLayer_set_rotationd>` **(** :ref:`float<class_float>` degrees **)** |
| void | :ref:`set_rotation_degrees<class_CanvasLayer_set_rotation_degrees>` **(** :ref:`float<class_float>` degrees **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scale<class_CanvasLayer_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
@@ -103,9 +103,9 @@ Return the base offset for this layer (helper).
Return the base rotation for this layer in radians (helper).
.. _class_CanvasLayer_get_rotationd:
.. _class_CanvasLayer_get_rotation_degrees:
- :ref:`float<class_float>` **get_rotationd** **(** **)** const
- :ref:`float<class_float>` **get_rotation_degrees** **(** **)** const
Return the base rotation for this layer in degrees.
@@ -149,9 +149,9 @@ Set the base offset for this layer (helper).
Set the base rotation for this layer in radians (helper).
.. _class_CanvasLayer_set_rotationd:
.. _class_CanvasLayer_set_rotation_degrees:
- void **set_rotationd** **(** :ref:`float<class_float>` degrees **)**
- void **set_rotation_degrees** **(** :ref:`float<class_float>` degrees **)**
Set the base rotation for this layer in degrees (helper).

12
classes/class_control.rst
View File

@@ -102,7 +102,7 @@ Member Functions
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation<class_Control_get_rotation>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation_deg<class_Control_get_rotation_deg>` **(** **)** const |
| :ref:`float<class_float>` | :ref:`get_rotation_degrees<class_Control_get_rotation_degrees>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_Control_get_scale>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -198,7 +198,7 @@ Member Functions
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_Control_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation_deg<class_Control_set_rotation_deg>` **(** :ref:`float<class_float>` degrees **)** |
| void | :ref:`set_rotation_degrees<class_Control_set_rotation_degrees>` **(** :ref:`float<class_float>` degrees **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scale<class_Control_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -688,9 +688,9 @@ Return position and size of the Control, relative to the top-left corner of the
Return the rotation (in radians)
.. _class_Control_get_rotation_deg:
.. _class_Control_get_rotation_degrees:
- :ref:`float<class_float>` **get_rotation_deg** **(** **)** const
- :ref:`float<class_float>` **get_rotation_degrees** **(** **)** const
Return the rotation (in degrees)
@@ -920,9 +920,9 @@ Move the Control to a new position, relative to the top-left corner of the paren
Set the rotation (in radians).
.. _class_Control_set_rotation_deg:
.. _class_Control_set_rotation_degrees:
- void **set_rotation_deg** **(** :ref:`float<class_float>` degrees **)**
- void **set_rotation_degrees** **(** :ref:`float<class_float>` degrees **)**
Set the rotation (in degrees).

32
classes/class_geometry.rst
View File

@@ -26,6 +26,10 @@ Member Functions
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`build_cylinder_planes<class_Geometry_build_cylinder_planes>` **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` axis=2 **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`clip_polygon<class_Geometry_clip_polygon>` **(** :ref:`PoolVector3Array<class_poolvector3array>` points, :ref:`Plane<class_plane>` plane **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`convex_hull_2d<class_Geometry_convex_hull_2d>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_closest_point_to_segment<class_Geometry_get_closest_point_to_segment>` **(** :ref:`Vector3<class_vector3>` point, :ref:`Vector3<class_vector3>` s1, :ref:`Vector3<class_vector3>` s2 **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_closest_point_to_segment_2d<class_Geometry_get_closest_point_to_segment_2d>` **(** :ref:`Vector2<class_vector2>` point, :ref:`Vector2<class_vector2>` s1, :ref:`Vector2<class_vector2>` s2 **)** |
@@ -60,10 +64,6 @@ Member Functions
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`triangulate_polygon<class_Geometry_triangulate_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`convex_hull_2d<class_Geometry_convex_hull_2d>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`clip_polygon<class_Geometry_clip_polygon>` **(** :ref:`PoolVector3Array<class_poolvector3array>` points, :ref:`Plane<class_plane>` plane **)** |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
@@ -86,6 +86,18 @@ Returns an array of :ref:`Plane<class_plane>`\ s closely bounding a faceted caps
Returns an array of :ref:`Plane<class_plane>`\ s closely bounding a faceted cylinder centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the round part of the cylinder. The parameter ``axis`` describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z).
.. _class_Geometry_clip_polygon:
- :ref:`PoolVector3Array<class_poolvector3array>` **clip_polygon** **(** :ref:`PoolVector3Array<class_poolvector3array>` points, :ref:`Plane<class_plane>` plane **)**
Clips the polygon defined by the points in ``points`` against the ``plane`` and returns the points of the clipped polygon.
.. _class_Geometry_convex_hull_2d:
- :ref:`PoolVector2Array<class_poolvector2array>` **convex_hull_2d** **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)**
Given an array of :ref:`Vector2<class_vector2>`\ s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one.
.. _class_Geometry_get_closest_point_to_segment:
- :ref:`Vector3<class_vector3>` **get_closest_point_to_segment** **(** :ref:`Vector3<class_vector3>` point, :ref:`Vector3<class_vector3>` s1, :ref:`Vector3<class_vector3>` s2 **)**
@@ -186,16 +198,4 @@ Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, ``
Triangulates the polygon specified by the points in ``polygon``. Returns a :ref:`PoolIntArray<class_poolintarray>` where each triangle consists of three consecutive point indices into ``polygon`` (i.e. the returned array will have ``n \* 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PoolIntArray<class_poolintarray>` is returned.
.. _class_Geometry_convex_hull_2d:
- :ref:`PoolVector2Array<class_poolvector2array>` **convex_hull_2d** **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)**
Given an array of :ref:`Vector2<class_vector2>`\ s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one.
.. _class_Geometry_clip_polygon:
- :ref:`PoolVector3Array<class_poolvector3array>` **clip_polygon** **(** :ref:`PoolVector3Array<class_poolvector3array>` points, :ref:`Plane<class_plane>` plane **)**
Clips the polygon defined by the points in ``points`` against the ``plane`` and returns the points of the clipped polygon.

23
classes/class_lineedit.rst
View File

@@ -48,6 +48,8 @@ Member Functions
+------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_text<class_LineEdit_get_text>` **(** **)** const |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_context_menu_enabled<class_LineEdit_is_context_menu_enabled>` **(** **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editable<class_LineEdit_is_editable>` **(** **)** const |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_secret<class_LineEdit_is_secret>` **(** **)** const |
@@ -60,6 +62,8 @@ Member Functions
+------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_align<class_LineEdit_set_align>` **(** :ref:`int<class_int>` align **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_context_menu_enabled<class_LineEdit_set_context_menu_enabled>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cursor_position<class_LineEdit_set_cursor_position>` **(** :ref:`int<class_int>` position **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_editable<class_LineEdit_set_editable>` **(** :ref:`bool<class_bool>` enabled **)** |
@@ -108,6 +112,10 @@ Member Variables
- :ref:`float<class_float>` **caret_blink_speed** - Duration (in seconds) of a caret's blinking cycle.
.. _class_LineEdit_context_menu_enabled:
- :ref:`bool<class_bool>` **context_menu_enabled** - If ``true`` the context menu will appear when right clicked.
.. _class_LineEdit_editable:
- :ref:`bool<class_bool>` **editable** - If ``false`` existing text cannot be modified and new text cannot be added.
@@ -154,7 +162,8 @@ Numeric Constants
- **MENU_CLEAR** = **3** --- Erases the whole Linedit text.
- **MENU_SELECT_ALL** = **4** --- Selects the whole Linedit text.
- **MENU_UNDO** = **5** --- Undoes the previous action.
- **MENU_MAX** = **6**
- **MENU_REDO** = **6**
- **MENU_MAX** = **7**
Description
-----------
@@ -246,6 +255,12 @@ Return transparency of the placeholder text.
Return the text in the ``LineEdit``.
.. _class_LineEdit_is_context_menu_enabled:
- :ref:`bool<class_bool>` **is_context_menu_enabled** **(** **)**
Returns true if the context menu is enabled.
.. _class_LineEdit_is_editable:
- :ref:`bool<class_bool>` **is_editable** **(** **)** const
@@ -289,6 +304,12 @@ Selects the whole :ref:`String<class_string>`.
Set text alignment of the ``LineEdit``.
.. _class_LineEdit_set_context_menu_enabled:
- void **set_context_menu_enabled** **(** :ref:`bool<class_bool>` enable **)**
Set the status of the context menu. When enabled, the context menu will appear when the ``LineEdit`` is right clicked.
.. _class_LineEdit_set_cursor_position:
- void **set_cursor_position** **(** :ref:`int<class_int>` position **)**

32
classes/class_node2d.rst
View File

@@ -32,7 +32,7 @@ Member Functions
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_global_rotation<class_Node2D_get_global_rotation>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_global_rotation_in_degrees<class_Node2D_get_global_rotation_in_degrees>` **(** **)** const |
| :ref:`float<class_float>` | :ref:`get_global_rotation_degrees<class_Node2D_get_global_rotation_degrees>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_global_scale<class_Node2D_get_global_scale>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
@@ -42,7 +42,7 @@ Member Functions
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation<class_Node2D_get_rotation>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation_in_degrees<class_Node2D_get_rotation_in_degrees>` **(** **)** const |
| :ref:`float<class_float>` | :ref:`get_rotation_degrees<class_Node2D_get_rotation_degrees>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_Node2D_get_scale>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
@@ -64,7 +64,7 @@ Member Functions
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_global_rotation<class_Node2D_set_global_rotation>` **(** :ref:`float<class_float>` radians **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_global_rotation_in_degrees<class_Node2D_set_global_rotation_in_degrees>` **(** :ref:`float<class_float>` degrees **)** |
| void | :ref:`set_global_rotation_degrees<class_Node2D_set_global_rotation_degrees>` **(** :ref:`float<class_float>` degrees **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_global_scale<class_Node2D_set_global_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
@@ -74,7 +74,7 @@ Member Functions
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_Node2D_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation_in_degrees<class_Node2D_set_rotation_in_degrees>` **(** :ref:`float<class_float>` degrees **)** |
| void | :ref:`set_rotation_degrees<class_Node2D_set_rotation_degrees>` **(** :ref:`float<class_float>` degrees **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scale<class_Node2D_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
@@ -102,9 +102,9 @@ Member Variables
- :ref:`float<class_float>` **global_rotation** - Global rotation in radians.
.. _class_Node2D_global_rotation_deg:
.. _class_Node2D_global_rotation_degrees:
- :ref:`float<class_float>` **global_rotation_deg** - Global rotation in degrees.
- :ref:`float<class_float>` **global_rotation_degrees** - Global rotation in degrees.
.. _class_Node2D_global_scale:
@@ -122,9 +122,9 @@ Member Variables
- :ref:`float<class_float>` **rotation** - Rotation in radians, relative to the node's parent.
.. _class_Node2D_rotation_deg:
.. _class_Node2D_rotation_degrees:
- :ref:`float<class_float>` **rotation_deg** - Rotation in degrees, relative to the node's parent.
- :ref:`float<class_float>` **rotation_degrees** - Rotation in degrees, relative to the node's parent.
.. _class_Node2D_scale:
@@ -181,9 +181,9 @@ Returns the node's global position.
Returns the node's global rotation in radians.
.. _class_Node2D_get_global_rotation_in_degrees:
.. _class_Node2D_get_global_rotation_degrees:
- :ref:`float<class_float>` **get_global_rotation_in_degrees** **(** **)** const
- :ref:`float<class_float>` **get_global_rotation_degrees** **(** **)** const
Return the node's global rotation in degrees.
@@ -211,9 +211,9 @@ Returns the :ref:`Transform2D<class_transform2d>` relative to this node's parent
Returns the node's rotation in radians.
.. _class_Node2D_get_rotation_in_degrees:
.. _class_Node2D_get_rotation_degrees:
- :ref:`float<class_float>` **get_rotation_in_degrees** **(** **)** const
- :ref:`float<class_float>` **get_rotation_degrees** **(** **)** const
Returns the node's rotation in degrees.
@@ -277,9 +277,9 @@ Sets the node's global position.
Sets the node's global rotation in radians.
.. _class_Node2D_set_global_rotation_in_degrees:
.. _class_Node2D_set_global_rotation_degrees:
- void **set_global_rotation_in_degrees** **(** :ref:`float<class_float>` degrees **)**
- void **set_global_rotation_degrees** **(** :ref:`float<class_float>` degrees **)**
Sets the node's global rotation in degrees.
@@ -307,9 +307,9 @@ Sets the node's position.
Sets the node's rotation in radians.
.. _class_Node2D_set_rotation_in_degrees:
.. _class_Node2D_set_rotation_degrees:
- void **set_rotation_in_degrees** **(** :ref:`float<class_float>` degrees **)**
- void **set_rotation_degrees** **(** :ref:`float<class_float>` degrees **)**
Sets the node's rotation in degrees.

66
classes/class_object.rst
View File

@@ -138,91 +138,103 @@ Member Function Description
- void **_get** **(** :ref:`String<class_string>` property **)** virtual
Return a property, return null if the property does not exist.
Returns the given property. Returns ``null`` if the ``property`` does not exist.
.. _class_Object__get_property_list:
- :ref:`Array<class_array>` **_get_property_list** **(** **)** virtual
Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE\_\* enum in :ref:`@Global Scope<class_@global scope>`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@Global Scope<class_@global scope>`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@Global Scope<class_@global scope>`).
Returns the object's property list as an :ref:`Array<class_array>` of dictionaries. Dictionaries must contain: name:String, type:int (see TYPE\_\* enum in :ref:`@Global Scope<class_@global scope>`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@Global Scope<class_@global scope>`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@Global Scope<class_@global scope>`).
.. _class_Object__init:
- void **_init** **(** **)** virtual
The virtual method called upon initialization.
.. _class_Object__notification:
- void **_notification** **(** :ref:`int<class_int>` what **)** virtual
Notification request, the notification id is received.
Notify the object internally using an ID.
.. _class_Object__set:
- :ref:`bool<class_bool>` **_set** **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** virtual
Set a property. Return true if the property was found.
Sets a property. Returns ``true`` if the ``property`` exists.
.. _class_Object_add_user_signal:
- void **add_user_signal** **(** :ref:`String<class_string>` signal, :ref:`Array<class_array>` arguments=[ ] **)**
Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from :ref:`@Global Scope<class_@global scope>` TYPE\_\*).
Adds a user-defined ``signal``. Arguments are optional, but can be added as an :ref:`Array<class_array>` of dictionaries, each containing "name" and "type" (from :ref:`@Global Scope<class_@global scope>` TYPE\_\*).
.. _class_Object_call:
- :ref:`Variant<class_variant>` **call** **(** :ref:`String<class_string>` method **)** vararg
Calls the ``method`` on the object and returns a result. Pass parameters as a comma separated list.
.. _class_Object_call_deferred:
- :ref:`Variant<class_variant>` **call_deferred** **(** :ref:`String<class_string>` method **)** vararg
Calls the ``method`` on the object during idle time and returns a result. Pass parameters as a comma separated list.
.. _class_Object_callv:
- :ref:`Variant<class_variant>` **callv** **(** :ref:`String<class_string>` method, :ref:`Array<class_array>` arg_array **)**
Calls the ``method`` on the object and returns a result. Pass parameters as an :ref:`Array<class_array>`.
.. _class_Object_can_translate_messages:
- :ref:`bool<class_bool>` **can_translate_messages** **(** **)** const
Return true if this object can translate strings.
Returns ``true`` if the object can translate strings.
.. _class_Object_connect:
- :ref:`int<class_int>` **connect** **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method, :ref:`Array<class_array>` binds=[ ], :ref:`int<class_int>` flags=0 **)**
Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT\_\*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use :ref:`is_connected<class_Object_is_connected>` to check.
Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call. Use ``flags`` to set deferred or one shot connections. See ``CONNECT\_\*`` constants. A ``signal`` can only be connected once to a ``method``. It will throw an error if already connected. To avoid this, first use :ref:`is_connected<class_Object_is_connected>` to check for existing connections.
.. _class_Object_disconnect:
- void **disconnect** **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method **)**
Disconnect a signal from a method.
Disconnects a ``signal`` from a ``method`` on the given ``target``.
.. _class_Object_emit_signal:
- :ref:`Variant<class_variant>` **emit_signal** **(** :ref:`String<class_string>` signal **)** vararg
Emits the given ``signal``.
.. _class_Object_free:
- void **free** **(** **)**
Deletes the object from memory.
.. _class_Object_get:
- :ref:`Variant<class_variant>` **get** **(** :ref:`String<class_string>` property **)** const
Get a property from the object.
Returns a :ref:`Variant<class_variant>` for a ``property``.
.. _class_Object_get_class:
- :ref:`String<class_string>` **get_class** **(** **)** const
Return the class of the object as a string.
Returns the object's class as a :ref:`String<class_string>`.
.. _class_Object_get_incoming_connections:
- :ref:`Array<class_array>` **get_incoming_connections** **(** **)** const
Returns an :ref:`Array<class_array>` of dictionaries with information about signals that are connected to this object.
Returns an :ref:`Array<class_array>` of dictionaries with information about signals that are connected to the object.
Inside each :ref:`Dictionary<class_dictionary>` there are 3 fields:
@@ -236,82 +248,92 @@ Inside each :ref:`Dictionary<class_dictionary>` there are 3 fields:
- :ref:`int<class_int>` **get_instance_id** **(** **)** const
Return the instance ID. All objects have a unique instance ID.
Returns the object's unique instance ID.
.. _class_Object_get_meta:
- :ref:`Variant<class_variant>` **get_meta** **(** :ref:`String<class_string>` name **)** const
Return a metadata from the object.
Returns the object's metadata for the given ``name``.
.. _class_Object_get_meta_list:
- :ref:`PoolStringArray<class_poolstringarray>` **get_meta_list** **(** **)** const
Return the list of metadata in the object.
Returns the object's metadata as a :ref:`PoolStringArray<class_poolstringarray>`.
.. _class_Object_get_method_list:
- :ref:`Array<class_array>` **get_method_list** **(** **)** const
Returns the object's methods and their signatures as an :ref:`Array<class_array>`.
.. _class_Object_get_property_list:
- :ref:`Array<class_array>` **get_property_list** **(** **)** const
Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE\_\* enum in :ref:`@Global Scope<class_@global scope>`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@Global Scope<class_@global scope>`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@Global Scope<class_@global scope>`).
Returns the list of properties as an :ref:`Array<class_array>` of dictionaries. Dictionaries contain: name:String, type:int (see TYPE\_\* enum in :ref:`@Global Scope<class_@global scope>`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@Global Scope<class_@global scope>`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@Global Scope<class_@global scope>`).
.. _class_Object_get_script:
- :ref:`Reference<class_reference>` **get_script** **(** **)** const
Return the object script (or null if it doesn't have one).
Returns the object's :ref:`Script<class_script>` or ``null`` if one doesn't exist.
.. _class_Object_get_signal_connection_list:
- :ref:`Array<class_array>` **get_signal_connection_list** **(** :ref:`String<class_string>` signal **)** const
Returns an :ref:`Array<class_array>` of connections for the given ``signal``.
.. _class_Object_get_signal_list:
- :ref:`Array<class_array>` **get_signal_list** **(** **)** const
Return the list of signals as an array of dictionaries.
Returns the list of signals as an :ref:`Array<class_array>` of dictionaries.
.. _class_Object_has_meta:
- :ref:`bool<class_bool>` **has_meta** **(** :ref:`String<class_string>` name **)** const
Return true if a metadata is found with the requested name.
Returns ``true`` if a metadata is found with the given ``name``.
.. _class_Object_has_method:
- :ref:`bool<class_bool>` **has_method** **(** :ref:`String<class_string>` method **)** const
Returns ``true`` if the object contains the given ``method``.
.. _class_Object_has_user_signal:
- :ref:`bool<class_bool>` **has_user_signal** **(** :ref:`String<class_string>` signal **)** const
Returns ``true`` if the given user-defined ``signal`` exists.
.. _class_Object_is_blocking_signals:
- :ref:`bool<class_bool>` **is_blocking_signals** **(** **)** const
Return true if signal emission blocking is enabled.
Returns ``true`` if signal emission blocking is enabled.
.. _class_Object_is_class:
- :ref:`bool<class_bool>` **is_class** **(** :ref:`String<class_string>` type **)** const
Check the class of the object against a string (including inheritance).
Returns ``true`` if the object inherits from the given ``type``.
.. _class_Object_is_connected:
- :ref:`bool<class_bool>` **is_connected** **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method **)** const
Return true if a connection exists for a given signal and target/method.
Returns ``true`` if a connection exists for a given ``signal``, ``target``, and ``method``.
.. _class_Object_is_queued_for_deletion:
- :ref:`bool<class_bool>` **is_queued_for_deletion** **(** **)** const
Returns ``true`` if the ``queue_free`` method was called for the object.
.. _class_Object_notification:
- void **notification** **(** :ref:`int<class_int>` what, :ref:`bool<class_bool>` reversed=false **)**
@@ -338,7 +360,7 @@ If set to true, signal emission is blocked.
- void **set_message_translation** **(** :ref:`bool<class_bool>` enable **)**
Define whether this object can translate strings (with calls to :ref:`tr<class_Object_tr>`). Default is true.
Define whether the object can translate strings (with calls to :ref:`tr<class_Object_tr>`). Default is true.
.. _class_Object_set_meta:

2
classes/class_os.rst
View File

@@ -560,7 +560,7 @@ Returns the current time zone as a dictionary with the keys: bias and name.
- :ref:`String<class_string>` **get_unique_id** **(** **)** const
Returns a unique string.
Returns a string that is unique to the device. Currently only works on Android and iOS. Returns empty string on other platforms.
.. _class_OS_get_unix_time:

60
classes/class_physics2dserver.rst
View File

@@ -80,7 +80,7 @@ Member Functions
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_clear_shapes<class_Physics2DServer_body_clear_shapes>` **(** :ref:`RID<class_rid>` body **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`body_create<class_Physics2DServer_body_create>` **(** :ref:`int<class_int>` mode=2, :ref:`bool<class_bool>` init_sleeping=false **)** |
| :ref:`RID<class_rid>` | :ref:`body_create<class_Physics2DServer_body_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_Physics2DServer_body_get_collision_layer>` **(** :ref:`RID<class_rid>` body **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -150,6 +150,14 @@ Member Functions
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`body_test_motion<class_Physics2DServer_body_test_motion>` **(** :ref:`RID<class_rid>` body, :ref:`Transform2D<class_transform2d>` from, :ref:`Vector2<class_vector2>` motion, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` result=null **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`capsule_shape_create<class_Physics2DServer_capsule_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`circle_shape_create<class_Physics2DServer_circle_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`concave_polygon_shape_create<class_Physics2DServer_concave_polygon_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`convex_polygon_shape_create<class_Physics2DServer_convex_polygon_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`damped_spring_joint_create<class_Physics2DServer_damped_spring_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`damped_string_joint_get_param<class_Physics2DServer_damped_string_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const |
@@ -168,11 +176,17 @@ Member Functions
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`joint_set_param<class_Physics2DServer_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`line_shape_create<class_Physics2DServer_line_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`pin_joint_create<class_Physics2DServer_pin_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_Physics2DServer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
| :ref:`RID<class_rid>` | :ref:`ray_shape_create<class_Physics2DServer_ray_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`shape_create<class_Physics2DServer_shape_create>` **(** :ref:`int<class_int>` type **)** |
| :ref:`RID<class_rid>` | :ref:`rectangle_shape_create<class_Physics2DServer_rectangle_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`segment_shape_create<class_Physics2DServer_segment_shape_create>` **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_Physics2DServer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`shape_get_data<class_Physics2DServer_shape_get_data>` **(** :ref:`RID<class_rid>` shape **)** const |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -451,7 +465,7 @@ Removes all shapes from a body.
.. _class_Physics2DServer_body_create:
- :ref:`RID<class_rid>` **body_create** **(** :ref:`int<class_int>` mode=2, :ref:`bool<class_bool>` init_sleeping=false **)**
- :ref:`RID<class_rid>` **body_create** **(** **)**
Creates a physics body. The first parameter can be any value from constants BODY_MODE\*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
@@ -661,6 +675,22 @@ Sets a body state (see BODY_STATE\* constants).
Returns whether a body can move from a given point in a given direction. Apart from the boolean return value, a :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` can be passed to return additional information in.
.. _class_Physics2DServer_capsule_shape_create:
- :ref:`RID<class_rid>` **capsule_shape_create** **(** **)**
.. _class_Physics2DServer_circle_shape_create:
- :ref:`RID<class_rid>` **circle_shape_create** **(** **)**
.. _class_Physics2DServer_concave_polygon_shape_create:
- :ref:`RID<class_rid>` **concave_polygon_shape_create** **(** **)**
.. _class_Physics2DServer_convex_polygon_shape_create:
- :ref:`RID<class_rid>` **convex_polygon_shape_create** **(** **)**
.. _class_Physics2DServer_damped_spring_joint_create:
- :ref:`RID<class_rid>` **damped_spring_joint_create** **(** :ref:`Vector2<class_vector2>` anchor_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b **)**
@@ -715,24 +745,34 @@ Returns the type of a joint (see JOINT\_\* constants).
Sets a joint parameter. Parameters are explained in the JOINT_PARAM\* constants.
.. _class_Physics2DServer_line_shape_create:
- :ref:`RID<class_rid>` **line_shape_create** **(** **)**
.. _class_Physics2DServer_pin_joint_create:
- :ref:`RID<class_rid>` **pin_joint_create** **(** :ref:`Vector2<class_vector2>` anchor, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b **)**
Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself.
.. _class_Physics2DServer_ray_shape_create:
- :ref:`RID<class_rid>` **ray_shape_create** **(** **)**
.. _class_Physics2DServer_rectangle_shape_create:
- :ref:`RID<class_rid>` **rectangle_shape_create** **(** **)**
.. _class_Physics2DServer_segment_shape_create:
- :ref:`RID<class_rid>` **segment_shape_create** **(** **)**
.. _class_Physics2DServer_set_active:
- void **set_active** **(** :ref:`bool<class_bool>` active **)**
Activates or deactivates the 2D physics engine.
.. _class_Physics2DServer_shape_create:
- :ref:`RID<class_rid>` **shape_create** **(** :ref:`int<class_int>` type **)**
Creates a shape of type SHAPE\_\*. Does not assign it to a body or an area. To do so, you must use :ref:`area_set_shape<class_Physics2DServer_area_set_shape>` or :ref:`body_set_shape<class_Physics2DServer_body_set_shape>`.
.. _class_Physics2DServer_shape_get_data:
- :ref:`Variant<class_variant>` **shape_get_data** **(** :ref:`RID<class_rid>` shape **)** const

2
classes/class_physicsdirectbodystate.rst
View File

@@ -9,7 +9,7 @@ PhysicsDirectBodyState
**Inherits:** :ref:`Object<class_object>`
**Inherited By:** :ref:`PhysicsDirectBodyStateSW<class_physicsdirectbodystatesw>`
**Inherited By:** :ref:`BulletPhysicsDirectBodyState<class_bulletphysicsdirectbodystate>`
**Category:** Core

17
classes/class_physicsserver.rst
View File

@@ -9,7 +9,7 @@ PhysicsServer
**Inherits:** :ref:`Object<class_object>`
**Inherited By:** :ref:`PhysicsServerSW<class_physicsserversw>`
**Inherited By:** :ref:`BulletPhysicsServer<class_bulletphysicsserver>`
**Category:** Core
@@ -92,6 +92,8 @@ Member Functions
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PhysicsDirectBodyState<class_physicsdirectbodystate>` | :ref:`body_get_direct_state<class_PhysicsServer_body_get_direct_state>` **(** :ref:`RID<class_rid>` body **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`body_get_kinematic_safe_margin<class_PhysicsServer_body_get_kinematic_safe_margin>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_PhysicsServer_body_get_max_contacts_reported>` **(** :ref:`RID<class_rid>` body **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_get_mode<class_PhysicsServer_body_get_mode>` **(** :ref:`RID<class_rid>` body **)** const |
@@ -132,6 +134,8 @@ Member Functions
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_force_integration_callback<class_PhysicsServer_body_set_force_integration_callback>` **(** :ref:`RID<class_rid>` body, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata=null **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_kinematic_safe_margin<class_PhysicsServer_body_set_kinematic_safe_margin>` **(** :ref:`RID<class_rid>` body, :ref:`float<class_float>` margin **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_max_contacts_reported<class_PhysicsServer_body_set_max_contacts_reported>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` amount **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`body_set_mode<class_PhysicsServer_body_set_mode>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)** |
@@ -334,7 +338,8 @@ The higher, the faster.
- **BODY_MODE_STATIC** = **0** --- Constant for static bodies.
- **BODY_MODE_KINEMATIC** = **1** --- Constant for kinematic bodies.
- **BODY_MODE_RIGID** = **2** --- Constant for rigid bodies.
- **BODY_MODE_CHARACTER** = **3** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics.
- **BODY_MODE_SOFT** = **3**
- **BODY_MODE_CHARACTER** = **4** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics.
- **BODY_PARAM_BOUNCE** = **0** --- Constant to set/get a body's bounce factor.
- **BODY_PARAM_FRICTION** = **1** --- Constant to set/get a body's friction.
- **BODY_PARAM_MASS** = **2** --- Constant to set/get a body's mass.
@@ -595,6 +600,10 @@ Returns the physics layer or layers a body can collide with.
Returns the :ref:`PhysicsDirectBodyState<class_physicsdirectbodystate>` of the body.
.. _class_PhysicsServer_body_get_kinematic_safe_margin:
- :ref:`float<class_float>` **body_get_kinematic_safe_margin** **(** :ref:`RID<class_rid>` body **)** const
.. _class_PhysicsServer_body_get_max_contacts_reported:
- :ref:`int<class_int>` **body_get_max_contacts_reported** **(** :ref:`RID<class_rid>` body **)** const
@@ -719,6 +728,10 @@ Continuous collision detection tries to predict where a moving body will collide
Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force integration<class_PhysicsServer_body_set_omit_force integration>`).
.. _class_PhysicsServer_body_set_kinematic_safe_margin:
- void **body_set_kinematic_safe_margin** **(** :ref:`RID<class_rid>` body, :ref:`float<class_float>` margin **)**
.. _class_PhysicsServer_body_set_max_contacts_reported:
- void **body_set_max_contacts_reported** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` amount **)**

23
classes/class_physicsserversw.rst
View File

@@ -1,23 +0,0 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PhysicsServerSW.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_PhysicsServerSW:
PhysicsServerSW
===============
**Inherits:** :ref:`PhysicsServer<class_physicsserver>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Software implementation of :ref:`PhysicsServer<class_physicsserver>`.
Description
-----------
This class exposes no new methods or properties and should not be used, as :ref:`PhysicsServer<class_physicsserver>` automatically selects the best implementation available.

110
classes/class_polygon2d.rst
View File

@@ -19,55 +19,59 @@ A 2D polygon.
Member Functions
----------------
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_antialiased<class_Polygon2D_get_antialiased>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_Polygon2D_get_color>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_invert<class_Polygon2D_get_invert>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_invert_border<class_Polygon2D_get_invert_border>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_Polygon2D_get_offset>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_polygon<class_Polygon2D_get_polygon>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_Polygon2D_get_texture>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_texture_offset<class_Polygon2D_get_texture_offset>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_texture_rotation<class_Polygon2D_get_texture_rotation>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_texture_scale<class_Polygon2D_get_texture_scale>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_uv<class_Polygon2D_get_uv>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolColorArray<class_poolcolorarray>` | :ref:`get_vertex_colors<class_Polygon2D_get_vertex_colors>` **(** **)** const |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_antialiased<class_Polygon2D_set_antialiased>` **(** :ref:`bool<class_bool>` antialiased **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_Polygon2D_set_color>` **(** :ref:`Color<class_color>` color **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_invert<class_Polygon2D_set_invert>` **(** :ref:`bool<class_bool>` invert **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_invert_border<class_Polygon2D_set_invert_border>` **(** :ref:`float<class_float>` invert_border **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_Polygon2D_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_polygon<class_Polygon2D_set_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_Polygon2D_set_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture_offset<class_Polygon2D_set_texture_offset>` **(** :ref:`Vector2<class_vector2>` texture_offset **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture_rotation<class_Polygon2D_set_texture_rotation>` **(** :ref:`float<class_float>` texture_rotation **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture_scale<class_Polygon2D_set_texture_scale>` **(** :ref:`Vector2<class_vector2>` texture_scale **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv<class_Polygon2D_set_uv>` **(** :ref:`PoolVector2Array<class_poolvector2array>` uv **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_vertex_colors<class_Polygon2D_set_vertex_colors>` **(** :ref:`PoolColorArray<class_poolcolorarray>` vertex_colors **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_antialiased<class_Polygon2D_get_antialiased>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_Polygon2D_get_color>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_invert<class_Polygon2D_get_invert>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_invert_border<class_Polygon2D_get_invert_border>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_Polygon2D_get_offset>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_polygon<class_Polygon2D_get_polygon>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_Polygon2D_get_texture>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_texture_offset<class_Polygon2D_get_texture_offset>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_texture_rotation<class_Polygon2D_get_texture_rotation>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_texture_rotation_degrees<class_Polygon2D_get_texture_rotation_degrees>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_texture_scale<class_Polygon2D_get_texture_scale>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_uv<class_Polygon2D_get_uv>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolColorArray<class_poolcolorarray>` | :ref:`get_vertex_colors<class_Polygon2D_get_vertex_colors>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_antialiased<class_Polygon2D_set_antialiased>` **(** :ref:`bool<class_bool>` antialiased **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_Polygon2D_set_color>` **(** :ref:`Color<class_color>` color **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_invert<class_Polygon2D_set_invert>` **(** :ref:`bool<class_bool>` invert **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_invert_border<class_Polygon2D_set_invert_border>` **(** :ref:`float<class_float>` invert_border **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_Polygon2D_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_polygon<class_Polygon2D_set_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_Polygon2D_set_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture_offset<class_Polygon2D_set_texture_offset>` **(** :ref:`Vector2<class_vector2>` texture_offset **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture_rotation<class_Polygon2D_set_texture_rotation>` **(** :ref:`float<class_float>` texture_rotation **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture_rotation_degrees<class_Polygon2D_set_texture_rotation_degrees>` **(** :ref:`float<class_float>` texture_rotation **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture_scale<class_Polygon2D_set_texture_scale>` **(** :ref:`Vector2<class_vector2>` texture_scale **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv<class_Polygon2D_set_uv>` **(** :ref:`PoolVector2Array<class_poolvector2array>` uv **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_vertex_colors<class_Polygon2D_set_vertex_colors>` **(** :ref:`PoolColorArray<class_poolcolorarray>` vertex_colors **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -181,6 +185,10 @@ Return the polygon texture offset.
Return the rotation in radians of the texture polygon.
.. _class_Polygon2D_get_texture_rotation_degrees:
- :ref:`float<class_float>` **get_texture_rotation_degrees** **(** **)** const
.. _class_Polygon2D_get_texture_scale:
- :ref:`Vector2<class_vector2>` **get_texture_scale** **(** **)** const
@@ -249,6 +257,10 @@ Set the offset of the polygon texture. Initially the texture will appear anchore
Set the amount of rotation of the polygon texture, ``texture_rotation`` is specified in radians and clockwise rotation.
.. _class_Polygon2D_set_texture_rotation_degrees:
- void **set_texture_rotation_degrees** **(** :ref:`float<class_float>` texture_rotation **)**
.. _class_Polygon2D_set_texture_scale:
- void **set_texture_scale** **(** :ref:`Vector2<class_vector2>` texture_scale **)**

20
classes/class_spatial.rst
View File

@@ -30,7 +30,7 @@ Member Functions
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_rotation<class_Spatial_get_rotation>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_rotation_deg<class_Spatial_get_rotation_deg>` **(** **)** const |
| :ref:`Vector3<class_vector3>` | :ref:`get_rotation_degrees<class_Spatial_get_rotation_degrees>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_scale<class_Spatial_get_scale>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -84,9 +84,9 @@ Member Functions
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_notify_transform<class_Spatial_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_Spatial_set_rotation>` **(** :ref:`Vector3<class_vector3>` rotation_rad **)** |
| void | :ref:`set_rotation<class_Spatial_set_rotation>` **(** :ref:`Vector3<class_vector3>` radians **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation_deg<class_Spatial_set_rotation_deg>` **(** :ref:`Vector3<class_vector3>` rotation_deg **)** |
| void | :ref:`set_rotation_degrees<class_Spatial_set_rotation_degrees>` **(** :ref:`Vector3<class_vector3>` degrees **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scale<class_Spatial_set_scale>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -128,9 +128,9 @@ Member Variables
- :ref:`Vector3<class_vector3>` **rotation** - Local euler rotation in radians of this node.
.. _class_Spatial_rotation_deg:
.. _class_Spatial_rotation_degrees:
- :ref:`Vector3<class_vector3>` **rotation_deg** - Local euler rotation in degrees of this node.
- :ref:`Vector3<class_vector3>` **rotation_degrees** - Local euler rotation in degrees of this node.
.. _class_Spatial_scale:
@@ -191,9 +191,9 @@ Returns the parent ``Spatial``, or an empty :ref:`Object<class_object>` if no pa
Returns the rotation (in radians).
.. _class_Spatial_get_rotation_deg:
.. _class_Spatial_get_rotation_degrees:
- :ref:`Vector3<class_vector3>` **get_rotation_deg** **(** **)** const
- :ref:`Vector3<class_vector3>` **get_rotation_degrees** **(** **)** const
Returns the rotation (in degrees).
@@ -351,13 +351,13 @@ Set whether the node notifies about its global and local transformation changes.
.. _class_Spatial_set_rotation:
- void **set_rotation** **(** :ref:`Vector3<class_vector3>` rotation_rad **)**
- void **set_rotation** **(** :ref:`Vector3<class_vector3>` radians **)**
Set the rotation (in radians).
.. _class_Spatial_set_rotation_deg:
.. _class_Spatial_set_rotation_degrees:
- void **set_rotation_deg** **(** :ref:`Vector3<class_vector3>` rotation_deg **)**
- void **set_rotation_degrees** **(** :ref:`Vector3<class_vector3>` degrees **)**
Set the rotation (in degrees).

6
classes/class_string.rst
View File

@@ -78,6 +78,8 @@ Member Functions
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`casecmp_to<class_String_casecmp_to>` **(** :ref:`String<class_string>` to **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`dedent<class_String_dedent>` **(** **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_String_empty>` **(** **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`ends_with<class_String_ends_with>` **(** :ref:`String<class_string>` text **)** |
@@ -381,6 +383,10 @@ Changes the case of some letters. Replaces underscores with spaces, converts all
Performs a case-sensitive comparison to another string. Returns ``-1`` if less than, ``+1`` if greater than, or ``0`` if equal.
.. _class_String_dedent:
- :ref:`String<class_string>` **dedent** **(** **)**
.. _class_String_empty:
- :ref:`bool<class_bool>` **empty** **(** **)**

2
classes/class_stylebox.rst
View File

@@ -9,7 +9,7 @@ StyleBox
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`StyleBoxFlat<class_styleboxflat>`, :ref:`StyleBoxTexture<class_styleboxtexture>`, :ref:`StyleBoxEmpty<class_styleboxempty>`
**Inherited By:** :ref:`StyleBoxLine<class_styleboxline>`, :ref:`StyleBoxFlat<class_styleboxflat>`, :ref:`StyleBoxTexture<class_styleboxtexture>`, :ref:`StyleBoxEmpty<class_styleboxempty>`
**Category:** Core

91
classes/class_styleboxline.rst Normal file
View File

@@ -0,0 +1,91 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the StyleBoxLine.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_StyleBoxLine:
StyleBoxLine
============
**Inherits:** :ref:`StyleBox<class_stylebox>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_StyleBoxLine_get_color>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_grow<class_StyleBoxLine_get_grow>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_thickness<class_StyleBoxLine_get_thickness>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_vertical<class_StyleBoxLine_is_vertical>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_StyleBoxLine_set_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_grow<class_StyleBoxLine_set_grow>` **(** :ref:`float<class_float>` grow **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_thickness<class_StyleBoxLine_set_thickness>` **(** :ref:`int<class_int>` thickness **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_vertical<class_StyleBoxLine_set_vertical>` **(** :ref:`bool<class_bool>` vertical **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_StyleBoxLine_color:
- :ref:`Color<class_color>` **color**
.. _class_StyleBoxLine_thickness:
- :ref:`int<class_int>` **thickness**
.. _class_StyleBoxLine_vertical:
- :ref:`bool<class_bool>` **vertical**
Member Function Description
---------------------------
.. _class_StyleBoxLine_get_color:
- :ref:`Color<class_color>` **get_color** **(** **)** const
.. _class_StyleBoxLine_get_grow:
- :ref:`float<class_float>` **get_grow** **(** **)** const
.. _class_StyleBoxLine_get_thickness:
- :ref:`int<class_int>` **get_thickness** **(** **)** const
.. _class_StyleBoxLine_is_vertical:
- :ref:`bool<class_bool>` **is_vertical** **(** **)** const
.. _class_StyleBoxLine_set_color:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
.. _class_StyleBoxLine_set_grow:
- void **set_grow** **(** :ref:`float<class_float>` grow **)**
.. _class_StyleBoxLine_set_thickness:
- void **set_thickness** **(** :ref:`int<class_int>` thickness **)**
.. _class_StyleBoxLine_set_vertical:
- void **set_vertical** **(** :ref:`bool<class_bool>` vertical **)**

36
classes/class_textedit.rst
View File

@@ -76,12 +76,16 @@ Member Functions
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`insert_text_at_cursor<class_TextEdit_insert_text_at_cursor>` **(** :ref:`String<class_string>` text **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_context_menu_enabled<class_TextEdit_is_context_menu_enabled>` **(** **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_highlight_all_occurrences_enabled<class_TextEdit_is_highlight_all_occurrences_enabled>` **(** **)** const |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_highlight_current_line_enabled<class_TextEdit_is_highlight_current_line_enabled>` **(** **)** const |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_overriding_selected_font_color<class_TextEdit_is_overriding_selected_font_color>` **(** **)** const |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_readonly<class_TextEdit_is_readonly>` **(** **)** const |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selection_active<class_TextEdit_is_selection_active>` **(** **)** const |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_show_line_numbers_enabled<class_TextEdit_is_show_line_numbers_enabled>` **(** **)** const |
@@ -102,6 +106,8 @@ Member Functions
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`select_all<class_TextEdit_select_all>` **(** **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_context_menu_enabled<class_TextEdit_set_context_menu_enabled>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_highlight_all_occurrences<class_TextEdit_set_highlight_all_occurrences>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_highlight_current_line<class_TextEdit_set_highlight_current_line>` **(** :ref:`bool<class_bool>` enabled **)** |
@@ -172,6 +178,10 @@ Member Variables
- :ref:`bool<class_bool>` **caret_block_mode**
.. _class_TextEdit_context_menu_enabled:
- :ref:`bool<class_bool>` **context_menu_enabled**
.. _class_TextEdit_highlight_all_occurrences:
- :ref:`bool<class_bool>` **highlight_all_occurrences**
@@ -184,6 +194,10 @@ Member Variables
- :ref:`bool<class_bool>` **override_selected_font_color**
.. _class_TextEdit_readonly:
- :ref:`bool<class_bool>` **readonly** - If ``true`` read-only mode is enabled. Existing text cannot be modified and new text cannot be added.
.. _class_TextEdit_show_line_numbers:
- :ref:`bool<class_bool>` **show_line_numbers**
@@ -196,6 +210,10 @@ Member Variables
- :ref:`bool<class_bool>` **syntax_highlighting**
.. _class_TextEdit_text:
- :ref:`String<class_string>` **text** - String value of the :ref:`TextEdit<class_textedit>`.
.. _class_TextEdit_v_scroll_speed:
- :ref:`float<class_float>` **v_scroll_speed**
@@ -381,6 +399,12 @@ Return the whole text.
Insert a given text at the cursor position.
.. _class_TextEdit_is_context_menu_enabled:
- :ref:`bool<class_bool>` **is_context_menu_enabled** **(** **)**
Returns true if the context menu is enabled.
.. _class_TextEdit_is_highlight_all_occurrences_enabled:
- :ref:`bool<class_bool>` **is_highlight_all_occurrences_enabled** **(** **)** const
@@ -395,6 +419,12 @@ Returns true if highlight all occurrences is enabled.
- :ref:`bool<class_bool>` **is_overriding_selected_font_color** **(** **)** const
.. _class_TextEdit_is_readonly:
- :ref:`bool<class_bool>` **is_readonly** **(** **)** const
Return true if the text editor is in read-only mode (see :ref:`set_readonly<class_TextEdit_set_readonly>`).
.. _class_TextEdit_is_selection_active:
- :ref:`bool<class_bool>` **is_selection_active** **(** **)** const
@@ -451,6 +481,12 @@ Perform selection, from line/column to line/column.
Select all the text.
.. _class_TextEdit_set_context_menu_enabled:
- void **set_context_menu_enabled** **(** :ref:`bool<class_bool>` enable **)**
Set the status of the context menu. When enabled, the context menu will appear when the ``TextEdit`` is right clicked.
.. _class_TextEdit_set_highlight_all_occurrences:
- void **set_highlight_all_occurrences** **(** :ref:`bool<class_bool>` enable **)**

16
classes/class_tilemap.rst
View File

@@ -32,6 +32,8 @@ Member Functions
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_y<class_TileMap_get_center_y>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_clip_uv<class_TileMap_get_clip_uv>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_collision_bounce<class_TileMap_get_collision_bounce>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_collision_friction<class_TileMap_get_collision_friction>` **(** **)** const |
@@ -86,6 +88,8 @@ Member Functions
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_y<class_TileMap_set_center_y>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clip_uv<class_TileMap_set_clip_uv>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_bounce<class_TileMap_set_collision_bounce>` **(** :ref:`float<class_float>` value **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_friction<class_TileMap_set_collision_friction>` **(** :ref:`float<class_float>` value **)** |
@@ -132,6 +136,10 @@ Emitted when a tilemap setting has changed.
Member Variables
----------------
.. _class_TileMap_cell_clip_uv:
- :ref:`bool<class_bool>` **cell_clip_uv**
.. _class_TileMap_cell_custom_transform:
- :ref:`Transform2D<class_transform2d>` **cell_custom_transform** - The custom :ref:`Transform2D<class_transform2d>` to be applied to the TileMap's cells.
@@ -251,6 +259,10 @@ Return true if tiles are to be centered in x coordinate (by default this is fals
Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner).
.. _class_TileMap_get_clip_uv:
- :ref:`bool<class_bool>` **get_clip_uv** **(** **)** const
.. _class_TileMap_get_collision_bounce:
- :ref:`float<class_float>` **get_collision_bounce** **(** **)** const
@@ -413,6 +425,10 @@ Set tiles to be centered in x coordinate. (by default this is false and they are
Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner).
.. _class_TileMap_set_clip_uv:
- void **set_clip_uv** **(** :ref:`bool<class_bool>` enable **)**
.. _class_TileMap_set_collision_bounce:
- void **set_collision_bounce** **(** :ref:`float<class_float>` value **)**

26
classes/class_viewportcontainer.rst
View File

@@ -19,11 +19,15 @@ Brief Description
Member Functions
----------------
+--------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_stretch_enabled<class_ViewportContainer_is_stretch_enabled>` **(** **)** const |
+--------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_stretch<class_ViewportContainer_set_stretch>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------+----------------------------------------------------------------------------------------------------+
+--------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_stretch_shrink<class_ViewportContainer_get_stretch_shrink>` **(** **)** const |
+--------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_stretch_enabled<class_ViewportContainer_is_stretch_enabled>` **(** **)** const |
+--------------------------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stretch<class_ViewportContainer_set_stretch>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stretch_shrink<class_ViewportContainer_set_stretch_shrink>` **(** :ref:`int<class_int>` amount **)** |
+--------------------------+----------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -32,10 +36,18 @@ Member Variables
- :ref:`bool<class_bool>` **stretch**
.. _class_ViewportContainer_stretch_shrink:
- :ref:`int<class_int>` **stretch_shrink**
Member Function Description
---------------------------
.. _class_ViewportContainer_get_stretch_shrink:
- :ref:`int<class_int>` **get_stretch_shrink** **(** **)** const
.. _class_ViewportContainer_is_stretch_enabled:
- :ref:`bool<class_bool>` **is_stretch_enabled** **(** **)** const
@@ -44,4 +56,8 @@ Member Function Description
- void **set_stretch** **(** :ref:`bool<class_bool>` enable **)**
.. _class_ViewportContainer_set_stretch_shrink:
- void **set_stretch_shrink** **(** :ref:`int<class_int>` amount **)**

42
classes/class_visualscriptbuiltinfunc.rst
View File

@@ -76,26 +76,28 @@ Numeric Constants
- **MATH_RAD2DEG** = **37** --- Convert the input from radians to degrees.
- **MATH_LINEAR2DB** = **38** --- Convert the input from linear volume to decibel volume.
- **MATH_DB2LINEAR** = **39** --- Convert the input from decibel volume to linear volume.
- **LOGIC_MAX** = **40** --- Return the greater of the two numbers, also known as their maximum.
- **LOGIC_MIN** = **41** --- Return the lesser of the two numbers, also known as their minimum.
- **LOGIC_CLAMP** = **42** --- Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)`
- **LOGIC_NEAREST_PO2** = **43** --- Return the nearest power of 2 to the input.
- **OBJ_WEAKREF** = **44** --- Create a :ref:`WeakRef<class_weakref>` from the input.
- **FUNC_FUNCREF** = **45** --- Create a :ref:`FuncRef<class_funcref>` from the input.
- **TYPE_CONVERT** = **46** --- Convert between types.
- **TYPE_OF** = **47** --- Return the type of the input as an integer. Check enum Variant.Type for the integers that might be returned.
- **TYPE_EXISTS** = **48** --- Checks if a type is registered in the :ref:`ClassDB<class_classdb>`.
- **TEXT_CHAR** = **49** --- Return a character with the given ascii value.
- **TEXT_STR** = **50** --- Convert the input to a string.
- **TEXT_PRINT** = **51** --- Print the given string to the output window.
- **TEXT_PRINTERR** = **52** --- Print the given string to the standard error output.
- **TEXT_PRINTRAW** = **53** --- Print the given string to the standard output, without adding a newline.
- **VAR_TO_STR** = **54** --- Serialize a :ref:`Variant<class_variant>` to a string.
- **STR_TO_VAR** = **55** --- Deserialize a :ref:`Variant<class_variant>` from a string serialized using VAR_TO_STR.
- **VAR_TO_BYTES** = **56** --- Serialize a :ref:`Variant<class_variant>` to a :ref:`PoolByteArray<class_poolbytearray>`.
- **BYTES_TO_VAR** = **57** --- Deserialize a :ref:`Variant<class_variant>` from a :ref:`PoolByteArray<class_poolbytearray>` serialized using VAR_TO_BYTES.
- **COLORN** = **58** --- Return the :ref:`Color<class_color>` with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc.
- **FUNC_MAX** = **59** --- The maximum value the :ref:`function<class_VisualScriptBuiltinFunc_function>` property can have.
- **MATH_WRAP** = **40**
- **MATH_WRAPF** = **41**
- **LOGIC_MAX** = **42** --- Return the greater of the two numbers, also known as their maximum.
- **LOGIC_MIN** = **43** --- Return the lesser of the two numbers, also known as their minimum.
- **LOGIC_CLAMP** = **44** --- Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)`
- **LOGIC_NEAREST_PO2** = **45** --- Return the nearest power of 2 to the input.
- **OBJ_WEAKREF** = **46** --- Create a :ref:`WeakRef<class_weakref>` from the input.
- **FUNC_FUNCREF** = **47** --- Create a :ref:`FuncRef<class_funcref>` from the input.
- **TYPE_CONVERT** = **48** --- Convert between types.
- **TYPE_OF** = **49** --- Return the type of the input as an integer. Check enum Variant.Type for the integers that might be returned.
- **TYPE_EXISTS** = **50** --- Checks if a type is registered in the :ref:`ClassDB<class_classdb>`.
- **TEXT_CHAR** = **51** --- Return a character with the given ascii value.
- **TEXT_STR** = **52** --- Convert the input to a string.
- **TEXT_PRINT** = **53** --- Print the given string to the output window.
- **TEXT_PRINTERR** = **54** --- Print the given string to the standard error output.
- **TEXT_PRINTRAW** = **55** --- Print the given string to the standard output, without adding a newline.
- **VAR_TO_STR** = **56** --- Serialize a :ref:`Variant<class_variant>` to a string.
- **STR_TO_VAR** = **57** --- Deserialize a :ref:`Variant<class_variant>` from a string serialized using VAR_TO_STR.
- **VAR_TO_BYTES** = **58** --- Serialize a :ref:`Variant<class_variant>` to a :ref:`PoolByteArray<class_poolbytearray>`.
- **BYTES_TO_VAR** = **59** --- Deserialize a :ref:`Variant<class_variant>` from a :ref:`PoolByteArray<class_poolbytearray>` serialized using VAR_TO_BYTES.
- **COLORN** = **60** --- Return the :ref:`Color<class_color>` with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc.
- **FUNC_MAX** = **61** --- The maximum value the :ref:`function<class_VisualScriptBuiltinFunc_function>` property can have.
Description
-----------

4
classes/class_visualscriptmathconstant.rst
View File

@@ -38,8 +38,8 @@ Numeric Constants
- **MATH_CONSTANT_ONE** = **0** --- Unity: ``1``
- **MATH_CONSTANT_PI** = **1** --- Pi: ``3.141593``
- **MATH_CONSTANT_2PI** = **2** --- Pi times two: ``6.283185``
- **MATH_CONSTANT_HALF_PI** = **3** --- Pi divided by two: ``1.570796``
- **MATH_CONSTANT_HALF_PI** = **2** --- Pi divided by two: ``1.570796``
- **MATH_CONSTANT_TAU** = **3** --- Tau: ``6.283185``
- **MATH_CONSTANT_E** = **4** --- Natural log: ``2.718282``
- **MATH_CONSTANT_SQRT2** = **5** --- Square root of two: ``1.414214``
- **MATH_CONSTANT_INF** = **6** --- Infinity: ``inf``