Skip to content

Commit

Permalink
Sync classref with current source
Browse files Browse the repository at this point in the history
  • Loading branch information
akien-mga committed Mar 23, 2020
1 parent 48615ec commit 13bb7a6
Show file tree
Hide file tree
Showing 25 changed files with 746 additions and 481 deletions.
8 changes: 8 additions & 0 deletions classes/class_animationnodestatemachine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ Methods
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rename_node<class_AnimationNodeStateMachine_method_rename_node>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` new_name **)** |
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`replace_node<class_AnimationNodeStateMachine_method_replace_node>` **(** :ref:`StringName<class_StringName>` name, :ref:`AnimationNode<class_AnimationNode>` node **)** |
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_end_node<class_AnimationNodeStateMachine_method_set_end_node>` **(** :ref:`StringName<class_StringName>` name **)** |
+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_graph_offset<class_AnimationNodeStateMachine_method_set_graph_offset>` **(** :ref:`Vector2<class_Vector2>` offset **)** |
Expand Down Expand Up @@ -226,6 +228,12 @@ Renames the given node.

----

.. _class_AnimationNodeStateMachine_method_replace_node:

- void **replace_node** **(** :ref:`StringName<class_StringName>` name, :ref:`AnimationNode<class_AnimationNode>` node **)**

----

.. _class_AnimationNodeStateMachine_method_set_end_node:

- void **set_end_node** **(** :ref:`StringName<class_StringName>` name **)**
Expand Down
170 changes: 85 additions & 85 deletions classes/class_array.rst

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions classes/class_astar2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ This is a wrapper for the :ref:`AStar<class_AStar>` class which uses 2D vectors
Methods
-------

+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`_compute_cost<class_AStar2D_method__compute_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`_estimate_cost<class_AStar2D_method__estimate_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_AStar2D_method_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` weight_scale=1.0 **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -72,6 +76,26 @@ Methods
Method Descriptions
-------------------

.. _class_AStar2D_method__compute_cost:

- :ref:`float<class_float>` **_compute_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual

Called when computing the cost between two connected points.

Note that this function is hidden in the default ``AStar2D`` class.

----

.. _class_AStar2D_method__estimate_cost:

- :ref:`float<class_float>` **_estimate_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual

Called when estimating the cost between a point and the path's ending point.

Note that this function is hidden in the default ``AStar2D`` class.

----

.. _class_AStar2D_method_add_point:

- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` weight_scale=1.0 **)**
Expand Down
4 changes: 2 additions & 2 deletions classes/class_dictionary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Methods
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`erase<class_Dictionary_method_erase>` **(** :ref:`Variant<class_Variant>` key **)** |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get<class_Dictionary_method_get>` **(** :ref:`Variant<class_Variant>` key, :ref:`Variant<class_Variant>` default=null **)** |
| :ref:`Variant<class_Variant>` | :ref:`get<class_Dictionary_method_get>` **(** :ref:`Variant<class_Variant>` key, :ref:`Variant<class_Variant>` default=null **)** |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_method_has>` **(** :ref:`Variant<class_Variant>` key **)** |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -156,7 +156,7 @@ Erase a dictionary key/value pair by key. Returns ``true`` if the given key was

.. _class_Dictionary_method_get:

- void **get** **(** :ref:`Variant<class_Variant>` key, :ref:`Variant<class_Variant>` default=null **)**
- :ref:`Variant<class_Variant>` **get** **(** :ref:`Variant<class_Variant>` key, :ref:`Variant<class_Variant>` default=null **)**

Returns the current value for the specified key in the ``Dictionary``. If the key does not exist, the method returns the value of the optional default argument, or ``null`` if it is omitted.

Expand Down
6 changes: 2 additions & 4 deletions classes/class_directory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Methods
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`file_exists<class_Directory_method_file_exists>` **(** :ref:`String<class_String>` path **)** |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_current_dir<class_Directory_method_get_current_dir>` **(** :ref:`bool<class_bool>` include_drive=true **)** |
| :ref:`String<class_String>` | :ref:`get_current_dir<class_Directory_method_get_current_dir>` **(** **)** |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_current_drive<class_Directory_method_get_current_drive>` **(** **)** |
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -133,12 +133,10 @@ Returns whether the target file exists. The argument can be relative to the curr

.. _class_Directory_method_get_current_dir:

- :ref:`String<class_String>` **get_current_dir** **(** :ref:`bool<class_bool>` include_drive=true **)**
- :ref:`String<class_String>` **get_current_dir** **(** **)**

Returns the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``).

On Windows, if ``include_drive`` is ``false``, the leading drive specificator is omitted from the returned value (e.g. ``\tmp\folder``).

----

.. _class_Directory_method_get_current_drive:
Expand Down
8 changes: 8 additions & 0 deletions classes/class_editorinterface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Methods
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_Control>` | :ref:`get_editor_viewport<class_EditorInterface_method_get_editor_viewport>` **(** **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`FileSystemDock<class_FileSystemDock>` | :ref:`get_file_system_dock<class_EditorInterface_method_get_file_system_dock>` **(** **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorInspector<class_EditorInspector>` | :ref:`get_inspector<class_EditorInterface_method_get_inspector>` **(** **)** const |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_open_scenes<class_EditorInterface_method_get_open_scenes>` **(** **)** const |
Expand Down Expand Up @@ -120,6 +122,12 @@ Returns the editor :ref:`Viewport<class_Viewport>`.

----

.. _class_EditorInterface_method_get_file_system_dock:

- :ref:`FileSystemDock<class_FileSystemDock>` **get_file_system_dock** **(** **)**

----

.. _class_EditorInterface_method_get_inspector:

- :ref:`EditorInspector<class_EditorInspector>` **get_inspector** **(** **)** const
Expand Down
96 changes: 96 additions & 0 deletions classes/class_filesystemdock.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the FileSystemDock.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_FileSystemDock:

FileSystemDock
==============

**Inherits:** :ref:`VBoxContainer<class_VBoxContainer>` **<** :ref:`BoxContainer<class_BoxContainer>` **<** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`



Methods
-------

+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_drop_data_fw<class_FileSystemDock_method_can_drop_data_fw>` **(** :ref:`Vector2<class_Vector2>` arg0, :ref:`Variant<class_Variant>` arg1, :ref:`Control<class_Control>` arg2 **)** const |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`drop_data_fw<class_FileSystemDock_method_drop_data_fw>` **(** :ref:`Vector2<class_Vector2>` arg0, :ref:`Variant<class_Variant>` arg1, :ref:`Control<class_Control>` arg2 **)** |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`get_drag_data_fw<class_FileSystemDock_method_get_drag_data_fw>` **(** :ref:`Vector2<class_Vector2>` arg0, :ref:`Control<class_Control>` arg1 **)** |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`navigate_to_path<class_FileSystemDock_method_navigate_to_path>` **(** :ref:`String<class_String>` arg0 **)** |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

.. _class_FileSystemDock_signal_display_mode_changed:

- **display_mode_changed** **(** **)**

----

.. _class_FileSystemDock_signal_file_removed:

- **file_removed** **(** :ref:`String<class_String>` file **)**

----

.. _class_FileSystemDock_signal_files_moved:

- **files_moved** **(** :ref:`String<class_String>` old_file, :ref:`String<class_String>` new_file **)**

----

.. _class_FileSystemDock_signal_folder_moved:

- **folder_moved** **(** :ref:`String<class_String>` old_folder, :ref:`String<class_String>` new_file **)**

----

.. _class_FileSystemDock_signal_folder_removed:

- **folder_removed** **(** :ref:`String<class_String>` folder **)**

----

.. _class_FileSystemDock_signal_inherit:

- **inherit** **(** :ref:`String<class_String>` file **)**

----

.. _class_FileSystemDock_signal_instance:

- **instance** **(** :ref:`PackedStringArray<class_PackedStringArray>` files **)**

Method Descriptions
-------------------

.. _class_FileSystemDock_method_can_drop_data_fw:

- :ref:`bool<class_bool>` **can_drop_data_fw** **(** :ref:`Vector2<class_Vector2>` arg0, :ref:`Variant<class_Variant>` arg1, :ref:`Control<class_Control>` arg2 **)** const

----

.. _class_FileSystemDock_method_drop_data_fw:

- void **drop_data_fw** **(** :ref:`Vector2<class_Vector2>` arg0, :ref:`Variant<class_Variant>` arg1, :ref:`Control<class_Control>` arg2 **)**

----

.. _class_FileSystemDock_method_get_drag_data_fw:

- :ref:`Variant<class_Variant>` **get_drag_data_fw** **(** :ref:`Vector2<class_Vector2>` arg0, :ref:`Control<class_Control>` arg1 **)**

----

.. _class_FileSystemDock_method_navigate_to_path:

- void **navigate_to_path** **(** :ref:`String<class_String>` arg0 **)**

4 changes: 3 additions & 1 deletion classes/class_inputeventmousemotion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,9 @@ Represents the pressure the user puts on the pen. Ranges from ``0.0`` to ``1.0``
| *Getter* | get_relative() |
+-----------+---------------------+

The mouse position relative to the previous position (position at the last frame).
The mouse position relative to the previous position (position at the last frame).

**Note:** Since ``InputEventMouseMotion`` is only emitted when the mouse moves, the last event won't have a relative position of ``Vector2(0, 0)`` when the user stops moving the mouse.

----

Expand Down
2 changes: 1 addition & 1 deletion classes/class_material.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Material

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`, :ref:`ParticlesMaterial<class_ParticlesMaterial>`, :ref:`ShaderMaterial<class_ShaderMaterial>`
**Inherited By:** :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`, :ref:`PanoramaSkyMaterial<class_PanoramaSkyMaterial>`, :ref:`ParticlesMaterial<class_ParticlesMaterial>`, :ref:`PhysicalSkyMaterial<class_PhysicalSkyMaterial>`, :ref:`ProceduralSkyMaterial<class_ProceduralSkyMaterial>`, :ref:`ShaderMaterial<class_ShaderMaterial>`

Abstract base :ref:`Resource<class_Resource>` for coloring and shading geometry.

Expand Down
Loading

0 comments on commit 13bb7a6

Please sign in to comment.