Parcourir la source

classref: Sync with 2.0 branch

Rémi Verschelde il y a 9 ans
Parent
commit
9773d655eb

+ 6 - 0
classes/class_array.rst

@@ -134,10 +134,14 @@ Get whether this is a shared array instance.
 
 - void  **pop_back**  **(** **)**
 
+Remove the last element of the array.
+
 .. _class_Array_pop_front:
 
 - void  **pop_front**  **(** **)**
 
+Remove the first element of the array.
+
 .. _class_Array_push_back:
 
 - void  **push_back**  **(** var value  **)**
@@ -148,6 +152,8 @@ Append an element at the end of the array.
 
 - void  **push_front**  **(** var value  **)**
 
+Add an element at the beginning of the array.
+
 .. _class_Array_remove:
 
 - void  **remove**  **(** :ref:`int<class_int>` pos  **)**

+ 16 - 1
classes/class_button.rst

@@ -42,6 +42,13 @@ Member Functions
 | :ref:`bool<class_bool>`        | :ref:`is_flat<class_Button_is_flat>`  **(** **)** const                                                  |
 +--------------------------------+----------------------------------------------------------------------------------------------------------+
 
+Numeric Constants
+-----------------
+
+- **ALIGN_LEFT** = **0** --- Align the text to the left.
+- **ALIGN_CENTER** = **1** --- Center the text.
+- **ALIGN_RIGHT** = **2** --- Align the text to the right.
+
 Description
 -----------
 
@@ -66,10 +73,14 @@ Return the button text.
 
 - void  **set_button_icon**  **(** :ref:`Texture<class_texture>` texture  **)**
 
+Set the icon that will be displayed next to the text inside the button area.
+
 .. _class_Button_get_button_icon:
 
 - :ref:`Texture<class_texture>`  **get_button_icon**  **(** **)** const
 
+Return the button icon.
+
 .. _class_Button_set_flat:
 
 - void  **set_flat**  **(** :ref:`bool<class_bool>` enabled  **)**
@@ -92,14 +103,18 @@ Return the state of the *clip_text* property (see :ref:`set_clip_text<class_Butt
 
 - void  **set_text_align**  **(** :ref:`int<class_int>` align  **)**
 
+Set the text alignment policy, using one of the ALIGN\_\* constants.
+
 .. _class_Button_get_text_align:
 
 - :ref:`int<class_int>`  **get_text_align**  **(** **)** const
 
+Return the text alignment policy.
+
 .. _class_Button_is_flat:
 
 - :ref:`bool<class_bool>`  **is_flat**  **(** **)** const
 
-Return the state of the *flat* property (see :ref:`set_flat<class_Button_set_flat>`)
+Return the state of the *flat* property (see :ref:`set_flat<class_Button_set_flat>`).
 
 

+ 49 - 43
classes/class_buttonarray.rst

@@ -20,36 +20,36 @@ Array of Buttons.
 Member Functions
 ----------------
 
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| void                         | :ref:`add_button<class_ButtonArray_add_button>`  **(** :ref:`String<class_string>` text  **)**                                                |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| void                         | :ref:`add_icon_button<class_ButtonArray_add_icon_button>`  **(** :ref:`Object<class_object>` icon, :ref:`String<class_string>` text=""  **)** |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| void                         | :ref:`set_button_text<class_ButtonArray_set_button_text>`  **(** :ref:`int<class_int>` button, :ref:`String<class_string>` text  **)**        |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| void                         | :ref:`set_button_icon<class_ButtonArray_set_button_icon>`  **(** :ref:`int<class_int>` button, :ref:`Object<class_object>` icon  **)**        |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`String<class_string>`  | :ref:`get_button_text<class_ButtonArray_get_button_text>`  **(** :ref:`int<class_int>` button  **)** const                                    |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`Object<class_object>`  | :ref:`get_button_icon<class_ButtonArray_get_button_icon>`  **(** :ref:`int<class_int>` button  **)** const                                    |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`int<class_int>`        | :ref:`get_button_count<class_ButtonArray_get_button_count>`  **(** **)** const                                                                |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`int<class_int>`        | :ref:`get_selected<class_ButtonArray_get_selected>`  **(** **)** const                                                                        |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`int<class_int>`        | :ref:`get_hovered<class_ButtonArray_get_hovered>`  **(** **)** const                                                                          |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| void                         | :ref:`set_selected<class_ButtonArray_set_selected>`  **(** :ref:`int<class_int>` button  **)**                                                |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| void                         | :ref:`erase_button<class_ButtonArray_erase_button>`  **(** :ref:`int<class_int>` button  **)**                                                |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| void                         | :ref:`clear<class_ButtonArray_clear>`  **(** **)**                                                                                            |
-+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                           | :ref:`add_button<class_ButtonArray_add_button>`  **(** :ref:`String<class_string>` text  **)**                                                  |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                           | :ref:`add_icon_button<class_ButtonArray_add_icon_button>`  **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text=""  **)** |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                           | :ref:`set_button_text<class_ButtonArray_set_button_text>`  **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text  **)**      |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                           | :ref:`set_button_icon<class_ButtonArray_set_button_icon>`  **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon  **)**    |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`String<class_string>`    | :ref:`get_button_text<class_ButtonArray_get_button_text>`  **(** :ref:`int<class_int>` button_idx  **)** const                                  |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`Texture<class_texture>`  | :ref:`get_button_icon<class_ButtonArray_get_button_icon>`  **(** :ref:`int<class_int>` button_idx  **)** const                                  |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`int<class_int>`          | :ref:`get_button_count<class_ButtonArray_get_button_count>`  **(** **)** const                                                                  |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`int<class_int>`          | :ref:`get_selected<class_ButtonArray_get_selected>`  **(** **)** const                                                                          |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`int<class_int>`          | :ref:`get_hovered<class_ButtonArray_get_hovered>`  **(** **)** const                                                                            |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                           | :ref:`set_selected<class_ButtonArray_set_selected>`  **(** :ref:`int<class_int>` button_idx  **)**                                              |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                           | :ref:`erase_button<class_ButtonArray_erase_button>`  **(** :ref:`int<class_int>` button_idx  **)**                                              |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                           | :ref:`clear<class_ButtonArray_clear>`  **(** **)**                                                                                              |
++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Signals
 -------
 
--  **button_selected**  **(** :ref:`int<class_int>` button  **)**
+-  **button_selected**  **(** :ref:`int<class_int>` button_idx  **)**
 
 Numeric Constants
 -----------------
@@ -63,7 +63,9 @@ Numeric Constants
 Description
 -----------
 
-Array of Buttons. A Button array is useful to have an array of buttons laid out vertically or horizontally. Only one can be selected. This is useful for joy pad based interfaces and option menus.
+Array of Buttons. A ButtonArray is useful to have an array of buttons laid out vertically or horizontally. Only one button can be selected, and is referenced by its index in the array (first button is 0, second button is 1, etc.).
+
+This is useful *e.g.* for joypad-friendly interfaces and option menus.
 
 Member Function Description
 ---------------------------
@@ -72,33 +74,37 @@ Member Function Description
 
 - void  **add_button**  **(** :ref:`String<class_string>` text  **)**
 
-Add a new button.
+Append a new button to the array, with the specified text.
 
 .. _class_ButtonArray_add_icon_button:
 
-- void  **add_icon_button**  **(** :ref:`Object<class_object>` icon, :ref:`String<class_string>` text=""  **)**
+- void  **add_icon_button**  **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text=""  **)**
+
+Append a new button to the array, with the specified icon and text.
 
 .. _class_ButtonArray_set_button_text:
 
-- void  **set_button_text**  **(** :ref:`int<class_int>` button, :ref:`String<class_string>` text  **)**
+- void  **set_button_text**  **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text  **)**
+
+Define the text of the specified button.
 
 .. _class_ButtonArray_set_button_icon:
 
-- void  **set_button_icon**  **(** :ref:`int<class_int>` button, :ref:`Object<class_object>` icon  **)**
+- void  **set_button_icon**  **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon  **)**
 
-Set the icon of an existing button.
+Set the icon of the specified button.
 
 .. _class_ButtonArray_get_button_text:
 
-- :ref:`String<class_string>`  **get_button_text**  **(** :ref:`int<class_int>` button  **)** const
+- :ref:`String<class_string>`  **get_button_text**  **(** :ref:`int<class_int>` button_idx  **)** const
 
-Return the text of an existing button.
+Return the text of the specified button.
 
 .. _class_ButtonArray_get_button_icon:
 
-- :ref:`Object<class_object>`  **get_button_icon**  **(** :ref:`int<class_int>` button  **)** const
+- :ref:`Texture<class_texture>`  **get_button_icon**  **(** :ref:`int<class_int>` button_idx  **)** const
 
-Return the icon of an existing button.
+Return the icon of the specified button.
 
 .. _class_ButtonArray_get_button_count:
 
@@ -110,30 +116,30 @@ Return the amount of buttons in the array.
 
 - :ref:`int<class_int>`  **get_selected**  **(** **)** const
 
-Return the currently selected button in the array.
+Return the index of the currently selected button in the array.
 
 .. _class_ButtonArray_get_hovered:
 
 - :ref:`int<class_int>`  **get_hovered**  **(** **)** const
 
-Return the currently hovered button in the array.
+Return the index of the currently hovered button in the array.
 
 .. _class_ButtonArray_set_selected:
 
-- void  **set_selected**  **(** :ref:`int<class_int>` button  **)**
+- void  **set_selected**  **(** :ref:`int<class_int>` button_idx  **)**
 
-Select a button in the array.
+Select a button in the array based on the given index.
 
 .. _class_ButtonArray_erase_button:
 
-- void  **erase_button**  **(** :ref:`int<class_int>` button  **)**
+- void  **erase_button**  **(** :ref:`int<class_int>` button_idx  **)**
 
-Remove a button in the array, by index.
+Remove the specified button in the array.
 
 .. _class_ButtonArray_clear:
 
 - void  **clear**  **(** **)**
 
-Clear the button array.
+Remove all buttons from the array.
 
 

+ 10 - 1
classes/class_canvasmodulate.rst

@@ -13,7 +13,7 @@ CanvasModulate
 Brief Description
 -----------------
 
-
+Tint the entire canvas
 
 Member Functions
 ----------------
@@ -24,6 +24,11 @@ Member Functions
 | :ref:`Color<class_color>`  | :ref:`get_color<class_CanvasModulate_get_color>`  **(** **)** const                            |
 +----------------------------+------------------------------------------------------------------------------------------------+
 
+Description
+-----------
+
+CanvasModulate tints the canvas elements using its asigned color
+
 Member Function Description
 ---------------------------
 
@@ -31,8 +36,12 @@ Member Function Description
 
 - void  **set_color**  **(** :ref:`Color<class_color>` color  **)**
 
+Sets the canvas tint color
+
 .. _class_CanvasModulate_get_color:
 
 - :ref:`Color<class_color>`  **get_color**  **(** **)** const
 
+Gets the canvas tint color
+
 

+ 4 - 0
classes/class_centercontainer.rst

@@ -36,8 +36,12 @@ Member Function Description
 
 - void  **set_use_top_left**  **(** :ref:`bool<class_bool>` enable  **)**
 
+This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container).
+
 .. _class_CenterContainer_is_using_top_left:
 
 - :ref:`bool<class_bool>`  **is_using_top_left**  **(** **)** const
 
+Should put children to the top left corner instead of center of the container.
+
 

+ 5 - 0
classes/class_checkbox.rst

@@ -13,5 +13,10 @@ CheckBox
 Brief Description
 -----------------
 
+Binary choice user interface widget
 
+Description
+-----------
+
+A checkbox allows the user to make a binary choice (choosing only one of two posible options), for example Answer 'yes' or 'no'.
 

+ 10 - 0
classes/class_colorpicker.rst

@@ -63,20 +63,30 @@ Return the current (edited) color.
 
 - void  **set_raw_mode**  **(** :ref:`bool<class_bool>` mode  **)**
 
+When set to true, every color channel will be represented as a value from 0 to 1, insetead of 0, 255.
+
 .. _class_ColorPicker_is_raw_mode:
 
 - :ref:`bool<class_bool>`  **is_raw_mode**  **(** **)** const
 
+Returns whether this color picker is in raw mode or not
+
 .. _class_ColorPicker_set_edit_alpha:
 
 - void  **set_edit_alpha**  **(** :ref:`bool<class_bool>` show  **)**
 
+Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color.
+
 .. _class_ColorPicker_is_editing_alpha:
 
 - :ref:`bool<class_bool>`  **is_editing_alpha**  **(** **)** const
 
+Returns whether the color has transparency or not.
+
 .. _class_ColorPicker_add_preset:
 
 - void  **add_preset**  **(** :ref:`Color<class_color>` arg0  **)**
 
+Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker.
+
 

+ 14 - 1
classes/class_colorpickerbutton.rst

@@ -13,7 +13,7 @@ ColorPickerButton
 Brief Description
 -----------------
 
-
+Button that pops out a :ref:`ColorPicker<class_colorpicker>`
 
 Member Functions
 ----------------
@@ -33,6 +33,11 @@ Signals
 
 -  **color_changed**  **(** :ref:`Color<class_color>` color  **)**
 
+Description
+-----------
+
+Encapsulates a :ref:`ColorPicker<class_colorpicker>` making it accesible by pressing a button, pressing the button will toggle the :ref:`ColorPicker<class_colorpicker>` visibility
+
 Member Function Description
 ---------------------------
 
@@ -40,16 +45,24 @@ Member Function Description
 
 - void  **set_color**  **(** :ref:`Color<class_color>` color  **)**
 
+Sets the current color
+
 .. _class_ColorPickerButton_get_color:
 
 - :ref:`Color<class_color>`  **get_color**  **(** **)** const
 
+Gets the current color
+
 .. _class_ColorPickerButton_set_edit_alpha:
 
 - void  **set_edit_alpha**  **(** :ref:`bool<class_bool>` show  **)**
 
+See :ref:`ColorPicker.set_edit_alpha<class_ColorPicker_set_edit_alpha>`
+
 .. _class_ColorPickerButton_is_editing_alpha:
 
 - :ref:`bool<class_bool>`  **is_editing_alpha**  **(** **)** const
 
+See :ref:`ColorPicker.is_edit_alpha<class_ColorPicker_is_edit_alpha>`
+
 

+ 4 - 0
classes/class_dictionary.rst

@@ -84,6 +84,8 @@ Return the list of keys in the 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.
+
 .. _class_Dictionary_size:
 
 - :ref:`int<class_int>`  **size**  **(** **)**
@@ -94,4 +96,6 @@ Return the size of the dictionary (in pairs).
 
 - :ref:`String<class_string>`  **to_json**  **(** **)**
 
+Return the dictionary as json text.
+
 

+ 10 - 1
classes/class_gridcontainer.rst

@@ -13,7 +13,7 @@ GridContainer
 Brief Description
 -----------------
 
-
+Grid container used to arrange elements in a grid like layout
 
 Member Functions
 ----------------
@@ -24,6 +24,11 @@ Member Functions
 | :ref:`int<class_int>`  | :ref:`get_columns<class_GridContainer_get_columns>`  **(** **)** const                          |
 +------------------------+-------------------------------------------------------------------------------------------------+
 
+Description
+-----------
+
+Grid container will arrange its children in a grid like structure, the grid columns are specified using the :ref:`set_columns<class_GridContainer_set_columns>` method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container.
+
 Member Function Description
 ---------------------------
 
@@ -31,8 +36,12 @@ Member Function Description
 
 - void  **set_columns**  **(** :ref:`int<class_int>` columns  **)**
 
+Sets the numbers of columns in the container, then reorder its children to accommodate the new layout
+
 .. _class_GridContainer_get_columns:
 
 - :ref:`int<class_int>`  **get_columns**  **(** **)** const
 
+Returns the number of columns in this container
+
 

+ 38 - 1
classes/class_polygon2d.rst

@@ -13,7 +13,7 @@ Polygon2D
 Brief Description
 -----------------
 
-
+2D polygon representation
 
 Member Functions
 ----------------
@@ -60,6 +60,11 @@ Member Functions
 | :ref:`Vector2<class_vector2>`            | :ref:`get_offset<class_Polygon2D_get_offset>`  **(** **)** const                                                           |
 +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
 
+Description
+-----------
+
+A Polygon2D is defined by a set of n points connected together by line segments, meaning that the point 1 will be connected with point 2, point 2 with point 3 ..., point n-1 with point n and point n with point 1 in order to close the loop and define a plane.
+
 Member Function Description
 ---------------------------
 
@@ -67,50 +72,74 @@ Member Function Description
 
 - void  **set_polygon**  **(** :ref:`Vector2Array<class_vector2array>` polygon  **)**
 
+Defines the set of points that will represent the polygon.
+
 .. _class_Polygon2D_get_polygon:
 
 - :ref:`Vector2Array<class_vector2array>`  **get_polygon**  **(** **)** const
 
+Returns the set of points that defines this polygon
+
 .. _class_Polygon2D_set_uv:
 
 - void  **set_uv**  **(** :ref:`Vector2Array<class_vector2array>` uv  **)**
 
+Sets the uv value for every point of the polygon
+
 .. _class_Polygon2D_get_uv:
 
 - :ref:`Vector2Array<class_vector2array>`  **get_uv**  **(** **)** const
 
+Returns the uv value associated with every point of the polygon
+
 .. _class_Polygon2D_set_color:
 
 - void  **set_color**  **(** :ref:`Color<class_color>` color  **)**
 
+Sets the polygon fill color, if the polygon has a texture defined, the defined texture will be tinted to the polygon fill color.
+
 .. _class_Polygon2D_get_color:
 
 - :ref:`Color<class_color>`  **get_color**  **(** **)** const
 
+Returns the polygon fill color
+
 .. _class_Polygon2D_set_texture:
 
 - void  **set_texture**  **(** :ref:`Object<class_object>` texture  **)**
 
+Sets the polygon texture.
+
 .. _class_Polygon2D_get_texture:
 
 - :ref:`Object<class_object>`  **get_texture**  **(** **)** const
 
+Returns the polygon texture
+
 .. _class_Polygon2D_set_texture_offset:
 
 - void  **set_texture_offset**  **(** :ref:`Vector2<class_vector2>` texture_offset  **)**
 
+Sets the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top.
+
 .. _class_Polygon2D_get_texture_offset:
 
 - :ref:`Vector2<class_vector2>`  **get_texture_offset**  **(** **)** const
 
+Returns the polygon texture offset
+
 .. _class_Polygon2D_set_texture_rotation:
 
 - void  **set_texture_rotation**  **(** :ref:`float<class_float>` texture_rotation  **)**
 
+Sets the amount of rotation of the polygon texture, ``texture_rotation`` is specified in degrees and clockwise rotation, meaning that if the texture rotation is set to 45 degrees, the texture will be rotated 45 degrees clockwise along the polygon position plus the texture offset.
+
 .. _class_Polygon2D_get_texture_rotation:
 
 - :ref:`float<class_float>`  **get_texture_rotation**  **(** **)** const
 
+Returns the rotation in degrees of the texture polygon
+
 .. _class_Polygon2D_set_texture_scale:
 
 - void  **set_texture_scale**  **(** :ref:`Vector2<class_vector2>` texture_scale  **)**
@@ -123,10 +152,14 @@ Member Function Description
 
 - void  **set_invert**  **(** :ref:`bool<class_bool>` invert  **)**
 
+Sets the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on square that contains the defined polygon).
+
 .. _class_Polygon2D_get_invert:
 
 - :ref:`bool<class_bool>`  **get_invert**  **(** **)** const
 
+Returns whether this polygon is inverted or not
+
 .. _class_Polygon2D_set_invert_border:
 
 - void  **set_invert_border**  **(** :ref:`float<class_float>` invert_border  **)**
@@ -139,8 +172,12 @@ Member Function Description
 
 - void  **set_offset**  **(** :ref:`Vector2<class_vector2>` offset  **)**
 
+Sets the amount of distance from the polygon points from the polygon position, for example if the offset is set to 10,10 then all the polygon points will move 10 units to the right and 10 units to the bottom.
+
 .. _class_Polygon2D_get_offset:
 
 - :ref:`Vector2<class_vector2>`  **get_offset**  **(** **)** const
 
+Returns the polygon points offset to the polygon position.
+
 

+ 29 - 2
classes/class_raycast2d.rst

@@ -13,7 +13,7 @@ RayCast2D
 Brief Description
 -----------------
 
-
+Query the closest object intersecting a ray
 
 Member Functions
 ----------------
@@ -56,6 +56,11 @@ Member Functions
 | :ref:`int<class_int>`          | :ref:`get_type_mask<class_RayCast2D_get_type_mask>`  **(** **)** const                                    |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------+
 
+Description
+-----------
+
+A RayCast2D represents a line from its origin to its destination position ``cast_to``, it is used to query the 2D space in order to find the closest object intersecting with the ray.
+
 Member Function Description
 ---------------------------
 
@@ -63,23 +68,31 @@ Member Function Description
 
 - void  **set_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**
 
+Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions.
+
 .. _class_RayCast2D_is_enabled:
 
 - :ref:`bool<class_bool>`  **is_enabled**  **(** **)** const
 
+Returns whether this raycast is enabled or not
+
 .. _class_RayCast2D_set_cast_to:
 
 - void  **set_cast_to**  **(** :ref:`Vector2<class_vector2>` local_point  **)**
 
+Sets the ray destination point, so that the ray will test from the ray's origin to ``local_point``
+
 .. _class_RayCast2D_get_cast_to:
 
 - :ref:`Vector2<class_vector2>`  **get_cast_to**  **(** **)** const
 
+Return the destination point of this ray object
+
 .. _class_RayCast2D_is_colliding:
 
 - :ref:`bool<class_bool>`  **is_colliding**  **(** **)** const
 
-Return whether the closest object the ray is pointing to is colliding with the vector, with the vector length considered.
+Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length).
 
 .. _class_RayCast2D_get_collider:
 
@@ -91,14 +104,20 @@ Return the closest object the ray is pointing to. Note that this does not consid
 
 - :ref:`int<class_int>`  **get_collider_shape**  **(** **)** const
 
+Returns the collision shape of the closest object the ray is pointing to.
+
 .. _class_RayCast2D_get_collision_point:
 
 - :ref:`Vector2<class_vector2>`  **get_collision_point**  **(** **)** const
 
+Returns the collision point in which the ray intersects the closest object.
+
 .. _class_RayCast2D_get_collision_normal:
 
 - :ref:`Vector2<class_vector2>`  **get_collision_normal**  **(** **)** const
 
+Returns the normal of the intersecting object shape face containing the collision point.
+
 .. _class_RayCast2D_add_exception_rid:
 
 - void  **add_exception_rid**  **(** :ref:`RID<class_rid>` rid  **)**
@@ -107,6 +126,8 @@ Return the closest object the ray is pointing to. Note that this does not consid
 
 - void  **add_exception**  **(** :ref:`Object<class_object>` node  **)**
 
+Adds a collision exception so the ray does not report collisions with the specified ``node``.
+
 .. _class_RayCast2D_remove_exception_rid:
 
 - void  **remove_exception_rid**  **(** :ref:`RID<class_rid>` rid  **)**
@@ -115,10 +136,14 @@ Return the closest object the ray is pointing to. Note that this does not consid
 
 - void  **remove_exception**  **(** :ref:`Object<class_object>` node  **)**
 
+Removes a collision exception so the ray does report collisions with the specified ``node``.
+
 .. _class_RayCast2D_clear_exceptions:
 
 - void  **clear_exceptions**  **(** **)**
 
+Removes all collision exception for this ray.
+
 .. _class_RayCast2D_set_layer_mask:
 
 - void  **set_layer_mask**  **(** :ref:`int<class_int>` mask  **)**
@@ -127,6 +152,8 @@ Return the closest object the ray is pointing to. Note that this does not consid
 
 - :ref:`int<class_int>`  **get_layer_mask**  **(** **)** const
 
+Returns the layer mask for this ray.
+
 .. _class_RayCast2D_set_type_mask:
 
 - void  **set_type_mask**  **(** :ref:`int<class_int>` mask  **)**

+ 5 - 0
classes/class_vector2.rst

@@ -66,6 +66,11 @@ Member Variables
 - :ref:`float<class_float>` **width**
 - :ref:`float<class_float>` **height**
 
+Description
+-----------
+
+2-element structure that can be used to represent positions in 2d-space, or any other pair of numeric values.
+
 Member Function Description
 ---------------------------