stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 18:29:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current 2.1 source

Browse Source
This commit is contained in:
Rémi Verschelde
2017-09-06 14:47:12 +02:00
parent 6c9e0a39f0
commit 53517d1d21
46 changed files with 474 additions and 247 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_acceptdialog.rst
+1 -1
View File
@@ -64,7 +64,7 @@ Member Function Description
Add custom button to the dialog and return the created button.
The button titled with *text* and the *action* will be passed to :ref:`custom_action<class_custom_action>` signal when it is pressed.
The button titled with *text* and the *action* will be passed to custom_action signal when it is pressed.
.. _class_AcceptDialog_add_cancel:
classes/class_array.rst
+8 -1
View File
@@ -188,7 +188,14 @@ Returns the first element of the array if the array is not empty (size>0).
- :ref:`bool<class_bool>` **has** **(** var value **)**
Return true if the array contains given value. ``:ref:` "inside", 7 <class_ "inside", 7 >`.has("inside") == true, :ref:` "inside", 7 <class_ "inside", 7 >`.has("outside") == false, :ref:` "inside", 7 <class_ "inside", 7 >`.has(7) == true, :ref:` "inside", 7 <class_ "inside", 7 >`.has("7") == false``
Return true if the array contains given value.
::
[ "inside", 7 ].has("inside") == true
[ "inside", 7 ].has("outside") == false
[ "inside", 7 ].has(7) == true
[ "inside", 7 ].has("7") == false
.. _class_Array_hash:
classes/class_astar.rst
+6
View File
@@ -47,6 +47,8 @@ Member Functions
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_point<class_AStar_has_point>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_AStar_remove_point>` **(** :ref:`int<class_int>` id **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -111,6 +113,10 @@ Add a new point at the given position. The ``weight_scale`` has to be 1 or large
- :ref:`float<class_float>` **get_point_weight_scale** **(** :ref:`int<class_int>` id **)** const
.. _class_AStar_has_point:
- :ref:`bool<class_bool>` **has_point** **(** :ref:`int<class_int>` id **)** const
.. _class_AStar_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` id **)**
classes/class_control.rst
+2 -2
View File
@@ -331,7 +331,7 @@ Override a single icon (:ref:`Texture<class_texture>`) in the theme of this Cont
- void **add_style_override** **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox **)**
Override a single stylebox (:ref:`Stylebox<class_stylebox>`) in the theme of this Control. If stylebox is empty, override is cleared.
Override a single stylebox (Stylebox) in the theme of this Control. If stylebox is empty, override is cleared.
.. _class_Control_can_drop_data:
@@ -491,7 +491,7 @@ Return position and size of the Control, relative to the top-left corner of the
- :ref:`Vector2<class_vector2>` **get_size** **(** **)** const
Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by :ref:`get_minimum_size<class_Control_get_minimum_size>`**. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, :ref:`get_minimum_size<class_Control_get_minimum_size>`, :ref:`set_margin<class_Control_set_margin>`, :ref:`set_anchor<class_Control_set_anchor>`).
Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by** :ref:`get_minimum_size<class_Control_get_minimum_size>`. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, :ref:`get_minimum_size<class_Control_get_minimum_size>`, :ref:`set_margin<class_Control_set_margin>`, :ref:`set_anchor<class_Control_set_anchor>`).
.. _class_Control_get_stretch_ratio:
classes/class_dictionary.rst
+3 -1
View File
@@ -94,7 +94,9 @@ Return the list of keys in the :ref:`Dictionary<class_dictionary>`.
- :ref:`int<class_int>` **parse_json** **(** :ref:`String<class_string>` json **)**
Parse json text to the dictionary. Return OK when successed or the error code when failed.
Parse JSON text to the dictionary. Return OK when successed or the error code when failed.
Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert every numerical values to :ref:`float<class_float>` types.
.. _class_Dictionary_size:
classes/class_editorspatialgizmo.rst
+1 -1
View File
@@ -62,7 +62,7 @@ Member Function Description
- void **add_collision_triangles** **(** TriangleMesh triangles **)**
Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh<class_trianglemesh>` can be generated from a regular :ref:`Mesh<class_mesh>` too. Call this function during :ref:`redraw<class_EditorSpatialGizmo_redraw>`.
Add collision triangles to the gizmo for picking. A TriangleMesh can be generated from a regular :ref:`Mesh<class_mesh>` too. Call this function during :ref:`redraw<class_EditorSpatialGizmo_redraw>`.
.. _class_EditorSpatialGizmo_add_handles:
classes/class_filedialog.rst
+1 -1
View File
@@ -157,7 +157,7 @@ Return true if the diaog allows show hidden files.
- void **set_access** **(** :ref:`int<class_int>` access **)**
Set the file access permission of the dialog(Must be one of :ref:`ACCESS_RESOURCES<class_access_resources>`, :ref:`ACCESS_USERDATA<class_access_userdata>` or :ref:`ACCESS_FILESYSTEM<class_access_filesystem>`).
Set the file access permission of the dialog(Must be one of ACCESS_RESOURCES, ACCESS_USERDATA or ACCESS_FILESYSTEM).
.. _class_FileDialog_set_current_dir:
classes/class_graphedit.rst
+1 -1
View File
@@ -125,6 +125,6 @@ Enable the disconnection of existing connections in the visual GraphEdit by left
- void **set_zoom** **(** :ref:`float<class_float>` p_zoom **)**
Set the zoom value of the GraphEdit. Zoom value is between :ref:`0.01; 1.728<class_0.01; 1.728>`.
Set the zoom value of the GraphEdit. Zoom value is between 0.01; 1.728.
classes/class_httpclient.rst
+1 -1
View File
@@ -256,7 +256,7 @@ To create a POST request with query strings to push to the server, do:
var fields = {"username" : "user", "password" : "pass"}
var queryString = httpClient.query_string_from_dict(fields)
var headers = :ref:`"Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())<class_"content-type: application/x-www-form-urlencoded", "content-length: " + str(querystring.length())>`
var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())]
var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString)
.. _class_HTTPClient_request_raw:
classes/class_image.rst
+46 -22
View File
@@ -16,49 +16,55 @@ Image datatype.
Member Functions
----------------
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`Image<class_Image_Image>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` mipmaps, :ref:`int<class_int>` format **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend_rect<class_Image_blend_rect>` **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dest=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend_rect_mask<class_Image_blend_rect_mask>` **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` mask, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dest=0 **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blit_rect<class_Image_blit_rect>` **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dest=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blit_rect_mask<class_Image_blit_rect_mask>` **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` mask, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dest=0 **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`brush_transfer<class_Image_brush_transfer>` **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` brush, :ref:`Vector2<class_vector2>` pos=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`brushed<class_Image_brushed>` **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` brush, :ref:`Vector2<class_vector2>` pos=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`compressed<class_Image_compressed>` **(** :ref:`int<class_int>` format=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`converted<class_Image_converted>` **(** :ref:`int<class_int>` format=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`decompressed<class_Image_decompressed>` **(** **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_Image_empty>` **(** **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fill<class_Image_fill>` **(** :ref:`Color<class_color>` color=0 **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fix_alpha_edges<class_Image_fix_alpha_edges>` **(** **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`get_data<class_Image_get_data>` **(** **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_format<class_Image_get_format>` **(** **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_height<class_Image_get_height>` **(** **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_pixel<class_Image_get_pixel>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` mipmap_level=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`get_rect<class_Image_get_rect>` **(** :ref:`Rect2<class_rect2>` area=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_used_rect<class_Image_get_used_rect>` **(** **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_width<class_Image_get_width>` **(** **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`load<class_Image_load>` **(** :ref:`String<class_string>` path=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_pixel<class_Image_put_pixel>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`Color<class_color>` color, :ref:`int<class_int>` mipmap_level=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`resized<class_Image_resized>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` interpolation=1 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`save_png<class_Image_save_png>` **(** :ref:`String<class_string>` path=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -114,12 +120,24 @@ Create an empty image of a specific size and format.
Alpha-blends a "src_rect" :ref:`Rect2<class_rect2>` from "src" :ref:`Image<class_image>` to this :ref:`Image<class_image>` on coordinates "dest".
.. _class_Image_blend_rect_mask:
- void **blend_rect_mask** **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` mask, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dest=0 **)**
Alpha-blends a "src_rect" :ref:`Rect2<class_rect2>` from "src" :ref:`Image<class_image>` to this :ref:`Image<class_image>` using a "mask" :ref:`Image<class_image>` on coordinates "dest". Alpha channels are required for both "src" and "mask", dest pixels and src pixels will blend if the corresponding mask pixel's alpha value is not 0. "src" :ref:`Image<class_image>` and "mask" :ref:`Image<class_image>` \*must\* have the same size (width and height) but they can have different formats
.. _class_Image_blit_rect:
- void **blit_rect** **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dest=0 **)**
Copy a "src_rect" :ref:`Rect2<class_rect2>` from "src" :ref:`Image<class_image>` to this :ref:`Image<class_image>` on coordinates "dest".
.. _class_Image_blit_rect_mask:
- void **blit_rect_mask** **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` mask, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dest=0 **)**
Blits a "src_rect" :ref:`Rect2<class_rect2>` from "src" :ref:`Image<class_image>` to this :ref:`Image<class_image>` using a "mask" :ref:`Image<class_image>` on coordinates "dest". Alpha channel is required for "mask", will copy src pixel onto dest if the corresponding mask pixel's alpha value is not 0. "src" :ref:`Image<class_image>` and "mask" :ref:`Image<class_image>` \*must\* have the same size (width and height) but they can have different formats
.. _class_Image_brush_transfer:
- void **brush_transfer** **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` brush, :ref:`Vector2<class_vector2>` pos=0 **)**
@@ -156,6 +174,12 @@ Return a new decompressed :ref:`Image<class_image>`.
Return whether this :ref:`Image<class_image>` is empty(no data).
.. _class_Image_fill:
- void **fill** **(** :ref:`Color<class_color>` color=0 **)**
Fills an :ref:`Image<class_image>` with a specified :ref:`Color<class_color>`
.. _class_Image_fix_alpha_edges:
- void **fix_alpha_edges** **(** **)**
classes/class_imagetexture.rst
+1 -1
View File
@@ -113,7 +113,7 @@ Return the storage type. One of :ref:`ImageTexture<class_imagetexture>`.STORAGE\
- void **load** **(** :ref:`String<class_string>` path **)**
Load an :ref:`ImageTexure<class_imagetexure>`.
Load an ImageTexure.
.. _class_ImageTexture_normal_to_xy:
classes/class_kinematicbody2d.rst
+46 -16
View File
@@ -18,37 +18,47 @@ Kinematic body 2D node.
Member Functions
----------------
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_collider<class_KinematicBody2D_get_collider>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_collider_metadata<class_KinematicBody2D_get_collider_metadata>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collider_shape<class_KinematicBody2D_get_collider_shape>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_collider_velocity<class_KinematicBody2D_get_collider_velocity>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_collision_margin<class_KinematicBody2D_get_collision_margin>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_normal<class_KinematicBody2D_get_collision_normal>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_pos<class_KinematicBody2D_get_collision_pos>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_move_and_slide_colliders<class_KinematicBody2D_get_move_and_slide_colliders>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_travel<class_KinematicBody2D_get_travel>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_colliding<class_KinematicBody2D_is_colliding>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_move_and_slide_on_ceiling<class_KinematicBody2D_is_move_and_slide_on_ceiling>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_move_and_slide_on_floor<class_KinematicBody2D_is_move_and_slide_on_floor>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_move_and_slide_on_wall<class_KinematicBody2D_is_move_and_slide_on_wall>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`move<class_KinematicBody2D_move>` **(** :ref:`Vector2<class_vector2>` rel_vec **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`move_and_slide<class_KinematicBody2D_move_and_slide>` **(** :ref:`Vector2<class_vector2>` linear_velocity, :ref:`Vector2<class_vector2>` floor_normal=Vector2(0, 0), :ref:`float<class_float>` slope_stop_min_velocity=5, :ref:`int<class_int>` max_bounces=4 **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`move_to<class_KinematicBody2D_move_to>` **(** :ref:`Vector2<class_vector2>` position **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`revert_motion<class_KinematicBody2D_revert_motion>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_margin<class_KinematicBody2D_set_collision_margin>` **(** :ref:`float<class_float>` pixels **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`test_move<class_KinematicBody2D_test_move>` **(** :ref:`Vector2<class_vector2>` rel_vec **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`test_move_from<class_KinematicBody2D_test_move_from>` **(** :ref:`Matrix32<class_matrix32>` from, :ref:`Vector2<class_vector2>` rel_vec **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -104,6 +114,10 @@ Return the normal of the surface the body collided with. This is useful to imple
Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with :ref:`is_colliding<class_KinematicBody2D_is_colliding>`.
.. _class_KinematicBody2D_get_move_and_slide_colliders:
- :ref:`Array<class_array>` **get_move_and_slide_colliders** **(** **)** const
.. _class_KinematicBody2D_get_travel:
- :ref:`Vector2<class_vector2>` **get_travel** **(** **)** const
@@ -116,12 +130,28 @@ Return the last movement done by the body.
Return whether the body is colliding with another.
.. _class_KinematicBody2D_is_move_and_slide_on_ceiling:
- :ref:`bool<class_bool>` **is_move_and_slide_on_ceiling** **(** **)** const
.. _class_KinematicBody2D_is_move_and_slide_on_floor:
- :ref:`bool<class_bool>` **is_move_and_slide_on_floor** **(** **)** const
.. _class_KinematicBody2D_is_move_and_slide_on_wall:
- :ref:`bool<class_bool>` **is_move_and_slide_on_wall** **(** **)** const
.. _class_KinematicBody2D_move:
- :ref:`Vector2<class_vector2>` **move** **(** :ref:`Vector2<class_vector2>` rel_vec **)**
Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped.
.. _class_KinematicBody2D_move_and_slide:
- :ref:`Vector2<class_vector2>` **move_and_slide** **(** :ref:`Vector2<class_vector2>` linear_velocity, :ref:`Vector2<class_vector2>` floor_normal=Vector2(0, 0), :ref:`float<class_float>` slope_stop_min_velocity=5, :ref:`int<class_int>` max_bounces=4 **)**
.. _class_KinematicBody2D_move_to:
- :ref:`Vector2<class_vector2>` **move_to** **(** :ref:`Vector2<class_vector2>` position **)**
classes/class_margincontainer.rst
+1 -1
View File
@@ -18,5 +18,5 @@ Simple margin container.
Description
-----------
Simple margin container. Adds a left margin to anything contained.
Simple margin container. Adds custom margins to anything contained.
classes/class_mutex.rst
+1 -1
View File
@@ -44,7 +44,7 @@ Lock this :ref:`Mutex<class_mutex>`, blocks until it is unlocked by the current
- Error **try_lock** **(** **)**
Try locking this :ref:`Mutex<class_mutex>`, does not block. Returns :ref:`OK<class_ok>` on success else :ref:`ERR_BUSY<class_err_busy>`.
Try locking this :ref:`Mutex<class_mutex>`, does not block. Returns OK on success else ERR_BUSY.
.. _class_Mutex_unlock:
classes/class_navigationmesh.rst
+6
View File
@@ -23,6 +23,8 @@ Member Functions
+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_polygons<class_NavigationMesh_clear_polygons>` **(** **)** |
+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_from_mesh<class_NavigationMesh_create_from_mesh>` **(** :ref:`Object<class_object>` mesh **)** |
+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`get_polygon<class_NavigationMesh_get_polygon>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_polygon_count<class_NavigationMesh_get_polygon_count>` **(** **)** const |
@@ -43,6 +45,10 @@ Member Function Description
- void **clear_polygons** **(** **)**
.. _class_NavigationMesh_create_from_mesh:
- void **create_from_mesh** **(** :ref:`Object<class_object>` mesh **)**
.. _class_NavigationMesh_get_polygon:
- :ref:`IntArray<class_intarray>` **get_polygon** **(** :ref:`int<class_int>` idx **)**
classes/class_node.rst
+1 -1
View File
@@ -8,7 +8,7 @@ Node
**Inherits:** :ref:`Object<class_object>`
**Inherited By:** :ref:`Viewport<class_viewport>`, :ref:`Timer<class_timer>`, :ref:`CanvasLayer<class_canvaslayer>`, :ref:`EventPlayer<class_eventplayer>`, :ref:`SoundRoomParams<class_soundroomparams>`, :ref:`Spatial<class_spatial>`, :ref:`AnimationPlayer<class_animationplayer>`, :ref:`EditorPlugin<class_editorplugin>`, :ref:`ResourcePreloader<class_resourcepreloader>`, :ref:`AnimationTreePlayer<class_animationtreeplayer>`, :ref:`SamplePlayer<class_sampleplayer>`, :ref:`InstancePlaceholder<class_instanceplaceholder>`, :ref:`HTTPRequest<class_httprequest>`, :ref:`StreamPlayer<class_streamplayer>`, :ref:`CanvasItem<class_canvasitem>`, :ref:`Tween<class_tween>`
**Inherited By:** :ref:`Viewport<class_viewport>`, :ref:`Timer<class_timer>`, :ref:`CanvasLayer<class_canvaslayer>`, :ref:`EventPlayer<class_eventplayer>`, :ref:`SoundRoomParams<class_soundroomparams>`, :ref:`Tween<class_tween>`, :ref:`Spatial<class_spatial>`, :ref:`AnimationPlayer<class_animationplayer>`, :ref:`EditorPlugin<class_editorplugin>`, :ref:`ResourcePreloader<class_resourcepreloader>`, :ref:`AnimationTreePlayer<class_animationtreeplayer>`, :ref:`SamplePlayer<class_sampleplayer>`, :ref:`InstancePlaceholder<class_instanceplaceholder>`, :ref:`HTTPRequest<class_httprequest>`, :ref:`StreamPlayer<class_streamplayer>`, :ref:`CanvasItem<class_canvasitem>`
**Category:** Core
classes/class_object.rst
+2 -2
View File
@@ -53,7 +53,7 @@ Member Functions
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_instance_ID<class_Object_get_instance_ID>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_meta<class_Object_get_meta>` **(** :ref:`String<class_string>` name **)** const |
| :ref:`Variant<class_variant>` | :ref:`get_meta<class_Object_get_meta>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_meta_list<class_Object_get_meta_list>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -228,7 +228,7 @@ Return the instance ID. All objects have a unique instance ID.
.. _class_Object_get_meta:
- void **get_meta** **(** :ref:`String<class_string>` name **)** const
- :ref:`Variant<class_variant>` **get_meta** **(** :ref:`String<class_string>` name **)** const
Return a metadata from the object.
classes/class_os.rst
+1 -1
View File
@@ -376,7 +376,7 @@ Returns the value of the commandline argument "-level".
- :ref:`String<class_string>` **get_data_dir** **(** **)** const
Return the absolute directory path of user data path(:ref:`user://<class_user://>`).
Return the absolute directory path of user data path(user://).
.. _class_OS_get_date:
classes/class_packetpeerudp.rst
+1 -1
View File
@@ -37,7 +37,7 @@ Member Functions
Description
-----------
UDP packet peer. Can be used to send raw UDP packets as well as :ref:`Variant<class_variant>`s.
UDP packet peer. Can be used to send raw UDP packets as well as :ref:`Variant<class_variant>`\ s.
Member Function Description
---------------------------
classes/class_physics2ddirectspacestate.rst
+2 -2
View File
@@ -104,7 +104,7 @@ collider: Object the point is inside of.
rid: :ref:`RID<class_rid>` of the object the point is in.
Additionally, the method can take an array of objects or :ref:`RID<class_rid>`s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK\_\* constants).
Additionally, the method can take an array of objects or :ref:`RID<class_rid>`\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK\_\* constants).
.. _class_Physics2DDirectSpaceState_intersect_ray:
@@ -128,7 +128,7 @@ rid: :ref:`RID<class_rid>` of the object against which the ray was stopped.
If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead.
Additionally, the method can take an array of objects or :ref:`RID<class_rid>`s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK\_\* constants).
Additionally, the method can take an array of objects or :ref:`RID<class_rid>`\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK\_\* constants).
.. _class_Physics2DDirectSpaceState_intersect_shape:
classes/class_physics2dserver.rst
+2 -2
View File
@@ -621,13 +621,13 @@ Set whether a body uses a callback function to calculate its own physics (see :r
- void **body_set_one_way_collision_direction** **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` normal **)**
Set a direction in which bodies can go through the given one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions.
Set a direction from which bodies can go through the given one; that is, the passed vector is the normal of the pass-through side of the surface. If this value is different from (0,0), any movement within 90 degrees of the opposite of this vector is considered an valid movement. Set this direction to (0,0) to disable one-way collisions.
.. _class_Physics2DServer_body_set_one_way_collision_max_depth:
- void **body_set_one_way_collision_max_depth** **(** :ref:`RID<class_rid>` body, :ref:`float<class_float>` depth **)**
Set how far a body can go through the given one, if it allows one-way collisions (see :ref:`body_set_one_way_collision_direction<class_Physics2DServer_body_set_one_way_collision_direction>`).
Set how deep at most a body can be with respect to the given one for the physics server to force it to a non-overlapping position, if it allows one-way collisions (see :ref:`body_set_one_way_collision_direction<class_Physics2DServer_body_set_one_way_collision_direction>`).
.. _class_Physics2DServer_body_set_param:
classes/class_physics2dshapequeryparameters.rst
+2 -2
View File
@@ -62,7 +62,7 @@ Member Function Description
- :ref:`Array<class_array>` **get_exclude** **(** **)** const
Return the list of objects, or object :ref:`RID<class_rid>`s, that will be excluded from collisions.
Return the list of objects, or object :ref:`RID<class_rid>`\ s, that will be excluded from collisions.
.. _class_Physics2DShapeQueryParameters_get_layer_mask:
@@ -104,7 +104,7 @@ Return the transform matrix of the shape queried.
- void **set_exclude** **(** :ref:`Array<class_array>` exclude **)**
Set the list of objects, or object :ref:`RID<class_rid>`s, that will be excluded from collisions.
Set the list of objects, or object :ref:`RID<class_rid>`\ s, that will be excluded from collisions.
.. _class_Physics2DShapeQueryParameters_set_layer_mask:
classes/class_physicsbody2d.rst
+2 -2
View File
@@ -138,12 +138,12 @@ Set/clear individual bits on the layer mask. This makes getting a body in/out of
- void **set_one_way_collision_direction** **(** :ref:`Vector2<class_vector2>` dir **)**
Set a direction in which bodies can go through this one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions.
Set a direction from which bodies can go through this one; that is, the passed vector is the normal of the pass-through side of the surface. If this value is different from (0,0), any movement within 90 degrees of the opposite of this vector is considered an valid movement. Set this direction to (0,0) to disable one-way collisions.
.. _class_PhysicsBody2D_set_one_way_collision_max_depth:
- void **set_one_way_collision_max_depth** **(** :ref:`float<class_float>` depth **)**
Set how far a body can go through this one, when it allows one-way collisions (see :ref:`set_one_way_collision_direction<class_PhysicsBody2D_set_one_way_collision_direction>`).
Set how deep at most a body can be with respect to this one for the physics server to force it to a non-overlapping position, if it allows one-way collisions (see :ref:`body_set_one_way_collision_direction<class_PhysicsBody2D_body_set_one_way_collision_direction>`).
classes/class_rect2.rst
+24 -12
View File
@@ -16,29 +16,33 @@ Brief Description
Member Functions
----------------
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`Rect2<class_Rect2_Rect2>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`Vector2<class_vector2>` size **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`Rect2<class_Rect2_Rect2>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` width, :ref:`float<class_float>` height **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`clip<class_Rect2_clip>` **(** :ref:`Rect2<class_rect2>` b **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`encloses<class_Rect2_encloses>` **(** :ref:`Rect2<class_rect2>` b **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`expand<class_Rect2_expand>` **(** :ref:`Vector2<class_vector2>` to **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_area<class_Rect2_get_area>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`grow<class_Rect2_grow>` **(** :ref:`float<class_float>` by **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`grow_individual<class_Rect2_grow_individual>` **(** :ref:`float<class_float>` left, :ref:`float<class_float>` top, :ref:`float<class_float>` right, :ref:`float<class_float>` bottom **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`grow_margin<class_Rect2_grow_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` by **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_no_area<class_Rect2_has_no_area>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_point<class_Rect2_has_point>` **(** :ref:`Vector2<class_vector2>` point **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`intersects<class_Rect2_intersects>` **(** :ref:`Rect2<class_rect2>` b **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`merge<class_Rect2_merge>` **(** :ref:`Rect2<class_rect2>` b **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -97,6 +101,14 @@ Get the area of the :ref:`Rect2<class_rect2>`.
Return a copy of the :ref:`Rect2<class_rect2>` grown a given amount of units towards all the sides.
.. _class_Rect2_grow_individual:
- :ref:`Rect2<class_rect2>` **grow_individual** **(** :ref:`float<class_float>` left, :ref:`float<class_float>` top, :ref:`float<class_float>` right, :ref:`float<class_float>` bottom **)**
.. _class_Rect2_grow_margin:
- :ref:`Rect2<class_rect2>` **grow_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` by **)**
.. _class_Rect2_has_no_area:
- :ref:`bool<class_bool>` **has_no_area** **(** **)**
classes/class_regex.rst
+4 -4
View File
@@ -51,9 +51,9 @@ would be read by RegEx as ``\d+``
Similarly:
``exp.compile("\"(?:\\\\.|:ref:`^\"<class_^\">`)\*\"")``
``exp.compile("\"(?:\\\\.|[^\"])\*\"")``
would be read as ``"(?:\\.|:ref:`^"<class_^">`)\*"``
would be read as ``"(?:\\.|[^"])\*"``
Currently supported features:
@@ -63,7 +63,7 @@ Currently supported features:
\* Shorthand character classes ``\w \W \s \S \d \D``
\* User-defined character classes such as ``:ref:`A-Za-z<class_a-za-z>```
\* User-defined character classes such as ``[A-Za-z]``
\* Simple quantifiers ``?``, ``\*`` and ``+``
@@ -77,7 +77,7 @@ Currently supported features:
\* Backreferences ``\1`` and ``\g{1}``
\* POSIX character classes ``:ref:`[:alnum:<class_[:alnum:>`]``
\* POSIX character classes ``[[:alnum:]]``
\* Lookahead ``(?=)``, ``(?!)`` and lookbehind ``(?<=)``, ``(?<!)``
classes/class_resource.rst
+1 -1
View File
@@ -8,7 +8,7 @@ Resource
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`Theme<class_theme>`, :ref:`AudioStream<class_audiostream>`, :ref:`EventStream<class_eventstream>`, :ref:`CubeMap<class_cubemap>`, :ref:`DynamicFontData<class_dynamicfontdata>`, :ref:`Translation<class_translation>`, :ref:`Curve2D<class_curve2d>`, :ref:`Shape<class_shape>`, :ref:`Shape2D<class_shape2d>`, :ref:`Shader<class_shader>`, :ref:`ColorRamp<class_colorramp>`, :ref:`StyleBox<class_stylebox>`, :ref:`Environment<class_environment>`, :ref:`Material<class_material>`, :ref:`VideoStream<class_videostream>`, :ref:`RoomBounds<class_roombounds>`, :ref:`PackedScene<class_packedscene>`, :ref:`Texture<class_texture>`, :ref:`Script<class_script>`, :ref:`OccluderPolygon2D<class_occluderpolygon2d>`, :ref:`Mesh<class_mesh>`, :ref:`TileSet<class_tileset>`, :ref:`ShortCut<class_shortcut>`, :ref:`BitMap<class_bitmap>`, :ref:`Animation<class_animation>`, :ref:`Sample<class_sample>`, :ref:`PolygonPathFinder<class_polygonpathfinder>`, :ref:`BakedLight<class_bakedlight>`, :ref:`World<class_world>`, :ref:`SampleLibrary<class_samplelibrary>`, :ref:`World2D<class_world2d>`, :ref:`Font<class_font>`, :ref:`SpriteFrames<class_spriteframes>`, :ref:`MeshLibrary<class_meshlibrary>`, :ref:`Curve3D<class_curve3d>`, :ref:`NavigationPolygon<class_navigationpolygon>`, :ref:`EditorSettings<class_editorsettings>`, :ref:`MultiMesh<class_multimesh>`, :ref:`CanvasItemMaterial<class_canvasitemmaterial>`, :ref:`PackedDataContainer<class_packeddatacontainer>`, :ref:`NavigationMesh<class_navigationmesh>`
**Inherited By:** :ref:`Theme<class_theme>`, :ref:`AudioStream<class_audiostream>`, :ref:`EventStream<class_eventstream>`, :ref:`CubeMap<class_cubemap>`, :ref:`DynamicFontData<class_dynamicfontdata>`, :ref:`Translation<class_translation>`, :ref:`Curve2D<class_curve2d>`, :ref:`Shape<class_shape>`, :ref:`Shape2D<class_shape2d>`, :ref:`Shader<class_shader>`, :ref:`ColorRamp<class_colorramp>`, :ref:`StyleBox<class_stylebox>`, :ref:`Material<class_material>`, :ref:`VideoStream<class_videostream>`, :ref:`RoomBounds<class_roombounds>`, :ref:`PackedScene<class_packedscene>`, :ref:`Texture<class_texture>`, :ref:`Script<class_script>`, :ref:`OccluderPolygon2D<class_occluderpolygon2d>`, :ref:`Mesh<class_mesh>`, :ref:`TileSet<class_tileset>`, :ref:`ShortCut<class_shortcut>`, :ref:`BitMap<class_bitmap>`, :ref:`Animation<class_animation>`, :ref:`Sample<class_sample>`, :ref:`PolygonPathFinder<class_polygonpathfinder>`, :ref:`BakedLight<class_bakedlight>`, :ref:`World<class_world>`, :ref:`SampleLibrary<class_samplelibrary>`, :ref:`World2D<class_world2d>`, :ref:`Font<class_font>`, :ref:`SpriteFrames<class_spriteframes>`, :ref:`MeshLibrary<class_meshlibrary>`, :ref:`Curve3D<class_curve3d>`, :ref:`NavigationPolygon<class_navigationpolygon>`, :ref:`EditorSettings<class_editorsettings>`, :ref:`Environment<class_environment>`, :ref:`MultiMesh<class_multimesh>`, :ref:`CanvasItemMaterial<class_canvasitemmaterial>`, :ref:`PackedDataContainer<class_packeddatacontainer>`, :ref:`NavigationMesh<class_navigationmesh>`
**Category:** Core
classes/class_richtextlabel.rst
+61 -43
View File
@@ -18,83 +18,89 @@ Label that displays rich text.
Member Functions
----------------
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_image<class_RichTextLabel_add_image>` **(** :ref:`Texture<class_texture>` image **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_text<class_RichTextLabel_add_text>` **(** :ref:`String<class_string>` text **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`append_bbcode<class_RichTextLabel_append_bbcode>` **(** :ref:`String<class_string>` bbcode **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_RichTextLabel_clear>` **(** **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_bbcode<class_RichTextLabel_get_bbcode>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_percent_visible<class_RichTextLabel_get_percent_visible>` **(** **)** const |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tab_size<class_RichTextLabel_get_tab_size>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_text<class_RichTextLabel_get_text>` **(** **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_total_character_count<class_RichTextLabel_get_total_character_count>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_v_scroll<class_RichTextLabel_get_v_scroll>` **(** **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VScrollBar<class_vscrollbar>` | :ref:`get_v_scroll<class_RichTextLabel_get_v_scroll>` **(** **)** |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_visible_characters<class_RichTextLabel_get_visible_characters>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_meta_underlined<class_RichTextLabel_is_meta_underlined>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_scroll_active<class_RichTextLabel_is_scroll_active>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_scroll_following<class_RichTextLabel_is_scroll_following>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selection_enabled<class_RichTextLabel_is_selection_enabled>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_using_bbcode<class_RichTextLabel_is_using_bbcode>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`newline<class_RichTextLabel_newline>` **(** **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`parse_bbcode<class_RichTextLabel_parse_bbcode>` **(** :ref:`String<class_string>` bbcode **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`pop<class_RichTextLabel_pop>` **(** **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_align<class_RichTextLabel_push_align>` **(** :ref:`int<class_int>` align **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_cell<class_RichTextLabel_push_cell>` **(** **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_color<class_RichTextLabel_push_color>` **(** :ref:`Color<class_color>` color **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_font<class_RichTextLabel_push_font>` **(** :ref:`Object<class_object>` font **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_font<class_RichTextLabel_push_font>` **(** :ref:`Font<class_font>` font **)** |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_indent<class_RichTextLabel_push_indent>` **(** :ref:`int<class_int>` level **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_list<class_RichTextLabel_push_list>` **(** :ref:`int<class_int>` type **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_meta<class_RichTextLabel_push_meta>` **(** :ref:`Variant<class_variant>` data **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_table<class_RichTextLabel_push_table>` **(** :ref:`int<class_int>` columns **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_underline<class_RichTextLabel_push_underline>` **(** **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`remove_line<class_RichTextLabel_remove_line>` **(** :ref:`int<class_int>` arg0 **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`scroll_to_line<class_RichTextLabel_scroll_to_line>` **(** :ref:`int<class_int>` line **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bbcode<class_RichTextLabel_set_bbcode>` **(** :ref:`String<class_string>` text **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_meta_underline<class_RichTextLabel_set_meta_underline>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_percent_visible<class_RichTextLabel_set_percent_visible>` **(** :ref:`float<class_float>` percent_visible **)** |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scroll_active<class_RichTextLabel_set_scroll_active>` **(** :ref:`bool<class_bool>` active **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scroll_follow<class_RichTextLabel_set_scroll_follow>` **(** :ref:`bool<class_bool>` follow **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selection_enabled<class_RichTextLabel_set_selection_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tab_size<class_RichTextLabel_set_tab_size>` **(** :ref:`int<class_int>` spaces **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_table_column_expand<class_RichTextLabel_set_table_column_expand>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` expand, :ref:`int<class_int>` ratio **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text<class_RichTextLabel_set_text>` **(** :ref:`String<class_string>` text **)** |
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_bbcode<class_RichTextLabel_set_use_bbcode>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_visible_characters<class_RichTextLabel_set_visible_characters>` **(** :ref:`int<class_int>` amount **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -151,6 +157,10 @@ Member Function Description
- :ref:`String<class_string>` **get_bbcode** **(** **)** const
.. _class_RichTextLabel_get_percent_visible:
- :ref:`float<class_float>` **get_percent_visible** **(** **)** const
.. _class_RichTextLabel_get_tab_size:
- :ref:`int<class_int>` **get_tab_size** **(** **)** const
@@ -167,7 +177,7 @@ Returns the raw text, stripping out the formatting information.
.. _class_RichTextLabel_get_v_scroll:
- :ref:`Object<class_object>` **get_v_scroll** **(** **)**
- :ref:`VScrollBar<class_vscrollbar>` **get_v_scroll** **(** **)**
.. _class_RichTextLabel_get_visible_characters:
@@ -221,7 +231,7 @@ Return true if selecting the text inside this richtext is allowed.
.. _class_RichTextLabel_push_font:
- void **push_font** **(** :ref:`Object<class_object>` font **)**
- void **push_font** **(** :ref:`Font<class_font>` font **)**
.. _class_RichTextLabel_push_indent:
@@ -259,6 +269,10 @@ Return true if selecting the text inside this richtext is allowed.
- void **set_meta_underline** **(** :ref:`bool<class_bool>` enable **)**
.. _class_RichTextLabel_set_percent_visible:
- void **set_percent_visible** **(** :ref:`float<class_float>` percent_visible **)**
.. _class_RichTextLabel_set_scroll_active:
- void **set_scroll_active** **(** :ref:`bool<class_bool>` active **)**
@@ -281,6 +295,10 @@ Set to true if selecting the text inside this richtext is allowed.
- void **set_table_column_expand** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` expand, :ref:`int<class_int>` ratio **)**
.. _class_RichTextLabel_set_text:
- void **set_text** **(** :ref:`String<class_string>` text **)**
.. _class_RichTextLabel_set_use_bbcode:
- void **set_use_bbcode** **(** :ref:`bool<class_bool>` enable **)**
classes/class_scrollcontainer.rst
+1 -1
View File
@@ -39,7 +39,7 @@ Member Functions
Description
-----------
A ScrollContainer node with a :ref:`Control<class_control>` child and scrollbar child (:ref:`HScrollbar<class_hscrollbar>`, :ref:`VScrollBar<class_vscrollbar>`, or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel<class_panel>` control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension).
A ScrollContainer node with a :ref:`Control<class_control>` child and scrollbar child (HScrollbar, :ref:`VScrollBar<class_vscrollbar>`, or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel<class_panel>` control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension).
Member Function Description
---------------------------
classes/class_splitcontainer.rst
+2 -2
View File
@@ -60,7 +60,7 @@ Member Function Description
- :ref:`int<class_int>` **get_dragger_visibility** **(** **)** const
Return visibility of the split dragger(One of :ref:`DRAGGER_VISIBLE<class_dragger_visible>`, :ref:`DRAGGER_HIDDEN<class_dragger_hidden>` or :ref:`DRAGGER_HIDDEN_COLLAPSED<class_dragger_hidden_collapsed>`).
Return visibility of the split dragger(One of DRAGGER_VISIBLE, DRAGGER_HIDDEN or DRAGGER_HIDDEN_COLLAPSED).
.. _class_SplitContainer_get_split_offset:
@@ -84,7 +84,7 @@ Set if the split must be collapsed.
- void **set_dragger_visibility** **(** :ref:`int<class_int>` mode **)**
Set visibility of the split dragger(*mode* must be one of :ref:`DRAGGER_VISIBLE<class_dragger_visible>`, :ref:`DRAGGER_HIDDEN<class_dragger_hidden>` or :ref:`DRAGGER_HIDDEN_COLLAPSED<class_dragger_hidden_collapsed>`).
Set visibility of the split dragger(*mode* must be one of DRAGGER_VISIBLE, DRAGGER_HIDDEN or DRAGGER_HIDDEN_COLLAPSED).
.. _class_SplitContainer_set_split_offset:
classes/class_spritebase3d.rst
+3 -1
View File
@@ -69,7 +69,9 @@ Numeric Constants
- **FLAG_TRANSPARENT** = **0**
- **FLAG_SHADED** = **1**
- **FLAG_MAX** = **2**
- **FLAG_DOUBLE_SIDED** = **2**
- **FLAG_ONTOP** = **3**
- **FLAG_MAX** = **4**
- **ALPHA_CUT_DISABLED** = **0**
- **ALPHA_CUT_DISCARD** = **1**
- **ALPHA_CUT_OPAQUE_PREPASS** = **2**
classes/class_staticbody.rst
+1 -1
View File
@@ -39,7 +39,7 @@ Member Functions
Description
-----------
Static body for 3D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a :ref:`RigidBody3D<class_rigidbody3d>` so they are great for scenario collision.
Static body for 3D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a RigidBody3D so they are great for scenario collision.
A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies.
classes/class_streampeer.rst
+1 -1
View File
@@ -8,7 +8,7 @@ StreamPeer
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherited By:** :ref:`StreamPeerSSL<class_streampeerssl>`, :ref:`StreamPeerTCP<class_streampeertcp>`
**Inherited By:** :ref:`StreamPeerBuffer<class_streampeerbuffer>`, :ref:`StreamPeerSSL<class_streampeerssl>`, :ref:`StreamPeerTCP<class_streampeertcp>`
**Category:** Core
classes/class_streampeerbuffer.rst
+74
View File
@@ -0,0 +1,74 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_StreamPeerBuffer:
StreamPeerBuffer
================
**Inherits:** :ref:`StreamPeer<class_streampeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_StreamPeerBuffer_clear>` **(** **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`duplicate<class_StreamPeerBuffer_duplicate>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`get_data_array<class_StreamPeerBuffer_get_data_array>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_pos<class_StreamPeerBuffer_get_pos>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_size<class_StreamPeerBuffer_get_size>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`resize<class_StreamPeerBuffer_resize>` **(** :ref:`int<class_int>` size **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_StreamPeerBuffer_seek>` **(** :ref:`int<class_int>` pos **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_data_array<class_StreamPeerBuffer_set_data_array>` **(** :ref:`RawArray<class_rawarray>` data **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_StreamPeerBuffer_clear:
- void **clear** **(** **)**
.. _class_StreamPeerBuffer_duplicate:
- :ref:`Object<class_object>` **duplicate** **(** **)** const
.. _class_StreamPeerBuffer_get_data_array:
- :ref:`RawArray<class_rawarray>` **get_data_array** **(** **)** const
.. _class_StreamPeerBuffer_get_pos:
- :ref:`int<class_int>` **get_pos** **(** **)** const
.. _class_StreamPeerBuffer_get_size:
- :ref:`int<class_int>` **get_size** **(** **)** const
.. _class_StreamPeerBuffer_resize:
- void **resize** **(** :ref:`int<class_int>` size **)**
.. _class_StreamPeerBuffer_seek:
- void **seek** **(** :ref:`int<class_int>` pos **)**
.. _class_StreamPeerBuffer_set_data_array:
- void **set_data_array** **(** :ref:`RawArray<class_rawarray>` data **)**
classes/class_streampeertcp.rst
+1 -1
View File
@@ -52,7 +52,7 @@ Member Function Description
- :ref:`int<class_int>` **connect** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)**
Connect to the specified host:port pair. A hostname will be resolved if valid. Returns :ref:`OK<class_ok>` on success or :ref:`FAILED<class_failed>` on failure.
Connect to the specified host:port pair. A hostname will be resolved if valid. Returns OK on success or FAILED on failure.
.. _class_StreamPeerTCP_disconnect:
classes/class_string.rst
+8 -2
View File
@@ -95,6 +95,8 @@ Member Functions
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`findn<class_String_findn>` **(** :ref:`String<class_string>` what, :ref:`int<class_int>` from=0 **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`format<class_String_format>` **(** var values, :ref:`String<class_string>` placeholder={_} **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_base_dir<class_String_get_base_dir>` **(** **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_file<class_String_get_file>` **(** **)** |
@@ -384,6 +386,10 @@ Find the last occurrence of a substring, return the starting position of the sub
Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.
.. _class_String_format:
- :ref:`String<class_string>` **format** **(** var values, :ref:`String<class_string>` placeholder={_} **)**
.. _class_String_get_base_dir:
- :ref:`String<class_string>` **get_base_dir** **(** **)**
@@ -602,13 +608,13 @@ Return the similarity index of the text compared to this string. 1 means totally
- :ref:`StringArray<class_stringarray>` **split** **(** :ref:`String<class_string>` divisor, :ref:`bool<class_bool>` allow_empty=True **)**
Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return :ref:`"One","Two","Three"<class_"one","two","three">` if split by ",".
Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return "One","Two","Three" if split by ",".
.. _class_String_split_floats:
- :ref:`RealArray<class_realarray>` **split_floats** **(** :ref:`String<class_string>` divisor, :ref:`bool<class_bool>` allow_empty=True **)**
Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return :ref:`1,2.5,3<class_1,2.5,3>` if split by ",".
Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return 1,2.5,3 if split by ",".
.. _class_String_strip_edges:
classes/class_surfacetool.rst
+24
View File
@@ -31,6 +31,8 @@ Member Functions
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_tangent<class_SurfaceTool_add_tangent>` **(** :ref:`Plane<class_plane>` tangent **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_to_format<class_SurfaceTool_add_to_format>` **(** :ref:`int<class_int>` flags **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_triangle_fan<class_SurfaceTool_add_triangle_fan>` **(** :ref:`Vector3Array<class_vector3array>` vertexes, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array([]), :ref:`ColorArray<class_colorarray>` colors=ColorArray([ColorArray]), :ref:`Vector2Array<class_vector2array>` uv2s=Vector2Array([]), :ref:`Vector3Array<class_vector3array>` normals=Vector3Array([]), :ref:`Array<class_array>` tangents=Array() **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_uv<class_SurfaceTool_add_uv>` **(** :ref:`Vector2<class_vector2>` uv **)** |
@@ -41,16 +43,22 @@ Member Functions
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_weights<class_SurfaceTool_add_weights>` **(** :ref:`RealArray<class_realarray>` weights **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`append_from<class_SurfaceTool_append_from>` **(** :ref:`Mesh<class_mesh>` existing, :ref:`int<class_int>` surface, :ref:`Transform<class_transform>` transform **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`begin<class_SurfaceTool_begin>` **(** :ref:`int<class_int>` primitive **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_SurfaceTool_clear>` **(** **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Mesh<class_mesh>` | :ref:`commit<class_SurfaceTool_commit>` **(** :ref:`Mesh<class_mesh>` existing=NULL **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_from<class_SurfaceTool_create_from>` **(** :ref:`Mesh<class_mesh>` existing, :ref:`int<class_int>` surface **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`deindex<class_SurfaceTool_deindex>` **(** **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`generate_normals<class_SurfaceTool_generate_normals>` **(** **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`generate_tangents<class_SurfaceTool_generate_tangents>` **(** **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`index<class_SurfaceTool_index>` **(** **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_material<class_SurfaceTool_set_material>` **(** :ref:`Material<class_material>` material **)** |
@@ -112,6 +120,10 @@ Specify whether current Vertex (if using only Vertex arrays) or current index (i
Specify a Tangent for the next Vertex to use.
.. _class_SurfaceTool_add_to_format:
- void **add_to_format** **(** :ref:`int<class_int>` flags **)**
.. _class_SurfaceTool_add_triangle_fan:
- void **add_triangle_fan** **(** :ref:`Vector3Array<class_vector3array>` vertexes, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array([]), :ref:`ColorArray<class_colorarray>` colors=ColorArray([ColorArray]), :ref:`Vector2Array<class_vector2array>` uv2s=Vector2Array([]), :ref:`Vector3Array<class_vector3array>` normals=Vector3Array([]), :ref:`Array<class_array>` tangents=Array() **)**
@@ -142,6 +154,10 @@ Specify position of current Vertex. Should be called after specifying other vert
Specify weight value for next Vertex to use.
.. _class_SurfaceTool_append_from:
- void **append_from** **(** :ref:`Mesh<class_mesh>` existing, :ref:`int<class_int>` surface, :ref:`Transform<class_transform>` transform **)**
.. _class_SurfaceTool_begin:
- void **begin** **(** :ref:`int<class_int>` primitive **)**
@@ -160,6 +176,10 @@ Clear all information passed into the surface tool so far.
Returns a constructed :ref:`Mesh<class_mesh>` from current information passed in. If an existing :ref:`Mesh<class_mesh>` is passed in as an argument, will add an extra surface to the existing :ref:`Mesh<class_mesh>`.
.. _class_SurfaceTool_create_from:
- void **create_from** **(** :ref:`Mesh<class_mesh>` existing, :ref:`int<class_int>` surface **)**
.. _class_SurfaceTool_deindex:
- void **deindex** **(** **)**
@@ -172,6 +192,10 @@ Removes index array by expanding Vertex array.
Generates normals from Vertices so you do not have to do it manually.
.. _class_SurfaceTool_generate_tangents:
- void **generate_tangents** **(** **)**
.. _class_SurfaceTool_index:
- void **index** **(** **)**
classes/class_tabcontainer.rst
+1 -1
View File
@@ -57,7 +57,7 @@ Signals
- **pre_popup_pressed** **(** **)**
- **tab_changed** **(** :ref:`int<class_int>` tab **)**
Emitted when a tab gets selected. Same behavior as :ref:`tab_selected<class_tab_selected>` signal for backward compatibility. Note: In Godot v3.0+ this will change to be only emitted when tab gets changed.
Emitted when a tab gets selected. Same behavior as tab_selected signal for backward compatibility. Note: In Godot v3.0+ this will change to be only emitted when tab gets changed.
- **tab_selected** **(** :ref:`int<class_int>` tab **)**
Emitted when a tab is being selected, even if it is the same tab.
classes/class_tabs.rst
+15 -15
View File
@@ -18,31 +18,31 @@ Tabs Control.
Member Functions
----------------
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_tab<class_Tabs_add_tab>` **(** :ref:`String<class_string>` title, :ref:`Texture<class_texture>` icon **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_tab<class_Tabs_add_tab>` **(** :ref:`String<class_string>` title="", :ref:`Texture<class_texture>` icon=NULL **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`ensure_tab_visible<class_Tabs_ensure_tab_visible>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_current_tab<class_Tabs_get_current_tab>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tab_align<class_Tabs_get_tab_align>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tab_count<class_Tabs_get_tab_count>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_tab_icon<class_Tabs_get_tab_icon>` **(** :ref:`int<class_int>` tab_idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_tab_title<class_Tabs_get_tab_title>` **(** :ref:`int<class_int>` tab_idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_tab<class_Tabs_remove_tab>` **(** :ref:`int<class_int>` tab_idx **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_tab<class_Tabs_set_current_tab>` **(** :ref:`int<class_int>` tab_idx **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tab_align<class_Tabs_set_tab_align>` **(** :ref:`int<class_int>` align **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tab_icon<class_Tabs_set_tab_icon>` **(** :ref:`int<class_int>` tab_idx, :ref:`Texture<class_texture>` icon **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tab_title<class_Tabs_set_tab_title>` **(** :ref:`int<class_int>` tab_idx, :ref:`String<class_string>` title **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -71,7 +71,7 @@ Member Function Description
.. _class_Tabs_add_tab:
- void **add_tab** **(** :ref:`String<class_string>` title, :ref:`Texture<class_texture>` icon **)**
- void **add_tab** **(** :ref:`String<class_string>` title="", :ref:`Texture<class_texture>` icon=NULL **)**
.. _class_Tabs_ensure_tab_visible:
classes/class_thread.rst
+1 -1
View File
@@ -38,7 +38,7 @@ Numeric Constants
Description
-----------
A unit of execution in a process. Can run methods on :ref:`Object<class_object>`s simultaneously. The use of synchronization via :ref:`Mutex<class_mutex>`, :ref:`Semaphore<class_semaphore>` is advised if working with shared objects.
A unit of execution in a process. Can run methods on :ref:`Object<class_object>`\ s simultaneously. The use of synchronization via :ref:`Mutex<class_mutex>`, :ref:`Semaphore<class_semaphore>` is advised if working with shared objects.
Member Function Description
---------------------------
classes/class_tilemap.rst
+6
View File
@@ -61,6 +61,8 @@ Member Functions
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_used_cells<class_TileMap_get_used_cells>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_used_cells_by_id<class_TileMap_get_used_cells_by_id>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_used_rect<class_TileMap_get_used_rect>` **(** **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_cell_transposed<class_TileMap_is_cell_transposed>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y **)** const |
@@ -267,6 +269,10 @@ Return the current tileset.
Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1).
.. _class_TileMap_get_used_cells_by_id:
- :ref:`Array<class_array>` **get_used_cells_by_id** **(** :ref:`int<class_int>` id **)** const
.. _class_TileMap_get_used_rect:
- :ref:`Rect2<class_rect2>` **get_used_rect** **(** **)**
classes/class_tween.rst
+1 -1
View File
@@ -174,7 +174,7 @@ Call ``callback`` of ``object`` after ``times_in_sec``. ``arg1``-``arg5`` are ar
- :ref:`bool<class_bool>` **interpolate_deferred_callback** **(** :ref:`Object<class_object>` object, :ref:`float<class_float>` times_in_sec, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` arg1=NULL, :ref:`Variant<class_variant>` arg2=NULL, :ref:`Variant<class_variant>` arg3=NULL, :ref:`Variant<class_variant>` arg4=NULL, :ref:`Variant<class_variant>` arg5=NULL **)**
Call ``callback`` of ``object`` after ``times_in_sec`` on the main thread (similar to :ref:`methog Object.call_deferred). [code<class_methog object.call_deferred). [code>`arg1``-``arg5`` are arguments to be passed to the callback.
Call ``callback`` of ``object`` after ``times_in_sec`` on the main thread (similar to methog Object.call_deferred). [codearg1``-``arg5`` are arguments to be passed to the callback.
.. _class_Tween_interpolate_method:
classes/class_vector2.rst
+4
View File
@@ -88,6 +88,8 @@ Constructs a new Vector2 from the given x and y.
- :ref:`Vector2<class_vector2>` **abs** **(** **)**
Returns a new vector with all components in absolute values (i.e. positive).
.. _class_Vector2_angle:
- :ref:`float<class_float>` **angle** **(** **)**
@@ -112,6 +114,8 @@ Returns the angle in radians between the line connecting the two points and the
- :ref:`Vector2<class_vector2>` **clamped** **(** :ref:`float<class_float>` length **)**
Returns the vector with a maximum length.
.. _class_Vector2_cubic_interpolate:
- :ref:`Vector2<class_vector2>` **cubic_interpolate** **(** :ref:`Vector2<class_vector2>` b, :ref:`Vector2<class_vector2>` pre_a, :ref:`Vector2<class_vector2>` post_b, :ref:`float<class_float>` t **)**
classes/class_vector3.rst
+1 -1
View File
@@ -92,7 +92,7 @@ Returns a Vector3 with the given components.
- :ref:`Vector3<class_vector3>` **abs** **(** **)**
Returns a new vector with all components in absolute values (e.g. positive).
Returns a new vector with all components in absolute values (i.e. positive).
.. _class_Vector3_angle_to:
classes/class_viewport.rst
+1 -1
View File
@@ -389,7 +389,7 @@ Set the viewport's render target mode.
- void **set_canvas_transform** **(** :ref:`Matrix32<class_matrix32>` xform **)**
Set the canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem<class_canvasitem>`s. This is relative to the global canvas transform of the viewport.
Set the canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem<class_canvasitem>`\ s. This is relative to the global canvas transform of the viewport.
.. _class_Viewport_set_disable_input:
classes/class_viewportsprite.rst
+1 -1
View File
@@ -39,7 +39,7 @@ Member Functions
Description
-----------
Used to display a :ref:`Viewport<class_viewport>` node at some position in the world, without having to mess with :ref:`RenderTargetTexture<class_rendertargettexture>`s.
Used to display a :ref:`Viewport<class_viewport>` node at some position in the world, without having to mess with :ref:`RenderTargetTexture<class_rendertargettexture>`\ s.
Member Function Description
---------------------------
classes/class_visualserver.rst
+6
View File
@@ -297,6 +297,8 @@ Member Functions
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_clear_color<class_VisualServer_set_default_clear_color>` **(** :ref:`Color<class_color>` arg0 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_time_scale<class_VisualServer_set_time_scale>` **(** :ref:`float<class_float>` arg0 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`shader_create<class_VisualServer_shader_create>` **(** :ref:`int<class_int>` mode=0 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`shader_set_mode<class_VisualServer_shader_set_mode>` **(** :ref:`RID<class_rid>` shader, :ref:`int<class_int>` mode **)** |
@@ -1030,6 +1032,10 @@ Member Function Description
- void **set_default_clear_color** **(** :ref:`Color<class_color>` arg0 **)**
.. _class_VisualServer_set_time_scale:
- void **set_time_scale** **(** :ref:`float<class_float>` arg0 **)**
.. _class_VisualServer_shader_create:
- :ref:`RID<class_rid>` **shader_create** **(** :ref:`int<class_int>` mode=0 **)**