Browse Source

Sync classref with current source

Rémi Verschelde 6 years ago
parent
commit
471a0e23ac

+ 5 - 5
classes/[email protected]

@@ -297,15 +297,15 @@ Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``.
 
 
 - void **assert** **(** :ref:`bool<class_bool>` condition **)**
 - void **assert** **(** :ref:`bool<class_bool>` condition **)**
 
 
-Assert that the ``condition`` is ``true`` . If the ``condition`` is ``false`` a fatal error is generated and the program is halted. Useful for debugging to make sure a value is always ``true``.
+Asserts that the ``condition`` is ``true`` . If the ``condition`` is ``false``, an error is generated and the program is halted until you resume it. Only executes in debug builds, or when running the game from the editor. Use it for debugging purposes, to make sure a statement is ``true`` during development.
 
 
 ::
 ::
 
 
-    # Speed should always be between 0 and 20
+    # Imagine we always want speed to be between 0 and 20
     speed = -10
     speed = -10
-    assert(speed < 20) # Is true and program continues
-    assert(speed >= 0) # Is false and program stops
-    assert(speed >= 0 && speed < 20) # Or combined
+    assert(speed < 20) # True, the program will continue
+    assert(speed >= 0) # False, the program will stop
+    assert(speed >= 0 && speed < 20) # You can also combine the two conditional statements in one check
 
 
 .. _class_@GDScript_method_atan:
 .. _class_@GDScript_method_atan:
 
 

+ 0 - 8
classes/class_arraymesh.rst

@@ -57,8 +57,6 @@ Methods
 +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | void                                          | :ref:`surface_remove<class_ArrayMesh_method_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)**                                                                                                                                                                       |
 | void                                          | :ref:`surface_remove<class_ArrayMesh_method_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)**                                                                                                                                                                       |
 +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                                          | :ref:`surface_set_material<class_ArrayMesh_method_surface_set_material>` **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_Material>` material **)**                                                                                                                 |
-+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | void                                          | :ref:`surface_set_name<class_ArrayMesh_method_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)**                                                                                                                                 |
 | void                                          | :ref:`surface_set_name<class_ArrayMesh_method_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)**                                                                                                                                 |
 +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | void                                          | :ref:`surface_update_region<class_ArrayMesh_method_surface_update_region>` **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)**                                                                           |
 | void                                          | :ref:`surface_update_region<class_ArrayMesh_method_surface_update_region>` **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)**                                                                           |
@@ -305,12 +303,6 @@ Returns the primitive type of the requested surface (see :ref:`add_surface_from_
 
 
 Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
 Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
 
 
-.. _class_ArrayMesh_method_surface_set_material:
-
-- void **surface_set_material** **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_Material>` material **)**
-
-Set a :ref:`Material<class_Material>` for a given surface. Surface will be rendered using this material.
-
 .. _class_ArrayMesh_method_surface_set_name:
 .. _class_ArrayMesh_method_surface_set_name:
 
 
 - void **surface_set_name** **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)**
 - void **surface_set_name** **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)**

+ 5 - 5
classes/class_audioeffectreverb.rst

@@ -87,11 +87,11 @@ High-pass filter passes signals with a frequency higher than a certain cutoff fr
 
 
 - :ref:`float<class_float>` **predelay_feedback**
 - :ref:`float<class_float>` **predelay_feedback**
 
 
-+----------+--------------------------+
-| *Setter* | set_predelay_msec(value) |
-+----------+--------------------------+
-| *Getter* | get_predelay_msec()      |
-+----------+--------------------------+
++----------+------------------------------+
+| *Setter* | set_predelay_feedback(value) |
++----------+------------------------------+
+| *Getter* | get_predelay_feedback()      |
++----------+------------------------------+
 
 
 Output percent of predelay. Value can range from 0 to 1. Default value: ``1``.
 Output percent of predelay. Value can range from 0 to 1. Default value: ``1``.
 
 

+ 9 - 15
classes/class_control.rst

@@ -850,11 +850,9 @@ Enables whether rendering of children should be clipped to this control's rectan
 
 
 - :ref:`Vector2<class_Vector2>` **rect_global_position**
 - :ref:`Vector2<class_Vector2>` **rect_global_position**
 
 
-+----------+----------------------------+
-| *Setter* | set_global_position(value) |
-+----------+----------------------------+
-| *Getter* | get_global_position()      |
-+----------+----------------------------+
++----------+-----------------------+
+| *Getter* | get_global_position() |
++----------+-----------------------+
 
 
 The node's global position, relative to the world (usually to the top-left corner of the window).
 The node's global position, relative to the world (usually to the top-left corner of the window).
 
 
@@ -886,11 +884,9 @@ By default, the node's pivot is its top-left corner. When you change its :ref:`r
 
 
 - :ref:`Vector2<class_Vector2>` **rect_position**
 - :ref:`Vector2<class_Vector2>` **rect_position**
 
 
-+----------+---------------------+
-| *Setter* | set_position(value) |
-+----------+---------------------+
-| *Getter* | get_position()      |
-+----------+---------------------+
++----------+----------------+
+| *Getter* | get_position() |
++----------+----------------+
 
 
 The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>`.
 The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>`.
 
 
@@ -922,11 +918,9 @@ The node's scale, relative to its :ref:`rect_size<class_Control_property_rect_si
 
 
 - :ref:`Vector2<class_Vector2>` **rect_size**
 - :ref:`Vector2<class_Vector2>` **rect_size**
 
 
-+----------+-----------------+
-| *Setter* | set_size(value) |
-+----------+-----------------+
-| *Getter* | get_size()      |
-+----------+-----------------+
++----------+------------+
+| *Getter* | get_size() |
++----------+------------+
 
 
 The size of the node's bounding rectangle, in pixels. :ref:`Container<class_Container>` nodes update this property automatically.
 The size of the node's bounding rectangle, in pixels. :ref:`Container<class_Container>` nodes update this property automatically.
 
 

+ 5 - 5
classes/class_environment.rst

@@ -1161,11 +1161,11 @@ Glow strength.
 
 
 - :ref:`SSAOBlur<enum_Environment_SSAOBlur>` **ssao_blur**
 - :ref:`SSAOBlur<enum_Environment_SSAOBlur>` **ssao_blur**
 
 
-+----------+------------------------+
-| *Setter* | set_ssao_blur(value)   |
-+----------+------------------------+
-| *Getter* | is_ssao_blur_enabled() |
-+----------+------------------------+
++----------+----------------------+
+| *Setter* | set_ssao_blur(value) |
++----------+----------------------+
+| *Getter* | get_ssao_blur()      |
++----------+----------------------+
 
 
 .. _class_Environment_property_ssao_color:
 .. _class_Environment_property_ssao_color:
 
 

+ 19 - 5
classes/class_inputeventaction.rst

@@ -19,11 +19,13 @@ Input event type for actions.
 Properties
 Properties
 ----------
 ----------
 
 
-+-----------------------------+---------------------------------------------------------+
-| :ref:`String<class_String>` | :ref:`action<class_InputEventAction_property_action>`   |
-+-----------------------------+---------------------------------------------------------+
-| :ref:`bool<class_bool>`     | :ref:`pressed<class_InputEventAction_property_pressed>` |
-+-----------------------------+---------------------------------------------------------+
++-----------------------------+-----------------------------------------------------------+
+| :ref:`String<class_String>` | :ref:`action<class_InputEventAction_property_action>`     |
++-----------------------------+-----------------------------------------------------------+
+| :ref:`bool<class_bool>`     | :ref:`pressed<class_InputEventAction_property_pressed>`   |
++-----------------------------+-----------------------------------------------------------+
+| :ref:`float<class_float>`   | :ref:`strength<class_InputEventAction_property_strength>` |
++-----------------------------+-----------------------------------------------------------+
 
 
 Description
 Description
 -----------
 -----------
@@ -62,3 +64,15 @@ The action's name. Actions are accessed via this :ref:`String<class_String>`.
 
 
 If ``true``, the action's state is pressed. If ``false``, the action's state is released.
 If ``true``, the action's state is pressed. If ``false``, the action's state is released.
 
 
+.. _class_InputEventAction_property_strength:
+
+- :ref:`float<class_float>` **strength**
+
++----------+---------------------+
+| *Setter* | set_strength(value) |
++----------+---------------------+
+| *Getter* | get_strength()      |
++----------+---------------------+
+
+The action's strength between 0 and 1. This value is consired as equal to 0 if pressed is ``false``. The event strength allows faking analog joypad motion events, by precising how strongly is the joypad axis bent or pressed.
+

+ 1 - 1
classes/class_inputeventkey.rst

@@ -95,7 +95,7 @@ Key scancode, one of the :ref:`KeyList<enum_@GlobalScope_KeyList>` constants.
 | *Getter* | get_unicode()      |
 | *Getter* | get_unicode()      |
 +----------+--------------------+
 +----------+--------------------+
 
 
-Key unicode identifier when relevant.
+Key unicode identifier when relevant. Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See :ref:`OS.set_ime_active<class_OS_method_set_ime_active>` for more information.
 
 
 Method Descriptions
 Method Descriptions
 -------------------
 -------------------

+ 27 - 19
classes/class_mesh.rst

@@ -28,25 +28,27 @@ Properties
 Methods
 Methods
 -------
 -------
 
 
-+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`Shape<class_Shape>`                       | :ref:`create_convex_shape<class_Mesh_method_create_convex_shape>` **(** **)** const                                                      |
-+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`Mesh<class_Mesh>`                         | :ref:`create_outline<class_Mesh_method_create_outline>` **(** :ref:`float<class_float>` margin **)** const                               |
-+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`Shape<class_Shape>`                       | :ref:`create_trimesh_shape<class_Mesh_method_create_trimesh_shape>` **(** **)** const                                                    |
-+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`TriangleMesh<class_TriangleMesh>`         | :ref:`generate_triangle_mesh<class_Mesh_method_generate_triangle_mesh>` **(** **)** const                                                |
-+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_faces<class_Mesh_method_get_faces>` **(** **)** const                                                                          |
-+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`int<class_int>`                           | :ref:`get_surface_count<class_Mesh_method_get_surface_count>` **(** **)** const                                                          |
-+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`Array<class_Array>`                       | :ref:`surface_get_arrays<class_Mesh_method_surface_get_arrays>` **(** :ref:`int<class_int>` surf_idx **)** const                         |
-+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`Array<class_Array>`                       | :ref:`surface_get_blend_shape_arrays<class_Mesh_method_surface_get_blend_shape_arrays>` **(** :ref:`int<class_int>` surf_idx **)** const |
-+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`Material<class_Material>`                 | :ref:`surface_get_material<class_Mesh_method_surface_get_material>` **(** :ref:`int<class_int>` surf_idx **)** const                     |
-+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`Shape<class_Shape>`                       | :ref:`create_convex_shape<class_Mesh_method_create_convex_shape>` **(** **)** const                                                                      |
++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`Mesh<class_Mesh>`                         | :ref:`create_outline<class_Mesh_method_create_outline>` **(** :ref:`float<class_float>` margin **)** const                                               |
++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`Shape<class_Shape>`                       | :ref:`create_trimesh_shape<class_Mesh_method_create_trimesh_shape>` **(** **)** const                                                                    |
++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`TriangleMesh<class_TriangleMesh>`         | :ref:`generate_triangle_mesh<class_Mesh_method_generate_triangle_mesh>` **(** **)** const                                                                |
++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_faces<class_Mesh_method_get_faces>` **(** **)** const                                                                                          |
++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`int<class_int>`                           | :ref:`get_surface_count<class_Mesh_method_get_surface_count>` **(** **)** const                                                                          |
++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`Array<class_Array>`                       | :ref:`surface_get_arrays<class_Mesh_method_surface_get_arrays>` **(** :ref:`int<class_int>` surf_idx **)** const                                         |
++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`Array<class_Array>`                       | :ref:`surface_get_blend_shape_arrays<class_Mesh_method_surface_get_blend_shape_arrays>` **(** :ref:`int<class_int>` surf_idx **)** const                 |
++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`Material<class_Material>`                 | :ref:`surface_get_material<class_Mesh_method_surface_get_material>` **(** :ref:`int<class_int>` surf_idx **)** const                                     |
++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                                            | :ref:`surface_set_material<class_Mesh_method_surface_set_material>` **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_Material>` material **)** |
++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 
 Enumerations
 Enumerations
 ------------
 ------------
@@ -306,3 +308,9 @@ Returns the blend shape arrays for the requested surface.
 
 
 Returns a :ref:`Material<class_Material>` in a given surface. Surface is rendered using this material.
 Returns a :ref:`Material<class_Material>` in a given surface. Surface is rendered using this material.
 
 
+.. _class_Mesh_method_surface_set_material:
+
+- void **surface_set_material** **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_Material>` material **)**
+
+Set a :ref:`Material<class_Material>` for a given surface. Surface will be rendered using this material.
+

+ 75 - 0
classes/class_multimeshinstance2d.rst

@@ -0,0 +1,75 @@
+.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
+.. DO NOT EDIT THIS FILE, but the MultiMeshInstance2D.xml source instead.
+.. The source is found in doc/classes or modules/<name>/doc_classes.
+
+.. _class_MultiMeshInstance2D:
+
+MultiMeshInstance2D
+===================
+
+**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
+
+**Category:** Core
+
+Brief Description
+-----------------
+
+Node that instances a :ref:`MultiMesh<class_MultiMesh>` in 2D.
+
+Properties
+----------
+
++-----------------------------------+------------------------------------------------------------------+
+| :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance2D_property_multimesh>`   |
++-----------------------------------+------------------------------------------------------------------+
+| :ref:`Texture<class_Texture>`     | :ref:`normal_map<class_MultiMeshInstance2D_property_normal_map>` |
++-----------------------------------+------------------------------------------------------------------+
+| :ref:`Texture<class_Texture>`     | :ref:`texture<class_MultiMeshInstance2D_property_texture>`       |
++-----------------------------------+------------------------------------------------------------------+
+
+Description
+-----------
+
+``MultiMeshInstance2D`` is a specialized node to instance a :ref:`MultiMesh<class_MultiMesh>` resource in 2D.
+
+Usage is the same as :ref:`MultiMeshInstance<class_MultiMeshInstance>`.
+
+Property Descriptions
+---------------------
+
+.. _class_MultiMeshInstance2D_property_multimesh:
+
+- :ref:`MultiMesh<class_MultiMesh>` **multimesh**
+
++----------+----------------------+
+| *Setter* | set_multimesh(value) |
++----------+----------------------+
+| *Getter* | get_multimesh()      |
++----------+----------------------+
+
+The :ref:`MultiMesh<class_MultiMesh>` that will be drawn by the ``MultiMeshInstance2D``.
+
+.. _class_MultiMeshInstance2D_property_normal_map:
+
+- :ref:`Texture<class_Texture>` **normal_map**
+
++----------+-----------------------+
+| *Setter* | set_normal_map(value) |
++----------+-----------------------+
+| *Getter* | get_normal_map()      |
++----------+-----------------------+
+
+The normal map that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`.
+
+.. _class_MultiMeshInstance2D_property_texture:
+
+- :ref:`Texture<class_Texture>` **texture**
+
++----------+--------------------+
+| *Setter* | set_texture(value) |
++----------+--------------------+
+| *Getter* | get_texture()      |
++----------+--------------------+
+
+The :ref:`Texture<class_Texture>` that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`. Can be accessed as ``TEXTURE`` in CanvasItem shader.
+

+ 1 - 1
classes/class_node2d.rst

@@ -9,7 +9,7 @@ Node2D
 
 
 **Inherits:** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
 
 
-**Inherited By:** :ref:`AnimatedSprite<class_AnimatedSprite>`, :ref:`AudioStreamPlayer2D<class_AudioStreamPlayer2D>`, :ref:`BackBufferCopy<class_BackBufferCopy>`, :ref:`Bone2D<class_Bone2D>`, :ref:`CPUParticles2D<class_CPUParticles2D>`, :ref:`Camera2D<class_Camera2D>`, :ref:`CanvasModulate<class_CanvasModulate>`, :ref:`CollisionObject2D<class_CollisionObject2D>`, :ref:`CollisionPolygon2D<class_CollisionPolygon2D>`, :ref:`CollisionShape2D<class_CollisionShape2D>`, :ref:`Joint2D<class_Joint2D>`, :ref:`Light2D<class_Light2D>`, :ref:`LightOccluder2D<class_LightOccluder2D>`, :ref:`Line2D<class_Line2D>`, :ref:`MeshInstance2D<class_MeshInstance2D>`, :ref:`Navigation2D<class_Navigation2D>`, :ref:`NavigationPolygonInstance<class_NavigationPolygonInstance>`, :ref:`ParallaxLayer<class_ParallaxLayer>`, :ref:`Particles2D<class_Particles2D>`, :ref:`Path2D<class_Path2D>`, :ref:`PathFollow2D<class_PathFollow2D>`, :ref:`Polygon2D<class_Polygon2D>`, :ref:`Position2D<class_Position2D>`, :ref:`RayCast2D<class_RayCast2D>`, :ref:`RemoteTransform2D<class_RemoteTransform2D>`, :ref:`Skeleton2D<class_Skeleton2D>`, :ref:`Sprite<class_Sprite>`, :ref:`TileMap<class_TileMap>`, :ref:`TouchScreenButton<class_TouchScreenButton>`, :ref:`VisibilityNotifier2D<class_VisibilityNotifier2D>`, :ref:`YSort<class_YSort>`
+**Inherited By:** :ref:`AnimatedSprite<class_AnimatedSprite>`, :ref:`AudioStreamPlayer2D<class_AudioStreamPlayer2D>`, :ref:`BackBufferCopy<class_BackBufferCopy>`, :ref:`Bone2D<class_Bone2D>`, :ref:`CPUParticles2D<class_CPUParticles2D>`, :ref:`Camera2D<class_Camera2D>`, :ref:`CanvasModulate<class_CanvasModulate>`, :ref:`CollisionObject2D<class_CollisionObject2D>`, :ref:`CollisionPolygon2D<class_CollisionPolygon2D>`, :ref:`CollisionShape2D<class_CollisionShape2D>`, :ref:`Joint2D<class_Joint2D>`, :ref:`Light2D<class_Light2D>`, :ref:`LightOccluder2D<class_LightOccluder2D>`, :ref:`Line2D<class_Line2D>`, :ref:`MeshInstance2D<class_MeshInstance2D>`, :ref:`MultiMeshInstance2D<class_MultiMeshInstance2D>`, :ref:`Navigation2D<class_Navigation2D>`, :ref:`NavigationPolygonInstance<class_NavigationPolygonInstance>`, :ref:`ParallaxLayer<class_ParallaxLayer>`, :ref:`Particles2D<class_Particles2D>`, :ref:`Path2D<class_Path2D>`, :ref:`PathFollow2D<class_PathFollow2D>`, :ref:`Polygon2D<class_Polygon2D>`, :ref:`Position2D<class_Position2D>`, :ref:`RayCast2D<class_RayCast2D>`, :ref:`RemoteTransform2D<class_RemoteTransform2D>`, :ref:`Skeleton2D<class_Skeleton2D>`, :ref:`Sprite<class_Sprite>`, :ref:`TileMap<class_TileMap>`, :ref:`TouchScreenButton<class_TouchScreenButton>`, :ref:`VisibilityNotifier2D<class_VisibilityNotifier2D>`, :ref:`YSort<class_YSort>`
 
 
 **Category:** Core
 **Category:** Core
 
 

+ 12 - 6
classes/class_object.rst

@@ -159,17 +159,17 @@ Constants
 Description
 Description
 -----------
 -----------
 
 
-Base class for all non built-in types. Everything which is not a built-in type starts the inheritance chain from this class.
+Every class which is not a built-in type inherits from this class.
 
 
-Objects can be constructed from scripting languages, using ``Object.new()`` in GDScript, ``new Object`` in C#, or the "Construct Object" node in VisualScript.
+You can construct Objects from scripting languages, using ``Object.new()`` in GDScript, ``new Object`` in C#, or the "Construct Object" node in VisualScript.
 
 
-Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the :ref:`free<class_Object_method_free>` function from the script or delete from C++).
+Objects do not manage memory. If a class inherits from Object, you will have to delete instances of it manually. To do so, call the :ref:`free<class_Object_method_free>` method from your script or delete the instance from C++.
 
 
-Some derivatives add memory management, such as :ref:`Reference<class_Reference>` (which keeps a reference count and deletes itself automatically when no longer referenced) and :ref:`Node<class_Node>`, which deletes the children tree when deleted.
+Some classes that extend Object add memory management. This is the case of :ref:`Reference<class_Reference>`, which counts references and deletes itself automatically when no longer referenced. :ref:`Node<class_Node>`, another fundamental type, deletes all its children when freed from memory.
 
 
 Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in :ref:`_get_property_list<class_Object_method__get_property_list>` and handled in :ref:`_get<class_Object_method__get>` and :ref:`_set<class_Object_method__set>`. However, scripting languages and C++ have simpler means to export them.
 Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in :ref:`_get_property_list<class_Object_method__get_property_list>` and handled in :ref:`_get<class_Object_method__get>` and :ref:`_set<class_Object_method__set>`. However, scripting languages and C++ have simpler means to export them.
 
 
-Objects also receive notifications (:ref:`_notification<class_Object_method__notification>`). Notifications are a simple way to notify the object about simple events, so they can all be handled together.
+Objects also receive notifications. Notifications are a simple way to notify the object about simple events, so they can all be handled together. See :ref:`_notification<class_Object_method__notification>`.
 
 
 Method Descriptions
 Method Descriptions
 -------------------
 -------------------
@@ -246,7 +246,11 @@ Returns ``true`` if the object can translate strings.
 
 
 - :ref:`Error<enum_@GlobalScope_Error>` **connect** **(** :ref:`String<class_String>` signal, :ref:`Object<class_Object>` target, :ref:`String<class_String>` method, :ref:`Array<class_Array>` binds=[  ], :ref:`int<class_int>` flags=0 **)**
 - :ref:`Error<enum_@GlobalScope_Error>` **connect** **(** :ref:`String<class_String>` signal, :ref:`Object<class_Object>` target, :ref:`String<class_String>` method, :ref:`Array<class_Array>` binds=[  ], :ref:`int<class_int>` flags=0 **)**
 
 
-Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call. Use ``flags`` to set deferred or one shot connections. See ``CONNECT_*`` constants. A ``signal`` can only be connected once to a ``method``. It will throw an error if already connected. To avoid this, first use :ref:`is_connected<class_Object_method_is_connected>` to check for existing connections.
+Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call. Use ``flags`` to set deferred or one shot connections. See ``CONNECT_*`` constants.
+
+A ``signal`` can only be connected once to a ``method``. It will throw an error if already connected. To avoid this, first, use :ref:`is_connected<class_Object_method_is_connected>` to check for existing connections.
+
+If the ``target`` is destroyed in the game's lifecycle, the connection will be lost.
 
 
 .. _class_Object_method_disconnect:
 .. _class_Object_method_disconnect:
 
 
@@ -254,6 +258,8 @@ Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``bi
 
 
 Disconnects a ``signal`` from a ``method`` on the given ``target``.
 Disconnects a ``signal`` from a ``method`` on the given ``target``.
 
 
+If you try to disconnect a connection that does not exist, the method will throw an error. Use :ref:`is_connected<class_Object_method_is_connected>` to ensure that the connection exists.
+
 .. _class_Object_method_emit_signal:
 .. _class_Object_method_emit_signal:
 
 
 - :ref:`Variant<class_Variant>` **emit_signal** **(** :ref:`String<class_String>` signal, ... **)** vararg
 - :ref:`Variant<class_Variant>` **emit_signal** **(** :ref:`String<class_String>` signal, ... **)** vararg

+ 12 - 2
classes/class_os.rst

@@ -789,13 +789,17 @@ Returns the path to the current engine executable.
 
 
 - :ref:`Vector2<class_Vector2>` **get_ime_selection** **(** **)** const
 - :ref:`Vector2<class_Vector2>` **get_ime_selection** **(** **)** const
 
 
-Returns IME selection range.
+Returns IME cursor position (currently edited portion of the string) relative to the characters in the composition string.
+
+``NOTIFICATION_OS_IME_UPDATE`` is sent to the application to notify it of changes to the IME cursor position.
 
 
 .. _class_OS_method_get_ime_text:
 .. _class_OS_method_get_ime_text:
 
 
 - :ref:`String<class_String>` **get_ime_text** **(** **)** const
 - :ref:`String<class_String>` **get_ime_text** **(** **)** const
 
 
-Returns IME intermediate text.
+Returns IME intermediate composition string.
+
+``NOTIFICATION_OS_IME_UPDATE`` is sent to the application to notify it of changes to the IME composition string.
 
 
 .. _class_OS_method_get_latin_keyboard_variant:
 .. _class_OS_method_get_latin_keyboard_variant:
 
 
@@ -1191,6 +1195,12 @@ The same image is used for window caption, taskbar/dock and window selection dia
 
 
 Sets whether IME input mode should be enabled.
 Sets whether IME input mode should be enabled.
 
 
+If active IME handles key events before the application and creates an composition string and suggestion list.
+
+Application can retrieve the composition status by using :ref:`get_ime_selection<class_OS_method_get_ime_selection>` and :ref:`get_ime_text<class_OS_method_get_ime_text>` functions.
+
+Completed composition string is committed when input is finished.
+
 .. _class_OS_method_set_ime_position:
 .. _class_OS_method_set_ime_position:
 
 
 - void **set_ime_position** **(** :ref:`Vector2<class_Vector2>` position **)**
 - void **set_ime_position** **(** :ref:`Vector2<class_Vector2>` position **)**

+ 3 - 1
classes/class_particles.rst

@@ -340,9 +340,11 @@ Method Descriptions
 
 
 - :ref:`AABB<class_AABB>` **capture_aabb** **(** **)** const
 - :ref:`AABB<class_AABB>` **capture_aabb** **(** **)** const
 
 
+Returns the bounding box that contains all the particles that are active in the current frame.
+
 .. _class_Particles_method_restart:
 .. _class_Particles_method_restart:
 
 
 - void **restart** **(** **)**
 - void **restart** **(** **)**
 
 
-Restarts the particle emmission, clearing existing particles.
+Restarts the particle emission, clearing existing particles.
 
 

+ 7 - 3
classes/class_particlesmaterial.rst

@@ -184,7 +184,7 @@ enum **Parameter**:
 
 
 - **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set animation offset properties.
 - **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param<class_ParticlesMaterial_method_set_param>`, :ref:`set_param_randomness<class_ParticlesMaterial_method_set_param_randomness>`, and :ref:`set_param_texture<class_ParticlesMaterial_method_set_param_texture>` to set animation offset properties.
 
 
-- **PARAM_MAX** = **12**
+- **PARAM_MAX** = **12** --- Represents the size of the :ref:`Parameter<enum_ParticlesMaterial_Parameter>` enum.
 
 
 .. _enum_ParticlesMaterial_Flags:
 .. _enum_ParticlesMaterial_Flags:
 
 
@@ -192,15 +192,19 @@ enum **Parameter**:
 
 
 .. _class_ParticlesMaterial_constant_FLAG_ROTATE_Y:
 .. _class_ParticlesMaterial_constant_FLAG_ROTATE_Y:
 
 
+.. _class_ParticlesMaterial_constant_FLAG_DISABLE_Z:
+
 .. _class_ParticlesMaterial_constant_FLAG_MAX:
 .. _class_ParticlesMaterial_constant_FLAG_MAX:
 
 
 enum **Flags**:
 enum **Flags**:
 
 
 - **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag<class_ParticlesMaterial_method_set_flag>` to set :ref:`flag_align_y<class_ParticlesMaterial_property_flag_align_y>`.
 - **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag<class_ParticlesMaterial_method_set_flag>` to set :ref:`flag_align_y<class_ParticlesMaterial_property_flag_align_y>`.
 
 
-- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag<class_ParticlesMaterial_method_set_flag>` to set :ref:`flag_rotate_y<class_ParticlesMaterial_property_flag_rotate_y>`
+- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag<class_ParticlesMaterial_method_set_flag>` to set :ref:`flag_rotate_y<class_ParticlesMaterial_property_flag_rotate_y>`.
+
+- **FLAG_DISABLE_Z** = **2** --- Use with :ref:`set_flag<class_ParticlesMaterial_method_set_flag>` to set :ref:`flag_disable_z<class_ParticlesMaterial_property_flag_disable_z>`.
 
 
-- **FLAG_MAX** = **3**
+- **FLAG_MAX** = **3** --- Represents the size of the :ref:`Flags<enum_ParticlesMaterial_Flags>` enum.
 
 
 .. _enum_ParticlesMaterial_EmissionShape:
 .. _enum_ParticlesMaterial_EmissionShape:
 
 

+ 5 - 5
classes/class_polygon2d.rst

@@ -218,11 +218,11 @@ Amount to offset the polygon's ``texture``. If ``(0, 0)`` the texture's origin (
 
 
 - :ref:`float<class_float>` **texture_rotation**
 - :ref:`float<class_float>` **texture_rotation**
 
 
-+----------+-------------------------------------+
-| *Setter* | set_texture_rotation_degrees(value) |
-+----------+-------------------------------------+
-| *Getter* | get_texture_rotation_degrees()      |
-+----------+-------------------------------------+
++----------+-----------------------------+
+| *Setter* | set_texture_rotation(value) |
++----------+-----------------------------+
+| *Getter* | get_texture_rotation()      |
++----------+-----------------------------+
 
 
 The texture's rotation in radians.
 The texture's rotation in radians.
 
 

+ 1 - 1
classes/class_position2d.rst

@@ -19,5 +19,5 @@ Generic 2D Position hint for editing.
 Description
 Description
 -----------
 -----------
 
 
-Generic 2D Position hint for editing. It's just like a plain :ref:`Node2D<class_Node2D>` but displays as a cross in the 2D-Editor at all times.
+Generic 2D Position hint for editing. It's just like a plain :ref:`Node2D<class_Node2D>` but displays as a cross in the 2D-Editor at all times. You can set visual size of the cross by changing Gizmo Extents in the inspector.
 
 

+ 5 - 5
classes/class_textedit.rst

@@ -431,11 +431,11 @@ If ``true``, the "tab" character will have a visible representation.
 
 
 - :ref:`bool<class_bool>` **fold_gutter**
 - :ref:`bool<class_bool>` **fold_gutter**
 
 
-+----------+--------------------------------+
-| *Setter* | set_fold_gutter_enabled(value) |
-+----------+--------------------------------+
-| *Getter* | is_fold_gutter_enabled()       |
-+----------+--------------------------------+
++----------+-----------------------------+
+| *Setter* | set_draw_fold_gutter(value) |
++----------+-----------------------------+
+| *Getter* | is_drawing_fold_gutter()    |
++----------+-----------------------------+
 
 
 If ``true``, the fold gutter is visible. This enables folding groups of indented lines.
 If ``true``, the fold gutter is visible. This enables folding groups of indented lines.