mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
Sync classref with changes from godotengine/godot#24640
This commit is contained in:
Rémi Verschelde
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -17,60 +17,60 @@ Axis-Aligned Bounding Box.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+--------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`end<class_AABB_end>` |
|
||||
+-------------------------------+--------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`position<class_AABB_position>` |
|
||||
+-------------------------------+--------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`size<class_AABB_size>` |
|
||||
+-------------------------------+--------------------------------------+
|
||||
+-------------------------------+-----------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`end<class_AABB_property_end>` |
|
||||
+-------------------------------+-----------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`position<class_AABB_property_position>` |
|
||||
+-------------------------------+-----------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`size<class_AABB_property_size>` |
|
||||
+-------------------------------+-----------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`AABB<class_AABB_AABB>` **(** :ref:`Vector3<class_Vector3>` position, :ref:`Vector3<class_Vector3>` size **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`encloses<class_AABB_encloses>` **(** :ref:`AABB<class_AABB>` with **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`expand<class_AABB_expand>` **(** :ref:`Vector3<class_Vector3>` to_point **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_area<class_AABB_get_area>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_endpoint<class_AABB_get_endpoint>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_longest_axis<class_AABB_get_longest_axis>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_longest_axis_index<class_AABB_get_longest_axis_index>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_longest_axis_size<class_AABB_get_longest_axis_size>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_shortest_axis<class_AABB_get_shortest_axis>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_shortest_axis_index<class_AABB_get_shortest_axis_index>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_shortest_axis_size<class_AABB_get_shortest_axis_size>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_support<class_AABB_get_support>` **(** :ref:`Vector3<class_Vector3>` dir **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`grow<class_AABB_grow>` **(** :ref:`float<class_float>` by **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_no_area<class_AABB_has_no_area>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_no_surface<class_AABB_has_no_surface>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_AABB_has_point>` **(** :ref:`Vector3<class_Vector3>` point **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`intersection<class_AABB_intersection>` **(** :ref:`AABB<class_AABB>` with **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`intersects<class_AABB_intersects>` **(** :ref:`AABB<class_AABB>` with **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`intersects_plane<class_AABB_intersects_plane>` **(** :ref:`Plane<class_Plane>` plane **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`intersects_segment<class_AABB_intersects_segment>` **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`merge<class_AABB_merge>` **(** :ref:`AABB<class_AABB>` with **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`AABB<class_AABB_method_AABB>` **(** :ref:`Vector3<class_Vector3>` position, :ref:`Vector3<class_Vector3>` size **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`encloses<class_AABB_method_encloses>` **(** :ref:`AABB<class_AABB>` with **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`expand<class_AABB_method_expand>` **(** :ref:`Vector3<class_Vector3>` to_point **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_area<class_AABB_method_get_area>` **(** **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_endpoint<class_AABB_method_get_endpoint>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_longest_axis<class_AABB_method_get_longest_axis>` **(** **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_longest_axis_index<class_AABB_method_get_longest_axis_index>` **(** **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_longest_axis_size<class_AABB_method_get_longest_axis_size>` **(** **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_shortest_axis<class_AABB_method_get_shortest_axis>` **(** **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_shortest_axis_index<class_AABB_method_get_shortest_axis_index>` **(** **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_shortest_axis_size<class_AABB_method_get_shortest_axis_size>` **(** **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_support<class_AABB_method_get_support>` **(** :ref:`Vector3<class_Vector3>` dir **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`grow<class_AABB_method_grow>` **(** :ref:`float<class_float>` by **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_no_area<class_AABB_method_has_no_area>` **(** **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_no_surface<class_AABB_method_has_no_surface>` **(** **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_AABB_method_has_point>` **(** :ref:`Vector3<class_Vector3>` point **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`intersection<class_AABB_method_intersection>` **(** :ref:`AABB<class_AABB>` with **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`intersects<class_AABB_method_intersects>` **(** :ref:`AABB<class_AABB>` with **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`intersects_plane<class_AABB_method_intersects_plane>` **(** :ref:`Plane<class_Plane>` plane **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`intersects_segment<class_AABB_method_intersects_segment>` **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`merge<class_AABB_method_merge>` **(** :ref:`AABB<class_AABB>` with **)** |
|
||||
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -85,19 +85,19 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AABB_end:
|
||||
.. _class_AABB_property_end:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **end**
|
||||
|
||||
Ending corner.
|
||||
|
||||
.. _class_AABB_position:
|
||||
.. _class_AABB_property_position:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **position**
|
||||
|
||||
Beginning corner.
|
||||
|
||||
.. _class_AABB_size:
|
||||
.. _class_AABB_property_size:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **size**
|
||||
|
||||
@@ -106,127 +106,127 @@ Size from position to end.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AABB_AABB:
|
||||
.. _class_AABB_method_AABB:
|
||||
|
||||
- :ref:`AABB<class_AABB>` **AABB** **(** :ref:`Vector3<class_Vector3>` position, :ref:`Vector3<class_Vector3>` size **)**
|
||||
|
||||
Optional constructor, accepts position and size.
|
||||
|
||||
.. _class_AABB_encloses:
|
||||
.. _class_AABB_method_encloses:
|
||||
|
||||
- :ref:`bool<class_bool>` **encloses** **(** :ref:`AABB<class_AABB>` with **)**
|
||||
|
||||
Returns ``true`` if this ``AABB`` completely encloses another one.
|
||||
|
||||
.. _class_AABB_expand:
|
||||
.. _class_AABB_method_expand:
|
||||
|
||||
- :ref:`AABB<class_AABB>` **expand** **(** :ref:`Vector3<class_Vector3>` to_point **)**
|
||||
|
||||
Returns this ``AABB`` expanded to include a given point.
|
||||
|
||||
.. _class_AABB_get_area:
|
||||
.. _class_AABB_method_get_area:
|
||||
|
||||
- :ref:`float<class_float>` **get_area** **(** **)**
|
||||
|
||||
Gets the area of the ``AABB``.
|
||||
|
||||
.. _class_AABB_get_endpoint:
|
||||
.. _class_AABB_method_get_endpoint:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **get_endpoint** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Gets the position of the 8 endpoints of the ``AABB`` in space.
|
||||
|
||||
.. _class_AABB_get_longest_axis:
|
||||
.. _class_AABB_method_get_longest_axis:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **get_longest_axis** **(** **)**
|
||||
|
||||
Returns the normalized longest axis of the ``AABB``.
|
||||
|
||||
.. _class_AABB_get_longest_axis_index:
|
||||
.. _class_AABB_method_get_longest_axis_index:
|
||||
|
||||
- :ref:`int<class_int>` **get_longest_axis_index** **(** **)**
|
||||
|
||||
Returns the index of the longest axis of the ``AABB`` (according to :ref:`Vector3<class_Vector3>`::AXIS\* enum).
|
||||
|
||||
.. _class_AABB_get_longest_axis_size:
|
||||
.. _class_AABB_method_get_longest_axis_size:
|
||||
|
||||
- :ref:`float<class_float>` **get_longest_axis_size** **(** **)**
|
||||
|
||||
Returns the scalar length of the longest axis of the ``AABB``.
|
||||
|
||||
.. _class_AABB_get_shortest_axis:
|
||||
.. _class_AABB_method_get_shortest_axis:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **get_shortest_axis** **(** **)**
|
||||
|
||||
Returns the normalized shortest axis of the ``AABB``.
|
||||
|
||||
.. _class_AABB_get_shortest_axis_index:
|
||||
.. _class_AABB_method_get_shortest_axis_index:
|
||||
|
||||
- :ref:`int<class_int>` **get_shortest_axis_index** **(** **)**
|
||||
|
||||
Returns the index of the shortest axis of the ``AABB`` (according to :ref:`Vector3<class_Vector3>`::AXIS\* enum).
|
||||
|
||||
.. _class_AABB_get_shortest_axis_size:
|
||||
.. _class_AABB_method_get_shortest_axis_size:
|
||||
|
||||
- :ref:`float<class_float>` **get_shortest_axis_size** **(** **)**
|
||||
|
||||
Returns the scalar length of the shortest axis of the ``AABB``.
|
||||
|
||||
.. _class_AABB_get_support:
|
||||
.. _class_AABB_method_get_support:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **get_support** **(** :ref:`Vector3<class_Vector3>` dir **)**
|
||||
|
||||
Returns the support point in a given direction. This is useful for collision detection algorithms.
|
||||
|
||||
.. _class_AABB_grow:
|
||||
.. _class_AABB_method_grow:
|
||||
|
||||
- :ref:`AABB<class_AABB>` **grow** **(** :ref:`float<class_float>` by **)**
|
||||
|
||||
Returns a copy of the ``AABB`` grown a given amount of units towards all the sides.
|
||||
|
||||
.. _class_AABB_has_no_area:
|
||||
.. _class_AABB_method_has_no_area:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_no_area** **(** **)**
|
||||
|
||||
Returns ``true`` if the ``AABB`` is flat or empty.
|
||||
|
||||
.. _class_AABB_has_no_surface:
|
||||
.. _class_AABB_method_has_no_surface:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_no_surface** **(** **)**
|
||||
|
||||
Returns ``true`` if the ``AABB`` is empty.
|
||||
|
||||
.. _class_AABB_has_point:
|
||||
.. _class_AABB_method_has_point:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_point** **(** :ref:`Vector3<class_Vector3>` point **)**
|
||||
|
||||
Returns ``true`` if the ``AABB`` contains a point.
|
||||
|
||||
.. _class_AABB_intersection:
|
||||
.. _class_AABB_method_intersection:
|
||||
|
||||
- :ref:`AABB<class_AABB>` **intersection** **(** :ref:`AABB<class_AABB>` with **)**
|
||||
|
||||
Returns the intersection between two ``AABB``. An empty AABB (size 0,0,0) is returned on failure.
|
||||
|
||||
.. _class_AABB_intersects:
|
||||
.. _class_AABB_method_intersects:
|
||||
|
||||
- :ref:`bool<class_bool>` **intersects** **(** :ref:`AABB<class_AABB>` with **)**
|
||||
|
||||
Returns ``true`` if the ``AABB`` overlaps with another.
|
||||
|
||||
.. _class_AABB_intersects_plane:
|
||||
.. _class_AABB_method_intersects_plane:
|
||||
|
||||
- :ref:`bool<class_bool>` **intersects_plane** **(** :ref:`Plane<class_Plane>` plane **)**
|
||||
|
||||
Returns ``true`` if the ``AABB`` is on both sides of a plane.
|
||||
|
||||
.. _class_AABB_intersects_segment:
|
||||
.. _class_AABB_method_intersects_segment:
|
||||
|
||||
- :ref:`bool<class_bool>` **intersects_segment** **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to **)**
|
||||
|
||||
Returns ``true`` if the ``AABB`` intersects the line segment between ``from`` and ``to``.
|
||||
|
||||
.. _class_AABB_merge:
|
||||
.. _class_AABB_method_merge:
|
||||
|
||||
- :ref:`AABB<class_AABB>` **merge** **(** :ref:`AABB<class_AABB>` with **)**
|
||||
|
||||
|
||||
@@ -21,41 +21,41 @@ Base dialog for user notification.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+----------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dialog_hide_on_ok<class_AcceptDialog_dialog_hide_on_ok>` |
|
||||
+-----------------------------+----------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`dialog_text<class_AcceptDialog_dialog_text>` |
|
||||
+-----------------------------+----------------------------------------------------------------+
|
||||
+-----------------------------+-------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dialog_hide_on_ok<class_AcceptDialog_property_dialog_hide_on_ok>` |
|
||||
+-----------------------------+-------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`dialog_text<class_AcceptDialog_property_dialog_text>` |
|
||||
+-----------------------------+-------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Button<class_Button>` | :ref:`add_button<class_AcceptDialog_add_button>` **(** :ref:`String<class_String>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_String>` action="" **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Button<class_Button>` | :ref:`add_cancel<class_AcceptDialog_add_cancel>` **(** :ref:`String<class_String>` name **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Label<class_Label>` | :ref:`get_label<class_AcceptDialog_get_label>` **(** **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Button<class_Button>` | :ref:`get_ok<class_AcceptDialog_get_ok>` **(** **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`register_text_enter<class_AcceptDialog_register_text_enter>` **(** :ref:`Node<class_Node>` line_edit **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Button<class_Button>` | :ref:`add_button<class_AcceptDialog_method_add_button>` **(** :ref:`String<class_String>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_String>` action="" **)** |
|
||||
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Button<class_Button>` | :ref:`add_cancel<class_AcceptDialog_method_add_cancel>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Label<class_Label>` | :ref:`get_label<class_AcceptDialog_method_get_label>` **(** **)** |
|
||||
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Button<class_Button>` | :ref:`get_ok<class_AcceptDialog_method_get_ok>` **(** **)** |
|
||||
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`register_text_enter<class_AcceptDialog_method_register_text_enter>` **(** :ref:`Node<class_Node>` line_edit **)** |
|
||||
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AcceptDialog_confirmed:
|
||||
.. _class_AcceptDialog_signal_confirmed:
|
||||
|
||||
- **confirmed** **(** **)**
|
||||
|
||||
Emitted when the dialog is accepted, i.e. the OK button is pressed.
|
||||
|
||||
.. _class_AcceptDialog_custom_action:
|
||||
.. _class_AcceptDialog_signal_custom_action:
|
||||
|
||||
- **custom_action** **(** :ref:`String<class_String>` action **)**
|
||||
|
||||
Emitted when a custom button is pressed. See :ref:`add_button<class_AcceptDialog_add_button>`.
|
||||
Emitted when a custom button is pressed. See :ref:`add_button<class_AcceptDialog_method_add_button>`.
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -65,7 +65,7 @@ This dialog is useful for small notifications to the user about an event. It can
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AcceptDialog_dialog_hide_on_ok:
|
||||
.. _class_AcceptDialog_property_dialog_hide_on_ok:
|
||||
|
||||
- :ref:`bool<class_bool>` **dialog_hide_on_ok**
|
||||
|
||||
@@ -75,11 +75,11 @@ Property Descriptions
|
||||
| *Getter* | get_hide_on_ok() |
|
||||
+----------+-----------------------+
|
||||
|
||||
If ``true``, the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed<class_AcceptDialog_confirmed>` signal, and handle hiding the dialog in your own logic. Default value: ``true``.
|
||||
If ``true``, the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed<class_AcceptDialog_signal_confirmed>` signal, and handle hiding the dialog in your own logic. Default value: ``true``.
|
||||
|
||||
Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example :ref:`FileDialog<class_FileDialog>` defaults to ``false``, and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in :ref:`FileDialog<class_FileDialog>` to disable hiding the dialog when pressing OK.
|
||||
|
||||
.. _class_AcceptDialog_dialog_text:
|
||||
.. _class_AcceptDialog_property_dialog_text:
|
||||
|
||||
- :ref:`String<class_String>` **dialog_text**
|
||||
|
||||
@@ -94,33 +94,33 @@ The text displayed by this dialog.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AcceptDialog_add_button:
|
||||
.. _class_AcceptDialog_method_add_button:
|
||||
|
||||
- :ref:`Button<class_Button>` **add_button** **(** :ref:`String<class_String>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_String>` action="" **)**
|
||||
|
||||
Adds a button with label *text* and a custom *action* to the dialog and returns the created button. *action* will be passed to the :ref:`custom_action<class_AcceptDialog_custom_action>` signal when pressed.
|
||||
Adds a button with label *text* and a custom *action* to the dialog and returns the created button. *action* will be passed to the :ref:`custom_action<class_AcceptDialog_signal_custom_action>` signal when pressed.
|
||||
|
||||
If ``true``, *right* will place the button to the right of any sibling buttons. Default value: ``false``.
|
||||
|
||||
.. _class_AcceptDialog_add_cancel:
|
||||
.. _class_AcceptDialog_method_add_cancel:
|
||||
|
||||
- :ref:`Button<class_Button>` **add_cancel** **(** :ref:`String<class_String>` name **)**
|
||||
|
||||
Adds a button with label *name* and a cancel action to the dialog and returns the created button.
|
||||
|
||||
.. _class_AcceptDialog_get_label:
|
||||
.. _class_AcceptDialog_method_get_label:
|
||||
|
||||
- :ref:`Label<class_Label>` **get_label** **(** **)**
|
||||
|
||||
Return the label used for built-in text.
|
||||
|
||||
.. _class_AcceptDialog_get_ok:
|
||||
.. _class_AcceptDialog_method_get_ok:
|
||||
|
||||
- :ref:`Button<class_Button>` **get_ok** **(** **)**
|
||||
|
||||
Return the OK Button.
|
||||
|
||||
.. _class_AcceptDialog_register_text_enter:
|
||||
.. _class_AcceptDialog_method_register_text_enter:
|
||||
|
||||
- void **register_text_enter** **(** :ref:`Node<class_Node>` line_edit **)**
|
||||
|
||||
|
||||
@@ -19,51 +19,51 @@ Sprite node that can use multiple textures for animation.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------+------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite_animation>` |
|
||||
+-----------------------------------------+------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`centered<class_AnimatedSprite_centered>` |
|
||||
+-----------------------------------------+------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_h<class_AnimatedSprite_flip_h>` |
|
||||
+-----------------------------------------+------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_v<class_AnimatedSprite_flip_v>` |
|
||||
+-----------------------------------------+------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite_frame>` |
|
||||
+-----------------------------------------+------------------------------------------------------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite_frames>` |
|
||||
+-----------------------------------------+------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_AnimatedSprite_offset>` |
|
||||
+-----------------------------------------+------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite_playing>` |
|
||||
+-----------------------------------------+------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimatedSprite_speed_scale>` |
|
||||
+-----------------------------------------+------------------------------------------------------+
|
||||
+-----------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite_property_animation>` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`centered<class_AnimatedSprite_property_centered>` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_h<class_AnimatedSprite_property_flip_h>` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_v<class_AnimatedSprite_property_flip_v>` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite_property_frame>` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite_property_frames>` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_AnimatedSprite_property_offset>` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite_property_playing>` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimatedSprite_property_speed_scale>` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------+----------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite_is_playing>` **(** **)** const |
|
||||
+--------------------------+----------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite_play>` **(** :ref:`String<class_String>` anim="" **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite_stop>` **(** **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------+
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite_method_is_playing>` **(** **)** const |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite_method_play>` **(** :ref:`String<class_String>` anim="" **)** |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite_method_stop>` **(** **)** |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AnimatedSprite_animation_finished:
|
||||
.. _class_AnimatedSprite_signal_animation_finished:
|
||||
|
||||
- **animation_finished** **(** **)**
|
||||
|
||||
Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn.
|
||||
|
||||
.. _class_AnimatedSprite_frame_changed:
|
||||
.. _class_AnimatedSprite_signal_frame_changed:
|
||||
|
||||
- **frame_changed** **(** **)**
|
||||
|
||||
Emitted when :ref:`frame<class_AnimatedSprite_frame>` changed.
|
||||
Emitted when :ref:`frame<class_AnimatedSprite_property_frame>` changed.
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -73,7 +73,7 @@ Animations are created using a :ref:`SpriteFrames<class_SpriteFrames>` resource,
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimatedSprite_animation:
|
||||
.. _class_AnimatedSprite_property_animation:
|
||||
|
||||
- :ref:`String<class_String>` **animation**
|
||||
|
||||
@@ -85,7 +85,7 @@ Property Descriptions
|
||||
|
||||
The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset.
|
||||
|
||||
.. _class_AnimatedSprite_centered:
|
||||
.. _class_AnimatedSprite_property_centered:
|
||||
|
||||
- :ref:`bool<class_bool>` **centered**
|
||||
|
||||
@@ -97,7 +97,7 @@ The current animation from the ``frames`` resource. If this value changes, the `
|
||||
|
||||
If ``true``, texture will be centered. Default value: ``true``.
|
||||
|
||||
.. _class_AnimatedSprite_flip_h:
|
||||
.. _class_AnimatedSprite_property_flip_h:
|
||||
|
||||
- :ref:`bool<class_bool>` **flip_h**
|
||||
|
||||
@@ -109,7 +109,7 @@ If ``true``, texture will be centered. Default value: ``true``.
|
||||
|
||||
If ``true``, texture is flipped horizontally. Default value: ``false``.
|
||||
|
||||
.. _class_AnimatedSprite_flip_v:
|
||||
.. _class_AnimatedSprite_property_flip_v:
|
||||
|
||||
- :ref:`bool<class_bool>` **flip_v**
|
||||
|
||||
@@ -121,7 +121,7 @@ If ``true``, texture is flipped horizontally. Default value: ``false``.
|
||||
|
||||
If ``true``, texture is flipped vertically. Default value: ``false``.
|
||||
|
||||
.. _class_AnimatedSprite_frame:
|
||||
.. _class_AnimatedSprite_property_frame:
|
||||
|
||||
- :ref:`int<class_int>` **frame**
|
||||
|
||||
@@ -133,7 +133,7 @@ If ``true``, texture is flipped vertically. Default value: ``false``.
|
||||
|
||||
The displayed animation frame's index.
|
||||
|
||||
.. _class_AnimatedSprite_frames:
|
||||
.. _class_AnimatedSprite_property_frames:
|
||||
|
||||
- :ref:`SpriteFrames<class_SpriteFrames>` **frames**
|
||||
|
||||
@@ -145,7 +145,7 @@ The displayed animation frame's index.
|
||||
|
||||
The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s).
|
||||
|
||||
.. _class_AnimatedSprite_offset:
|
||||
.. _class_AnimatedSprite_property_offset:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **offset**
|
||||
|
||||
@@ -157,13 +157,13 @@ The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s)
|
||||
|
||||
The texture's drawing offset.
|
||||
|
||||
.. _class_AnimatedSprite_playing:
|
||||
.. _class_AnimatedSprite_property_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **playing**
|
||||
|
||||
If ``true``, the :ref:`animation<class_AnimatedSprite_animation>` is currently playing.
|
||||
If ``true``, the :ref:`animation<class_AnimatedSprite_property_animation>` is currently playing.
|
||||
|
||||
.. _class_AnimatedSprite_speed_scale:
|
||||
.. _class_AnimatedSprite_property_speed_scale:
|
||||
|
||||
- :ref:`float<class_float>` **speed_scale**
|
||||
|
||||
@@ -176,19 +176,19 @@ If ``true``, the :ref:`animation<class_AnimatedSprite_animation>` is currently p
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimatedSprite_is_playing:
|
||||
.. _class_AnimatedSprite_method_is_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
|
||||
Return true if an animation if currently being played.
|
||||
|
||||
.. _class_AnimatedSprite_play:
|
||||
.. _class_AnimatedSprite_method_play:
|
||||
|
||||
- void **play** **(** :ref:`String<class_String>` anim="" **)**
|
||||
|
||||
Play the animation set in parameter. If no parameter is provided, the current animation is played.
|
||||
|
||||
.. _class_AnimatedSprite_stop:
|
||||
.. _class_AnimatedSprite_method_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
|
||||
|
||||
@@ -19,35 +19,35 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------+----------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite3D_animation>` |
|
||||
+-----------------------------------------+----------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite3D_frame>` |
|
||||
+-----------------------------------------+----------------------------------------------------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite3D_frames>` |
|
||||
+-----------------------------------------+----------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite3D_playing>` |
|
||||
+-----------------------------------------+----------------------------------------------------+
|
||||
+-----------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite3D_property_animation>` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite3D_property_frame>` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite3D_property_frames>` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite3D_property_playing>` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------+------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite3D_is_playing>` **(** **)** const |
|
||||
+--------------------------+------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite3D_play>` **(** :ref:`String<class_String>` anim="" **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite3D_stop>` **(** **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite3D_method_is_playing>` **(** **)** const |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite3D_method_play>` **(** :ref:`String<class_String>` anim="" **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite3D_method_stop>` **(** **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AnimatedSprite3D_frame_changed:
|
||||
.. _class_AnimatedSprite3D_signal_frame_changed:
|
||||
|
||||
- **frame_changed** **(** **)**
|
||||
|
||||
Emitted when :ref:`frame<class_AnimatedSprite3D_frame>` changed.
|
||||
Emitted when :ref:`frame<class_AnimatedSprite3D_property_frame>` changed.
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -57,7 +57,7 @@ Animations are created using a :ref:`SpriteFrames<class_SpriteFrames>` resource,
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimatedSprite3D_animation:
|
||||
.. _class_AnimatedSprite3D_property_animation:
|
||||
|
||||
- :ref:`String<class_String>` **animation**
|
||||
|
||||
@@ -69,7 +69,7 @@ Property Descriptions
|
||||
|
||||
The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset.
|
||||
|
||||
.. _class_AnimatedSprite3D_frame:
|
||||
.. _class_AnimatedSprite3D_property_frame:
|
||||
|
||||
- :ref:`int<class_int>` **frame**
|
||||
|
||||
@@ -81,7 +81,7 @@ The current animation from the ``frames`` resource. If this value changes, the `
|
||||
|
||||
The displayed animation frame's index.
|
||||
|
||||
.. _class_AnimatedSprite3D_frames:
|
||||
.. _class_AnimatedSprite3D_property_frames:
|
||||
|
||||
- :ref:`SpriteFrames<class_SpriteFrames>` **frames**
|
||||
|
||||
@@ -93,28 +93,28 @@ The displayed animation frame's index.
|
||||
|
||||
The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s).
|
||||
|
||||
.. _class_AnimatedSprite3D_playing:
|
||||
.. _class_AnimatedSprite3D_property_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **playing**
|
||||
|
||||
If ``true``, the :ref:`animation<class_AnimatedSprite3D_animation>` is currently playing.
|
||||
If ``true``, the :ref:`animation<class_AnimatedSprite3D_property_animation>` is currently playing.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimatedSprite3D_is_playing:
|
||||
.. _class_AnimatedSprite3D_method_is_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
|
||||
Return true if an animation if currently being played.
|
||||
|
||||
.. _class_AnimatedSprite3D_play:
|
||||
.. _class_AnimatedSprite3D_method_play:
|
||||
|
||||
- void **play** **(** :ref:`String<class_String>` anim="" **)**
|
||||
|
||||
Play the animation set in parameter. If no parameter is provided, the current animation is played.
|
||||
|
||||
.. _class_AnimatedSprite3D_stop:
|
||||
.. _class_AnimatedSprite3D_method_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
|
||||
|
||||
@@ -19,29 +19,29 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fps<class_AnimatedTexture_fps>` |
|
||||
+---------------------------+---------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`frames<class_AnimatedTexture_frames>` |
|
||||
+---------------------------+---------------------------------------------+
|
||||
+---------------------------+------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fps<class_AnimatedTexture_property_fps>` |
|
||||
+---------------------------+------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`frames<class_AnimatedTexture_property_frames>` |
|
||||
+---------------------------+------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_frame_delay<class_AnimatedTexture_get_frame_delay>` **(** :ref:`int<class_int>` frame **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`get_frame_texture<class_AnimatedTexture_get_frame_texture>` **(** :ref:`int<class_int>` frame **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame_delay<class_AnimatedTexture_set_frame_delay>` **(** :ref:`int<class_int>` frame, :ref:`float<class_float>` delay **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame_texture<class_AnimatedTexture_set_frame_texture>` **(** :ref:`int<class_int>` frame, :ref:`Texture<class_Texture>` texture **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_frame_delay<class_AnimatedTexture_method_get_frame_delay>` **(** :ref:`int<class_int>` frame **)** const |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`get_frame_texture<class_AnimatedTexture_method_get_frame_texture>` **(** :ref:`int<class_int>` frame **)** const |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame_delay<class_AnimatedTexture_method_set_frame_delay>` **(** :ref:`int<class_int>` frame, :ref:`float<class_float>` delay **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame_texture<class_AnimatedTexture_method_set_frame_texture>` **(** :ref:`int<class_int>` frame, :ref:`Texture<class_Texture>` texture **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimatedTexture_fps:
|
||||
.. _class_AnimatedTexture_property_fps:
|
||||
|
||||
- :ref:`float<class_float>` **fps**
|
||||
|
||||
@@ -51,7 +51,7 @@ Property Descriptions
|
||||
| *Getter* | get_fps() |
|
||||
+----------+----------------+
|
||||
|
||||
.. _class_AnimatedTexture_frames:
|
||||
.. _class_AnimatedTexture_property_frames:
|
||||
|
||||
- :ref:`int<class_int>` **frames**
|
||||
|
||||
@@ -64,19 +64,19 @@ Property Descriptions
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimatedTexture_get_frame_delay:
|
||||
.. _class_AnimatedTexture_method_get_frame_delay:
|
||||
|
||||
- :ref:`float<class_float>` **get_frame_delay** **(** :ref:`int<class_int>` frame **)** const
|
||||
|
||||
.. _class_AnimatedTexture_get_frame_texture:
|
||||
.. _class_AnimatedTexture_method_get_frame_texture:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **get_frame_texture** **(** :ref:`int<class_int>` frame **)** const
|
||||
|
||||
.. _class_AnimatedTexture_set_frame_delay:
|
||||
.. _class_AnimatedTexture_method_set_frame_delay:
|
||||
|
||||
- void **set_frame_delay** **(** :ref:`int<class_int>` frame, :ref:`float<class_float>` delay **)**
|
||||
|
||||
.. _class_AnimatedTexture_set_frame_texture:
|
||||
.. _class_AnimatedTexture_method_set_frame_texture:
|
||||
|
||||
- void **set_frame_texture** **(** :ref:`int<class_int>` frame, :ref:`Texture<class_Texture>` texture **)**
|
||||
|
||||
|
||||
@@ -19,136 +19,148 @@ Contains data used to animate everything in the engine.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`length<class_Animation_length>` |
|
||||
+---------------------------+---------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`loop<class_Animation_loop>` |
|
||||
+---------------------------+---------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`step<class_Animation_step>` |
|
||||
+---------------------------+---------------------------------------+
|
||||
+---------------------------+------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`length<class_Animation_property_length>` |
|
||||
+---------------------------+------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`loop<class_Animation_property_loop>` |
|
||||
+---------------------------+------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`step<class_Animation_property_step>` |
|
||||
+---------------------------+------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`add_track<class_Animation_add_track>` **(** :ref:`TrackType<enum_Animation_TrackType>` type, :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation_track_get_key_animation<class_Animation_animation_track_get_key_animation>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`animation_track_insert_key<class_Animation_animation_track_insert_key>` **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`String<class_String>` animation **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_track_set_key_animation<class_Animation_animation_track_set_key_animation>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`String<class_String>` animation **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`audio_track_get_key_end_offset<class_Animation_audio_track_get_key_end_offset>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`audio_track_get_key_start_offset<class_Animation_audio_track_get_key_start_offset>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Resource<class_Resource>` | :ref:`audio_track_get_key_stream<class_Animation_audio_track_get_key_stream>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`audio_track_insert_key<class_Animation_audio_track_insert_key>` **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`Resource<class_Resource>` stream, :ref:`float<class_float>` start_offset=0, :ref:`float<class_float>` end_offset=0 **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`audio_track_set_key_end_offset<class_Animation_audio_track_set_key_end_offset>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`audio_track_set_key_start_offset<class_Animation_audio_track_set_key_start_offset>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`audio_track_set_key_stream<class_Animation_audio_track_set_key_stream>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Resource<class_Resource>` stream **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`bezier_track_get_key_in_handle<class_Animation_bezier_track_get_key_in_handle>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`bezier_track_get_key_out_handle<class_Animation_bezier_track_get_key_out_handle>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bezier_track_get_key_value<class_Animation_bezier_track_get_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bezier_track_insert_key<class_Animation_bezier_track_insert_key>` **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`float<class_float>` value, :ref:`Vector2<class_Vector2>` in_handle=Vector2( 0, 0 ), :ref:`Vector2<class_Vector2>` out_handle=Vector2( 0, 0 ) **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bezier_track_interpolate<class_Animation_bezier_track_interpolate>` **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`bezier_track_set_key_in_handle<class_Animation_bezier_track_set_key_in_handle>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` in_handle **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`bezier_track_set_key_out_handle<class_Animation_bezier_track_set_key_out_handle>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` out_handle **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`bezier_track_set_key_value<class_Animation_bezier_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` value **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Animation_clear>` **(** **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`copy_track<class_Animation_copy_track>` **(** :ref:`int<class_int>` track, :ref:`Animation<class_Animation>` to_animation **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_track<class_Animation_find_track>` **(** :ref:`NodePath<class_NodePath>` path **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_get_track_count>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`method_track_get_key_indices<class_Animation_method_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`method_track_get_name<class_Animation_method_track_get_name>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`method_track_get_params<class_Animation_method_track_get_params>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_track<class_Animation_remove_track>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`track_find_key<class_Animation_track_find_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`track_get_interpolation_loop_wrap<class_Animation_track_get_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`InterpolationType<enum_Animation_InterpolationType>` | :ref:`track_get_interpolation_type<class_Animation_track_get_interpolation_type>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`track_get_key_count<class_Animation_track_get_key_count>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`track_get_key_time<class_Animation_track_get_key_time>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`track_get_key_transition<class_Animation_track_get_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`track_get_key_value<class_Animation_track_get_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`track_get_path<class_Animation_track_get_path>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`TrackType<enum_Animation_TrackType>` | :ref:`track_get_type<class_Animation_track_get_type>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_insert_key<class_Animation_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_Variant>` key, :ref:`float<class_float>` transition=1 **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`track_is_enabled<class_Animation_track_is_enabled>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`track_is_imported<class_Animation_track_is_imported>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_move_down<class_Animation_track_move_down>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_move_up<class_Animation_track_move_up>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_remove_key<class_Animation_track_remove_key>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_remove_key_at_position<class_Animation_track_remove_key_at_position>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` position **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_enabled<class_Animation_track_set_enabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_imported<class_Animation_track_set_imported>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_interpolation_loop_wrap<class_Animation_track_set_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_interpolation_type<class_Animation_track_set_interpolation_type>` **(** :ref:`int<class_int>` idx, :ref:`InterpolationType<enum_Animation_InterpolationType>` interpolation **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_key_transition<class_Animation_track_set_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_key_value<class_Animation_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_path<class_Animation_track_set_path>` **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_NodePath>` path **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_swap<class_Animation_track_swap>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` with_idx **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transform_track_insert_key<class_Animation_transform_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_Vector3>` location, :ref:`Quat<class_Quat>` rotation, :ref:`Vector3<class_Vector3>` scale **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`transform_track_interpolate<class_Animation_transform_track_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`value_track_get_key_indices<class_Animation_value_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`UpdateMode<enum_Animation_UpdateMode>` | :ref:`value_track_get_update_mode<class_Animation_value_track_get_update_mode>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`value_track_set_update_mode<class_Animation_value_track_set_update_mode>` **(** :ref:`int<class_int>` idx, :ref:`UpdateMode<enum_Animation_UpdateMode>` mode **)** |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`add_track<class_Animation_method_add_track>` **(** :ref:`TrackType<enum_Animation_TrackType>` type, :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation_track_get_key_animation<class_Animation_method_animation_track_get_key_animation>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`animation_track_insert_key<class_Animation_method_animation_track_insert_key>` **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`String<class_String>` animation **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_track_set_key_animation<class_Animation_method_animation_track_set_key_animation>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`String<class_String>` animation **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`audio_track_get_key_end_offset<class_Animation_method_audio_track_get_key_end_offset>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`audio_track_get_key_start_offset<class_Animation_method_audio_track_get_key_start_offset>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Resource<class_Resource>` | :ref:`audio_track_get_key_stream<class_Animation_method_audio_track_get_key_stream>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`audio_track_insert_key<class_Animation_method_audio_track_insert_key>` **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`Resource<class_Resource>` stream, :ref:`float<class_float>` start_offset=0, :ref:`float<class_float>` end_offset=0 **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`audio_track_set_key_end_offset<class_Animation_method_audio_track_set_key_end_offset>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`audio_track_set_key_start_offset<class_Animation_method_audio_track_set_key_start_offset>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`audio_track_set_key_stream<class_Animation_method_audio_track_set_key_stream>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Resource<class_Resource>` stream **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`bezier_track_get_key_in_handle<class_Animation_method_bezier_track_get_key_in_handle>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`bezier_track_get_key_out_handle<class_Animation_method_bezier_track_get_key_out_handle>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bezier_track_get_key_value<class_Animation_method_bezier_track_get_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bezier_track_insert_key<class_Animation_method_bezier_track_insert_key>` **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`float<class_float>` value, :ref:`Vector2<class_Vector2>` in_handle=Vector2( 0, 0 ), :ref:`Vector2<class_Vector2>` out_handle=Vector2( 0, 0 ) **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bezier_track_interpolate<class_Animation_method_bezier_track_interpolate>` **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`bezier_track_set_key_in_handle<class_Animation_method_bezier_track_set_key_in_handle>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` in_handle **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`bezier_track_set_key_out_handle<class_Animation_method_bezier_track_set_key_out_handle>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` out_handle **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`bezier_track_set_key_value<class_Animation_method_bezier_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` value **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Animation_method_clear>` **(** **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`copy_track<class_Animation_method_copy_track>` **(** :ref:`int<class_int>` track, :ref:`Animation<class_Animation>` to_animation **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_track<class_Animation_method_find_track>` **(** :ref:`NodePath<class_NodePath>` path **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_method_get_track_count>` **(** **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`method_track_get_key_indices<class_Animation_method_method_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`method_track_get_name<class_Animation_method_method_track_get_name>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`method_track_get_params<class_Animation_method_method_track_get_params>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_track<class_Animation_method_remove_track>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`track_find_key<class_Animation_method_track_find_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`track_get_interpolation_loop_wrap<class_Animation_method_track_get_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`InterpolationType<enum_Animation_InterpolationType>` | :ref:`track_get_interpolation_type<class_Animation_method_track_get_interpolation_type>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`track_get_key_count<class_Animation_method_track_get_key_count>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`track_get_key_time<class_Animation_method_track_get_key_time>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`track_get_key_transition<class_Animation_method_track_get_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`track_get_key_value<class_Animation_method_track_get_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`track_get_path<class_Animation_method_track_get_path>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`TrackType<enum_Animation_TrackType>` | :ref:`track_get_type<class_Animation_method_track_get_type>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_insert_key<class_Animation_method_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_Variant>` key, :ref:`float<class_float>` transition=1 **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`track_is_enabled<class_Animation_method_track_is_enabled>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`track_is_imported<class_Animation_method_track_is_imported>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_move_down<class_Animation_method_track_move_down>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_move_up<class_Animation_method_track_move_up>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_remove_key<class_Animation_method_track_remove_key>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_remove_key_at_position<class_Animation_method_track_remove_key_at_position>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` position **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_enabled<class_Animation_method_track_set_enabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_imported<class_Animation_method_track_set_imported>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_interpolation_loop_wrap<class_Animation_method_track_set_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_interpolation_type<class_Animation_method_track_set_interpolation_type>` **(** :ref:`int<class_int>` idx, :ref:`InterpolationType<enum_Animation_InterpolationType>` interpolation **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_key_transition<class_Animation_method_track_set_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_key_value<class_Animation_method_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_Variant>` value **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_path<class_Animation_method_track_set_path>` **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_NodePath>` path **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_swap<class_Animation_method_track_swap>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` with_idx **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transform_track_insert_key<class_Animation_method_transform_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_Vector3>` location, :ref:`Quat<class_Quat>` rotation, :ref:`Vector3<class_Vector3>` scale **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`transform_track_interpolate<class_Animation_method_transform_track_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`value_track_get_key_indices<class_Animation_method_value_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`UpdateMode<enum_Animation_UpdateMode>` | :ref:`value_track_get_update_mode<class_Animation_method_value_track_get_update_mode>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`value_track_set_update_mode<class_Animation_method_value_track_set_update_mode>` **(** :ref:`int<class_int>` idx, :ref:`UpdateMode<enum_Animation_UpdateMode>` mode **)** |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_Animation_TrackType:
|
||||
|
||||
.. _class_Animation_constant_TYPE_VALUE:
|
||||
|
||||
.. _class_Animation_constant_TYPE_TRANSFORM:
|
||||
|
||||
.. _class_Animation_constant_TYPE_METHOD:
|
||||
|
||||
.. _class_Animation_constant_TYPE_BEZIER:
|
||||
|
||||
.. _class_Animation_constant_TYPE_AUDIO:
|
||||
|
||||
.. _class_Animation_constant_TYPE_ANIMATION:
|
||||
|
||||
enum **TrackType**:
|
||||
|
||||
- **TYPE_VALUE** = **0** --- Value tracks set values in node properties, but only those which can be Interpolated.
|
||||
@@ -165,6 +177,12 @@ enum **TrackType**:
|
||||
|
||||
.. _enum_Animation_InterpolationType:
|
||||
|
||||
.. _class_Animation_constant_INTERPOLATION_NEAREST:
|
||||
|
||||
.. _class_Animation_constant_INTERPOLATION_LINEAR:
|
||||
|
||||
.. _class_Animation_constant_INTERPOLATION_CUBIC:
|
||||
|
||||
enum **InterpolationType**:
|
||||
|
||||
- **INTERPOLATION_NEAREST** = **0** --- No interpolation (nearest value).
|
||||
@@ -175,6 +193,14 @@ enum **InterpolationType**:
|
||||
|
||||
.. _enum_Animation_UpdateMode:
|
||||
|
||||
.. _class_Animation_constant_UPDATE_CONTINUOUS:
|
||||
|
||||
.. _class_Animation_constant_UPDATE_DISCRETE:
|
||||
|
||||
.. _class_Animation_constant_UPDATE_TRIGGER:
|
||||
|
||||
.. _class_Animation_constant_UPDATE_CAPTURE:
|
||||
|
||||
enum **UpdateMode**:
|
||||
|
||||
- **UPDATE_CONTINUOUS** = **0** --- Update between keyframes.
|
||||
@@ -210,7 +236,7 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Animation_length:
|
||||
.. _class_Animation_property_length:
|
||||
|
||||
- :ref:`float<class_float>` **length**
|
||||
|
||||
@@ -222,7 +248,7 @@ Property Descriptions
|
||||
|
||||
The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
|
||||
|
||||
.. _class_Animation_loop:
|
||||
.. _class_Animation_property_loop:
|
||||
|
||||
- :ref:`bool<class_bool>` **loop**
|
||||
|
||||
@@ -234,7 +260,7 @@ The total length of the animation (in seconds). Note that length is not delimite
|
||||
|
||||
A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
|
||||
|
||||
.. _class_Animation_step:
|
||||
.. _class_Animation_property_step:
|
||||
|
||||
- :ref:`float<class_float>` **step**
|
||||
|
||||
@@ -249,265 +275,265 @@ The animation step value.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Animation_add_track:
|
||||
.. _class_Animation_method_add_track:
|
||||
|
||||
- :ref:`int<class_int>` **add_track** **(** :ref:`TrackType<enum_Animation_TrackType>` type, :ref:`int<class_int>` at_position=-1 **)**
|
||||
|
||||
Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration.
|
||||
|
||||
.. _class_Animation_animation_track_get_key_animation:
|
||||
.. _class_Animation_method_animation_track_get_key_animation:
|
||||
|
||||
- :ref:`String<class_String>` **animation_track_get_key_animation** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
.. _class_Animation_animation_track_insert_key:
|
||||
.. _class_Animation_method_animation_track_insert_key:
|
||||
|
||||
- :ref:`int<class_int>` **animation_track_insert_key** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`String<class_String>` animation **)**
|
||||
|
||||
.. _class_Animation_animation_track_set_key_animation:
|
||||
.. _class_Animation_method_animation_track_set_key_animation:
|
||||
|
||||
- void **animation_track_set_key_animation** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`String<class_String>` animation **)**
|
||||
|
||||
.. _class_Animation_audio_track_get_key_end_offset:
|
||||
.. _class_Animation_method_audio_track_get_key_end_offset:
|
||||
|
||||
- :ref:`float<class_float>` **audio_track_get_key_end_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
.. _class_Animation_audio_track_get_key_start_offset:
|
||||
.. _class_Animation_method_audio_track_get_key_start_offset:
|
||||
|
||||
- :ref:`float<class_float>` **audio_track_get_key_start_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
.. _class_Animation_audio_track_get_key_stream:
|
||||
.. _class_Animation_method_audio_track_get_key_stream:
|
||||
|
||||
- :ref:`Resource<class_Resource>` **audio_track_get_key_stream** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
.. _class_Animation_audio_track_insert_key:
|
||||
.. _class_Animation_method_audio_track_insert_key:
|
||||
|
||||
- :ref:`int<class_int>` **audio_track_insert_key** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`Resource<class_Resource>` stream, :ref:`float<class_float>` start_offset=0, :ref:`float<class_float>` end_offset=0 **)**
|
||||
|
||||
.. _class_Animation_audio_track_set_key_end_offset:
|
||||
.. _class_Animation_method_audio_track_set_key_end_offset:
|
||||
|
||||
- void **audio_track_set_key_end_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)**
|
||||
|
||||
.. _class_Animation_audio_track_set_key_start_offset:
|
||||
.. _class_Animation_method_audio_track_set_key_start_offset:
|
||||
|
||||
- void **audio_track_set_key_start_offset** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` offset **)**
|
||||
|
||||
.. _class_Animation_audio_track_set_key_stream:
|
||||
.. _class_Animation_method_audio_track_set_key_stream:
|
||||
|
||||
- void **audio_track_set_key_stream** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Resource<class_Resource>` stream **)**
|
||||
|
||||
.. _class_Animation_bezier_track_get_key_in_handle:
|
||||
.. _class_Animation_method_bezier_track_get_key_in_handle:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **bezier_track_get_key_in_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
.. _class_Animation_bezier_track_get_key_out_handle:
|
||||
.. _class_Animation_method_bezier_track_get_key_out_handle:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **bezier_track_get_key_out_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
.. _class_Animation_bezier_track_get_key_value:
|
||||
.. _class_Animation_method_bezier_track_get_key_value:
|
||||
|
||||
- :ref:`float<class_float>` **bezier_track_get_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
.. _class_Animation_bezier_track_insert_key:
|
||||
.. _class_Animation_method_bezier_track_insert_key:
|
||||
|
||||
- :ref:`int<class_int>` **bezier_track_insert_key** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time, :ref:`float<class_float>` value, :ref:`Vector2<class_Vector2>` in_handle=Vector2( 0, 0 ), :ref:`Vector2<class_Vector2>` out_handle=Vector2( 0, 0 ) **)**
|
||||
|
||||
.. _class_Animation_bezier_track_interpolate:
|
||||
.. _class_Animation_method_bezier_track_interpolate:
|
||||
|
||||
- :ref:`float<class_float>` **bezier_track_interpolate** **(** :ref:`int<class_int>` track, :ref:`float<class_float>` time **)** const
|
||||
|
||||
.. _class_Animation_bezier_track_set_key_in_handle:
|
||||
.. _class_Animation_method_bezier_track_set_key_in_handle:
|
||||
|
||||
- void **bezier_track_set_key_in_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` in_handle **)**
|
||||
|
||||
.. _class_Animation_bezier_track_set_key_out_handle:
|
||||
.. _class_Animation_method_bezier_track_set_key_out_handle:
|
||||
|
||||
- void **bezier_track_set_key_out_handle** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`Vector2<class_Vector2>` out_handle **)**
|
||||
|
||||
.. _class_Animation_bezier_track_set_key_value:
|
||||
.. _class_Animation_method_bezier_track_set_key_value:
|
||||
|
||||
- void **bezier_track_set_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` value **)**
|
||||
|
||||
.. _class_Animation_clear:
|
||||
.. _class_Animation_method_clear:
|
||||
|
||||
- void **clear** **(** **)**
|
||||
|
||||
Clear the animation (clear all tracks and reset all).
|
||||
|
||||
.. _class_Animation_copy_track:
|
||||
.. _class_Animation_method_copy_track:
|
||||
|
||||
- void **copy_track** **(** :ref:`int<class_int>` track, :ref:`Animation<class_Animation>` to_animation **)**
|
||||
|
||||
Adds a new track that is a copy of the given track from ``to_animation``.
|
||||
|
||||
.. _class_Animation_find_track:
|
||||
.. _class_Animation_method_find_track:
|
||||
|
||||
- :ref:`int<class_int>` **find_track** **(** :ref:`NodePath<class_NodePath>` path **)** const
|
||||
|
||||
Return the index of the specified track. If the track is not found, return -1.
|
||||
|
||||
.. _class_Animation_get_track_count:
|
||||
.. _class_Animation_method_get_track_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_track_count** **(** **)** const
|
||||
|
||||
Return the amount of tracks in the animation.
|
||||
|
||||
.. _class_Animation_method_track_get_key_indices:
|
||||
.. _class_Animation_method_method_track_get_key_indices:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **method_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
|
||||
|
||||
Return all the key indices of a method track, given a position and delta time.
|
||||
|
||||
.. _class_Animation_method_track_get_name:
|
||||
.. _class_Animation_method_method_track_get_name:
|
||||
|
||||
- :ref:`String<class_String>` **method_track_get_name** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Return the method name of a method track.
|
||||
|
||||
.. _class_Animation_method_track_get_params:
|
||||
.. _class_Animation_method_method_track_get_params:
|
||||
|
||||
- :ref:`Array<class_Array>` **method_track_get_params** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Return the arguments values to be called on a method track for a given key in a given track.
|
||||
|
||||
.. _class_Animation_remove_track:
|
||||
.. _class_Animation_method_remove_track:
|
||||
|
||||
- void **remove_track** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Remove a track by specifying the track index.
|
||||
|
||||
.. _class_Animation_track_find_key:
|
||||
.. _class_Animation_method_track_find_key:
|
||||
|
||||
- :ref:`int<class_int>` **track_find_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const
|
||||
|
||||
Find the key index by time in a given track. Optionally, only find it if the exact time is given.
|
||||
|
||||
.. _class_Animation_track_get_interpolation_loop_wrap:
|
||||
.. _class_Animation_method_track_get_interpolation_loop_wrap:
|
||||
|
||||
- :ref:`bool<class_bool>` **track_get_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns ``true`` if the track at ``idx`` wraps the interpolation loop. Default value: ``true``.
|
||||
|
||||
.. _class_Animation_track_get_interpolation_type:
|
||||
.. _class_Animation_method_track_get_interpolation_type:
|
||||
|
||||
- :ref:`InterpolationType<enum_Animation_InterpolationType>` **track_get_interpolation_type** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the interpolation type of a given track, from the INTERPOLATION\_\* enum.
|
||||
|
||||
.. _class_Animation_track_get_key_count:
|
||||
.. _class_Animation_method_track_get_key_count:
|
||||
|
||||
- :ref:`int<class_int>` **track_get_key_count** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the amount of keys in a given track.
|
||||
|
||||
.. _class_Animation_track_get_key_time:
|
||||
.. _class_Animation_method_track_get_key_time:
|
||||
|
||||
- :ref:`float<class_float>` **track_get_key_time** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Return the time at which the key is located.
|
||||
|
||||
.. _class_Animation_track_get_key_transition:
|
||||
.. _class_Animation_method_track_get_key_transition:
|
||||
|
||||
- :ref:`float<class_float>` **track_get_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Return the transition curve (easing) for a specific key (see built-in math function "ease").
|
||||
|
||||
.. _class_Animation_track_get_key_value:
|
||||
.. _class_Animation_method_track_get_key_value:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **track_get_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Return the value of a given key in a given track.
|
||||
|
||||
.. _class_Animation_track_get_path:
|
||||
.. _class_Animation_method_track_get_path:
|
||||
|
||||
- :ref:`NodePath<class_NodePath>` **track_get_path** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Get the path of a track. for more information on the path format, see :ref:`track_set_path<class_Animation_track_set_path>`
|
||||
Get the path of a track. for more information on the path format, see :ref:`track_set_path<class_Animation_method_track_set_path>`
|
||||
|
||||
.. _class_Animation_track_get_type:
|
||||
.. _class_Animation_method_track_get_type:
|
||||
|
||||
- :ref:`TrackType<enum_Animation_TrackType>` **track_get_type** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Get the type of a track.
|
||||
|
||||
.. _class_Animation_track_insert_key:
|
||||
.. _class_Animation_method_track_insert_key:
|
||||
|
||||
- void **track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_Variant>` key, :ref:`float<class_float>` transition=1 **)**
|
||||
|
||||
Insert a generic key in a given track.
|
||||
|
||||
.. _class_Animation_track_is_enabled:
|
||||
.. _class_Animation_method_track_is_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **track_is_enabled** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns ``true`` if the track at index ``idx`` is enabled.
|
||||
|
||||
.. _class_Animation_track_is_imported:
|
||||
.. _class_Animation_method_track_is_imported:
|
||||
|
||||
- :ref:`bool<class_bool>` **track_is_imported** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return true if the given track is imported. Else, return false.
|
||||
|
||||
.. _class_Animation_track_move_down:
|
||||
.. _class_Animation_method_track_move_down:
|
||||
|
||||
- void **track_move_down** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Move a track down.
|
||||
|
||||
.. _class_Animation_track_move_up:
|
||||
.. _class_Animation_method_track_move_up:
|
||||
|
||||
- void **track_move_up** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Move a track up.
|
||||
|
||||
.. _class_Animation_track_remove_key:
|
||||
.. _class_Animation_method_track_remove_key:
|
||||
|
||||
- void **track_remove_key** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)**
|
||||
|
||||
Remove a key by index in a given track.
|
||||
|
||||
.. _class_Animation_track_remove_key_at_position:
|
||||
.. _class_Animation_method_track_remove_key_at_position:
|
||||
|
||||
- void **track_remove_key_at_position** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` position **)**
|
||||
|
||||
Remove a key by position (seconds) in a given track.
|
||||
|
||||
.. _class_Animation_track_set_enabled:
|
||||
.. _class_Animation_method_track_set_enabled:
|
||||
|
||||
- void **track_set_enabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
Enables/disables the given track. Tracks are enabled by default.
|
||||
|
||||
.. _class_Animation_track_set_imported:
|
||||
.. _class_Animation_method_track_set_imported:
|
||||
|
||||
- void **track_set_imported** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)**
|
||||
|
||||
Set the given track as imported or not.
|
||||
|
||||
.. _class_Animation_track_set_interpolation_loop_wrap:
|
||||
.. _class_Animation_method_track_set_interpolation_loop_wrap:
|
||||
|
||||
- void **track_set_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)**
|
||||
|
||||
If ``true``, the track at ``idx`` wraps the interpolation loop.
|
||||
|
||||
.. _class_Animation_track_set_interpolation_type:
|
||||
.. _class_Animation_method_track_set_interpolation_type:
|
||||
|
||||
- void **track_set_interpolation_type** **(** :ref:`int<class_int>` idx, :ref:`InterpolationType<enum_Animation_InterpolationType>` interpolation **)**
|
||||
|
||||
Set the interpolation type of a given track, from the INTERPOLATION\_\* enum.
|
||||
|
||||
.. _class_Animation_track_set_key_transition:
|
||||
.. _class_Animation_method_track_set_key_transition:
|
||||
|
||||
- void **track_set_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)**
|
||||
|
||||
Set the transition curve (easing) for a specific key (see built-in math function "ease").
|
||||
|
||||
.. _class_Animation_track_set_key_value:
|
||||
.. _class_Animation_method_track_set_key_value:
|
||||
|
||||
- void **track_set_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Set the value of an existing key.
|
||||
|
||||
.. _class_Animation_track_set_path:
|
||||
.. _class_Animation_method_track_set_path:
|
||||
|
||||
- void **track_set_path** **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_NodePath>` path **)**
|
||||
|
||||
@@ -515,35 +541,35 @@ Set the path of a track. Paths must be valid scene-tree paths to a node, and mus
|
||||
|
||||
**Example:** "character/skeleton:ankle" or "character/mesh:transform/local".
|
||||
|
||||
.. _class_Animation_track_swap:
|
||||
.. _class_Animation_method_track_swap:
|
||||
|
||||
- void **track_swap** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` with_idx **)**
|
||||
|
||||
.. _class_Animation_transform_track_insert_key:
|
||||
.. _class_Animation_method_transform_track_insert_key:
|
||||
|
||||
- :ref:`int<class_int>` **transform_track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_Vector3>` location, :ref:`Quat<class_Quat>` rotation, :ref:`Vector3<class_Vector3>` scale **)**
|
||||
|
||||
Insert a transform key for a transform track.
|
||||
|
||||
.. _class_Animation_transform_track_interpolate:
|
||||
.. _class_Animation_method_transform_track_interpolate:
|
||||
|
||||
- :ref:`Array<class_Array>` **transform_track_interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const
|
||||
|
||||
Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3<class_Vector3>`), rotation (:ref:`Quat<class_Quat>`) and scale (:ref:`Vector3<class_Vector3>`).
|
||||
|
||||
.. _class_Animation_value_track_get_key_indices:
|
||||
.. _class_Animation_method_value_track_get_key_indices:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **value_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
|
||||
|
||||
Return all the key indices of a value track, given a position and delta time.
|
||||
|
||||
.. _class_Animation_value_track_get_update_mode:
|
||||
.. _class_Animation_method_value_track_get_update_mode:
|
||||
|
||||
- :ref:`UpdateMode<enum_Animation_UpdateMode>` **value_track_get_update_mode** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the update mode of a value track.
|
||||
|
||||
.. _class_Animation_value_track_set_update_mode:
|
||||
.. _class_Animation_method_value_track_set_update_mode:
|
||||
|
||||
- void **value_track_set_update_mode** **(** :ref:`int<class_int>` idx, :ref:`UpdateMode<enum_Animation_UpdateMode>` mode **)**
|
||||
|
||||
|
||||
@@ -21,61 +21,61 @@ Base resource for :ref:`AnimationTree<class_AnimationTree>` nodes.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+-----------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`filter_enabled<class_AnimationNode_filter_enabled>` |
|
||||
+-------------------------+-----------------------------------------------------------+
|
||||
+-------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`filter_enabled<class_AnimationNode_property_filter_enabled>` |
|
||||
+-------------------------+--------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_input<class_AnimationNode_add_input>` **(** :ref:`String<class_String>` name **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend_animation<class_AnimationNode_blend_animation>` **(** :ref:`String<class_String>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend_input<class_AnimationNode_blend_input>` **(** :ref:`int<class_int>` input_index, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend_node<class_AnimationNode_blend_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_caption<class_AnimationNode_get_caption>` **(** **)** virtual |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`get_child_by_name<class_AnimationNode_get_child_by_name>` **(** :ref:`String<class_String>` name **)** virtual |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_child_nodes<class_AnimationNode_get_child_nodes>` **(** **)** virtual |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_input_count<class_AnimationNode_get_input_count>` **(** **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_input_name<class_AnimationNode_get_input_name>` **(** :ref:`int<class_int>` input **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_parameter<class_AnimationNode_get_parameter>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_parameter_default_value<class_AnimationNode_get_parameter_default_value>` **(** :ref:`String<class_String>` name **)** virtual |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_parameter_list<class_AnimationNode_get_parameter_list>` **(** **)** virtual |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`has_filter<class_AnimationNode_has_filter>` **(** **)** virtual |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_path_filtered<class_AnimationNode_is_path_filtered>` **(** :ref:`NodePath<class_NodePath>` path **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`process<class_AnimationNode_process>` **(** :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek **)** virtual |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_input<class_AnimationNode_remove_input>` **(** :ref:`int<class_int>` index **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_filter_path<class_AnimationNode_set_filter_path>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_parameter<class_AnimationNode_set_parameter>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_input<class_AnimationNode_method_add_input>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend_animation<class_AnimationNode_method_blend_animation>` **(** :ref:`String<class_String>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend_input<class_AnimationNode_method_blend_input>` **(** :ref:`int<class_int>` input_index, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend_node<class_AnimationNode_method_blend_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_caption<class_AnimationNode_method_get_caption>` **(** **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`get_child_by_name<class_AnimationNode_method_get_child_by_name>` **(** :ref:`String<class_String>` name **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_child_nodes<class_AnimationNode_method_get_child_nodes>` **(** **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_input_count<class_AnimationNode_method_get_input_count>` **(** **)** const |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_input_name<class_AnimationNode_method_get_input_name>` **(** :ref:`int<class_int>` input **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_parameter<class_AnimationNode_method_get_parameter>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_parameter_default_value<class_AnimationNode_method_get_parameter_default_value>` **(** :ref:`String<class_String>` name **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_parameter_list<class_AnimationNode_method_get_parameter_list>` **(** **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`has_filter<class_AnimationNode_method_has_filter>` **(** **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_path_filtered<class_AnimationNode_method_is_path_filtered>` **(** :ref:`NodePath<class_NodePath>` path **)** const |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`process<class_AnimationNode_method_process>` **(** :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek **)** virtual |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_input<class_AnimationNode_method_remove_input>` **(** :ref:`int<class_int>` index **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_filter_path<class_AnimationNode_method_set_filter_path>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_parameter<class_AnimationNode_method_set_parameter>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AnimationNode_removed_from_graph:
|
||||
.. _class_AnimationNode_signal_removed_from_graph:
|
||||
|
||||
- **removed_from_graph** **(** **)**
|
||||
|
||||
Called when the node was removed from the graph.
|
||||
|
||||
.. _class_AnimationNode_tree_changed:
|
||||
.. _class_AnimationNode_signal_tree_changed:
|
||||
|
||||
- **tree_changed** **(** **)**
|
||||
|
||||
@@ -84,6 +84,14 @@ Enumerations
|
||||
|
||||
.. _enum_AnimationNode_FilterAction:
|
||||
|
||||
.. _class_AnimationNode_constant_FILTER_IGNORE:
|
||||
|
||||
.. _class_AnimationNode_constant_FILTER_PASS:
|
||||
|
||||
.. _class_AnimationNode_constant_FILTER_STOP:
|
||||
|
||||
.. _class_AnimationNode_constant_FILTER_BLEND:
|
||||
|
||||
enum **FilterAction**:
|
||||
|
||||
- **FILTER_IGNORE** = **0** --- Do not use filtering.
|
||||
@@ -104,7 +112,7 @@ Inherit this when creating nodes mainly for use in :ref:`AnimationNodeBlendTree<
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNode_filter_enabled:
|
||||
.. _class_AnimationNode_property_filter_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **filter_enabled**
|
||||
|
||||
@@ -119,115 +127,115 @@ Return whether filtering is enabled.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationNode_add_input:
|
||||
.. _class_AnimationNode_method_add_input:
|
||||
|
||||
- void **add_input** **(** :ref:`String<class_String>` name **)**
|
||||
|
||||
Add an input to the node. This is only useful for nodes created for use in an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`
|
||||
|
||||
.. _class_AnimationNode_blend_animation:
|
||||
.. _class_AnimationNode_method_blend_animation:
|
||||
|
||||
- void **blend_animation** **(** :ref:`String<class_String>` animation, :ref:`float<class_float>` time, :ref:`float<class_float>` delta, :ref:`bool<class_bool>` seeked, :ref:`float<class_float>` blend **)**
|
||||
|
||||
Blend an animation by "blend" amount (name must be valid in the linked :ref:`AnimationPlayer<class_AnimationPlayer>`). A time and delta mas be passed, as well as whether seek happened.
|
||||
|
||||
.. _class_AnimationNode_blend_input:
|
||||
.. _class_AnimationNode_method_blend_input:
|
||||
|
||||
- :ref:`float<class_float>` **blend_input** **(** :ref:`int<class_int>` input_index, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)**
|
||||
|
||||
Blend an input. This is only useful for nodes created for an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Time is a delta, unless "seek" is true, in which case it is absolute. A filter mode may be optionally passed.
|
||||
|
||||
.. _class_AnimationNode_blend_node:
|
||||
.. _class_AnimationNode_method_blend_node:
|
||||
|
||||
- :ref:`float<class_float>` **blend_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek, :ref:`float<class_float>` blend, :ref:`FilterAction<enum_AnimationNode_FilterAction>` filter=0, :ref:`bool<class_bool>` optimize=true **)**
|
||||
|
||||
Blend another animaiton node (in case this node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode<class_AnimationRootNode>` instead, else editors will not display your node for addition.
|
||||
|
||||
.. _class_AnimationNode_get_caption:
|
||||
.. _class_AnimationNode_method_get_caption:
|
||||
|
||||
- :ref:`String<class_String>` **get_caption** **(** **)** virtual
|
||||
|
||||
Get the text caption for this node (used by some editors)
|
||||
|
||||
.. _class_AnimationNode_get_child_by_name:
|
||||
.. _class_AnimationNode_method_get_child_by_name:
|
||||
|
||||
- :ref:`Object<class_Object>` **get_child_by_name** **(** :ref:`String<class_String>` name **)** virtual
|
||||
|
||||
Get the a child node by index (used by editors inheriting from :ref:`AnimationRootNode<class_AnimationRootNode>`).
|
||||
|
||||
.. _class_AnimationNode_get_child_nodes:
|
||||
.. _class_AnimationNode_method_get_child_nodes:
|
||||
|
||||
- :ref:`Dictionary<class_Dictionary>` **get_child_nodes** **(** **)** virtual
|
||||
|
||||
Get all children nodes, in order as a name:node dictionary. Only useful when inheriting :ref:`AnimationRootNode<class_AnimationRootNode>`.
|
||||
|
||||
.. _class_AnimationNode_get_input_count:
|
||||
.. _class_AnimationNode_method_get_input_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_input_count** **(** **)** const
|
||||
|
||||
Amount of inputs in this node, only useful for nodes that go into :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
|
||||
|
||||
.. _class_AnimationNode_get_input_name:
|
||||
.. _class_AnimationNode_method_get_input_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_input_name** **(** :ref:`int<class_int>` input **)**
|
||||
|
||||
Get the name of an input by index.
|
||||
|
||||
.. _class_AnimationNode_get_parameter:
|
||||
.. _class_AnimationNode_method_get_parameter:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **get_parameter** **(** :ref:`String<class_String>` name **)** const
|
||||
|
||||
Get the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
|
||||
|
||||
.. _class_AnimationNode_get_parameter_default_value:
|
||||
.. _class_AnimationNode_method_get_parameter_default_value:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **get_parameter_default_value** **(** :ref:`String<class_String>` name **)** virtual
|
||||
|
||||
Get the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
|
||||
|
||||
.. _class_AnimationNode_get_parameter_list:
|
||||
.. _class_AnimationNode_method_get_parameter_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **get_parameter_list** **(** **)** virtual
|
||||
|
||||
Get the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to :ref:`Object.get_property_list<class_Object_get_property_list>`.
|
||||
Get the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to :ref:`Object.get_property_list<class_Object_method_get_property_list>`.
|
||||
|
||||
.. _class_AnimationNode_has_filter:
|
||||
.. _class_AnimationNode_method_has_filter:
|
||||
|
||||
- :ref:`String<class_String>` **has_filter** **(** **)** virtual
|
||||
|
||||
Return true whether you want the blend tree editor to display filter editing on this node.
|
||||
|
||||
.. _class_AnimationNode_is_path_filtered:
|
||||
.. _class_AnimationNode_method_is_path_filtered:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_path_filtered** **(** :ref:`NodePath<class_NodePath>` path **)** const
|
||||
|
||||
Return true wether a given path is filtered.
|
||||
|
||||
.. _class_AnimationNode_process:
|
||||
.. _class_AnimationNode_method_process:
|
||||
|
||||
- void **process** **(** :ref:`float<class_float>` time, :ref:`bool<class_bool>` seek **)** virtual
|
||||
|
||||
Called when a custom node is processed. The argument "time" is relative, unless "seek" is true (in which case it is absolute).
|
||||
|
||||
Here, call the :ref:`blend_input<class_AnimationNode_blend_input>`, :ref:`blend_node<class_AnimationNode_blend_node>` or :ref:`blend_animation<class_AnimationNode_blend_animation>` functions.
|
||||
Here, call the :ref:`blend_input<class_AnimationNode_method_blend_input>`, :ref:`blend_node<class_AnimationNode_method_blend_node>` or :ref:`blend_animation<class_AnimationNode_method_blend_animation>` functions.
|
||||
|
||||
You can also use :ref:`get_parameter<class_AnimationNode_get_parameter>` and :ref:`set_parameter<class_AnimationNode_set_parameter>` to modify local memory.
|
||||
You can also use :ref:`get_parameter<class_AnimationNode_method_get_parameter>` and :ref:`set_parameter<class_AnimationNode_method_set_parameter>` to modify local memory.
|
||||
|
||||
This function returns the time left for the current animation to finish (if unsure, just pass the value from the main blend being called).
|
||||
|
||||
.. _class_AnimationNode_remove_input:
|
||||
.. _class_AnimationNode_method_remove_input:
|
||||
|
||||
- void **remove_input** **(** :ref:`int<class_int>` index **)**
|
||||
|
||||
Remove an input, call this only when inactive.
|
||||
|
||||
.. _class_AnimationNode_set_filter_path:
|
||||
.. _class_AnimationNode_method_set_filter_path:
|
||||
|
||||
- void **set_filter_path** **(** :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Add/Remove a path for the filter.
|
||||
|
||||
.. _class_AnimationNode_set_parameter:
|
||||
.. _class_AnimationNode_method_set_parameter:
|
||||
|
||||
- void **set_parameter** **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
|
||||
@@ -19,14 +19,14 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+-------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd2_sync>` |
|
||||
+-------------------------+-------------------------------------------+
|
||||
+-------------------------+----------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd2_property_sync>` |
|
||||
+-------------------------+----------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeAdd2_sync:
|
||||
.. _class_AnimationNodeAdd2_property_sync:
|
||||
|
||||
- :ref:`bool<class_bool>` **sync**
|
||||
|
||||
|
||||
@@ -19,14 +19,14 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+-------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd3_sync>` |
|
||||
+-------------------------+-------------------------------------------+
|
||||
+-------------------------+----------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd3_property_sync>` |
|
||||
+-------------------------+----------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeAdd3_sync:
|
||||
.. _class_AnimationNodeAdd3_property_sync:
|
||||
|
||||
- :ref:`bool<class_bool>` **sync**
|
||||
|
||||
|
||||
@@ -19,14 +19,14 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+----------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimationNodeAnimation_animation>` |
|
||||
+-----------------------------+----------------------------------------------------------+
|
||||
+-----------------------------+-------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` |
|
||||
+-----------------------------+-------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeAnimation_animation:
|
||||
.. _class_AnimationNodeAnimation_property_animation:
|
||||
|
||||
- :ref:`String<class_String>` **animation**
|
||||
|
||||
|
||||
@@ -19,14 +19,14 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+---------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend2_sync>` |
|
||||
+-------------------------+---------------------------------------------+
|
||||
+-------------------------+------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend2_property_sync>` |
|
||||
+-------------------------+------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeBlend2_sync:
|
||||
.. _class_AnimationNodeBlend2_property_sync:
|
||||
|
||||
- :ref:`bool<class_bool>` **sync**
|
||||
|
||||
|
||||
@@ -19,14 +19,14 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+---------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend3_sync>` |
|
||||
+-------------------------+---------------------------------------------+
|
||||
+-------------------------+------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend3_property_sync>` |
|
||||
+-------------------------+------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeBlend3_sync:
|
||||
.. _class_AnimationNodeBlend3_property_sync:
|
||||
|
||||
- :ref:`bool<class_bool>` **sync**
|
||||
|
||||
|
||||
@@ -19,39 +19,39 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_space<class_AnimationNodeBlendSpace1D_max_space>` |
|
||||
+-----------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`min_space<class_AnimationNodeBlendSpace1D_min_space>` |
|
||||
+-----------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`snap<class_AnimationNodeBlendSpace1D_snap>` |
|
||||
+-----------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`value_label<class_AnimationNodeBlendSpace1D_value_label>` |
|
||||
+-----------------------------+-----------------------------------------------------------------+
|
||||
+-----------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_space<class_AnimationNodeBlendSpace1D_property_max_space>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`min_space<class_AnimationNodeBlendSpace1D_property_min_space>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`snap<class_AnimationNodeBlendSpace1D_property_snap>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`value_label<class_AnimationNodeBlendSpace1D_property_value_label>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_add_blend_point>` **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`float<class_float>` pos, :ref:`int<class_int>` at_index=-1 **)** |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_point_count<class_AnimationNodeBlendSpace1D_get_blend_point_count>` **(** **)** const |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationRootNode<class_AnimationRootNode>` | :ref:`get_blend_point_node<class_AnimationNodeBlendSpace1D_get_blend_point_node>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_blend_point_position<class_AnimationNodeBlendSpace1D_get_blend_point_position>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_blend_point<class_AnimationNodeBlendSpace1D_remove_blend_point>` **(** :ref:`int<class_int>` point **)** |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_point_node<class_AnimationNodeBlendSpace1D_set_blend_point_node>` **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)** |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_point_position<class_AnimationNodeBlendSpace1D_set_blend_point_position>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)** |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>` **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`float<class_float>` pos, :ref:`int<class_int>` at_index=-1 **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_point_count<class_AnimationNodeBlendSpace1D_method_get_blend_point_count>` **(** **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationRootNode<class_AnimationRootNode>` | :ref:`get_blend_point_node<class_AnimationNodeBlendSpace1D_method_get_blend_point_node>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_blend_point_position<class_AnimationNodeBlendSpace1D_method_get_blend_point_position>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_blend_point<class_AnimationNodeBlendSpace1D_method_remove_blend_point>` **(** :ref:`int<class_int>` point **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_point_node<class_AnimationNodeBlendSpace1D_method_set_blend_point_node>` **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_point_position<class_AnimationNodeBlendSpace1D_method_set_blend_point_position>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeBlendSpace1D_max_space:
|
||||
.. _class_AnimationNodeBlendSpace1D_property_max_space:
|
||||
|
||||
- :ref:`float<class_float>` **max_space**
|
||||
|
||||
@@ -61,7 +61,7 @@ Property Descriptions
|
||||
| *Getter* | get_max_space() |
|
||||
+----------+----------------------+
|
||||
|
||||
.. _class_AnimationNodeBlendSpace1D_min_space:
|
||||
.. _class_AnimationNodeBlendSpace1D_property_min_space:
|
||||
|
||||
- :ref:`float<class_float>` **min_space**
|
||||
|
||||
@@ -71,7 +71,7 @@ Property Descriptions
|
||||
| *Getter* | get_min_space() |
|
||||
+----------+----------------------+
|
||||
|
||||
.. _class_AnimationNodeBlendSpace1D_snap:
|
||||
.. _class_AnimationNodeBlendSpace1D_property_snap:
|
||||
|
||||
- :ref:`float<class_float>` **snap**
|
||||
|
||||
@@ -81,7 +81,7 @@ Property Descriptions
|
||||
| *Getter* | get_snap() |
|
||||
+----------+-----------------+
|
||||
|
||||
.. _class_AnimationNodeBlendSpace1D_value_label:
|
||||
.. _class_AnimationNodeBlendSpace1D_property_value_label:
|
||||
|
||||
- :ref:`String<class_String>` **value_label**
|
||||
|
||||
@@ -94,31 +94,31 @@ Property Descriptions
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationNodeBlendSpace1D_add_blend_point:
|
||||
.. _class_AnimationNodeBlendSpace1D_method_add_blend_point:
|
||||
|
||||
- void **add_blend_point** **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`float<class_float>` pos, :ref:`int<class_int>` at_index=-1 **)**
|
||||
|
||||
.. _class_AnimationNodeBlendSpace1D_get_blend_point_count:
|
||||
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_blend_point_count** **(** **)** const
|
||||
|
||||
.. _class_AnimationNodeBlendSpace1D_get_blend_point_node:
|
||||
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_node:
|
||||
|
||||
- :ref:`AnimationRootNode<class_AnimationRootNode>` **get_blend_point_node** **(** :ref:`int<class_int>` point **)** const
|
||||
|
||||
.. _class_AnimationNodeBlendSpace1D_get_blend_point_position:
|
||||
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_position:
|
||||
|
||||
- :ref:`float<class_float>` **get_blend_point_position** **(** :ref:`int<class_int>` point **)** const
|
||||
|
||||
.. _class_AnimationNodeBlendSpace1D_remove_blend_point:
|
||||
.. _class_AnimationNodeBlendSpace1D_method_remove_blend_point:
|
||||
|
||||
- void **remove_blend_point** **(** :ref:`int<class_int>` point **)**
|
||||
|
||||
.. _class_AnimationNodeBlendSpace1D_set_blend_point_node:
|
||||
.. _class_AnimationNodeBlendSpace1D_method_set_blend_point_node:
|
||||
|
||||
- void **set_blend_point_node** **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)**
|
||||
|
||||
.. _class_AnimationNodeBlendSpace1D_set_blend_point_position:
|
||||
.. _class_AnimationNodeBlendSpace1D_method_set_blend_point_position:
|
||||
|
||||
- void **set_blend_point_position** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)**
|
||||
|
||||
|
||||
@@ -19,54 +19,60 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`auto_triangles<class_AnimationNodeBlendSpace2D_auto_triangles>` |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` | :ref:`blend_mode<class_AnimationNodeBlendSpace2D_blend_mode>` |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`max_space<class_AnimationNodeBlendSpace2D_max_space>` |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`min_space<class_AnimationNodeBlendSpace2D_min_space>` |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`snap<class_AnimationNodeBlendSpace2D_snap>` |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`x_label<class_AnimationNodeBlendSpace2D_x_label>` |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`y_label<class_AnimationNodeBlendSpace2D_y_label>` |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`auto_triangles<class_AnimationNodeBlendSpace2D_property_auto_triangles>` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+
|
||||
| :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` | :ref:`blend_mode<class_AnimationNodeBlendSpace2D_property_blend_mode>` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`max_space<class_AnimationNodeBlendSpace2D_property_max_space>` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`min_space<class_AnimationNodeBlendSpace2D_property_min_space>` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`snap<class_AnimationNodeBlendSpace2D_property_snap>` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`x_label<class_AnimationNodeBlendSpace2D_property_x_label>` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`y_label<class_AnimationNodeBlendSpace2D_property_y_label>` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_add_blend_point>` **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` at_index=-1 **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_triangle<class_AnimationNodeBlendSpace2D_add_triangle>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` at_index=-1 **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_point_count<class_AnimationNodeBlendSpace2D_get_blend_point_count>` **(** **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationRootNode<class_AnimationRootNode>` | :ref:`get_blend_point_node<class_AnimationNodeBlendSpace2D_get_blend_point_node>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_blend_point_position<class_AnimationNodeBlendSpace2D_get_blend_point_position>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_triangle_count<class_AnimationNodeBlendSpace2D_get_triangle_count>` **(** **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_triangle_point<class_AnimationNodeBlendSpace2D_get_triangle_point>` **(** :ref:`int<class_int>` triangle, :ref:`int<class_int>` point **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_blend_point<class_AnimationNodeBlendSpace2D_remove_blend_point>` **(** :ref:`int<class_int>` point **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_triangle<class_AnimationNodeBlendSpace2D_remove_triangle>` **(** :ref:`int<class_int>` triangle **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_point_node<class_AnimationNodeBlendSpace2D_set_blend_point_node>` **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_point_position<class_AnimationNodeBlendSpace2D_set_blend_point_position>` **(** :ref:`int<class_int>` point, :ref:`Vector2<class_Vector2>` pos **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>` **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` at_index=-1 **)** |
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_triangle<class_AnimationNodeBlendSpace2D_method_add_triangle>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` at_index=-1 **)** |
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_point_count<class_AnimationNodeBlendSpace2D_method_get_blend_point_count>` **(** **)** const |
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationRootNode<class_AnimationRootNode>` | :ref:`get_blend_point_node<class_AnimationNodeBlendSpace2D_method_get_blend_point_node>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_blend_point_position<class_AnimationNodeBlendSpace2D_method_get_blend_point_position>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_triangle_count<class_AnimationNodeBlendSpace2D_method_get_triangle_count>` **(** **)** const |
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_triangle_point<class_AnimationNodeBlendSpace2D_method_get_triangle_point>` **(** :ref:`int<class_int>` triangle, :ref:`int<class_int>` point **)** |
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_blend_point<class_AnimationNodeBlendSpace2D_method_remove_blend_point>` **(** :ref:`int<class_int>` point **)** |
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_triangle<class_AnimationNodeBlendSpace2D_method_remove_triangle>` **(** :ref:`int<class_int>` triangle **)** |
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_point_node<class_AnimationNodeBlendSpace2D_method_set_blend_point_node>` **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)** |
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_point_position<class_AnimationNodeBlendSpace2D_method_set_blend_point_position>` **(** :ref:`int<class_int>` point, :ref:`Vector2<class_Vector2>` pos **)** |
|
||||
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_AnimationNodeBlendSpace2D_BlendMode:
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_constant_BLEND_MODE_INTERPOLATED:
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_constant_BLEND_MODE_DISCRETE:
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_constant_BLEND_MODE_DISCRETE_CARRY:
|
||||
|
||||
enum **BlendMode**:
|
||||
|
||||
- **BLEND_MODE_INTERPOLATED** = **0**
|
||||
@@ -78,7 +84,7 @@ enum **BlendMode**:
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_auto_triangles:
|
||||
.. _class_AnimationNodeBlendSpace2D_property_auto_triangles:
|
||||
|
||||
- :ref:`bool<class_bool>` **auto_triangles**
|
||||
|
||||
@@ -88,7 +94,7 @@ Property Descriptions
|
||||
| *Getter* | get_auto_triangles() |
|
||||
+----------+---------------------------+
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_blend_mode:
|
||||
.. _class_AnimationNodeBlendSpace2D_property_blend_mode:
|
||||
|
||||
- :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` **blend_mode**
|
||||
|
||||
@@ -98,7 +104,7 @@ Property Descriptions
|
||||
| *Getter* | get_blend_mode() |
|
||||
+----------+-----------------------+
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_max_space:
|
||||
.. _class_AnimationNodeBlendSpace2D_property_max_space:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **max_space**
|
||||
|
||||
@@ -108,7 +114,7 @@ Property Descriptions
|
||||
| *Getter* | get_max_space() |
|
||||
+----------+----------------------+
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_min_space:
|
||||
.. _class_AnimationNodeBlendSpace2D_property_min_space:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **min_space**
|
||||
|
||||
@@ -118,7 +124,7 @@ Property Descriptions
|
||||
| *Getter* | get_min_space() |
|
||||
+----------+----------------------+
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_snap:
|
||||
.. _class_AnimationNodeBlendSpace2D_property_snap:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **snap**
|
||||
|
||||
@@ -128,7 +134,7 @@ Property Descriptions
|
||||
| *Getter* | get_snap() |
|
||||
+----------+-----------------+
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_x_label:
|
||||
.. _class_AnimationNodeBlendSpace2D_property_x_label:
|
||||
|
||||
- :ref:`String<class_String>` **x_label**
|
||||
|
||||
@@ -138,7 +144,7 @@ Property Descriptions
|
||||
| *Getter* | get_x_label() |
|
||||
+----------+--------------------+
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_y_label:
|
||||
.. _class_AnimationNodeBlendSpace2D_property_y_label:
|
||||
|
||||
- :ref:`String<class_String>` **y_label**
|
||||
|
||||
@@ -151,47 +157,47 @@ Property Descriptions
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_add_blend_point:
|
||||
.. _class_AnimationNodeBlendSpace2D_method_add_blend_point:
|
||||
|
||||
- void **add_blend_point** **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` at_index=-1 **)**
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_add_triangle:
|
||||
.. _class_AnimationNodeBlendSpace2D_method_add_triangle:
|
||||
|
||||
- void **add_triangle** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` at_index=-1 **)**
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_get_blend_point_count:
|
||||
.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_blend_point_count** **(** **)** const
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_get_blend_point_node:
|
||||
.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_node:
|
||||
|
||||
- :ref:`AnimationRootNode<class_AnimationRootNode>` **get_blend_point_node** **(** :ref:`int<class_int>` point **)** const
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_get_blend_point_position:
|
||||
.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_blend_point_position** **(** :ref:`int<class_int>` point **)** const
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_get_triangle_count:
|
||||
.. _class_AnimationNodeBlendSpace2D_method_get_triangle_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_triangle_count** **(** **)** const
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_get_triangle_point:
|
||||
.. _class_AnimationNodeBlendSpace2D_method_get_triangle_point:
|
||||
|
||||
- :ref:`int<class_int>` **get_triangle_point** **(** :ref:`int<class_int>` triangle, :ref:`int<class_int>` point **)**
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_remove_blend_point:
|
||||
.. _class_AnimationNodeBlendSpace2D_method_remove_blend_point:
|
||||
|
||||
- void **remove_blend_point** **(** :ref:`int<class_int>` point **)**
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_remove_triangle:
|
||||
.. _class_AnimationNodeBlendSpace2D_method_remove_triangle:
|
||||
|
||||
- void **remove_triangle** **(** :ref:`int<class_int>` triangle **)**
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_set_blend_point_node:
|
||||
.. _class_AnimationNodeBlendSpace2D_method_set_blend_point_node:
|
||||
|
||||
- void **set_blend_point_node** **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)**
|
||||
|
||||
.. _class_AnimationNodeBlendSpace2D_set_blend_point_position:
|
||||
.. _class_AnimationNodeBlendSpace2D_method_set_blend_point_position:
|
||||
|
||||
- void **set_blend_point_position** **(** :ref:`int<class_int>` point, :ref:`Vector2<class_Vector2>` pos **)**
|
||||
|
||||
|
||||
@@ -19,36 +19,48 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+----------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`graph_offset<class_AnimationNodeBlendTree_graph_offset>` |
|
||||
+-------------------------------+----------------------------------------------------------------+
|
||||
+-------------------------------+-------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`graph_offset<class_AnimationNodeBlendTree_property_graph_offset>` |
|
||||
+-------------------------------+-------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationNodeBlendTree_add_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_node<class_AnimationNodeBlendTree_connect_node>` **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index, :ref:`String<class_String>` output_node **)** |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_node<class_AnimationNodeBlendTree_disconnect_node>` **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index **)** |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`get_node<class_AnimationNodeBlendTree_get_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_node_position<class_AnimationNodeBlendTree_get_node_position>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_node<class_AnimationNodeBlendTree_has_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationNodeBlendTree_remove_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_node<class_AnimationNodeBlendTree_rename_node>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_node_position<class_AnimationNodeBlendTree_set_node_position>` **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationNodeBlendTree_method_add_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_node<class_AnimationNodeBlendTree_method_connect_node>` **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index, :ref:`String<class_String>` output_node **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_node<class_AnimationNodeBlendTree_method_disconnect_node>` **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`get_node<class_AnimationNodeBlendTree_method_get_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_node_position<class_AnimationNodeBlendTree_method_get_node_position>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_node<class_AnimationNodeBlendTree_method_has_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationNodeBlendTree_method_remove_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_node<class_AnimationNodeBlendTree_method_rename_node>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_node_position<class_AnimationNodeBlendTree_method_set_node_position>` **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Constants
|
||||
---------
|
||||
|
||||
.. _class_AnimationNodeBlendTree_constant_CONNECTION_OK:
|
||||
|
||||
.. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_NO_INPUT:
|
||||
|
||||
.. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_NO_INPUT_INDEX:
|
||||
|
||||
.. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_NO_OUTPUT:
|
||||
|
||||
.. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_SAME_NODE:
|
||||
|
||||
.. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_CONNECTION_EXISTS:
|
||||
|
||||
- **CONNECTION_OK** = **0**
|
||||
|
||||
- **CONNECTION_ERROR_NO_INPUT** = **1**
|
||||
@@ -64,7 +76,7 @@ Constants
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeBlendTree_graph_offset:
|
||||
.. _class_AnimationNodeBlendTree_property_graph_offset:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **graph_offset**
|
||||
|
||||
@@ -77,39 +89,39 @@ Property Descriptions
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationNodeBlendTree_add_node:
|
||||
.. _class_AnimationNodeBlendTree_method_add_node:
|
||||
|
||||
- void **add_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)**
|
||||
|
||||
.. _class_AnimationNodeBlendTree_connect_node:
|
||||
.. _class_AnimationNodeBlendTree_method_connect_node:
|
||||
|
||||
- void **connect_node** **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index, :ref:`String<class_String>` output_node **)**
|
||||
|
||||
.. _class_AnimationNodeBlendTree_disconnect_node:
|
||||
.. _class_AnimationNodeBlendTree_method_disconnect_node:
|
||||
|
||||
- void **disconnect_node** **(** :ref:`String<class_String>` input_node, :ref:`int<class_int>` input_index **)**
|
||||
|
||||
.. _class_AnimationNodeBlendTree_get_node:
|
||||
.. _class_AnimationNodeBlendTree_method_get_node:
|
||||
|
||||
- :ref:`AnimationNode<class_AnimationNode>` **get_node** **(** :ref:`String<class_String>` name **)** const
|
||||
|
||||
.. _class_AnimationNodeBlendTree_get_node_position:
|
||||
.. _class_AnimationNodeBlendTree_method_get_node_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`String<class_String>` name **)** const
|
||||
|
||||
.. _class_AnimationNodeBlendTree_has_node:
|
||||
.. _class_AnimationNodeBlendTree_method_has_node:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_String>` name **)** const
|
||||
|
||||
.. _class_AnimationNodeBlendTree_remove_node:
|
||||
.. _class_AnimationNodeBlendTree_method_remove_node:
|
||||
|
||||
- void **remove_node** **(** :ref:`String<class_String>` name **)**
|
||||
|
||||
.. _class_AnimationNodeBlendTree_rename_node:
|
||||
.. _class_AnimationNodeBlendTree_method_rename_node:
|
||||
|
||||
- void **rename_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)**
|
||||
|
||||
.. _class_AnimationNodeBlendTree_set_node_position:
|
||||
.. _class_AnimationNodeBlendTree_method_set_node_position:
|
||||
|
||||
- void **set_node_position** **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)**
|
||||
|
||||
|
||||
@@ -19,34 +19,38 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+--------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autorestart<class_AnimationNodeOneShot_autorestart>` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`autorestart_delay<class_AnimationNodeOneShot_autorestart_delay>` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`autorestart_random_delay<class_AnimationNodeOneShot_autorestart_random_delay>` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fadein_time<class_AnimationNodeOneShot_fadein_time>` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fadeout_time<class_AnimationNodeOneShot_fadeout_time>` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeOneShot_sync>` |
|
||||
+---------------------------+--------------------------------------------------------------------------------------+
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autorestart<class_AnimationNodeOneShot_property_autorestart>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`autorestart_delay<class_AnimationNodeOneShot_property_autorestart_delay>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`autorestart_random_delay<class_AnimationNodeOneShot_property_autorestart_random_delay>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fadein_time<class_AnimationNodeOneShot_property_fadein_time>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fadeout_time<class_AnimationNodeOneShot_property_fadeout_time>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeOneShot_property_sync>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` | :ref:`get_mix_mode<class_AnimationNodeOneShot_get_mix_mode>` **(** **)** const |
|
||||
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mix_mode<class_AnimationNodeOneShot_set_mix_mode>` **(** :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` mode **)** |
|
||||
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` | :ref:`get_mix_mode<class_AnimationNodeOneShot_method_get_mix_mode>` **(** **)** const |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mix_mode<class_AnimationNodeOneShot_method_set_mix_mode>` **(** :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` mode **)** |
|
||||
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_AnimationNodeOneShot_MixMode:
|
||||
|
||||
.. _class_AnimationNodeOneShot_constant_MIX_MODE_BLEND:
|
||||
|
||||
.. _class_AnimationNodeOneShot_constant_MIX_MODE_ADD:
|
||||
|
||||
enum **MixMode**:
|
||||
|
||||
- **MIX_MODE_BLEND** = **0**
|
||||
@@ -56,7 +60,7 @@ enum **MixMode**:
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeOneShot_autorestart:
|
||||
.. _class_AnimationNodeOneShot_property_autorestart:
|
||||
|
||||
- :ref:`bool<class_bool>` **autorestart**
|
||||
|
||||
@@ -66,7 +70,7 @@ Property Descriptions
|
||||
| *Getter* | has_autorestart() |
|
||||
+----------+------------------------+
|
||||
|
||||
.. _class_AnimationNodeOneShot_autorestart_delay:
|
||||
.. _class_AnimationNodeOneShot_property_autorestart_delay:
|
||||
|
||||
- :ref:`float<class_float>` **autorestart_delay**
|
||||
|
||||
@@ -76,7 +80,7 @@ Property Descriptions
|
||||
| *Getter* | get_autorestart_delay() |
|
||||
+----------+------------------------------+
|
||||
|
||||
.. _class_AnimationNodeOneShot_autorestart_random_delay:
|
||||
.. _class_AnimationNodeOneShot_property_autorestart_random_delay:
|
||||
|
||||
- :ref:`float<class_float>` **autorestart_random_delay**
|
||||
|
||||
@@ -86,7 +90,7 @@ Property Descriptions
|
||||
| *Getter* | get_autorestart_random_delay() |
|
||||
+----------+-------------------------------------+
|
||||
|
||||
.. _class_AnimationNodeOneShot_fadein_time:
|
||||
.. _class_AnimationNodeOneShot_property_fadein_time:
|
||||
|
||||
- :ref:`float<class_float>` **fadein_time**
|
||||
|
||||
@@ -96,7 +100,7 @@ Property Descriptions
|
||||
| *Getter* | get_fadein_time() |
|
||||
+----------+------------------------+
|
||||
|
||||
.. _class_AnimationNodeOneShot_fadeout_time:
|
||||
.. _class_AnimationNodeOneShot_property_fadeout_time:
|
||||
|
||||
- :ref:`float<class_float>` **fadeout_time**
|
||||
|
||||
@@ -106,7 +110,7 @@ Property Descriptions
|
||||
| *Getter* | get_fadeout_time() |
|
||||
+----------+-------------------------+
|
||||
|
||||
.. _class_AnimationNodeOneShot_sync:
|
||||
.. _class_AnimationNodeOneShot_property_sync:
|
||||
|
||||
- :ref:`bool<class_bool>` **sync**
|
||||
|
||||
@@ -119,11 +123,11 @@ Property Descriptions
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationNodeOneShot_get_mix_mode:
|
||||
.. _class_AnimationNodeOneShot_method_get_mix_mode:
|
||||
|
||||
- :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` **get_mix_mode** **(** **)** const
|
||||
|
||||
.. _class_AnimationNodeOneShot_set_mix_mode:
|
||||
.. _class_AnimationNodeOneShot_method_set_mix_mode:
|
||||
|
||||
- void **set_mix_mode** **(** :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` mode **)**
|
||||
|
||||
|
||||
@@ -19,140 +19,140 @@ Brief Description
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationNodeStateMachine_add_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_transition<class_AnimationNodeStateMachine_add_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to, :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` transition **)** |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_end_node<class_AnimationNodeStateMachine_get_end_node>` **(** **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_graph_offset<class_AnimationNodeStateMachine_get_graph_offset>` **(** **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`get_node<class_AnimationNodeStateMachine_get_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_node_name<class_AnimationNodeStateMachine_get_node_name>` **(** :ref:`AnimationNode<class_AnimationNode>` node **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_node_position<class_AnimationNodeStateMachine_get_node_position>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_start_node<class_AnimationNodeStateMachine_get_start_node>` **(** **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` | :ref:`get_transition<class_AnimationNodeStateMachine_get_transition>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_transition_count<class_AnimationNodeStateMachine_get_transition_count>` **(** **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_transition_from<class_AnimationNodeStateMachine_get_transition_from>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_transition_to<class_AnimationNodeStateMachine_get_transition_to>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_node<class_AnimationNodeStateMachine_has_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_transition<class_AnimationNodeStateMachine_has_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** const |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationNodeStateMachine_remove_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_transition<class_AnimationNodeStateMachine_remove_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_transition_by_index<class_AnimationNodeStateMachine_remove_transition_by_index>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_node<class_AnimationNodeStateMachine_rename_node>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_end_node<class_AnimationNodeStateMachine_set_end_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_graph_offset<class_AnimationNodeStateMachine_set_graph_offset>` **(** :ref:`Vector2<class_Vector2>` name **)** |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_node_position<class_AnimationNodeStateMachine_set_node_position>` **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_start_node<class_AnimationNodeStateMachine_set_start_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationNodeStateMachine_method_add_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_transition<class_AnimationNodeStateMachine_method_add_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to, :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` transition **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_end_node<class_AnimationNodeStateMachine_method_get_end_node>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_graph_offset<class_AnimationNodeStateMachine_method_get_graph_offset>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`get_node<class_AnimationNodeStateMachine_method_get_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_node_name<class_AnimationNodeStateMachine_method_get_node_name>` **(** :ref:`AnimationNode<class_AnimationNode>` node **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_node_position<class_AnimationNodeStateMachine_method_get_node_position>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_start_node<class_AnimationNodeStateMachine_method_get_start_node>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` | :ref:`get_transition<class_AnimationNodeStateMachine_method_get_transition>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_transition_count<class_AnimationNodeStateMachine_method_get_transition_count>` **(** **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_transition_from<class_AnimationNodeStateMachine_method_get_transition_from>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_transition_to<class_AnimationNodeStateMachine_method_get_transition_to>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_node<class_AnimationNodeStateMachine_method_has_node>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_transition<class_AnimationNodeStateMachine_method_has_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** const |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationNodeStateMachine_method_remove_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_transition<class_AnimationNodeStateMachine_method_remove_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_transition_by_index<class_AnimationNodeStateMachine_method_remove_transition_by_index>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_node<class_AnimationNodeStateMachine_method_rename_node>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_end_node<class_AnimationNodeStateMachine_method_set_end_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_graph_offset<class_AnimationNodeStateMachine_method_set_graph_offset>` **(** :ref:`Vector2<class_Vector2>` name **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_node_position<class_AnimationNodeStateMachine_method_set_node_position>` **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_start_node<class_AnimationNodeStateMachine_method_set_start_node>` **(** :ref:`String<class_String>` name **)** |
|
||||
+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationNodeStateMachine_add_node:
|
||||
.. _class_AnimationNodeStateMachine_method_add_node:
|
||||
|
||||
- void **add_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)**
|
||||
|
||||
.. _class_AnimationNodeStateMachine_add_transition:
|
||||
.. _class_AnimationNodeStateMachine_method_add_transition:
|
||||
|
||||
- void **add_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to, :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` transition **)**
|
||||
|
||||
.. _class_AnimationNodeStateMachine_get_end_node:
|
||||
.. _class_AnimationNodeStateMachine_method_get_end_node:
|
||||
|
||||
- :ref:`String<class_String>` **get_end_node** **(** **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_get_graph_offset:
|
||||
.. _class_AnimationNodeStateMachine_method_get_graph_offset:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_graph_offset** **(** **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_get_node:
|
||||
.. _class_AnimationNodeStateMachine_method_get_node:
|
||||
|
||||
- :ref:`AnimationNode<class_AnimationNode>` **get_node** **(** :ref:`String<class_String>` name **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_get_node_name:
|
||||
.. _class_AnimationNodeStateMachine_method_get_node_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_node_name** **(** :ref:`AnimationNode<class_AnimationNode>` node **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_get_node_position:
|
||||
.. _class_AnimationNodeStateMachine_method_get_node_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`String<class_String>` name **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_get_start_node:
|
||||
.. _class_AnimationNodeStateMachine_method_get_start_node:
|
||||
|
||||
- :ref:`String<class_String>` **get_start_node** **(** **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_get_transition:
|
||||
.. _class_AnimationNodeStateMachine_method_get_transition:
|
||||
|
||||
- :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` **get_transition** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_get_transition_count:
|
||||
.. _class_AnimationNodeStateMachine_method_get_transition_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_transition_count** **(** **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_get_transition_from:
|
||||
.. _class_AnimationNodeStateMachine_method_get_transition_from:
|
||||
|
||||
- :ref:`String<class_String>` **get_transition_from** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_get_transition_to:
|
||||
.. _class_AnimationNodeStateMachine_method_get_transition_to:
|
||||
|
||||
- :ref:`String<class_String>` **get_transition_to** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_has_node:
|
||||
.. _class_AnimationNodeStateMachine_method_has_node:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_String>` name **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_has_transition:
|
||||
.. _class_AnimationNodeStateMachine_method_has_transition:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachine_remove_node:
|
||||
.. _class_AnimationNodeStateMachine_method_remove_node:
|
||||
|
||||
- void **remove_node** **(** :ref:`String<class_String>` name **)**
|
||||
|
||||
.. _class_AnimationNodeStateMachine_remove_transition:
|
||||
.. _class_AnimationNodeStateMachine_method_remove_transition:
|
||||
|
||||
- void **remove_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)**
|
||||
|
||||
.. _class_AnimationNodeStateMachine_remove_transition_by_index:
|
||||
.. _class_AnimationNodeStateMachine_method_remove_transition_by_index:
|
||||
|
||||
- void **remove_transition_by_index** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
.. _class_AnimationNodeStateMachine_rename_node:
|
||||
.. _class_AnimationNodeStateMachine_method_rename_node:
|
||||
|
||||
- void **rename_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)**
|
||||
|
||||
.. _class_AnimationNodeStateMachine_set_end_node:
|
||||
.. _class_AnimationNodeStateMachine_method_set_end_node:
|
||||
|
||||
- void **set_end_node** **(** :ref:`String<class_String>` name **)**
|
||||
|
||||
.. _class_AnimationNodeStateMachine_set_graph_offset:
|
||||
.. _class_AnimationNodeStateMachine_method_set_graph_offset:
|
||||
|
||||
- void **set_graph_offset** **(** :ref:`Vector2<class_Vector2>` name **)**
|
||||
|
||||
.. _class_AnimationNodeStateMachine_set_node_position:
|
||||
.. _class_AnimationNodeStateMachine_method_set_node_position:
|
||||
|
||||
- void **set_node_position** **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)**
|
||||
|
||||
.. _class_AnimationNodeStateMachine_set_start_node:
|
||||
.. _class_AnimationNodeStateMachine_method_set_start_node:
|
||||
|
||||
- void **set_start_node** **(** :ref:`String<class_String>` name **)**
|
||||
|
||||
|
||||
@@ -19,44 +19,44 @@ Brief Description
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_current_node<class_AnimationNodeStateMachinePlayback_get_current_node>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_travel_path<class_AnimationNodeStateMachinePlayback_get_travel_path>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationNodeStateMachinePlayback_is_playing>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`start<class_AnimationNodeStateMachinePlayback_start>` **(** :ref:`String<class_String>` node **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimationNodeStateMachinePlayback_stop>` **(** **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`travel<class_AnimationNodeStateMachinePlayback_travel>` **(** :ref:`String<class_String>` to_node **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_current_node<class_AnimationNodeStateMachinePlayback_method_get_current_node>` **(** **)** const |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_travel_path<class_AnimationNodeStateMachinePlayback_method_get_travel_path>` **(** **)** const |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationNodeStateMachinePlayback_method_is_playing>` **(** **)** const |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`start<class_AnimationNodeStateMachinePlayback_method_start>` **(** :ref:`String<class_String>` node **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimationNodeStateMachinePlayback_method_stop>` **(** **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`travel<class_AnimationNodeStateMachinePlayback_method_travel>` **(** :ref:`String<class_String>` to_node **)** |
|
||||
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationNodeStateMachinePlayback_get_current_node:
|
||||
.. _class_AnimationNodeStateMachinePlayback_method_get_current_node:
|
||||
|
||||
- :ref:`String<class_String>` **get_current_node** **(** **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachinePlayback_get_travel_path:
|
||||
.. _class_AnimationNodeStateMachinePlayback_method_get_travel_path:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_travel_path** **(** **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachinePlayback_is_playing:
|
||||
.. _class_AnimationNodeStateMachinePlayback_method_is_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
|
||||
.. _class_AnimationNodeStateMachinePlayback_start:
|
||||
.. _class_AnimationNodeStateMachinePlayback_method_start:
|
||||
|
||||
- void **start** **(** :ref:`String<class_String>` node **)**
|
||||
|
||||
.. _class_AnimationNodeStateMachinePlayback_stop:
|
||||
.. _class_AnimationNodeStateMachinePlayback_method_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
|
||||
.. _class_AnimationNodeStateMachinePlayback_travel:
|
||||
.. _class_AnimationNodeStateMachinePlayback_method_travel:
|
||||
|
||||
- void **travel** **(** :ref:`String<class_String>` to_node **)**
|
||||
|
||||
|
||||
@@ -19,24 +19,24 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`advance_condition<class_AnimationNodeStateMachineTransition_advance_condition>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`auto_advance<class_AnimationNodeStateMachineTransition_auto_advance>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_AnimationNodeStateMachineTransition_disabled>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`priority<class_AnimationNodeStateMachineTransition_priority>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`SwitchMode<enum_AnimationNodeStateMachineTransition_SwitchMode>` | :ref:`switch_mode<class_AnimationNodeStateMachineTransition_switch_mode>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeStateMachineTransition_xfade_time>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`advance_condition<class_AnimationNodeStateMachineTransition_property_advance_condition>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`auto_advance<class_AnimationNodeStateMachineTransition_property_auto_advance>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_AnimationNodeStateMachineTransition_property_disabled>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`priority<class_AnimationNodeStateMachineTransition_property_priority>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SwitchMode<enum_AnimationNodeStateMachineTransition_SwitchMode>` | :ref:`switch_mode<class_AnimationNodeStateMachineTransition_property_switch_mode>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeStateMachineTransition_property_xfade_time>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AnimationNodeStateMachineTransition_advance_condition_changed:
|
||||
.. _class_AnimationNodeStateMachineTransition_signal_advance_condition_changed:
|
||||
|
||||
- **advance_condition_changed** **(** **)**
|
||||
|
||||
@@ -45,6 +45,12 @@ Enumerations
|
||||
|
||||
.. _enum_AnimationNodeStateMachineTransition_SwitchMode:
|
||||
|
||||
.. _class_AnimationNodeStateMachineTransition_constant_SWITCH_MODE_IMMEDIATE:
|
||||
|
||||
.. _class_AnimationNodeStateMachineTransition_constant_SWITCH_MODE_SYNC:
|
||||
|
||||
.. _class_AnimationNodeStateMachineTransition_constant_SWITCH_MODE_AT_END:
|
||||
|
||||
enum **SwitchMode**:
|
||||
|
||||
- **SWITCH_MODE_IMMEDIATE** = **0**
|
||||
@@ -56,7 +62,7 @@ enum **SwitchMode**:
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeStateMachineTransition_advance_condition:
|
||||
.. _class_AnimationNodeStateMachineTransition_property_advance_condition:
|
||||
|
||||
- :ref:`String<class_String>` **advance_condition**
|
||||
|
||||
@@ -66,7 +72,7 @@ Property Descriptions
|
||||
| *Getter* | get_advance_condition() |
|
||||
+----------+------------------------------+
|
||||
|
||||
.. _class_AnimationNodeStateMachineTransition_auto_advance:
|
||||
.. _class_AnimationNodeStateMachineTransition_property_auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **auto_advance**
|
||||
|
||||
@@ -76,7 +82,7 @@ Property Descriptions
|
||||
| *Getter* | has_auto_advance() |
|
||||
+----------+-------------------------+
|
||||
|
||||
.. _class_AnimationNodeStateMachineTransition_disabled:
|
||||
.. _class_AnimationNodeStateMachineTransition_property_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
@@ -86,7 +92,7 @@ Property Descriptions
|
||||
| *Getter* | is_disabled() |
|
||||
+----------+---------------------+
|
||||
|
||||
.. _class_AnimationNodeStateMachineTransition_priority:
|
||||
.. _class_AnimationNodeStateMachineTransition_property_priority:
|
||||
|
||||
- :ref:`int<class_int>` **priority**
|
||||
|
||||
@@ -96,7 +102,7 @@ Property Descriptions
|
||||
| *Getter* | get_priority() |
|
||||
+----------+---------------------+
|
||||
|
||||
.. _class_AnimationNodeStateMachineTransition_switch_mode:
|
||||
.. _class_AnimationNodeStateMachineTransition_property_switch_mode:
|
||||
|
||||
- :ref:`SwitchMode<enum_AnimationNodeStateMachineTransition_SwitchMode>` **switch_mode**
|
||||
|
||||
@@ -106,7 +112,7 @@ Property Descriptions
|
||||
| *Getter* | get_switch_mode() |
|
||||
+----------+------------------------+
|
||||
|
||||
.. _class_AnimationNodeStateMachineTransition_xfade_time:
|
||||
.. _class_AnimationNodeStateMachineTransition_property_xfade_time:
|
||||
|
||||
- :ref:`float<class_float>` **xfade_time**
|
||||
|
||||
|
||||
@@ -19,144 +19,144 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_0/auto_advance<class_AnimationNodeTransition_input_0/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_0/name<class_AnimationNodeTransition_input_0/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_1/auto_advance<class_AnimationNodeTransition_input_1/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_1/name<class_AnimationNodeTransition_input_1/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_10/auto_advance<class_AnimationNodeTransition_input_10/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_10/name<class_AnimationNodeTransition_input_10/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_11/auto_advance<class_AnimationNodeTransition_input_11/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_11/name<class_AnimationNodeTransition_input_11/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_12/auto_advance<class_AnimationNodeTransition_input_12/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_12/name<class_AnimationNodeTransition_input_12/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_13/auto_advance<class_AnimationNodeTransition_input_13/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_13/name<class_AnimationNodeTransition_input_13/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_14/auto_advance<class_AnimationNodeTransition_input_14/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_14/name<class_AnimationNodeTransition_input_14/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_15/auto_advance<class_AnimationNodeTransition_input_15/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_15/name<class_AnimationNodeTransition_input_15/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_16/auto_advance<class_AnimationNodeTransition_input_16/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_16/name<class_AnimationNodeTransition_input_16/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_17/auto_advance<class_AnimationNodeTransition_input_17/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_17/name<class_AnimationNodeTransition_input_17/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_18/auto_advance<class_AnimationNodeTransition_input_18/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_18/name<class_AnimationNodeTransition_input_18/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_19/auto_advance<class_AnimationNodeTransition_input_19/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_19/name<class_AnimationNodeTransition_input_19/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_2/auto_advance<class_AnimationNodeTransition_input_2/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_2/name<class_AnimationNodeTransition_input_2/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_20/auto_advance<class_AnimationNodeTransition_input_20/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_20/name<class_AnimationNodeTransition_input_20/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_21/auto_advance<class_AnimationNodeTransition_input_21/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_21/name<class_AnimationNodeTransition_input_21/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_22/auto_advance<class_AnimationNodeTransition_input_22/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_22/name<class_AnimationNodeTransition_input_22/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_23/auto_advance<class_AnimationNodeTransition_input_23/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_23/name<class_AnimationNodeTransition_input_23/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_24/auto_advance<class_AnimationNodeTransition_input_24/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_24/name<class_AnimationNodeTransition_input_24/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_25/auto_advance<class_AnimationNodeTransition_input_25/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_25/name<class_AnimationNodeTransition_input_25/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_26/auto_advance<class_AnimationNodeTransition_input_26/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_26/name<class_AnimationNodeTransition_input_26/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_27/auto_advance<class_AnimationNodeTransition_input_27/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_27/name<class_AnimationNodeTransition_input_27/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_28/auto_advance<class_AnimationNodeTransition_input_28/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_28/name<class_AnimationNodeTransition_input_28/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_29/auto_advance<class_AnimationNodeTransition_input_29/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_29/name<class_AnimationNodeTransition_input_29/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_3/auto_advance<class_AnimationNodeTransition_input_3/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_3/name<class_AnimationNodeTransition_input_3/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_30/auto_advance<class_AnimationNodeTransition_input_30/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_30/name<class_AnimationNodeTransition_input_30/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_31/auto_advance<class_AnimationNodeTransition_input_31/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_31/name<class_AnimationNodeTransition_input_31/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_4/auto_advance<class_AnimationNodeTransition_input_4/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_4/name<class_AnimationNodeTransition_input_4/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_5/auto_advance<class_AnimationNodeTransition_input_5/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_5/name<class_AnimationNodeTransition_input_5/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_6/auto_advance<class_AnimationNodeTransition_input_6/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_6/name<class_AnimationNodeTransition_input_6/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_7/auto_advance<class_AnimationNodeTransition_input_7/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_7/name<class_AnimationNodeTransition_input_7/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_8/auto_advance<class_AnimationNodeTransition_input_8/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_8/name<class_AnimationNodeTransition_input_8/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_9/auto_advance<class_AnimationNodeTransition_input_9/auto_advance>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_9/name<class_AnimationNodeTransition_input_9/name>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`input_count<class_AnimationNodeTransition_input_count>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeTransition_xfade_time>` |
|
||||
+-----------------------------+-----------------------------------------------------------------------------------+
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_0/auto_advance<class_AnimationNodeTransition_property_input_0/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_0/name<class_AnimationNodeTransition_property_input_0/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_1/auto_advance<class_AnimationNodeTransition_property_input_1/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_1/name<class_AnimationNodeTransition_property_input_1/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_10/auto_advance<class_AnimationNodeTransition_property_input_10/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_10/name<class_AnimationNodeTransition_property_input_10/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_11/auto_advance<class_AnimationNodeTransition_property_input_11/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_11/name<class_AnimationNodeTransition_property_input_11/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_12/auto_advance<class_AnimationNodeTransition_property_input_12/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_12/name<class_AnimationNodeTransition_property_input_12/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_13/auto_advance<class_AnimationNodeTransition_property_input_13/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_13/name<class_AnimationNodeTransition_property_input_13/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_14/auto_advance<class_AnimationNodeTransition_property_input_14/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_14/name<class_AnimationNodeTransition_property_input_14/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_15/auto_advance<class_AnimationNodeTransition_property_input_15/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_15/name<class_AnimationNodeTransition_property_input_15/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_16/auto_advance<class_AnimationNodeTransition_property_input_16/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_16/name<class_AnimationNodeTransition_property_input_16/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_17/auto_advance<class_AnimationNodeTransition_property_input_17/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_17/name<class_AnimationNodeTransition_property_input_17/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_18/auto_advance<class_AnimationNodeTransition_property_input_18/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_18/name<class_AnimationNodeTransition_property_input_18/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_19/auto_advance<class_AnimationNodeTransition_property_input_19/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_19/name<class_AnimationNodeTransition_property_input_19/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_2/auto_advance<class_AnimationNodeTransition_property_input_2/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_2/name<class_AnimationNodeTransition_property_input_2/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_20/auto_advance<class_AnimationNodeTransition_property_input_20/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_20/name<class_AnimationNodeTransition_property_input_20/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_21/auto_advance<class_AnimationNodeTransition_property_input_21/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_21/name<class_AnimationNodeTransition_property_input_21/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_22/auto_advance<class_AnimationNodeTransition_property_input_22/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_22/name<class_AnimationNodeTransition_property_input_22/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_23/auto_advance<class_AnimationNodeTransition_property_input_23/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_23/name<class_AnimationNodeTransition_property_input_23/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_24/auto_advance<class_AnimationNodeTransition_property_input_24/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_24/name<class_AnimationNodeTransition_property_input_24/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_25/auto_advance<class_AnimationNodeTransition_property_input_25/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_25/name<class_AnimationNodeTransition_property_input_25/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_26/auto_advance<class_AnimationNodeTransition_property_input_26/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_26/name<class_AnimationNodeTransition_property_input_26/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_27/auto_advance<class_AnimationNodeTransition_property_input_27/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_27/name<class_AnimationNodeTransition_property_input_27/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_28/auto_advance<class_AnimationNodeTransition_property_input_28/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_28/name<class_AnimationNodeTransition_property_input_28/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_29/auto_advance<class_AnimationNodeTransition_property_input_29/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_29/name<class_AnimationNodeTransition_property_input_29/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_3/auto_advance<class_AnimationNodeTransition_property_input_3/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_3/name<class_AnimationNodeTransition_property_input_3/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_30/auto_advance<class_AnimationNodeTransition_property_input_30/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_30/name<class_AnimationNodeTransition_property_input_30/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_31/auto_advance<class_AnimationNodeTransition_property_input_31/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_31/name<class_AnimationNodeTransition_property_input_31/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_4/auto_advance<class_AnimationNodeTransition_property_input_4/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_4/name<class_AnimationNodeTransition_property_input_4/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_5/auto_advance<class_AnimationNodeTransition_property_input_5/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_5/name<class_AnimationNodeTransition_property_input_5/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_6/auto_advance<class_AnimationNodeTransition_property_input_6/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_6/name<class_AnimationNodeTransition_property_input_6/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_7/auto_advance<class_AnimationNodeTransition_property_input_7/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_7/name<class_AnimationNodeTransition_property_input_7/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_8/auto_advance<class_AnimationNodeTransition_property_input_8/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_8/name<class_AnimationNodeTransition_property_input_8/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_9/auto_advance<class_AnimationNodeTransition_property_input_9/auto_advance>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`input_9/name<class_AnimationNodeTransition_property_input_9/name>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`input_count<class_AnimationNodeTransition_property_input_count>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeTransition_property_xfade_time>` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationNodeTransition_input_0/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_0/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_0/auto_advance**
|
||||
|
||||
@@ -166,7 +166,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_0/name:
|
||||
.. _class_AnimationNodeTransition_property_input_0/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_0/name**
|
||||
|
||||
@@ -176,7 +176,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_1/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_1/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_1/auto_advance**
|
||||
|
||||
@@ -186,7 +186,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_1/name:
|
||||
.. _class_AnimationNodeTransition_property_input_1/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_1/name**
|
||||
|
||||
@@ -196,7 +196,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_10/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_10/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_10/auto_advance**
|
||||
|
||||
@@ -206,7 +206,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_10/name:
|
||||
.. _class_AnimationNodeTransition_property_input_10/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_10/name**
|
||||
|
||||
@@ -216,7 +216,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_11/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_11/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_11/auto_advance**
|
||||
|
||||
@@ -226,7 +226,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_11/name:
|
||||
.. _class_AnimationNodeTransition_property_input_11/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_11/name**
|
||||
|
||||
@@ -236,7 +236,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_12/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_12/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_12/auto_advance**
|
||||
|
||||
@@ -246,7 +246,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_12/name:
|
||||
.. _class_AnimationNodeTransition_property_input_12/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_12/name**
|
||||
|
||||
@@ -256,7 +256,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_13/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_13/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_13/auto_advance**
|
||||
|
||||
@@ -266,7 +266,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_13/name:
|
||||
.. _class_AnimationNodeTransition_property_input_13/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_13/name**
|
||||
|
||||
@@ -276,7 +276,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_14/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_14/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_14/auto_advance**
|
||||
|
||||
@@ -286,7 +286,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_14/name:
|
||||
.. _class_AnimationNodeTransition_property_input_14/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_14/name**
|
||||
|
||||
@@ -296,7 +296,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_15/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_15/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_15/auto_advance**
|
||||
|
||||
@@ -306,7 +306,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_15/name:
|
||||
.. _class_AnimationNodeTransition_property_input_15/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_15/name**
|
||||
|
||||
@@ -316,7 +316,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_16/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_16/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_16/auto_advance**
|
||||
|
||||
@@ -326,7 +326,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_16/name:
|
||||
.. _class_AnimationNodeTransition_property_input_16/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_16/name**
|
||||
|
||||
@@ -336,7 +336,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_17/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_17/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_17/auto_advance**
|
||||
|
||||
@@ -346,7 +346,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_17/name:
|
||||
.. _class_AnimationNodeTransition_property_input_17/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_17/name**
|
||||
|
||||
@@ -356,7 +356,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_18/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_18/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_18/auto_advance**
|
||||
|
||||
@@ -366,7 +366,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_18/name:
|
||||
.. _class_AnimationNodeTransition_property_input_18/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_18/name**
|
||||
|
||||
@@ -376,7 +376,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_19/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_19/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_19/auto_advance**
|
||||
|
||||
@@ -386,7 +386,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_19/name:
|
||||
.. _class_AnimationNodeTransition_property_input_19/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_19/name**
|
||||
|
||||
@@ -396,7 +396,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_2/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_2/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_2/auto_advance**
|
||||
|
||||
@@ -406,7 +406,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_2/name:
|
||||
.. _class_AnimationNodeTransition_property_input_2/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_2/name**
|
||||
|
||||
@@ -416,7 +416,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_20/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_20/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_20/auto_advance**
|
||||
|
||||
@@ -426,7 +426,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_20/name:
|
||||
.. _class_AnimationNodeTransition_property_input_20/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_20/name**
|
||||
|
||||
@@ -436,7 +436,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_21/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_21/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_21/auto_advance**
|
||||
|
||||
@@ -446,7 +446,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_21/name:
|
||||
.. _class_AnimationNodeTransition_property_input_21/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_21/name**
|
||||
|
||||
@@ -456,7 +456,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_22/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_22/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_22/auto_advance**
|
||||
|
||||
@@ -466,7 +466,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_22/name:
|
||||
.. _class_AnimationNodeTransition_property_input_22/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_22/name**
|
||||
|
||||
@@ -476,7 +476,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_23/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_23/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_23/auto_advance**
|
||||
|
||||
@@ -486,7 +486,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_23/name:
|
||||
.. _class_AnimationNodeTransition_property_input_23/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_23/name**
|
||||
|
||||
@@ -496,7 +496,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_24/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_24/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_24/auto_advance**
|
||||
|
||||
@@ -506,7 +506,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_24/name:
|
||||
.. _class_AnimationNodeTransition_property_input_24/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_24/name**
|
||||
|
||||
@@ -516,7 +516,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_25/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_25/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_25/auto_advance**
|
||||
|
||||
@@ -526,7 +526,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_25/name:
|
||||
.. _class_AnimationNodeTransition_property_input_25/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_25/name**
|
||||
|
||||
@@ -536,7 +536,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_26/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_26/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_26/auto_advance**
|
||||
|
||||
@@ -546,7 +546,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_26/name:
|
||||
.. _class_AnimationNodeTransition_property_input_26/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_26/name**
|
||||
|
||||
@@ -556,7 +556,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_27/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_27/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_27/auto_advance**
|
||||
|
||||
@@ -566,7 +566,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_27/name:
|
||||
.. _class_AnimationNodeTransition_property_input_27/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_27/name**
|
||||
|
||||
@@ -576,7 +576,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_28/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_28/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_28/auto_advance**
|
||||
|
||||
@@ -586,7 +586,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_28/name:
|
||||
.. _class_AnimationNodeTransition_property_input_28/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_28/name**
|
||||
|
||||
@@ -596,7 +596,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_29/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_29/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_29/auto_advance**
|
||||
|
||||
@@ -606,7 +606,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_29/name:
|
||||
.. _class_AnimationNodeTransition_property_input_29/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_29/name**
|
||||
|
||||
@@ -616,7 +616,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_3/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_3/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_3/auto_advance**
|
||||
|
||||
@@ -626,7 +626,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_3/name:
|
||||
.. _class_AnimationNodeTransition_property_input_3/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_3/name**
|
||||
|
||||
@@ -636,7 +636,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_30/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_30/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_30/auto_advance**
|
||||
|
||||
@@ -646,7 +646,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_30/name:
|
||||
.. _class_AnimationNodeTransition_property_input_30/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_30/name**
|
||||
|
||||
@@ -656,7 +656,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_31/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_31/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_31/auto_advance**
|
||||
|
||||
@@ -666,7 +666,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_31/name:
|
||||
.. _class_AnimationNodeTransition_property_input_31/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_31/name**
|
||||
|
||||
@@ -676,7 +676,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_4/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_4/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_4/auto_advance**
|
||||
|
||||
@@ -686,7 +686,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_4/name:
|
||||
.. _class_AnimationNodeTransition_property_input_4/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_4/name**
|
||||
|
||||
@@ -696,7 +696,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_5/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_5/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_5/auto_advance**
|
||||
|
||||
@@ -706,7 +706,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_5/name:
|
||||
.. _class_AnimationNodeTransition_property_input_5/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_5/name**
|
||||
|
||||
@@ -716,7 +716,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_6/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_6/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_6/auto_advance**
|
||||
|
||||
@@ -726,7 +726,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_6/name:
|
||||
.. _class_AnimationNodeTransition_property_input_6/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_6/name**
|
||||
|
||||
@@ -736,7 +736,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_7/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_7/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_7/auto_advance**
|
||||
|
||||
@@ -746,7 +746,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_7/name:
|
||||
.. _class_AnimationNodeTransition_property_input_7/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_7/name**
|
||||
|
||||
@@ -756,7 +756,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_8/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_8/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_8/auto_advance**
|
||||
|
||||
@@ -766,7 +766,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_8/name:
|
||||
.. _class_AnimationNodeTransition_property_input_8/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_8/name**
|
||||
|
||||
@@ -776,7 +776,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_9/auto_advance:
|
||||
.. _class_AnimationNodeTransition_property_input_9/auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_9/auto_advance**
|
||||
|
||||
@@ -786,7 +786,7 @@ Property Descriptions
|
||||
| *Getter* | is_input_set_as_auto_advance() |
|
||||
+----------+----------------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_9/name:
|
||||
.. _class_AnimationNodeTransition_property_input_9/name:
|
||||
|
||||
- :ref:`String<class_String>` **input_9/name**
|
||||
|
||||
@@ -796,7 +796,7 @@ Property Descriptions
|
||||
| *Getter* | get_input_caption() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_input_count:
|
||||
.. _class_AnimationNodeTransition_property_input_count:
|
||||
|
||||
- :ref:`int<class_int>` **input_count**
|
||||
|
||||
@@ -806,7 +806,7 @@ Property Descriptions
|
||||
| *Getter* | get_enabled_inputs() |
|
||||
+----------+---------------------------+
|
||||
|
||||
.. _class_AnimationNodeTransition_xfade_time:
|
||||
.. _class_AnimationNodeTransition_property_xfade_time:
|
||||
|
||||
- :ref:`float<class_float>` **xfade_time**
|
||||
|
||||
|
||||
@@ -19,99 +19,99 @@ Container and player of :ref:`Animation<class_Animation>` resources.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`assigned_animation<class_AnimationPlayer_assigned_animation>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`autoplay<class_AnimationPlayer_autoplay>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`current_animation<class_AnimationPlayer_current_animation>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`current_animation_length<class_AnimationPlayer_current_animation_length>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`current_animation_position<class_AnimationPlayer_current_animation_position>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playback_active<class_AnimationPlayer_playback_active>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`playback_default_blend_time<class_AnimationPlayer_playback_default_blend_time>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationPlayer_playback_process_mode>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`playback_speed<class_AnimationPlayer_playback_speed>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`root_node<class_AnimationPlayer_root_node>` |
|
||||
+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`assigned_animation<class_AnimationPlayer_property_assigned_animation>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`autoplay<class_AnimationPlayer_property_autoplay>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`current_animation<class_AnimationPlayer_property_current_animation>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`current_animation_length<class_AnimationPlayer_property_current_animation_length>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`current_animation_position<class_AnimationPlayer_property_current_animation_position>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playback_active<class_AnimationPlayer_property_playback_active>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`playback_default_blend_time<class_AnimationPlayer_property_playback_default_blend_time>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationPlayer_property_playback_process_mode>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`playback_speed<class_AnimationPlayer_property_playback_speed>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`root_node<class_AnimationPlayer_property_root_node>` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`add_animation<class_AnimationPlayer_add_animation>` **(** :ref:`String<class_String>` name, :ref:`Animation<class_Animation>` animation **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`advance<class_AnimationPlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation_get_next<class_AnimationPlayer_animation_get_next>` **(** :ref:`String<class_String>` anim_from **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_set_next<class_AnimationPlayer_animation_set_next>` **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_caches<class_AnimationPlayer_clear_caches>` **(** **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_queue<class_AnimationPlayer_clear_queue>` **(** **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`find_animation<class_AnimationPlayer_find_animation>` **(** :ref:`Animation<class_Animation>` animation **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Animation<class_Animation>` | :ref:`get_animation<class_AnimationPlayer_get_animation>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_animation_list<class_AnimationPlayer_get_animation_list>` **(** **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_get_blend_time>` **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_playing_speed<class_AnimationPlayer_get_playing_speed>` **(** **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_queue<class_AnimationPlayer_get_queue>` **(** **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimationPlayer_play>` **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play_backwards<class_AnimationPlayer_play_backwards>` **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1 **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue<class_AnimationPlayer_queue>` **(** :ref:`String<class_String>` name **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_animation<class_AnimationPlayer_remove_animation>` **(** :ref:`String<class_String>` name **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_animation<class_AnimationPlayer_rename_animation>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` newname **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AnimationPlayer_seek>` **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_time<class_AnimationPlayer_set_blend_time>` **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to, :ref:`float<class_float>` sec **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`add_animation<class_AnimationPlayer_method_add_animation>` **(** :ref:`String<class_String>` name, :ref:`Animation<class_Animation>` animation **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`advance<class_AnimationPlayer_method_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation_get_next<class_AnimationPlayer_method_animation_get_next>` **(** :ref:`String<class_String>` anim_from **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_set_next<class_AnimationPlayer_method_animation_set_next>` **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_caches<class_AnimationPlayer_method_clear_caches>` **(** **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_queue<class_AnimationPlayer_method_clear_queue>` **(** **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`find_animation<class_AnimationPlayer_method_find_animation>` **(** :ref:`Animation<class_Animation>` animation **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Animation<class_Animation>` | :ref:`get_animation<class_AnimationPlayer_method_get_animation>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_animation_list<class_AnimationPlayer_method_get_animation_list>` **(** **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_method_get_blend_time>` **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_playing_speed<class_AnimationPlayer_method_get_playing_speed>` **(** **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_queue<class_AnimationPlayer_method_get_queue>` **(** **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_method_has_animation>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_method_is_playing>` **(** **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimationPlayer_method_play>` **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play_backwards<class_AnimationPlayer_method_play_backwards>` **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1 **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue<class_AnimationPlayer_method_queue>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_animation<class_AnimationPlayer_method_remove_animation>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_animation<class_AnimationPlayer_method_rename_animation>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` newname **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AnimationPlayer_method_seek>` **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_time<class_AnimationPlayer_method_set_blend_time>` **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to, :ref:`float<class_float>` sec **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimationPlayer_method_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AnimationPlayer_animation_changed:
|
||||
.. _class_AnimationPlayer_signal_animation_changed:
|
||||
|
||||
- **animation_changed** **(** :ref:`String<class_String>` old_name, :ref:`String<class_String>` new_name **)**
|
||||
|
||||
If the currently being played animation changes, this signal will notify of such change.
|
||||
|
||||
.. _class_AnimationPlayer_animation_finished:
|
||||
.. _class_AnimationPlayer_signal_animation_finished:
|
||||
|
||||
- **animation_finished** **(** :ref:`String<class_String>` anim_name **)**
|
||||
|
||||
Notifies when an animation finished playing.
|
||||
|
||||
.. _class_AnimationPlayer_animation_started:
|
||||
.. _class_AnimationPlayer_signal_animation_started:
|
||||
|
||||
- **animation_started** **(** :ref:`String<class_String>` anim_name **)**
|
||||
|
||||
Notifies when an animation starts playing.
|
||||
|
||||
.. _class_AnimationPlayer_caches_cleared:
|
||||
.. _class_AnimationPlayer_signal_caches_cleared:
|
||||
|
||||
- **caches_cleared** **(** **)**
|
||||
|
||||
@@ -120,6 +120,12 @@ Enumerations
|
||||
|
||||
.. _enum_AnimationPlayer_AnimationProcessMode:
|
||||
|
||||
.. _class_AnimationPlayer_constant_ANIMATION_PROCESS_PHYSICS:
|
||||
|
||||
.. _class_AnimationPlayer_constant_ANIMATION_PROCESS_IDLE:
|
||||
|
||||
.. _class_AnimationPlayer_constant_ANIMATION_PROCESS_MANUAL:
|
||||
|
||||
enum **AnimationProcessMode**:
|
||||
|
||||
- **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies.
|
||||
@@ -143,7 +149,7 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationPlayer_assigned_animation:
|
||||
.. _class_AnimationPlayer_property_assigned_animation:
|
||||
|
||||
- :ref:`String<class_String>` **assigned_animation**
|
||||
|
||||
@@ -153,9 +159,9 @@ Property Descriptions
|
||||
| *Getter* | get_assigned_animation() |
|
||||
+----------+-------------------------------+
|
||||
|
||||
If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also :ref:`current_animation<class_AnimationPlayer_current_animation>`.
|
||||
If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also :ref:`current_animation<class_AnimationPlayer_property_current_animation>`.
|
||||
|
||||
.. _class_AnimationPlayer_autoplay:
|
||||
.. _class_AnimationPlayer_property_autoplay:
|
||||
|
||||
- :ref:`String<class_String>` **autoplay**
|
||||
|
||||
@@ -167,7 +173,7 @@ If playing, the current animation; otherwise, the animation last played. When se
|
||||
|
||||
The name of the animation to play when the scene loads. Default value: ``""``.
|
||||
|
||||
.. _class_AnimationPlayer_current_animation:
|
||||
.. _class_AnimationPlayer_property_current_animation:
|
||||
|
||||
- :ref:`String<class_String>` **current_animation**
|
||||
|
||||
@@ -177,9 +183,9 @@ The name of the animation to play when the scene loads. Default value: ``""``.
|
||||
| *Getter* | get_current_animation() |
|
||||
+----------+------------------------------+
|
||||
|
||||
The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play<class_AnimationPlayer_play>`. Default value: ``""``.
|
||||
The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play<class_AnimationPlayer_method_play>`. Default value: ``""``.
|
||||
|
||||
.. _class_AnimationPlayer_current_animation_length:
|
||||
.. _class_AnimationPlayer_property_current_animation_length:
|
||||
|
||||
- :ref:`float<class_float>` **current_animation_length**
|
||||
|
||||
@@ -189,7 +195,7 @@ The name of the current animation, "" if not playing anything. When being set, d
|
||||
|
||||
The length (in seconds) of the currently being played animation.
|
||||
|
||||
.. _class_AnimationPlayer_current_animation_position:
|
||||
.. _class_AnimationPlayer_property_current_animation_position:
|
||||
|
||||
- :ref:`float<class_float>` **current_animation_position**
|
||||
|
||||
@@ -199,7 +205,7 @@ The length (in seconds) of the currently being played animation.
|
||||
|
||||
The position (in seconds) of the currently playing animation.
|
||||
|
||||
.. _class_AnimationPlayer_playback_active:
|
||||
.. _class_AnimationPlayer_property_playback_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **playback_active**
|
||||
|
||||
@@ -211,7 +217,7 @@ The position (in seconds) of the currently playing animation.
|
||||
|
||||
If ``true``, updates animations in response to process-related notifications. Default value: ``true``.
|
||||
|
||||
.. _class_AnimationPlayer_playback_default_blend_time:
|
||||
.. _class_AnimationPlayer_property_playback_default_blend_time:
|
||||
|
||||
- :ref:`float<class_float>` **playback_default_blend_time**
|
||||
|
||||
@@ -223,7 +229,7 @@ If ``true``, updates animations in response to process-related notifications. De
|
||||
|
||||
The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: ``0``.
|
||||
|
||||
.. _class_AnimationPlayer_playback_process_mode:
|
||||
.. _class_AnimationPlayer_property_playback_process_mode:
|
||||
|
||||
- :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` **playback_process_mode**
|
||||
|
||||
@@ -235,7 +241,7 @@ The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 p
|
||||
|
||||
The process notification in which to update animations. Default value: ``ANIMATION_PROCESS_IDLE``.
|
||||
|
||||
.. _class_AnimationPlayer_playback_speed:
|
||||
.. _class_AnimationPlayer_property_playback_speed:
|
||||
|
||||
- :ref:`float<class_float>` **playback_speed**
|
||||
|
||||
@@ -247,7 +253,7 @@ The process notification in which to update animations. Default value: ``ANIMATI
|
||||
|
||||
The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: ``1``.
|
||||
|
||||
.. _class_AnimationPlayer_root_node:
|
||||
.. _class_AnimationPlayer_property_root_node:
|
||||
|
||||
- :ref:`NodePath<class_NodePath>` **root_node**
|
||||
|
||||
@@ -262,131 +268,131 @@ The node from which node path references will travel. Default value: ``".."``.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationPlayer_add_animation:
|
||||
.. _class_AnimationPlayer_method_add_animation:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **add_animation** **(** :ref:`String<class_String>` name, :ref:`Animation<class_Animation>` animation **)**
|
||||
|
||||
Adds ``animation`` to the player accessible with the key ``name``.
|
||||
|
||||
.. _class_AnimationPlayer_advance:
|
||||
.. _class_AnimationPlayer_method_advance:
|
||||
|
||||
- void **advance** **(** :ref:`float<class_float>` delta **)**
|
||||
|
||||
Shifts position in the animation timeline. Delta is the time in seconds to shift.
|
||||
|
||||
.. _class_AnimationPlayer_animation_get_next:
|
||||
.. _class_AnimationPlayer_method_animation_get_next:
|
||||
|
||||
- :ref:`String<class_String>` **animation_get_next** **(** :ref:`String<class_String>` anim_from **)** const
|
||||
|
||||
Returns the name of the next animation in the queue.
|
||||
|
||||
.. _class_AnimationPlayer_animation_set_next:
|
||||
.. _class_AnimationPlayer_method_animation_set_next:
|
||||
|
||||
- void **animation_set_next** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)**
|
||||
|
||||
Triggers the ``anim_to`` animation when the ``anim_from`` animation completes.
|
||||
|
||||
.. _class_AnimationPlayer_clear_caches:
|
||||
.. _class_AnimationPlayer_method_clear_caches:
|
||||
|
||||
- void **clear_caches** **(** **)**
|
||||
|
||||
``AnimationPlayer`` caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again.
|
||||
|
||||
.. _class_AnimationPlayer_clear_queue:
|
||||
.. _class_AnimationPlayer_method_clear_queue:
|
||||
|
||||
- void **clear_queue** **(** **)**
|
||||
|
||||
Clears all queued, unplayed animations.
|
||||
|
||||
.. _class_AnimationPlayer_find_animation:
|
||||
.. _class_AnimationPlayer_method_find_animation:
|
||||
|
||||
- :ref:`String<class_String>` **find_animation** **(** :ref:`Animation<class_Animation>` animation **)** const
|
||||
|
||||
Returns the name of ``animation`` or empty string if not found.
|
||||
|
||||
.. _class_AnimationPlayer_get_animation:
|
||||
.. _class_AnimationPlayer_method_get_animation:
|
||||
|
||||
- :ref:`Animation<class_Animation>` **get_animation** **(** :ref:`String<class_String>` name **)** const
|
||||
|
||||
Returns the :ref:`Animation<class_Animation>` with key ``name`` or ``null`` if not found.
|
||||
|
||||
.. _class_AnimationPlayer_get_animation_list:
|
||||
.. _class_AnimationPlayer_method_get_animation_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_animation_list** **(** **)** const
|
||||
|
||||
Returns the list of stored animation names.
|
||||
|
||||
.. _class_AnimationPlayer_get_blend_time:
|
||||
.. _class_AnimationPlayer_method_get_blend_time:
|
||||
|
||||
- :ref:`float<class_float>` **get_blend_time** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to **)** const
|
||||
|
||||
Get the blend time (in seconds) between two animations, referenced by their names.
|
||||
|
||||
.. _class_AnimationPlayer_get_playing_speed:
|
||||
.. _class_AnimationPlayer_method_get_playing_speed:
|
||||
|
||||
- :ref:`float<class_float>` **get_playing_speed** **(** **)** const
|
||||
|
||||
Get the actual playing speed of current animation or 0 if not playing. This speed is the ``playback_speed`` property multiplied by ``custom_speed`` argument specified when calling the ``play`` method.
|
||||
|
||||
.. _class_AnimationPlayer_get_queue:
|
||||
.. _class_AnimationPlayer_method_get_queue:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_queue** **(** **)**
|
||||
|
||||
.. _class_AnimationPlayer_has_animation:
|
||||
.. _class_AnimationPlayer_method_has_animation:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_String>` name **)** const
|
||||
|
||||
Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation<class_Animation>` with key ``name``.
|
||||
|
||||
.. _class_AnimationPlayer_is_playing:
|
||||
.. _class_AnimationPlayer_method_is_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
|
||||
Returns ``true`` if playing an animation.
|
||||
|
||||
.. _class_AnimationPlayer_play:
|
||||
.. _class_AnimationPlayer_method_play:
|
||||
|
||||
- void **play** **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)**
|
||||
|
||||
Play the animation with key ``name``. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards.
|
||||
|
||||
.. _class_AnimationPlayer_play_backwards:
|
||||
.. _class_AnimationPlayer_method_play_backwards:
|
||||
|
||||
- void **play_backwards** **(** :ref:`String<class_String>` name="", :ref:`float<class_float>` custom_blend=-1 **)**
|
||||
|
||||
Play the animation with key ``name`` in reverse.
|
||||
|
||||
.. _class_AnimationPlayer_queue:
|
||||
.. _class_AnimationPlayer_method_queue:
|
||||
|
||||
- void **queue** **(** :ref:`String<class_String>` name **)**
|
||||
|
||||
Queue an animation for playback once the current one is done.
|
||||
|
||||
.. _class_AnimationPlayer_remove_animation:
|
||||
.. _class_AnimationPlayer_method_remove_animation:
|
||||
|
||||
- void **remove_animation** **(** :ref:`String<class_String>` name **)**
|
||||
|
||||
Remove the animation with key ``name``.
|
||||
|
||||
.. _class_AnimationPlayer_rename_animation:
|
||||
.. _class_AnimationPlayer_method_rename_animation:
|
||||
|
||||
- void **rename_animation** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` newname **)**
|
||||
|
||||
Rename an existing animation with key ``name`` to ``newname``.
|
||||
|
||||
.. _class_AnimationPlayer_seek:
|
||||
.. _class_AnimationPlayer_method_seek:
|
||||
|
||||
- void **seek** **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)**
|
||||
|
||||
Seek the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time.
|
||||
|
||||
.. _class_AnimationPlayer_set_blend_time:
|
||||
.. _class_AnimationPlayer_method_set_blend_time:
|
||||
|
||||
- void **set_blend_time** **(** :ref:`String<class_String>` anim_from, :ref:`String<class_String>` anim_to, :ref:`float<class_float>` sec **)**
|
||||
|
||||
Specify a blend time (in seconds) between two animations, referenced by their names.
|
||||
|
||||
.. _class_AnimationPlayer_stop:
|
||||
.. _class_AnimationPlayer_method_stop:
|
||||
|
||||
- void **stop** **(** :ref:`bool<class_bool>` reset=true **)**
|
||||
|
||||
|
||||
@@ -19,34 +19,40 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`active<class_AnimationTree_active>` |
|
||||
+----------------------------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`anim_player<class_AnimationTree_anim_player>` |
|
||||
+----------------------------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationTree_AnimationProcessMode>` | :ref:`process_mode<class_AnimationTree_process_mode>` |
|
||||
+----------------------------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`root_motion_track<class_AnimationTree_root_motion_track>` |
|
||||
+----------------------------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`tree_root<class_AnimationTree_tree_root>` |
|
||||
+----------------------------------------------------------------------+-----------------------------------------------------------------+
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`active<class_AnimationTree_property_active>` |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`anim_player<class_AnimationTree_property_anim_player>` |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationTree_AnimationProcessMode>` | :ref:`process_mode<class_AnimationTree_property_process_mode>` |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`root_motion_track<class_AnimationTree_property_root_motion_track>` |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`tree_root<class_AnimationTree_property_tree_root>` |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`advance<class_AnimationTree_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`get_root_motion_transform<class_AnimationTree_get_root_motion_transform>` **(** **)** const |
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_parameter<class_AnimationTree_rename_parameter>` **(** :ref:`String<class_String>` old_name, :ref:`String<class_String>` new_name **)** |
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`advance<class_AnimationTree_method_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`get_root_motion_transform<class_AnimationTree_method_get_root_motion_transform>` **(** **)** const |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_parameter<class_AnimationTree_method_rename_parameter>` **(** :ref:`String<class_String>` old_name, :ref:`String<class_String>` new_name **)** |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_AnimationTree_AnimationProcessMode:
|
||||
|
||||
.. _class_AnimationTree_constant_ANIMATION_PROCESS_PHYSICS:
|
||||
|
||||
.. _class_AnimationTree_constant_ANIMATION_PROCESS_IDLE:
|
||||
|
||||
.. _class_AnimationTree_constant_ANIMATION_PROCESS_MANUAL:
|
||||
|
||||
enum **AnimationProcessMode**:
|
||||
|
||||
- **ANIMATION_PROCESS_PHYSICS** = **0**
|
||||
@@ -58,7 +64,7 @@ enum **AnimationProcessMode**:
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationTree_active:
|
||||
.. _class_AnimationTree_property_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **active**
|
||||
|
||||
@@ -68,7 +74,7 @@ Property Descriptions
|
||||
| *Getter* | is_active() |
|
||||
+----------+-------------------+
|
||||
|
||||
.. _class_AnimationTree_anim_player:
|
||||
.. _class_AnimationTree_property_anim_player:
|
||||
|
||||
- :ref:`NodePath<class_NodePath>` **anim_player**
|
||||
|
||||
@@ -78,7 +84,7 @@ Property Descriptions
|
||||
| *Getter* | get_animation_player() |
|
||||
+----------+-----------------------------+
|
||||
|
||||
.. _class_AnimationTree_process_mode:
|
||||
.. _class_AnimationTree_property_process_mode:
|
||||
|
||||
- :ref:`AnimationProcessMode<enum_AnimationTree_AnimationProcessMode>` **process_mode**
|
||||
|
||||
@@ -88,7 +94,7 @@ Property Descriptions
|
||||
| *Getter* | get_process_mode() |
|
||||
+----------+-------------------------+
|
||||
|
||||
.. _class_AnimationTree_root_motion_track:
|
||||
.. _class_AnimationTree_property_root_motion_track:
|
||||
|
||||
- :ref:`NodePath<class_NodePath>` **root_motion_track**
|
||||
|
||||
@@ -98,7 +104,7 @@ Property Descriptions
|
||||
| *Getter* | get_root_motion_track() |
|
||||
+----------+------------------------------+
|
||||
|
||||
.. _class_AnimationTree_tree_root:
|
||||
.. _class_AnimationTree_property_tree_root:
|
||||
|
||||
- :ref:`AnimationNode<class_AnimationNode>` **tree_root**
|
||||
|
||||
@@ -111,15 +117,15 @@ Property Descriptions
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationTree_advance:
|
||||
.. _class_AnimationTree_method_advance:
|
||||
|
||||
- void **advance** **(** :ref:`float<class_float>` delta **)**
|
||||
|
||||
.. _class_AnimationTree_get_root_motion_transform:
|
||||
.. _class_AnimationTree_method_get_root_motion_transform:
|
||||
|
||||
- :ref:`Transform<class_Transform>` **get_root_motion_transform** **(** **)** const
|
||||
|
||||
.. _class_AnimationTree_rename_parameter:
|
||||
.. _class_AnimationTree_method_rename_parameter:
|
||||
|
||||
- void **rename_parameter** **(** :ref:`String<class_String>` old_name, :ref:`String<class_String>` new_name **)**
|
||||
|
||||
|
||||
@@ -19,140 +19,160 @@ Animation Player that uses a node graph for blending Animations.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`active<class_AnimationTreePlayer_active>` |
|
||||
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`base_path<class_AnimationTreePlayer_base_path>` |
|
||||
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`master_player<class_AnimationTreePlayer_master_player>` |
|
||||
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationTreePlayer_playback_process_mode>` |
|
||||
+----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`active<class_AnimationTreePlayer_property_active>` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`base_path<class_AnimationTreePlayer_property_base_path>` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`master_player<class_AnimationTreePlayer_property_master_player>` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationTreePlayer_property_playback_process_mode>` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationTreePlayer_add_node>` **(** :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` type, :ref:`String<class_String>` id **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`advance<class_AnimationTreePlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Animation<class_Animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_animation_node_get_animation>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_animation_node_get_master_animation>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`animation_node_get_position<class_AnimationTreePlayer_animation_node_get_position>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_animation_node_set_animation>` **(** :ref:`String<class_String>` id, :ref:`Animation<class_Animation>` animation **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_filter_path<class_AnimationTreePlayer_animation_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_animation_node_set_master_animation>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` source **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_nodes_connected<class_AnimationTreePlayer_are_nodes_connected>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_blend2_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_blend2_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_blend2_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_blend3_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_blend3_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_blend4_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_blend4_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` blend **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`connect_nodes<class_AnimationTreePlayer_connect_nodes>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_nodes<class_AnimationTreePlayer_disconnect_nodes>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` dst_input_idx **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_node_list<class_AnimationTreePlayer_get_node_list>` **(** **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`mix_node_get_amount<class_AnimationTreePlayer_mix_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_mix_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` ratio **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`node_exists<class_AnimationTreePlayer_node_exists>` **(** :ref:`String<class_String>` node **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`node_get_input_count<class_AnimationTreePlayer_node_get_input_count>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`node_get_input_source<class_AnimationTreePlayer_node_get_input_source>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` idx **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`node_get_position<class_AnimationTreePlayer_node_get_position>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` | :ref:`node_get_type<class_AnimationTreePlayer_node_get_type>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`node_rename<class_AnimationTreePlayer_node_rename>` **(** :ref:`String<class_String>` node, :ref:`String<class_String>` new_name **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`node_set_position<class_AnimationTreePlayer_node_set_position>` **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` screen_position **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_oneshot_node_get_fadein_time>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_oneshot_node_has_autorestart>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_oneshot_node_is_active>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_oneshot_node_set_autorestart>` **(** :ref:`String<class_String>` id, :ref:`bool<class_bool>` enable **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` delay_sec **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` rand_sec **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_oneshot_node_set_fadein_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_oneshot_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_start<class_AnimationTreePlayer_oneshot_node_start>` **(** :ref:`String<class_String>` id **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_stop<class_AnimationTreePlayer_oneshot_node_stop>` **(** :ref:`String<class_String>` id **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`recompute_caches<class_AnimationTreePlayer_recompute_caches>` **(** **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationTreePlayer_remove_node>` **(** :ref:`String<class_String>` id **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reset<class_AnimationTreePlayer_reset>` **(** **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_timescale_node_get_scale>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_timescale_node_set_scale>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` scale **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_timeseek_node_seek>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` seconds **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_transition_node_delete_input>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transition_node_get_current<class_AnimationTreePlayer_transition_node_get_current>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_transition_node_get_input_count>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_transition_node_get_xfade_time>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_transition_node_has_input_auto_advance>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** const |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_transition_node_set_current>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_transition_node_set_input_auto_advance>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_transition_node_set_input_count>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` count **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_transition_node_set_xfade_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationTreePlayer_method_add_node>` **(** :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` type, :ref:`String<class_String>` id **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`advance<class_AnimationTreePlayer_method_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Animation<class_Animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_method_animation_node_get_animation>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_method_animation_node_get_master_animation>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`animation_node_get_position<class_AnimationTreePlayer_method_animation_node_get_position>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_method_animation_node_set_animation>` **(** :ref:`String<class_String>` id, :ref:`Animation<class_Animation>` animation **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_filter_path<class_AnimationTreePlayer_method_animation_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_method_animation_node_set_master_animation>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` source **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_nodes_connected<class_AnimationTreePlayer_method_are_nodes_connected>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_method_blend2_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_method_blend2_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_method_blend2_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_method_blend3_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_method_blend3_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_method_blend4_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_method_blend4_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` blend **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`connect_nodes<class_AnimationTreePlayer_method_connect_nodes>` **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_nodes<class_AnimationTreePlayer_method_disconnect_nodes>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` dst_input_idx **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_node_list<class_AnimationTreePlayer_method_get_node_list>` **(** **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`mix_node_get_amount<class_AnimationTreePlayer_method_mix_node_get_amount>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_method_mix_node_set_amount>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` ratio **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`node_exists<class_AnimationTreePlayer_method_node_exists>` **(** :ref:`String<class_String>` node **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`node_get_input_count<class_AnimationTreePlayer_method_node_get_input_count>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`node_get_input_source<class_AnimationTreePlayer_method_node_get_input_source>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` idx **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`node_get_position<class_AnimationTreePlayer_method_node_get_position>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` | :ref:`node_get_type<class_AnimationTreePlayer_method_node_get_type>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`node_rename<class_AnimationTreePlayer_method_node_rename>` **(** :ref:`String<class_String>` node, :ref:`String<class_String>` new_name **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`node_set_position<class_AnimationTreePlayer_method_node_set_position>` **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` screen_position **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_method_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_method_oneshot_node_get_fadein_time>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_method_oneshot_node_has_autorestart>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_method_oneshot_node_is_active>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_method_oneshot_node_set_autorestart>` **(** :ref:`String<class_String>` id, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_method_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` delay_sec **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_method_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` rand_sec **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_method_oneshot_node_set_fadein_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_method_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_method_oneshot_node_set_filter_path>` **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_start<class_AnimationTreePlayer_method_oneshot_node_start>` **(** :ref:`String<class_String>` id **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_stop<class_AnimationTreePlayer_method_oneshot_node_stop>` **(** :ref:`String<class_String>` id **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`recompute_caches<class_AnimationTreePlayer_method_recompute_caches>` **(** **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationTreePlayer_method_remove_node>` **(** :ref:`String<class_String>` id **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reset<class_AnimationTreePlayer_method_reset>` **(** **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_method_timescale_node_get_scale>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_method_timescale_node_set_scale>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` scale **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_method_timeseek_node_seek>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` seconds **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_method_transition_node_delete_input>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transition_node_get_current<class_AnimationTreePlayer_method_transition_node_get_current>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_method_transition_node_get_input_count>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_method_transition_node_get_xfade_time>` **(** :ref:`String<class_String>` id **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_method_transition_node_has_input_auto_advance>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** const |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_method_transition_node_set_current>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_method_transition_node_set_input_auto_advance>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_method_transition_node_set_input_count>` **(** :ref:`String<class_String>` id, :ref:`int<class_int>` count **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_method_transition_node_set_xfade_time>` **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_AnimationTreePlayer_NodeType:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_OUTPUT:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_ANIMATION:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_ONESHOT:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_MIX:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_BLEND2:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_BLEND3:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_BLEND4:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_TIMESCALE:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_TIMESEEK:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_NODE_TRANSITION:
|
||||
|
||||
enum **NodeType**:
|
||||
|
||||
- **NODE_OUTPUT** = **0** --- Output node.
|
||||
@@ -177,6 +197,10 @@ enum **NodeType**:
|
||||
|
||||
.. _enum_AnimationTreePlayer_AnimationProcessMode:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_PHYSICS:
|
||||
|
||||
.. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_IDLE:
|
||||
|
||||
enum **AnimationProcessMode**:
|
||||
|
||||
- **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies.
|
||||
@@ -193,7 +217,7 @@ It takes :ref:`Animation<class_Animation>`\ s from an :ref:`AnimationPlayer<clas
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AnimationTreePlayer_active:
|
||||
.. _class_AnimationTreePlayer_property_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **active**
|
||||
|
||||
@@ -205,7 +229,7 @@ Property Descriptions
|
||||
|
||||
If ``true``, the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``.
|
||||
|
||||
.. _class_AnimationTreePlayer_base_path:
|
||||
.. _class_AnimationTreePlayer_property_base_path:
|
||||
|
||||
- :ref:`NodePath<class_NodePath>` **base_path**
|
||||
|
||||
@@ -219,7 +243,7 @@ The node from which to relatively access other nodes. Default value: ``".."``.
|
||||
|
||||
It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at.
|
||||
|
||||
.. _class_AnimationTreePlayer_master_player:
|
||||
.. _class_AnimationTreePlayer_property_master_player:
|
||||
|
||||
- :ref:`NodePath<class_NodePath>` **master_player**
|
||||
|
||||
@@ -233,7 +257,7 @@ The path to the :ref:`AnimationPlayer<class_AnimationPlayer>` from which this ``
|
||||
|
||||
Once set, Animation nodes can be added to the AnimationTreePlayer.
|
||||
|
||||
.. _class_AnimationTreePlayer_playback_process_mode:
|
||||
.. _class_AnimationTreePlayer_property_playback_process_mode:
|
||||
|
||||
- :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` **playback_process_mode**
|
||||
|
||||
@@ -248,65 +272,65 @@ The thread in which to update animations. Default value: ``ANIMATION_PROCESS_IDL
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AnimationTreePlayer_add_node:
|
||||
.. _class_AnimationTreePlayer_method_add_node:
|
||||
|
||||
- void **add_node** **(** :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` type, :ref:`String<class_String>` id **)**
|
||||
|
||||
Adds a ``type`` node to the graph with name ``id``.
|
||||
|
||||
.. _class_AnimationTreePlayer_advance:
|
||||
.. _class_AnimationTreePlayer_method_advance:
|
||||
|
||||
- void **advance** **(** :ref:`float<class_float>` delta **)**
|
||||
|
||||
Shifts position in the animation timeline. Delta is the time in seconds to shift.
|
||||
|
||||
.. _class_AnimationTreePlayer_animation_node_get_animation:
|
||||
.. _class_AnimationTreePlayer_method_animation_node_get_animation:
|
||||
|
||||
- :ref:`Animation<class_Animation>` **animation_node_get_animation** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the :ref:`AnimationPlayer<class_AnimationPlayer>`'s :ref:`Animation<class_Animation>` bound to the ``AnimationTreePlayer``'s animation node with name ``id``.
|
||||
|
||||
.. _class_AnimationTreePlayer_animation_node_get_master_animation:
|
||||
.. _class_AnimationTreePlayer_method_animation_node_get_master_animation:
|
||||
|
||||
- :ref:`String<class_String>` **animation_node_get_master_animation** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the name of the :ref:`master_player<class_AnimationTreePlayer_master_player>`'s :ref:`Animation<class_Animation>` bound to this animation node.
|
||||
Returns the name of the :ref:`master_player<class_AnimationTreePlayer_property_master_player>`'s :ref:`Animation<class_Animation>` bound to this animation node.
|
||||
|
||||
.. _class_AnimationTreePlayer_animation_node_get_position:
|
||||
.. _class_AnimationTreePlayer_method_animation_node_get_position:
|
||||
|
||||
- :ref:`float<class_float>` **animation_node_get_position** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
.. _class_AnimationTreePlayer_animation_node_set_animation:
|
||||
.. _class_AnimationTreePlayer_method_animation_node_set_animation:
|
||||
|
||||
- void **animation_node_set_animation** **(** :ref:`String<class_String>` id, :ref:`Animation<class_Animation>` animation **)**
|
||||
|
||||
Binds a new :ref:`Animation<class_Animation>` from the :ref:`master_player<class_AnimationTreePlayer_master_player>` to the ``AnimationTreePlayer``'s animation node with name ``id``.
|
||||
Binds a new :ref:`Animation<class_Animation>` from the :ref:`master_player<class_AnimationTreePlayer_property_master_player>` to the ``AnimationTreePlayer``'s animation node with name ``id``.
|
||||
|
||||
.. _class_AnimationTreePlayer_animation_node_set_filter_path:
|
||||
.. _class_AnimationTreePlayer_method_animation_node_set_filter_path:
|
||||
|
||||
- void **animation_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``enable`` is ``true``, the animation node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.
|
||||
|
||||
.. _class_AnimationTreePlayer_animation_node_set_master_animation:
|
||||
.. _class_AnimationTreePlayer_method_animation_node_set_master_animation:
|
||||
|
||||
- void **animation_node_set_master_animation** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` source **)**
|
||||
|
||||
Binds the :ref:`Animation<class_Animation>` named ``source`` from :ref:`master_player<class_AnimationTreePlayer_master_player>` to the animation node ``id``. Recalculates caches.
|
||||
Binds the :ref:`Animation<class_Animation>` named ``source`` from :ref:`master_player<class_AnimationTreePlayer_property_master_player>` to the animation node ``id``. Recalculates caches.
|
||||
|
||||
.. _class_AnimationTreePlayer_are_nodes_connected:
|
||||
.. _class_AnimationTreePlayer_method_are_nodes_connected:
|
||||
|
||||
- :ref:`bool<class_bool>` **are_nodes_connected** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const
|
||||
|
||||
Returns whether node ``id`` and ``dst_id`` are connected at the specified slot.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend2_node_get_amount:
|
||||
.. _class_AnimationTreePlayer_method_blend2_node_get_amount:
|
||||
|
||||
- :ref:`float<class_float>` **blend2_node_get_amount** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the blend amount of a Blend2 node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend2_node_set_amount:
|
||||
.. _class_AnimationTreePlayer_method_blend2_node_set_amount:
|
||||
|
||||
- void **blend2_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)**
|
||||
|
||||
@@ -320,19 +344,19 @@ Towards 1, the influence of a gets lessened, the influence of b gets raised.
|
||||
|
||||
At 1, Output is input b.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend2_node_set_filter_path:
|
||||
.. _class_AnimationTreePlayer_method_blend2_node_set_filter_path:
|
||||
|
||||
- void **blend2_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``enable`` is ``true``, the blend2 node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend3_node_get_amount:
|
||||
.. _class_AnimationTreePlayer_method_blend3_node_get_amount:
|
||||
|
||||
- :ref:`float<class_float>` **blend3_node_get_amount** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the blend amount of a Blend3 node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend3_node_set_amount:
|
||||
.. _class_AnimationTreePlayer_method_blend3_node_set_amount:
|
||||
|
||||
- void **blend3_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` blend **)**
|
||||
|
||||
@@ -350,13 +374,13 @@ From 0 to 1, the influence of a gets lessened, the influence of b+ gets raised a
|
||||
|
||||
At 1, Output is input b+.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend4_node_get_amount:
|
||||
.. _class_AnimationTreePlayer_method_blend4_node_get_amount:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **blend4_node_get_amount** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the blend amount of a Blend4 node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend4_node_set_amount:
|
||||
.. _class_AnimationTreePlayer_method_blend4_node_set_amount:
|
||||
|
||||
- void **blend4_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` blend **)**
|
||||
|
||||
@@ -366,31 +390,31 @@ A Blend4 Node blends two pairs of animations.
|
||||
|
||||
The two pairs are blended like blend2 and then added together.
|
||||
|
||||
.. _class_AnimationTreePlayer_connect_nodes:
|
||||
.. _class_AnimationTreePlayer_method_connect_nodes:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **connect_nodes** **(** :ref:`String<class_String>` id, :ref:`String<class_String>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
|
||||
|
||||
Connects node ``id`` to ``dst_id`` at the specified input slot.
|
||||
|
||||
.. _class_AnimationTreePlayer_disconnect_nodes:
|
||||
.. _class_AnimationTreePlayer_method_disconnect_nodes:
|
||||
|
||||
- void **disconnect_nodes** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` dst_input_idx **)**
|
||||
|
||||
Disconnects nodes connected to ``id`` at the specified input slot.
|
||||
|
||||
.. _class_AnimationTreePlayer_get_node_list:
|
||||
.. _class_AnimationTreePlayer_method_get_node_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_node_list** **(** **)**
|
||||
|
||||
Returns a :ref:`PoolStringArray<class_PoolStringArray>` containing the name of all nodes.
|
||||
|
||||
.. _class_AnimationTreePlayer_mix_node_get_amount:
|
||||
.. _class_AnimationTreePlayer_method_mix_node_get_amount:
|
||||
|
||||
- :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns mix amount of a Mix node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_mix_node_set_amount:
|
||||
.. _class_AnimationTreePlayer_method_mix_node_set_amount:
|
||||
|
||||
- void **mix_node_set_amount** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` ratio **)**
|
||||
|
||||
@@ -398,157 +422,157 @@ Sets mix amount of a Mix node given its name and value.
|
||||
|
||||
A Mix node adds input b to input a by a the amount given by ratio.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_exists:
|
||||
.. _class_AnimationTreePlayer_method_node_exists:
|
||||
|
||||
- :ref:`bool<class_bool>` **node_exists** **(** :ref:`String<class_String>` node **)** const
|
||||
|
||||
Check if a node exists (by name).
|
||||
|
||||
.. _class_AnimationTreePlayer_node_get_input_count:
|
||||
.. _class_AnimationTreePlayer_method_node_get_input_count:
|
||||
|
||||
- :ref:`int<class_int>` **node_get_input_count** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Return the input count for a given node. Different types of nodes have different amount of inputs.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_get_input_source:
|
||||
.. _class_AnimationTreePlayer_method_node_get_input_source:
|
||||
|
||||
- :ref:`String<class_String>` **node_get_input_source** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the input source for a given node input.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_get_position:
|
||||
.. _class_AnimationTreePlayer_method_node_get_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **node_get_position** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns position of a node in the graph given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_get_type:
|
||||
.. _class_AnimationTreePlayer_method_node_get_type:
|
||||
|
||||
- :ref:`NodeType<enum_AnimationTreePlayer_NodeType>` **node_get_type** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Get the node type, will return from NODE\_\* enum.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_rename:
|
||||
.. _class_AnimationTreePlayer_method_node_rename:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **node_rename** **(** :ref:`String<class_String>` node, :ref:`String<class_String>` new_name **)**
|
||||
|
||||
Rename a node in the graph.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_set_position:
|
||||
.. _class_AnimationTreePlayer_method_node_set_position:
|
||||
|
||||
- void **node_set_position** **(** :ref:`String<class_String>` id, :ref:`Vector2<class_Vector2>` screen_position **)**
|
||||
|
||||
Sets position of a node in the graph given its name and position.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_delay:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_delay:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_autorestart_delay** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns autostart delay of a OneShot node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns autostart random delay of a OneShot node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_get_fadein_time:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_get_fadein_time:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_fadein_time** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns fade in time of a OneShot node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_get_fadeout_time:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_fadeout_time** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns fade out time of a OneShot node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_has_autorestart:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_has_autorestart:
|
||||
|
||||
- :ref:`bool<class_bool>` **oneshot_node_has_autorestart** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns whether a OneShot node will auto restart given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_is_active:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_is_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **oneshot_node_is_active** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns whether a OneShot node is active given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_autorestart:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart:
|
||||
|
||||
- void **oneshot_node_set_autorestart** **(** :ref:`String<class_String>` id, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Sets autorestart property of a OneShot node given its name and value.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_autorestart_delay:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_delay:
|
||||
|
||||
- void **oneshot_node_set_autorestart_delay** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` delay_sec **)**
|
||||
|
||||
Sets autorestart delay of a OneShot node given its name and value in seconds.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_random_delay:
|
||||
|
||||
- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` rand_sec **)**
|
||||
|
||||
Sets autorestart random delay of a OneShot node given its name and value in seconds.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_fadein_time:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_fadein_time:
|
||||
|
||||
- void **oneshot_node_set_fadein_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**
|
||||
|
||||
Sets fade in time of a OneShot node given its name and value in seconds.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_fadeout_time:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_fadeout_time:
|
||||
|
||||
- void **oneshot_node_set_fadeout_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**
|
||||
|
||||
Sets fade out time of a OneShot node given its name and value in seconds.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_filter_path:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_set_filter_path:
|
||||
|
||||
- void **oneshot_node_set_filter_path** **(** :ref:`String<class_String>` id, :ref:`NodePath<class_NodePath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``enable`` is ``true``, the oneshot node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_start:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_start:
|
||||
|
||||
- void **oneshot_node_start** **(** :ref:`String<class_String>` id **)**
|
||||
|
||||
Starts a OneShot node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_stop:
|
||||
.. _class_AnimationTreePlayer_method_oneshot_node_stop:
|
||||
|
||||
- void **oneshot_node_stop** **(** :ref:`String<class_String>` id **)**
|
||||
|
||||
Stops the OneShot node with name ``id``.
|
||||
|
||||
.. _class_AnimationTreePlayer_recompute_caches:
|
||||
.. _class_AnimationTreePlayer_method_recompute_caches:
|
||||
|
||||
- void **recompute_caches** **(** **)**
|
||||
|
||||
Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state.
|
||||
|
||||
.. _class_AnimationTreePlayer_remove_node:
|
||||
.. _class_AnimationTreePlayer_method_remove_node:
|
||||
|
||||
- void **remove_node** **(** :ref:`String<class_String>` id **)**
|
||||
|
||||
Removes the animation node with name ``id``.
|
||||
|
||||
.. _class_AnimationTreePlayer_reset:
|
||||
.. _class_AnimationTreePlayer_method_reset:
|
||||
|
||||
- void **reset** **(** **)**
|
||||
|
||||
Resets this ``AnimationTreePlayer``.
|
||||
|
||||
.. _class_AnimationTreePlayer_timescale_node_get_scale:
|
||||
.. _class_AnimationTreePlayer_method_timescale_node_get_scale:
|
||||
|
||||
- :ref:`float<class_float>` **timescale_node_get_scale** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns time scale value of the TimeScale node with name ``id``.
|
||||
|
||||
.. _class_AnimationTreePlayer_timescale_node_set_scale:
|
||||
.. _class_AnimationTreePlayer_method_timescale_node_set_scale:
|
||||
|
||||
- void **timescale_node_set_scale** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` scale **)**
|
||||
|
||||
@@ -558,7 +582,7 @@ The timescale node is used to speed :ref:`Animation<class_Animation>`\ s up if t
|
||||
|
||||
If applied after a blend or mix, affects all input animations to that blend or mix.
|
||||
|
||||
.. _class_AnimationTreePlayer_timeseek_node_seek:
|
||||
.. _class_AnimationTreePlayer_method_timeseek_node_seek:
|
||||
|
||||
- void **timeseek_node_seek** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` seconds **)**
|
||||
|
||||
@@ -566,55 +590,55 @@ Sets the time seek value of the TimeSeek node with name ``id`` to ``seconds``
|
||||
|
||||
This functions as a seek in the :ref:`Animation<class_Animation>` or the blend or mix of :ref:`Animation<class_Animation>`\ s input in it.
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_delete_input:
|
||||
.. _class_AnimationTreePlayer_method_transition_node_delete_input:
|
||||
|
||||
- void **transition_node_delete_input** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)**
|
||||
|
||||
Deletes the input at ``input_idx`` for the transition node with name ``id``.
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_get_current:
|
||||
.. _class_AnimationTreePlayer_method_transition_node_get_current:
|
||||
|
||||
- :ref:`int<class_int>` **transition_node_get_current** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the index of the currently evaluated input for the transition node with name ``id``.
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_get_input_count:
|
||||
.. _class_AnimationTreePlayer_method_transition_node_get_input_count:
|
||||
|
||||
- :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the number of inputs for the transition node with name ``id``. You can add inputs by rightclicking on the transition node.
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_get_xfade_time:
|
||||
.. _class_AnimationTreePlayer_method_transition_node_get_xfade_time:
|
||||
|
||||
- :ref:`float<class_float>` **transition_node_get_xfade_time** **(** :ref:`String<class_String>` id **)** const
|
||||
|
||||
Returns the cross fade time for the transition node with name ``id``.
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_has_input_auto_advance:
|
||||
.. _class_AnimationTreePlayer_method_transition_node_has_input_auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **transition_node_has_input_auto_advance** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)** const
|
||||
|
||||
Returns ``true`` if the input at ``input_idx`` on transition node with name ``id`` is set to automatically advance to the next input upon completion.
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_set_current:
|
||||
.. _class_AnimationTreePlayer_method_transition_node_set_current:
|
||||
|
||||
- void **transition_node_set_current** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx **)**
|
||||
|
||||
The transition node with name ``id`` sets its current input at ``input_idx``.
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_set_input_auto_advance:
|
||||
.. _class_AnimationTreePlayer_method_transition_node_set_input_auto_advance:
|
||||
|
||||
- void **transition_node_set_input_auto_advance** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
The transition node with name ``id`` advances to its next input automatically when the input at ``input_idx`` completes.
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_set_input_count:
|
||||
.. _class_AnimationTreePlayer_method_transition_node_set_input_count:
|
||||
|
||||
- void **transition_node_set_input_count** **(** :ref:`String<class_String>` id, :ref:`int<class_int>` count **)**
|
||||
|
||||
Resizes the number of inputs available for the transition node with name ``id``.
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_set_xfade_time:
|
||||
.. _class_AnimationTreePlayer_method_transition_node_set_xfade_time:
|
||||
|
||||
- void **transition_node_set_xfade_time** **(** :ref:`String<class_String>` id, :ref:`float<class_float>` time_sec **)**
|
||||
|
||||
|
||||
@@ -19,111 +19,111 @@ General purpose area node for detection and 3D physics influence.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area_angular_damp>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area_audio_bus_name>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area_audio_bus_override>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_layer<class_Area_collision_layer>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_Area_collision_mask>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity<class_Area_gravity>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area_gravity_distance_scale>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area_gravity_point>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`gravity_vec<class_Area_gravity_vec>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_damp<class_Area_linear_damp>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area_monitorable>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area_monitoring>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`priority<class_Area_priority>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`reverb_bus_amount<class_Area_reverb_bus_amount>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`reverb_bus_enable<class_Area_reverb_bus_enable>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`reverb_bus_name<class_Area_reverb_bus_name>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`reverb_bus_uniformity<class_Area_reverb_bus_uniformity>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`SpaceOverride<enum_Area_SpaceOverride>` | :ref:`space_override<class_Area_space_override>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area_property_angular_damp>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area_property_audio_bus_name>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area_property_audio_bus_override>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_layer<class_Area_property_collision_layer>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_Area_property_collision_mask>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity<class_Area_property_gravity>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area_property_gravity_distance_scale>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area_property_gravity_point>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`gravity_vec<class_Area_property_gravity_vec>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_damp<class_Area_property_linear_damp>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area_property_monitorable>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area_property_monitoring>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`priority<class_Area_property_priority>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`reverb_bus_amount<class_Area_property_reverb_bus_amount>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`reverb_bus_enable<class_Area_property_reverb_bus_enable>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`reverb_bus_name<class_Area_property_reverb_bus_name>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`reverb_bus_uniformity<class_Area_property_reverb_bus_uniformity>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`SpaceOverride<enum_Area_SpaceOverride>` | :ref:`space_override<class_Area_property_space_override>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_overlapping_areas<class_Area_get_overlapping_areas>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_overlapping_bodies<class_Area_get_overlapping_bodies>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area_overlaps_area>` **(** :ref:`Node<class_Node>` area **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area_overlaps_body>` **(** :ref:`Node<class_Node>` body **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer_bit<class_Area_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area_method_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area_method_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_overlapping_areas<class_Area_method_get_overlapping_areas>` **(** **)** const |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_overlapping_bodies<class_Area_method_get_overlapping_bodies>` **(** **)** const |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area_method_overlaps_area>` **(** :ref:`Node<class_Node>` area **)** const |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area_method_overlaps_body>` **(** :ref:`Node<class_Node>` body **)** const |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer_bit<class_Area_method_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area_method_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_Area_area_entered:
|
||||
.. _class_Area_signal_area_entered:
|
||||
|
||||
- **area_entered** **(** :ref:`Area<class_Area>` area **)**
|
||||
|
||||
Emitted when another area enters.
|
||||
|
||||
.. _class_Area_area_exited:
|
||||
.. _class_Area_signal_area_exited:
|
||||
|
||||
- **area_exited** **(** :ref:`Area<class_Area>` area **)**
|
||||
|
||||
Emitted when another area exits.
|
||||
|
||||
.. _class_Area_area_shape_entered:
|
||||
.. _class_Area_signal_area_shape_entered:
|
||||
|
||||
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Area<class_Area>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
|
||||
Emitted when another area enters, reporting which areas overlapped.
|
||||
|
||||
.. _class_Area_area_shape_exited:
|
||||
.. _class_Area_signal_area_shape_exited:
|
||||
|
||||
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Area<class_Area>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
|
||||
Emitted when another area exits, reporting which areas were overlapping.
|
||||
|
||||
.. _class_Area_body_entered:
|
||||
.. _class_Area_signal_body_entered:
|
||||
|
||||
- **body_entered** **(** :ref:`Node<class_Node>` body **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody<class_PhysicsBody>` object enters.
|
||||
|
||||
.. _class_Area_body_exited:
|
||||
.. _class_Area_signal_body_exited:
|
||||
|
||||
- **body_exited** **(** :ref:`Node<class_Node>` body **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody<class_PhysicsBody>` object exits.
|
||||
|
||||
.. _class_Area_body_shape_entered:
|
||||
.. _class_Area_signal_body_shape_entered:
|
||||
|
||||
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody<class_PhysicsBody>` object enters, reporting which shapes overlapped.
|
||||
|
||||
.. _class_Area_body_shape_exited:
|
||||
.. _class_Area_signal_body_shape_exited:
|
||||
|
||||
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
|
||||
@@ -134,17 +134,27 @@ Enumerations
|
||||
|
||||
.. _enum_Area_SpaceOverride:
|
||||
|
||||
.. _class_Area_constant_SPACE_OVERRIDE_DISABLED:
|
||||
|
||||
.. _class_Area_constant_SPACE_OVERRIDE_COMBINE:
|
||||
|
||||
.. _class_Area_constant_SPACE_OVERRIDE_COMBINE_REPLACE:
|
||||
|
||||
.. _class_Area_constant_SPACE_OVERRIDE_REPLACE:
|
||||
|
||||
.. _class_Area_constant_SPACE_OVERRIDE_REPLACE_COMBINE:
|
||||
|
||||
enum **SpaceOverride**:
|
||||
|
||||
- **SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damping.
|
||||
|
||||
- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority<class_Area_priority>` order).
|
||||
- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority<class_Area_property_priority>` order).
|
||||
|
||||
- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority<class_Area_priority>` order), ignoring any lower priority areas.
|
||||
- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority<class_Area_property_priority>` order), ignoring any lower priority areas.
|
||||
|
||||
- **SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.
|
||||
|
||||
- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in :ref:`priority<class_Area_priority>` order), but keeps calculating the rest of the areas.
|
||||
- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in :ref:`priority<class_Area_property_priority>` order), but keeps calculating the rest of the areas.
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -154,7 +164,7 @@ Description
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Area_angular_damp:
|
||||
.. _class_Area_property_angular_damp:
|
||||
|
||||
- :ref:`float<class_float>` **angular_damp**
|
||||
|
||||
@@ -166,7 +176,7 @@ Property Descriptions
|
||||
|
||||
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
|
||||
|
||||
.. _class_Area_audio_bus_name:
|
||||
.. _class_Area_property_audio_bus_name:
|
||||
|
||||
- :ref:`String<class_String>` **audio_bus_name**
|
||||
|
||||
@@ -178,7 +188,7 @@ The rate at which objects stop spinning in this area. Represents the angular vel
|
||||
|
||||
The name of the area's audio bus.
|
||||
|
||||
.. _class_Area_audio_bus_override:
|
||||
.. _class_Area_property_audio_bus_override:
|
||||
|
||||
- :ref:`bool<class_bool>` **audio_bus_override**
|
||||
|
||||
@@ -190,7 +200,7 @@ The name of the area's audio bus.
|
||||
|
||||
If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``.
|
||||
|
||||
.. _class_Area_collision_layer:
|
||||
.. _class_Area_property_collision_layer:
|
||||
|
||||
- :ref:`int<class_int>` **collision_layer**
|
||||
|
||||
@@ -200,9 +210,9 @@ If ``true``, the area's audio bus overrides the default audio bus. Default value
|
||||
| *Getter* | get_collision_layer() |
|
||||
+----------+----------------------------+
|
||||
|
||||
The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask<class_Area_collision_mask>`.
|
||||
The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask<class_Area_property_collision_mask>`.
|
||||
|
||||
.. _class_Area_collision_mask:
|
||||
.. _class_Area_property_collision_mask:
|
||||
|
||||
- :ref:`int<class_int>` **collision_mask**
|
||||
|
||||
@@ -214,7 +224,7 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different
|
||||
|
||||
The physics layers this area scans to determine collision detection.
|
||||
|
||||
.. _class_Area_gravity:
|
||||
.. _class_Area_property_gravity:
|
||||
|
||||
- :ref:`float<class_float>` **gravity**
|
||||
|
||||
@@ -226,7 +236,7 @@ The physics layers this area scans to determine collision detection.
|
||||
|
||||
The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
|
||||
|
||||
.. _class_Area_gravity_distance_scale:
|
||||
.. _class_Area_property_gravity_distance_scale:
|
||||
|
||||
- :ref:`float<class_float>` **gravity_distance_scale**
|
||||
|
||||
@@ -238,7 +248,7 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies
|
||||
|
||||
The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
|
||||
|
||||
.. _class_Area_gravity_point:
|
||||
.. _class_Area_property_gravity_point:
|
||||
|
||||
- :ref:`bool<class_bool>` **gravity_point**
|
||||
|
||||
@@ -248,9 +258,9 @@ The falloff factor for point gravity. The greater the value, the faster gravity
|
||||
| *Getter* | is_gravity_a_point() |
|
||||
+----------+-----------------------------+
|
||||
|
||||
If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area_gravity_vec>`). Also see :ref:`space_override<class_Area_space_override>`. Default value: ``false``.
|
||||
If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area_property_gravity_vec>`). Also see :ref:`space_override<class_Area_property_space_override>`. Default value: ``false``.
|
||||
|
||||
.. _class_Area_gravity_vec:
|
||||
.. _class_Area_property_gravity_vec:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **gravity_vec**
|
||||
|
||||
@@ -260,9 +270,9 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class
|
||||
| *Getter* | get_gravity_vector() |
|
||||
+----------+---------------------------+
|
||||
|
||||
The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area_gravity_point>`), this will be the point of attraction.
|
||||
The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area_property_gravity_point>`), this will be the point of attraction.
|
||||
|
||||
.. _class_Area_linear_damp:
|
||||
.. _class_Area_property_linear_damp:
|
||||
|
||||
- :ref:`float<class_float>` **linear_damp**
|
||||
|
||||
@@ -274,7 +284,7 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra
|
||||
|
||||
The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
|
||||
|
||||
.. _class_Area_monitorable:
|
||||
.. _class_Area_property_monitorable:
|
||||
|
||||
- :ref:`bool<class_bool>` **monitorable**
|
||||
|
||||
@@ -286,7 +296,7 @@ The rate at which objects stop moving in this area. Represents the linear veloci
|
||||
|
||||
If ``true``, other monitoring areas can detect this area. Default value: ``true``.
|
||||
|
||||
.. _class_Area_monitoring:
|
||||
.. _class_Area_property_monitoring:
|
||||
|
||||
- :ref:`bool<class_bool>` **monitoring**
|
||||
|
||||
@@ -298,7 +308,7 @@ If ``true``, other monitoring areas can detect this area. Default value: ``true`
|
||||
|
||||
If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``.
|
||||
|
||||
.. _class_Area_priority:
|
||||
.. _class_Area_property_priority:
|
||||
|
||||
- :ref:`float<class_float>` **priority**
|
||||
|
||||
@@ -310,7 +320,7 @@ If ``true``, the area detects bodies or areas entering and exiting it. Default v
|
||||
|
||||
The area's priority. Higher priority areas are processed first. Default value: 0.
|
||||
|
||||
.. _class_Area_reverb_bus_amount:
|
||||
.. _class_Area_property_reverb_bus_amount:
|
||||
|
||||
- :ref:`float<class_float>` **reverb_bus_amount**
|
||||
|
||||
@@ -322,7 +332,7 @@ The area's priority. Higher priority areas are processed first. Default value: 0
|
||||
|
||||
The degree to which this area applies reverb to its associated audio. Ranges from ``0`` to ``1`` with ``0.1`` precision.
|
||||
|
||||
.. _class_Area_reverb_bus_enable:
|
||||
.. _class_Area_property_reverb_bus_enable:
|
||||
|
||||
- :ref:`bool<class_bool>` **reverb_bus_enable**
|
||||
|
||||
@@ -334,7 +344,7 @@ The degree to which this area applies reverb to its associated audio. Ranges fro
|
||||
|
||||
If ``true``, the area applies reverb to its associated audio.
|
||||
|
||||
.. _class_Area_reverb_bus_name:
|
||||
.. _class_Area_property_reverb_bus_name:
|
||||
|
||||
- :ref:`String<class_String>` **reverb_bus_name**
|
||||
|
||||
@@ -346,7 +356,7 @@ If ``true``, the area applies reverb to its associated audio.
|
||||
|
||||
The reverb bus name to use for this area's associated audio.
|
||||
|
||||
.. _class_Area_reverb_bus_uniformity:
|
||||
.. _class_Area_property_reverb_bus_uniformity:
|
||||
|
||||
- :ref:`float<class_float>` **reverb_bus_uniformity**
|
||||
|
||||
@@ -358,7 +368,7 @@ The reverb bus name to use for this area's associated audio.
|
||||
|
||||
The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to ``1`` with ``0.1`` precision.
|
||||
|
||||
.. _class_Area_space_override:
|
||||
.. _class_Area_property_space_override:
|
||||
|
||||
- :ref:`SpaceOverride<enum_Area_SpaceOverride>` **space_override**
|
||||
|
||||
@@ -373,49 +383,49 @@ Override mode for gravity and damping calculations within this area. See :ref:`S
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Area_get_collision_layer_bit:
|
||||
.. _class_Area_method_get_collision_layer_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Returns an individual bit on the layer mask.
|
||||
|
||||
.. _class_Area_get_collision_mask_bit:
|
||||
.. _class_Area_method_get_collision_mask_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Returns an individual bit on the collision mask.
|
||||
|
||||
.. _class_Area_get_overlapping_areas:
|
||||
.. _class_Area_method_get_overlapping_areas:
|
||||
|
||||
- :ref:`Array<class_Array>` **get_overlapping_areas** **(** **)** const
|
||||
|
||||
Returns a list of intersecting ``Area``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
|
||||
|
||||
.. _class_Area_get_overlapping_bodies:
|
||||
.. _class_Area_method_get_overlapping_bodies:
|
||||
|
||||
- :ref:`Array<class_Array>` **get_overlapping_bodies** **(** **)** const
|
||||
|
||||
Returns a list of intersecting :ref:`PhysicsBody<class_PhysicsBody>`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
|
||||
|
||||
.. _class_Area_overlaps_area:
|
||||
.. _class_Area_method_overlaps_area:
|
||||
|
||||
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_Node>` area **)** const
|
||||
|
||||
If ``true``, the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
|
||||
|
||||
.. _class_Area_overlaps_body:
|
||||
.. _class_Area_method_overlaps_body:
|
||||
|
||||
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_Node>` body **)** const
|
||||
|
||||
If ``true``, the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
|
||||
|
||||
.. _class_Area_set_collision_layer_bit:
|
||||
.. _class_Area_method_set_collision_layer_bit:
|
||||
|
||||
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
Set/clear individual bits on the layer mask. This simplifies editing this ``Area[code]'s layers.
|
||||
|
||||
.. _class_Area_set_collision_mask_bit:
|
||||
.. _class_Area_method_set_collision_mask_bit:
|
||||
|
||||
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
|
||||
@@ -19,103 +19,103 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area2D_angular_damp>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area2D_audio_bus_name>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area2D_audio_bus_override>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_layer<class_Area2D_collision_layer>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_Area2D_collision_mask>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity<class_Area2D_gravity>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area2D_gravity_distance_scale>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area2D_gravity_point>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`gravity_vec<class_Area2D_gravity_vec>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_damp<class_Area2D_linear_damp>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area2D_monitorable>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area2D_monitoring>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`priority<class_Area2D_priority>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` | :ref:`space_override<class_Area2D_space_override>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area2D_property_angular_damp>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area2D_property_audio_bus_name>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area2D_property_audio_bus_override>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_layer<class_Area2D_property_collision_layer>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_Area2D_property_collision_mask>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity<class_Area2D_property_gravity>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area2D_property_gravity_distance_scale>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area2D_property_gravity_point>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`gravity_vec<class_Area2D_property_gravity_vec>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_damp<class_Area2D_property_linear_damp>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area2D_property_monitorable>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area2D_property_monitoring>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`priority<class_Area2D_property_priority>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` | :ref:`space_override<class_Area2D_property_space_override>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area2D_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area2D_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_overlapping_areas<class_Area2D_get_overlapping_areas>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_overlapping_bodies<class_Area2D_get_overlapping_bodies>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area2D_overlaps_area>` **(** :ref:`Node<class_Node>` area **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area2D_overlaps_body>` **(** :ref:`Node<class_Node>` body **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer_bit<class_Area2D_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area2D_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area2D_method_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area2D_method_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_overlapping_areas<class_Area2D_method_get_overlapping_areas>` **(** **)** const |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_overlapping_bodies<class_Area2D_method_get_overlapping_bodies>` **(** **)** const |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area2D_method_overlaps_area>` **(** :ref:`Node<class_Node>` area **)** const |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area2D_method_overlaps_body>` **(** :ref:`Node<class_Node>` body **)** const |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer_bit<class_Area2D_method_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area2D_method_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_Area2D_area_entered:
|
||||
.. _class_Area2D_signal_area_entered:
|
||||
|
||||
- **area_entered** **(** :ref:`Area2D<class_Area2D>` area **)**
|
||||
|
||||
Emitted when another area enters.
|
||||
|
||||
.. _class_Area2D_area_exited:
|
||||
.. _class_Area2D_signal_area_exited:
|
||||
|
||||
- **area_exited** **(** :ref:`Area2D<class_Area2D>` area **)**
|
||||
|
||||
Emitted when another area exits.
|
||||
|
||||
.. _class_Area2D_area_shape_entered:
|
||||
.. _class_Area2D_signal_area_shape_entered:
|
||||
|
||||
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Area2D<class_Area2D>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
|
||||
Emitted when another area enters, reporting which shapes overlapped.
|
||||
|
||||
.. _class_Area2D_area_shape_exited:
|
||||
.. _class_Area2D_signal_area_shape_exited:
|
||||
|
||||
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Area2D<class_Area2D>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
|
||||
Emitted when another area exits, reporting which shapes were overlapping.
|
||||
|
||||
.. _class_Area2D_body_entered:
|
||||
.. _class_Area2D_signal_body_entered:
|
||||
|
||||
- **body_entered** **(** :ref:`PhysicsBody2D<class_PhysicsBody2D>` body **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody2D<class_PhysicsBody2D>` object enters.
|
||||
|
||||
.. _class_Area2D_body_exited:
|
||||
.. _class_Area2D_signal_body_exited:
|
||||
|
||||
- **body_exited** **(** :ref:`PhysicsBody2D<class_PhysicsBody2D>` body **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody2D<class_PhysicsBody2D>` object exits.
|
||||
|
||||
.. _class_Area2D_body_shape_entered:
|
||||
.. _class_Area2D_signal_body_shape_entered:
|
||||
|
||||
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`PhysicsBody2D<class_PhysicsBody2D>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody2D<class_PhysicsBody2D>` object enters, reporting which shapes overlapped.
|
||||
|
||||
.. _class_Area2D_body_shape_exited:
|
||||
.. _class_Area2D_signal_body_shape_exited:
|
||||
|
||||
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`PhysicsBody2D<class_PhysicsBody2D>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
|
||||
@@ -126,17 +126,27 @@ Enumerations
|
||||
|
||||
.. _enum_Area2D_SpaceOverride:
|
||||
|
||||
.. _class_Area2D_constant_SPACE_OVERRIDE_DISABLED:
|
||||
|
||||
.. _class_Area2D_constant_SPACE_OVERRIDE_COMBINE:
|
||||
|
||||
.. _class_Area2D_constant_SPACE_OVERRIDE_COMBINE_REPLACE:
|
||||
|
||||
.. _class_Area2D_constant_SPACE_OVERRIDE_REPLACE:
|
||||
|
||||
.. _class_Area2D_constant_SPACE_OVERRIDE_REPLACE_COMBINE:
|
||||
|
||||
enum **SpaceOverride**:
|
||||
|
||||
- **SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damping.
|
||||
|
||||
- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority<class_Area2D_priority>` order).
|
||||
- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority<class_Area2D_property_priority>` order).
|
||||
|
||||
- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority<class_Area2D_priority>` order), ignoring any lower priority areas.
|
||||
- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority<class_Area2D_property_priority>` order), ignoring any lower priority areas.
|
||||
|
||||
- **SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.
|
||||
|
||||
- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in :ref:`priority<class_Area2D_priority>` order), but keeps calculating the rest of the areas.
|
||||
- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in :ref:`priority<class_Area2D_property_priority>` order), but keeps calculating the rest of the areas.
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -146,7 +156,7 @@ Description
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Area2D_angular_damp:
|
||||
.. _class_Area2D_property_angular_damp:
|
||||
|
||||
- :ref:`float<class_float>` **angular_damp**
|
||||
|
||||
@@ -158,7 +168,7 @@ Property Descriptions
|
||||
|
||||
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
|
||||
|
||||
.. _class_Area2D_audio_bus_name:
|
||||
.. _class_Area2D_property_audio_bus_name:
|
||||
|
||||
- :ref:`String<class_String>` **audio_bus_name**
|
||||
|
||||
@@ -170,7 +180,7 @@ The rate at which objects stop spinning in this area. Represents the angular vel
|
||||
|
||||
The name of the area's audio bus.
|
||||
|
||||
.. _class_Area2D_audio_bus_override:
|
||||
.. _class_Area2D_property_audio_bus_override:
|
||||
|
||||
- :ref:`bool<class_bool>` **audio_bus_override**
|
||||
|
||||
@@ -182,7 +192,7 @@ The name of the area's audio bus.
|
||||
|
||||
If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``.
|
||||
|
||||
.. _class_Area2D_collision_layer:
|
||||
.. _class_Area2D_property_collision_layer:
|
||||
|
||||
- :ref:`int<class_int>` **collision_layer**
|
||||
|
||||
@@ -192,9 +202,9 @@ If ``true``, the area's audio bus overrides the default audio bus. Default value
|
||||
| *Getter* | get_collision_layer() |
|
||||
+----------+----------------------------+
|
||||
|
||||
The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask<class_Area2D_collision_mask>`.
|
||||
The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask<class_Area2D_property_collision_mask>`.
|
||||
|
||||
.. _class_Area2D_collision_mask:
|
||||
.. _class_Area2D_property_collision_mask:
|
||||
|
||||
- :ref:`int<class_int>` **collision_mask**
|
||||
|
||||
@@ -206,7 +216,7 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different
|
||||
|
||||
The physics layers this area scans to determine collision detection.
|
||||
|
||||
.. _class_Area2D_gravity:
|
||||
.. _class_Area2D_property_gravity:
|
||||
|
||||
- :ref:`float<class_float>` **gravity**
|
||||
|
||||
@@ -218,7 +228,7 @@ The physics layers this area scans to determine collision detection.
|
||||
|
||||
The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
|
||||
|
||||
.. _class_Area2D_gravity_distance_scale:
|
||||
.. _class_Area2D_property_gravity_distance_scale:
|
||||
|
||||
- :ref:`float<class_float>` **gravity_distance_scale**
|
||||
|
||||
@@ -230,7 +240,7 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies
|
||||
|
||||
The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
|
||||
|
||||
.. _class_Area2D_gravity_point:
|
||||
.. _class_Area2D_property_gravity_point:
|
||||
|
||||
- :ref:`bool<class_bool>` **gravity_point**
|
||||
|
||||
@@ -240,9 +250,9 @@ The falloff factor for point gravity. The greater the value, the faster gravity
|
||||
| *Getter* | is_gravity_a_point() |
|
||||
+----------+-----------------------------+
|
||||
|
||||
If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area2D_gravity_vec>`). Also see :ref:`space_override<class_Area2D_space_override>`. Default value: ``false``.
|
||||
If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area2D_property_gravity_vec>`). Also see :ref:`space_override<class_Area2D_property_space_override>`. Default value: ``false``.
|
||||
|
||||
.. _class_Area2D_gravity_vec:
|
||||
.. _class_Area2D_property_gravity_vec:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **gravity_vec**
|
||||
|
||||
@@ -252,9 +262,9 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class
|
||||
| *Getter* | get_gravity_vector() |
|
||||
+----------+---------------------------+
|
||||
|
||||
The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area2D_gravity_point>`), this will be the point of attraction.
|
||||
The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area2D_property_gravity_point>`), this will be the point of attraction.
|
||||
|
||||
.. _class_Area2D_linear_damp:
|
||||
.. _class_Area2D_property_linear_damp:
|
||||
|
||||
- :ref:`float<class_float>` **linear_damp**
|
||||
|
||||
@@ -266,7 +276,7 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra
|
||||
|
||||
The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
|
||||
|
||||
.. _class_Area2D_monitorable:
|
||||
.. _class_Area2D_property_monitorable:
|
||||
|
||||
- :ref:`bool<class_bool>` **monitorable**
|
||||
|
||||
@@ -278,7 +288,7 @@ The rate at which objects stop moving in this area. Represents the linear veloci
|
||||
|
||||
If ``true``, other monitoring areas can detect this area. Default value: ``true``.
|
||||
|
||||
.. _class_Area2D_monitoring:
|
||||
.. _class_Area2D_property_monitoring:
|
||||
|
||||
- :ref:`bool<class_bool>` **monitoring**
|
||||
|
||||
@@ -290,7 +300,7 @@ If ``true``, other monitoring areas can detect this area. Default value: ``true`
|
||||
|
||||
If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``.
|
||||
|
||||
.. _class_Area2D_priority:
|
||||
.. _class_Area2D_property_priority:
|
||||
|
||||
- :ref:`float<class_float>` **priority**
|
||||
|
||||
@@ -302,7 +312,7 @@ If ``true``, the area detects bodies or areas entering and exiting it. Default v
|
||||
|
||||
The area's priority. Higher priority areas are processed first. Default value: 0.
|
||||
|
||||
.. _class_Area2D_space_override:
|
||||
.. _class_Area2D_property_space_override:
|
||||
|
||||
- :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` **space_override**
|
||||
|
||||
@@ -317,49 +327,49 @@ Override mode for gravity and damping calculations within this area. See :ref:`S
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Area2D_get_collision_layer_bit:
|
||||
.. _class_Area2D_method_get_collision_layer_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer.
|
||||
|
||||
.. _class_Area2D_get_collision_mask_bit:
|
||||
.. _class_Area2D_method_get_collision_mask_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer.
|
||||
|
||||
.. _class_Area2D_get_overlapping_areas:
|
||||
.. _class_Area2D_method_get_overlapping_areas:
|
||||
|
||||
- :ref:`Array<class_Array>` **get_overlapping_areas** **(** **)** const
|
||||
|
||||
Returns a list of intersecting ``Area2D``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
|
||||
|
||||
.. _class_Area2D_get_overlapping_bodies:
|
||||
.. _class_Area2D_method_get_overlapping_bodies:
|
||||
|
||||
- :ref:`Array<class_Array>` **get_overlapping_bodies** **(** **)** const
|
||||
|
||||
Returns a list of intersecting :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
|
||||
|
||||
.. _class_Area2D_overlaps_area:
|
||||
.. _class_Area2D_method_overlaps_area:
|
||||
|
||||
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_Node>` area **)** const
|
||||
|
||||
If ``true``, the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
|
||||
|
||||
.. _class_Area2D_overlaps_body:
|
||||
.. _class_Area2D_method_overlaps_body:
|
||||
|
||||
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_Node>` body **)** const
|
||||
|
||||
If ``true``, the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
|
||||
|
||||
.. _class_Area2D_set_collision_layer_bit:
|
||||
.. _class_Area2D_method_set_collision_layer_bit:
|
||||
|
||||
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
|
||||
|
||||
.. _class_Area2D_set_collision_mask_bit:
|
||||
.. _class_Area2D_method_set_collision_mask_bit:
|
||||
|
||||
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
|
||||
@@ -17,79 +17,79 @@ Generic array datatype.
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolColorArray<class_PoolColorArray>` from **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` from **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` from **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolStringArray<class_PoolStringArray>` from **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolRealArray<class_PoolRealArray>` from **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolIntArray<class_PoolIntArray>` from **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolByteArray<class_PoolByteArray>` from **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`append<class_Array_append>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`back<class_Array_back>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bsearch<class_Array_bsearch>` **(** :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` before=True **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bsearch_custom<class_Array_bsearch_custom>` **(** :ref:`Variant<class_Variant>` value, :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func, :ref:`bool<class_bool>` before=True **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Array_clear>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`count<class_Array_count>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`duplicate<class_Array_duplicate>` **(** :ref:`bool<class_bool>` deep=False **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`empty<class_Array_empty>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase<class_Array_erase>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find<class_Array_find>` **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=0 **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_last<class_Array_find_last>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`front<class_Array_front>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has<class_Array_has>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hash<class_Array_hash>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`insert<class_Array_insert>` **(** :ref:`int<class_int>` position, :ref:`Variant<class_Variant>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`invert<class_Array_invert>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`max<class_Array_max>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`min<class_Array_min>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`pop_back<class_Array_pop_back>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`pop_front<class_Array_pop_front>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_back<class_Array_push_back>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_front<class_Array_push_front>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove<class_Array_remove>` **(** :ref:`int<class_int>` position **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resize<class_Array_resize>` **(** :ref:`int<class_int>` size **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`rfind<class_Array_rfind>` **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=-1 **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shuffle<class_Array_shuffle>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_Array_size>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort<class_Array_sort>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort_custom<class_Array_sort_custom>` **(** :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolColorArray<class_PoolColorArray>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolStringArray<class_PoolStringArray>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolRealArray<class_PoolRealArray>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolIntArray<class_PoolIntArray>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`Array<class_Array_method_Array>` **(** :ref:`PoolByteArray<class_PoolByteArray>` from **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`append<class_Array_method_append>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`back<class_Array_method_back>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bsearch<class_Array_method_bsearch>` **(** :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` before=True **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bsearch_custom<class_Array_method_bsearch_custom>` **(** :ref:`Variant<class_Variant>` value, :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func, :ref:`bool<class_bool>` before=True **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Array_method_clear>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`count<class_Array_method_count>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`duplicate<class_Array_method_duplicate>` **(** :ref:`bool<class_bool>` deep=False **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`empty<class_Array_method_empty>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase<class_Array_method_erase>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find<class_Array_method_find>` **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=0 **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_last<class_Array_method_find_last>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`front<class_Array_method_front>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has<class_Array_method_has>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hash<class_Array_method_hash>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`insert<class_Array_method_insert>` **(** :ref:`int<class_int>` position, :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`invert<class_Array_method_invert>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`max<class_Array_method_max>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`min<class_Array_method_min>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`pop_back<class_Array_method_pop_back>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`pop_front<class_Array_method_pop_front>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_back<class_Array_method_push_back>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_front<class_Array_method_push_front>` **(** :ref:`Variant<class_Variant>` value **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove<class_Array_method_remove>` **(** :ref:`int<class_int>` position **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resize<class_Array_method_resize>` **(** :ref:`int<class_int>` size **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`rfind<class_Array_method_rfind>` **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=-1 **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shuffle<class_Array_method_shuffle>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_Array_method_size>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort<class_Array_method_sort>` **(** **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort_custom<class_Array_method_sort_custom>` **(** :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -110,85 +110,73 @@ Arrays are always passed by reference.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Array_Array:
|
||||
.. _class_Array_method_Array:
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolColorArray<class_PoolColorArray>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolColorArray<class_PoolColorArray>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolVector3Array<class_PoolVector3Array>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolVector2Array<class_PoolVector2Array>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolStringArray<class_PoolStringArray>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolStringArray<class_PoolStringArray>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolRealArray<class_PoolRealArray>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolRealArray<class_PoolRealArray>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolIntArray<class_PoolIntArray>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolIntArray<class_PoolIntArray>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_Array>` **Array** **(** :ref:`PoolByteArray<class_PoolByteArray>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolByteArray<class_PoolByteArray>`.
|
||||
|
||||
.. _class_Array_append:
|
||||
.. _class_Array_method_append:
|
||||
|
||||
- void **append** **(** :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Append an element at the end of the array (alias of :ref:`push_back<class_Array_push_back>`).
|
||||
Append an element at the end of the array (alias of :ref:`push_back<class_Array_method_push_back>`).
|
||||
|
||||
.. _class_Array_back:
|
||||
.. _class_Array_method_back:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **back** **(** **)**
|
||||
|
||||
Returns the last element of the array if the array is not empty (size>0).
|
||||
|
||||
.. _class_Array_bsearch:
|
||||
.. _class_Array_method_bsearch:
|
||||
|
||||
- :ref:`int<class_int>` **bsearch** **(** :ref:`Variant<class_Variant>` value, :ref:`bool<class_bool>` before=True **)**
|
||||
|
||||
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior.
|
||||
|
||||
.. _class_Array_bsearch_custom:
|
||||
.. _class_Array_method_bsearch_custom:
|
||||
|
||||
- :ref:`int<class_int>` **bsearch_custom** **(** :ref:`Variant<class_Variant>` value, :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func, :ref:`bool<class_bool>` before=True **)**
|
||||
|
||||
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior.
|
||||
|
||||
.. _class_Array_clear:
|
||||
.. _class_Array_method_clear:
|
||||
|
||||
- void **clear** **(** **)**
|
||||
|
||||
Clear the array (resize to 0).
|
||||
|
||||
.. _class_Array_count:
|
||||
.. _class_Array_method_count:
|
||||
|
||||
- :ref:`int<class_int>` **count** **(** :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Return the amount of times an element is in the array.
|
||||
|
||||
.. _class_Array_duplicate:
|
||||
.. _class_Array_method_duplicate:
|
||||
|
||||
- :ref:`Array<class_Array>` **duplicate** **(** :ref:`bool<class_bool>` deep=False **)**
|
||||
|
||||
@@ -196,37 +184,37 @@ Returns a copy of the array.
|
||||
|
||||
If ``deep`` is ``true``, a deep copy is be performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If ``false``, a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array.
|
||||
|
||||
.. _class_Array_empty:
|
||||
.. _class_Array_method_empty:
|
||||
|
||||
- :ref:`bool<class_bool>` **empty** **(** **)**
|
||||
|
||||
Return true if the array is empty (size==0).
|
||||
|
||||
.. _class_Array_erase:
|
||||
.. _class_Array_method_erase:
|
||||
|
||||
- void **erase** **(** :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Remove the first occurrence of a value from the array.
|
||||
|
||||
.. _class_Array_find:
|
||||
.. _class_Array_method_find:
|
||||
|
||||
- :ref:`int<class_int>` **find** **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=0 **)**
|
||||
|
||||
Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.
|
||||
|
||||
.. _class_Array_find_last:
|
||||
.. _class_Array_method_find_last:
|
||||
|
||||
- :ref:`int<class_int>` **find_last** **(** :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Searches the array in reverse order for a value and returns its index or -1 if not found.
|
||||
|
||||
.. _class_Array_front:
|
||||
.. _class_Array_method_front:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **front** **(** **)**
|
||||
|
||||
Returns the first element of the array if the array is not empty (size>0).
|
||||
|
||||
.. _class_Array_has:
|
||||
.. _class_Array_method_has:
|
||||
|
||||
- :ref:`bool<class_bool>` **has** **(** :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
@@ -239,97 +227,97 @@ Return true if the array contains given value.
|
||||
["inside", 7].has(7) == true
|
||||
["inside", 7].has("7") == false
|
||||
|
||||
.. _class_Array_hash:
|
||||
.. _class_Array_method_hash:
|
||||
|
||||
- :ref:`int<class_int>` **hash** **(** **)**
|
||||
|
||||
Return a hashed integer value representing the array contents.
|
||||
|
||||
.. _class_Array_insert:
|
||||
.. _class_Array_method_insert:
|
||||
|
||||
- void **insert** **(** :ref:`int<class_int>` position, :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Insert a new element at a given position in the array. The position must be valid, or at the end of the array (``pos == size()``).
|
||||
|
||||
.. _class_Array_invert:
|
||||
.. _class_Array_method_invert:
|
||||
|
||||
- void **invert** **(** **)**
|
||||
|
||||
Reverse the order of the elements in the array.
|
||||
|
||||
.. _class_Array_max:
|
||||
.. _class_Array_method_max:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **max** **(** **)**
|
||||
|
||||
Return maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned.
|
||||
|
||||
.. _class_Array_min:
|
||||
.. _class_Array_method_min:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **min** **(** **)**
|
||||
|
||||
Return minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned.
|
||||
|
||||
.. _class_Array_pop_back:
|
||||
.. _class_Array_method_pop_back:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **pop_back** **(** **)**
|
||||
|
||||
Remove the last element of the array.
|
||||
|
||||
.. _class_Array_pop_front:
|
||||
.. _class_Array_method_pop_front:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **pop_front** **(** **)**
|
||||
|
||||
Remove the first element of the array.
|
||||
|
||||
.. _class_Array_push_back:
|
||||
.. _class_Array_method_push_back:
|
||||
|
||||
- void **push_back** **(** :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Append an element at the end of the array.
|
||||
|
||||
.. _class_Array_push_front:
|
||||
.. _class_Array_method_push_front:
|
||||
|
||||
- void **push_front** **(** :ref:`Variant<class_Variant>` value **)**
|
||||
|
||||
Add an element at the beginning of the array.
|
||||
|
||||
.. _class_Array_remove:
|
||||
.. _class_Array_method_remove:
|
||||
|
||||
- void **remove** **(** :ref:`int<class_int>` position **)**
|
||||
|
||||
Remove an element from the array by index.
|
||||
|
||||
.. _class_Array_resize:
|
||||
.. _class_Array_method_resize:
|
||||
|
||||
- void **resize** **(** :ref:`int<class_int>` size **)**
|
||||
|
||||
Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null.
|
||||
|
||||
.. _class_Array_rfind:
|
||||
.. _class_Array_method_rfind:
|
||||
|
||||
- :ref:`int<class_int>` **rfind** **(** :ref:`Variant<class_Variant>` what, :ref:`int<class_int>` from=-1 **)**
|
||||
|
||||
Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
|
||||
|
||||
.. _class_Array_shuffle:
|
||||
.. _class_Array_method_shuffle:
|
||||
|
||||
- void **shuffle** **(** **)**
|
||||
|
||||
Shuffle the array such that the items will have a random order.
|
||||
|
||||
.. _class_Array_size:
|
||||
.. _class_Array_method_size:
|
||||
|
||||
- :ref:`int<class_int>` **size** **(** **)**
|
||||
|
||||
Return the amount of elements in the array.
|
||||
|
||||
.. _class_Array_sort:
|
||||
.. _class_Array_method_sort:
|
||||
|
||||
- void **sort** **(** **)**
|
||||
|
||||
Sort the array using natural order.
|
||||
|
||||
.. _class_Array_sort_custom:
|
||||
.. _class_Array_method_sort_custom:
|
||||
|
||||
- void **sort_custom** **(** :ref:`Object<class_Object>` obj, :ref:`String<class_String>` func **)**
|
||||
|
||||
|
||||
@@ -19,58 +19,78 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` | :ref:`blend_shape_mode<class_ArrayMesh_blend_shape_mode>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`custom_aabb<class_ArrayMesh_custom_aabb>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` | :ref:`blend_shape_mode<class_ArrayMesh_property_blend_shape_mode>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`custom_aabb<class_ArrayMesh_property_custom_aabb>` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_blend_shape<class_ArrayMesh_add_blend_shape>` **(** :ref:`String<class_String>` name **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>` **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97280 **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`center_geometry<class_ArrayMesh_center_geometry>` **(** **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_blend_shapes<class_ArrayMesh_clear_blend_shapes>` **(** **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_get_blend_shape_count>` **(** **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_blend_shape_name<class_ArrayMesh_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`lightmap_unwrap<class_ArrayMesh_lightmap_unwrap>` **(** :ref:`Transform<class_Transform>` transform, :ref:`float<class_float>` texel_size **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`regen_normalmaps<class_ArrayMesh_regen_normalmaps>` **(** **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_find_by_name<class_ArrayMesh_surface_find_by_name>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_ArrayMesh_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_format<class_ArrayMesh_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`surface_get_name<class_ArrayMesh_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` | :ref:`surface_get_primitive_type<class_ArrayMesh_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_remove<class_ArrayMesh_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_set_material<class_ArrayMesh_surface_set_material>` **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_Material>` material **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_set_name<class_ArrayMesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_update_region<class_ArrayMesh_surface_update_region>` **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_blend_shape<class_ArrayMesh_method_add_blend_shape>` **(** :ref:`String<class_String>` name **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>` **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97280 **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`center_geometry<class_ArrayMesh_method_center_geometry>` **(** **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_blend_shapes<class_ArrayMesh_method_clear_blend_shapes>` **(** **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_method_get_blend_shape_count>` **(** **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_blend_shape_name<class_ArrayMesh_method_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`lightmap_unwrap<class_ArrayMesh_method_lightmap_unwrap>` **(** :ref:`Transform<class_Transform>` transform, :ref:`float<class_float>` texel_size **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`regen_normalmaps<class_ArrayMesh_method_regen_normalmaps>` **(** **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_find_by_name<class_ArrayMesh_method_surface_find_by_name>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_method_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_ArrayMesh_method_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_format<class_ArrayMesh_method_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`surface_get_name<class_ArrayMesh_method_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` | :ref:`surface_get_primitive_type<class_ArrayMesh_method_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_update_region<class_ArrayMesh_method_surface_update_region>` **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)** |
|
||||
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_ArrayMesh_ArrayType:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_VERTEX:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_NORMAL:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_TANGENT:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_COLOR:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_TEX_UV:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_TEX_UV2:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_BONES:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_WEIGHTS:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_INDEX:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_MAX:
|
||||
|
||||
enum **ArrayType**:
|
||||
|
||||
- **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3<class_Vector3>` vertices).
|
||||
@@ -97,6 +117,24 @@ For triangles, the index array is interpreted as triples, referring to the verti
|
||||
|
||||
.. _enum_ArrayMesh_ArrayFormat:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_FORMAT_VERTEX:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_FORMAT_NORMAL:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_FORMAT_TANGENT:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_FORMAT_COLOR:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_FORMAT_TEX_UV:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_FORMAT_TEX_UV2:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_FORMAT_BONES:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_FORMAT_WEIGHTS:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_FORMAT_INDEX:
|
||||
|
||||
enum **ArrayFormat**:
|
||||
|
||||
- **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory).
|
||||
@@ -120,6 +158,10 @@ enum **ArrayFormat**:
|
||||
Constants
|
||||
---------
|
||||
|
||||
.. _class_ArrayMesh_constant_NO_INDEX_ARRAY:
|
||||
|
||||
.. _class_ArrayMesh_constant_ARRAY_WEIGHTS_SIZE:
|
||||
|
||||
- **NO_INDEX_ARRAY** = **-1** --- Default value used for index_array_len when no indices are present.
|
||||
|
||||
- **ARRAY_WEIGHTS_SIZE** = **4** --- Amount of weights/bone indices per vertex (always 4).
|
||||
@@ -150,7 +192,7 @@ The ``MeshInstance`` is ready to be added to the SceneTree to be shown.
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_ArrayMesh_blend_shape_mode:
|
||||
.. _class_ArrayMesh_property_blend_shape_mode:
|
||||
|
||||
- :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` **blend_shape_mode**
|
||||
|
||||
@@ -160,7 +202,7 @@ Property Descriptions
|
||||
| *Getter* | get_blend_shape_mode() |
|
||||
+----------+-----------------------------+
|
||||
|
||||
.. _class_ArrayMesh_custom_aabb:
|
||||
.. _class_ArrayMesh_property_custom_aabb:
|
||||
|
||||
- :ref:`AABB<class_AABB>` **custom_aabb**
|
||||
|
||||
@@ -175,115 +217,115 @@ An overriding bounding box for this mesh.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_ArrayMesh_add_blend_shape:
|
||||
.. _class_ArrayMesh_method_add_blend_shape:
|
||||
|
||||
- void **add_blend_shape** **(** :ref:`String<class_String>` name **)**
|
||||
|
||||
.. _class_ArrayMesh_add_surface_from_arrays:
|
||||
.. _class_ArrayMesh_method_add_surface_from_arrays:
|
||||
|
||||
- void **add_surface_from_arrays** **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97280 **)**
|
||||
|
||||
Creates a new surface.
|
||||
|
||||
Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. See :ref:`Mesh<class_Mesh>` for details. (As a note, when using indices, it is recommended to only use points, lines or triangles). :ref:`Mesh.get_surface_count<class_Mesh_get_surface_count>` will become the ``surf_idx`` for this new surface.
|
||||
Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. See :ref:`Mesh<class_Mesh>` for details. (As a note, when using indices, it is recommended to only use points, lines or triangles). :ref:`Mesh.get_surface_count<class_Mesh_method_get_surface_count>` will become the ``surf_idx`` for this new surface.
|
||||
|
||||
The ``arrays`` argument is an array of arrays. See :ref:`ArrayType<enum_@GlobalScope_ArrayType>` for the values used in this array. For example, ``arrays[0]`` is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for ``ARRAY_INDEX`` if it is used.
|
||||
The ``arrays`` argument is an array of arrays. See :ref:`ArrayType<enum_ArrayMesh_ArrayType>` for the values used in this array. For example, ``arrays[0]`` is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for ``ARRAY_INDEX`` if it is used.
|
||||
|
||||
Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data, and the index array defines the order of the vertices.
|
||||
|
||||
Godot uses clockwise winding order for front faces of triangle primitive modes.
|
||||
|
||||
.. _class_ArrayMesh_center_geometry:
|
||||
.. _class_ArrayMesh_method_center_geometry:
|
||||
|
||||
- void **center_geometry** **(** **)**
|
||||
|
||||
Centers the geometry.
|
||||
|
||||
.. _class_ArrayMesh_clear_blend_shapes:
|
||||
.. _class_ArrayMesh_method_clear_blend_shapes:
|
||||
|
||||
- void **clear_blend_shapes** **(** **)**
|
||||
|
||||
Remove all blend shapes from this ``ArrayMesh``.
|
||||
|
||||
.. _class_ArrayMesh_get_blend_shape_count:
|
||||
.. _class_ArrayMesh_method_get_blend_shape_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_blend_shape_count** **(** **)** const
|
||||
|
||||
Returns the number of blend shapes that the ``ArrayMesh`` holds.
|
||||
|
||||
.. _class_ArrayMesh_get_blend_shape_name:
|
||||
.. _class_ArrayMesh_method_get_blend_shape_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_blend_shape_name** **(** :ref:`int<class_int>` index **)** const
|
||||
|
||||
Returns the name of the blend shape at this index.
|
||||
|
||||
.. _class_ArrayMesh_lightmap_unwrap:
|
||||
.. _class_ArrayMesh_method_lightmap_unwrap:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **lightmap_unwrap** **(** :ref:`Transform<class_Transform>` transform, :ref:`float<class_float>` texel_size **)**
|
||||
|
||||
Will perform a UV unwrap on the ``ArrayMesh`` to prepare the mesh for lightmapping.
|
||||
|
||||
.. _class_ArrayMesh_regen_normalmaps:
|
||||
.. _class_ArrayMesh_method_regen_normalmaps:
|
||||
|
||||
- void **regen_normalmaps** **(** **)**
|
||||
|
||||
Will regenerate normal maps for the ``ArrayMesh``.
|
||||
|
||||
.. _class_ArrayMesh_surface_find_by_name:
|
||||
.. _class_ArrayMesh_method_surface_find_by_name:
|
||||
|
||||
- :ref:`int<class_int>` **surface_find_by_name** **(** :ref:`String<class_String>` name **)** const
|
||||
|
||||
Return the index of the first surface with this name held within this ``ArrayMesh``. If none are found -1 is returned.
|
||||
|
||||
.. _class_ArrayMesh_surface_get_array_index_len:
|
||||
.. _class_ArrayMesh_method_surface_get_array_index_len:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_array_index_len** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>`).
|
||||
Return the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_get_array_len:
|
||||
.. _class_ArrayMesh_method_surface_get_array_len:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_array_len** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>`).
|
||||
Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_get_format:
|
||||
.. _class_ArrayMesh_method_surface_get_format:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_format** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the format mask of the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>`).
|
||||
Return the format mask of the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_get_name:
|
||||
.. _class_ArrayMesh_method_surface_get_name:
|
||||
|
||||
- :ref:`String<class_String>` **surface_get_name** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Get the name assigned to this surface.
|
||||
|
||||
.. _class_ArrayMesh_surface_get_primitive_type:
|
||||
.. _class_ArrayMesh_method_surface_get_primitive_type:
|
||||
|
||||
- :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` **surface_get_primitive_type** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the primitive type of the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>`).
|
||||
Return the primitive type of the requested surface (see :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_remove:
|
||||
.. _class_ArrayMesh_method_surface_remove:
|
||||
|
||||
- void **surface_remove** **(** :ref:`int<class_int>` surf_idx **)**
|
||||
|
||||
Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
|
||||
|
||||
.. _class_ArrayMesh_surface_set_material:
|
||||
.. _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_surface_set_name:
|
||||
.. _class_ArrayMesh_method_surface_set_name:
|
||||
|
||||
- void **surface_set_name** **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)**
|
||||
|
||||
Set a name for a given surface.
|
||||
|
||||
.. _class_ArrayMesh_surface_update_region:
|
||||
.. _class_ArrayMesh_method_surface_update_region:
|
||||
|
||||
- void **surface_update_region** **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)**
|
||||
|
||||
|
||||
@@ -19,22 +19,22 @@ Anchor point in AR Space.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------+----------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`anchor_id<class_ARVRAnchor_anchor_id>` |
|
||||
+-----------------------+----------------------------------------------+
|
||||
+-----------------------+-------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`anchor_id<class_ARVRAnchor_property_anchor_id>` |
|
||||
+-----------------------+-------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------+----------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_anchor_name<class_ARVRAnchor_get_anchor_name>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_is_active<class_ARVRAnchor_get_is_active>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`get_plane<class_ARVRAnchor_get_plane>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_size<class_ARVRAnchor_get_size>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------+
|
||||
+-------------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_anchor_name<class_ARVRAnchor_method_get_anchor_name>` **(** **)** const |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_is_active<class_ARVRAnchor_method_get_is_active>` **(** **)** const |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`get_plane<class_ARVRAnchor_method_get_plane>` **(** **)** const |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_size<class_ARVRAnchor_method_get_size>` **(** **)** const |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -48,7 +48,7 @@ Keep in mind that as long as plane detection is enable the size, placing and ori
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_ARVRAnchor_anchor_id:
|
||||
.. _class_ARVRAnchor_property_anchor_id:
|
||||
|
||||
- :ref:`int<class_int>` **anchor_id**
|
||||
|
||||
@@ -63,25 +63,25 @@ The anchor's id. You can set this before the anchor itself exists. The first anc
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_ARVRAnchor_get_anchor_name:
|
||||
.. _class_ARVRAnchor_method_get_anchor_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_anchor_name** **(** **)** const
|
||||
|
||||
Returns the name given to this anchor.
|
||||
|
||||
.. _class_ARVRAnchor_get_is_active:
|
||||
.. _class_ARVRAnchor_method_get_is_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_is_active** **(** **)** const
|
||||
|
||||
Returns true if the anchor is being tracked and false if no anchor with this id is currently known.
|
||||
|
||||
.. _class_ARVRAnchor_get_plane:
|
||||
.. _class_ARVRAnchor_method_get_plane:
|
||||
|
||||
- :ref:`Plane<class_Plane>` **get_plane** **(** **)** const
|
||||
|
||||
Returns a plane aligned with our anchor, handy for intersection testing
|
||||
|
||||
.. _class_ARVRAnchor_get_size:
|
||||
.. _class_ARVRAnchor_method_get_size:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **get_size** **(** **)** const
|
||||
|
||||
|
||||
@@ -19,39 +19,39 @@ A spatial node representing a spatially tracked controller.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+----------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`controller_id<class_ARVRController_controller_id>` |
|
||||
+---------------------------+----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRController_rumble>` |
|
||||
+---------------------------+----------------------------------------------------------+
|
||||
+---------------------------+-------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`controller_id<class_ARVRController_property_controller_id>` |
|
||||
+---------------------------+-------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRController_property_rumble>` |
|
||||
+---------------------------+-------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_controller_name<class_ARVRController_get_controller_name>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` | :ref:`get_hand<class_ARVRController_get_hand>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_is_active<class_ARVRController_get_is_active>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_joystick_axis<class_ARVRController_get_joystick_axis>` **(** :ref:`int<class_int>` axis **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_joystick_id<class_ARVRController_get_joystick_id>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`is_button_pressed<class_ARVRController_is_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
|
||||
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_controller_name<class_ARVRController_method_get_controller_name>` **(** **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` | :ref:`get_hand<class_ARVRController_method_get_hand>` **(** **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_is_active<class_ARVRController_method_get_is_active>` **(** **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_joystick_axis<class_ARVRController_method_get_joystick_axis>` **(** :ref:`int<class_int>` axis **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_joystick_id<class_ARVRController_method_get_joystick_id>` **(** **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`is_button_pressed<class_ARVRController_method_is_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
|
||||
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_ARVRController_button_pressed:
|
||||
.. _class_ARVRController_signal_button_pressed:
|
||||
|
||||
- **button_pressed** **(** :ref:`int<class_int>` button **)**
|
||||
|
||||
Emitted when a button on this controller is pressed.
|
||||
|
||||
.. _class_ARVRController_button_release:
|
||||
.. _class_ARVRController_signal_button_release:
|
||||
|
||||
- **button_release** **(** :ref:`int<class_int>` button **)**
|
||||
|
||||
@@ -69,7 +69,7 @@ The position of the controller node is automatically updated by the ARVR Server.
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_ARVRController_controller_id:
|
||||
.. _class_ARVRController_property_controller_id:
|
||||
|
||||
- :ref:`int<class_int>` **controller_id**
|
||||
|
||||
@@ -87,7 +87,7 @@ For any other controller that the :ref:`ARVRServer<class_ARVRServer>` detects we
|
||||
|
||||
When a controller is turned off, its slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off.
|
||||
|
||||
.. _class_ARVRController_rumble:
|
||||
.. _class_ARVRController_property_rumble:
|
||||
|
||||
- :ref:`float<class_float>` **rumble**
|
||||
|
||||
@@ -97,42 +97,42 @@ When a controller is turned off, its slot is freed. This ensures controllers wil
|
||||
| *Getter* | get_rumble() |
|
||||
+----------+-------------------+
|
||||
|
||||
The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. If changed, updates :ref:`ARVRPositionalTracker.rumble<class_ARVRPositionalTracker_rumble>` accordingly.
|
||||
The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. If changed, updates :ref:`ARVRPositionalTracker.rumble<class_ARVRPositionalTracker_property_rumble>` accordingly.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_ARVRController_get_controller_name:
|
||||
.. _class_ARVRController_method_get_controller_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_controller_name** **(** **)** const
|
||||
|
||||
If active, returns the name of the associated controller if provided by the AR/VR SDK used.
|
||||
|
||||
.. _class_ARVRController_get_hand:
|
||||
.. _class_ARVRController_method_get_hand:
|
||||
|
||||
- :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` **get_hand** **(** **)** const
|
||||
|
||||
Returns the hand holding this controller, if known. See TRACKER\_\* constants in :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>`.
|
||||
|
||||
.. _class_ARVRController_get_is_active:
|
||||
.. _class_ARVRController_method_get_is_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_is_active** **(** **)** const
|
||||
|
||||
Returns ``true`` if the bound controller is active. ARVR systems attempt to track active controllers.
|
||||
|
||||
.. _class_ARVRController_get_joystick_axis:
|
||||
.. _class_ARVRController_method_get_joystick_axis:
|
||||
|
||||
- :ref:`float<class_float>` **get_joystick_axis** **(** :ref:`int<class_int>` axis **)** const
|
||||
|
||||
Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller.
|
||||
|
||||
.. _class_ARVRController_get_joystick_id:
|
||||
.. _class_ARVRController_method_get_joystick_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_joystick_id** **(** **)** const
|
||||
|
||||
Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry.
|
||||
|
||||
.. _class_ARVRController_is_button_pressed:
|
||||
.. _class_ARVRController_method_is_button_pressed:
|
||||
|
||||
- :ref:`int<class_int>` **is_button_pressed** **(** :ref:`int<class_int>` button **)** const
|
||||
|
||||
|
||||
@@ -21,38 +21,48 @@ Base class for ARVR interface implementation.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+-------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`ar_is_anchor_detection_enabled<class_ARVRInterface_ar_is_anchor_detection_enabled>` |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`interface_is_initialized<class_ARVRInterface_interface_is_initialized>` |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`interface_is_primary<class_ARVRInterface_interface_is_primary>` |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------+
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`ar_is_anchor_detection_enabled<class_ARVRInterface_property_ar_is_anchor_detection_enabled>` |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`interface_is_initialized<class_ARVRInterface_property_interface_is_initialized>` |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`interface_is_primary<class_ARVRInterface_property_interface_is_primary>` |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_capabilities<class_ARVRInterface_get_capabilities>` **(** **)** const |
|
||||
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_name<class_ARVRInterface_get_name>` **(** **)** const |
|
||||
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_render_targetsize<class_ARVRInterface_get_render_targetsize>` **(** **)** |
|
||||
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`Tracking_status<enum_ARVRInterface_Tracking_status>` | :ref:`get_tracking_status<class_ARVRInterface_get_tracking_status>` **(** **)** const |
|
||||
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`initialize<class_ARVRInterface_initialize>` **(** **)** |
|
||||
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_ARVRInterface_is_stereo>` **(** **)** |
|
||||
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| void | :ref:`uninitialize<class_ARVRInterface_uninitialize>` **(** **)** |
|
||||
+-------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_capabilities<class_ARVRInterface_method_get_capabilities>` **(** **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_name<class_ARVRInterface_method_get_name>` **(** **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_render_targetsize<class_ARVRInterface_method_get_render_targetsize>` **(** **)** |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
| :ref:`Tracking_status<enum_ARVRInterface_Tracking_status>` | :ref:`get_tracking_status<class_ARVRInterface_method_get_tracking_status>` **(** **)** const |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`initialize<class_ARVRInterface_method_initialize>` **(** **)** |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_ARVRInterface_method_is_stereo>` **(** **)** |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`uninitialize<class_ARVRInterface_method_uninitialize>` **(** **)** |
|
||||
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_ARVRInterface_Capabilities:
|
||||
|
||||
.. _class_ARVRInterface_constant_ARVR_NONE:
|
||||
|
||||
.. _class_ARVRInterface_constant_ARVR_MONO:
|
||||
|
||||
.. _class_ARVRInterface_constant_ARVR_STEREO:
|
||||
|
||||
.. _class_ARVRInterface_constant_ARVR_AR:
|
||||
|
||||
.. _class_ARVRInterface_constant_ARVR_EXTERNAL:
|
||||
|
||||
enum **Capabilities**:
|
||||
|
||||
- **ARVR_NONE** = **0** --- No ARVR capabilities.
|
||||
@@ -67,6 +77,12 @@ enum **Capabilities**:
|
||||
|
||||
.. _enum_ARVRInterface_Eyes:
|
||||
|
||||
.. _class_ARVRInterface_constant_EYE_MONO:
|
||||
|
||||
.. _class_ARVRInterface_constant_EYE_LEFT:
|
||||
|
||||
.. _class_ARVRInterface_constant_EYE_RIGHT:
|
||||
|
||||
enum **Eyes**:
|
||||
|
||||
- **EYE_MONO** = **0** --- Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported.
|
||||
@@ -77,6 +93,16 @@ enum **Eyes**:
|
||||
|
||||
.. _enum_ARVRInterface_Tracking_status:
|
||||
|
||||
.. _class_ARVRInterface_constant_ARVR_NORMAL_TRACKING:
|
||||
|
||||
.. _class_ARVRInterface_constant_ARVR_EXCESSIVE_MOTION:
|
||||
|
||||
.. _class_ARVRInterface_constant_ARVR_INSUFFICIENT_FEATURES:
|
||||
|
||||
.. _class_ARVRInterface_constant_ARVR_UNKNOWN_TRACKING:
|
||||
|
||||
.. _class_ARVRInterface_constant_ARVR_NOT_TRACKING:
|
||||
|
||||
enum **Tracking_status**:
|
||||
|
||||
- **ARVR_NORMAL_TRACKING** = **0** --- Tracking is behaving as expected.
|
||||
@@ -99,7 +125,7 @@ Interfaces should be written in such a way that simply enabling them will give u
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_ARVRInterface_ar_is_anchor_detection_enabled:
|
||||
.. _class_ARVRInterface_property_ar_is_anchor_detection_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **ar_is_anchor_detection_enabled**
|
||||
|
||||
@@ -111,7 +137,7 @@ Property Descriptions
|
||||
|
||||
On an AR interface, is our anchor detection enabled?
|
||||
|
||||
.. _class_ARVRInterface_interface_is_initialized:
|
||||
.. _class_ARVRInterface_property_interface_is_initialized:
|
||||
|
||||
- :ref:`bool<class_bool>` **interface_is_initialized**
|
||||
|
||||
@@ -123,7 +149,7 @@ On an AR interface, is our anchor detection enabled?
|
||||
|
||||
Has this interface been initialized?
|
||||
|
||||
.. _class_ARVRInterface_interface_is_primary:
|
||||
.. _class_ARVRInterface_property_interface_is_primary:
|
||||
|
||||
- :ref:`bool<class_bool>` **interface_is_primary**
|
||||
|
||||
@@ -138,31 +164,31 @@ Is this our primary interface?
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_ARVRInterface_get_capabilities:
|
||||
.. _class_ARVRInterface_method_get_capabilities:
|
||||
|
||||
- :ref:`int<class_int>` **get_capabilities** **(** **)** const
|
||||
|
||||
Returns a combination of flags providing information about the capabilities of this interface.
|
||||
|
||||
.. _class_ARVRInterface_get_name:
|
||||
.. _class_ARVRInterface_method_get_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_name** **(** **)** const
|
||||
|
||||
Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc).
|
||||
|
||||
.. _class_ARVRInterface_get_render_targetsize:
|
||||
.. _class_ARVRInterface_method_get_render_targetsize:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_render_targetsize** **(** **)**
|
||||
|
||||
Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.
|
||||
|
||||
.. _class_ARVRInterface_get_tracking_status:
|
||||
.. _class_ARVRInterface_method_get_tracking_status:
|
||||
|
||||
- :ref:`Tracking_status<enum_ARVRInterface_Tracking_status>` **get_tracking_status** **(** **)** const
|
||||
|
||||
If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.
|
||||
|
||||
.. _class_ARVRInterface_initialize:
|
||||
.. _class_ARVRInterface_method_initialize:
|
||||
|
||||
- :ref:`bool<class_bool>` **initialize** **(** **)**
|
||||
|
||||
@@ -176,13 +202,13 @@ If you do this for a platform that handles its own output (such as OpenVR) Godot
|
||||
|
||||
While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD.
|
||||
|
||||
.. _class_ARVRInterface_is_stereo:
|
||||
.. _class_ARVRInterface_method_is_stereo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_stereo** **(** **)**
|
||||
|
||||
Returns true if the current output of this interface is in stereo.
|
||||
|
||||
.. _class_ARVRInterface_uninitialize:
|
||||
.. _class_ARVRInterface_method_uninitialize:
|
||||
|
||||
- void **uninitialize** **(** **)**
|
||||
|
||||
|
||||
@@ -19,9 +19,9 @@ Our origin point in AR/VR.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+--------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVROrigin_world_scale>` |
|
||||
+---------------------------+--------------------------------------------------+
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVROrigin_property_world_scale>` |
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -37,7 +37,7 @@ So say that your character is driving a car, the ARVROrigin node should be a chi
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_ARVROrigin_world_scale:
|
||||
.. _class_ARVROrigin_property_world_scale:
|
||||
|
||||
- :ref:`float<class_float>` **world_scale**
|
||||
|
||||
|
||||
@@ -19,38 +19,44 @@ A tracked object
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRPositionalTracker_rumble>` |
|
||||
+---------------------------+---------------------------------------------------+
|
||||
+---------------------------+------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRPositionalTracker_property_rumble>` |
|
||||
+---------------------------+------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` | :ref:`get_hand<class_ARVRPositionalTracker_get_hand>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_joy_id<class_ARVRPositionalTracker_get_joy_id>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_name<class_ARVRPositionalTracker_get_name>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`get_orientation<class_ARVRPositionalTracker_get_orientation>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_position<class_ARVRPositionalTracker_get_position>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_tracks_orientation<class_ARVRPositionalTracker_get_tracks_orientation>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_tracks_position<class_ARVRPositionalTracker_get_tracks_position>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`get_transform<class_ARVRPositionalTracker_get_transform>` **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** const |
|
||||
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`TrackerType<enum_ARVRServer_TrackerType>` | :ref:`get_type<class_ARVRPositionalTracker_get_type>` **(** **)** const |
|
||||
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` | :ref:`get_hand<class_ARVRPositionalTracker_method_get_hand>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_joy_id<class_ARVRPositionalTracker_method_get_joy_id>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_name<class_ARVRPositionalTracker_method_get_name>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`get_orientation<class_ARVRPositionalTracker_method_get_orientation>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_position<class_ARVRPositionalTracker_method_get_position>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_tracks_orientation<class_ARVRPositionalTracker_method_get_tracks_orientation>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_tracks_position<class_ARVRPositionalTracker_method_get_tracks_position>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`get_transform<class_ARVRPositionalTracker_method_get_transform>` **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`TrackerType<enum_ARVRServer_TrackerType>` | :ref:`get_type<class_ARVRPositionalTracker_method_get_type>` **(** **)** const |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_ARVRPositionalTracker_TrackerHand:
|
||||
|
||||
.. _class_ARVRPositionalTracker_constant_TRACKER_HAND_UNKNOWN:
|
||||
|
||||
.. _class_ARVRPositionalTracker_constant_TRACKER_LEFT_HAND:
|
||||
|
||||
.. _class_ARVRPositionalTracker_constant_TRACKER_RIGHT_HAND:
|
||||
|
||||
enum **TrackerHand**:
|
||||
|
||||
- **TRACKER_HAND_UNKNOWN** = **0** --- The hand this tracker is held in is unknown or not applicable.
|
||||
@@ -71,7 +77,7 @@ The ARVRController and ARVRAnchor both consume objects of this type and should b
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_ARVRPositionalTracker_rumble:
|
||||
.. _class_ARVRPositionalTracker_property_rumble:
|
||||
|
||||
- :ref:`float<class_float>` **rumble**
|
||||
|
||||
@@ -86,55 +92,55 @@ The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with pre
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_hand:
|
||||
.. _class_ARVRPositionalTracker_method_get_hand:
|
||||
|
||||
- :ref:`TrackerHand<enum_ARVRPositionalTracker_TrackerHand>` **get_hand** **(** **)** const
|
||||
|
||||
Returns the hand holding this tracker, if known. See TRACKER\_\* constants.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_joy_id:
|
||||
.. _class_ARVRPositionalTracker_method_get_joy_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_joy_id** **(** **)** const
|
||||
|
||||
If this is a controller that is being tracked the controller will also be represented by a joystick entry with this id.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_name:
|
||||
.. _class_ARVRPositionalTracker_method_get_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_name** **(** **)** const
|
||||
|
||||
Returns the controller or anchor point's name if available.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_orientation:
|
||||
.. _class_ARVRPositionalTracker_method_get_orientation:
|
||||
|
||||
- :ref:`Basis<class_Basis>` **get_orientation** **(** **)** const
|
||||
|
||||
Returns the controller's orientation matrix.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_position:
|
||||
.. _class_ARVRPositionalTracker_method_get_position:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **get_position** **(** **)** const
|
||||
|
||||
Returns the world-space controller position.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_tracks_orientation:
|
||||
.. _class_ARVRPositionalTracker_method_get_tracks_orientation:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_tracks_orientation** **(** **)** const
|
||||
|
||||
Returns ``true`` if this device tracks orientation.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_tracks_position:
|
||||
.. _class_ARVRPositionalTracker_method_get_tracks_position:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_tracks_position** **(** **)** const
|
||||
|
||||
Returns ``true`` if this device tracks position.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_transform:
|
||||
.. _class_ARVRPositionalTracker_method_get_transform:
|
||||
|
||||
- :ref:`Transform<class_Transform>` **get_transform** **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** const
|
||||
|
||||
Returns the transform combining this device's orientation and position.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_type:
|
||||
.. _class_ARVRPositionalTracker_method_get_type:
|
||||
|
||||
- :ref:`TrackerType<enum_ARVRServer_TrackerType>` **get_type** **(** **)** const
|
||||
|
||||
|
||||
@@ -19,63 +19,63 @@ This is our AR/VR Server.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`ARVRInterface<class_ARVRInterface>` | :ref:`primary_interface<class_ARVRServer_primary_interface>` |
|
||||
+-------------------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVRServer_world_scale>` |
|
||||
+-------------------------------------------+--------------------------------------------------------------+
|
||||
+-------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`ARVRInterface<class_ARVRInterface>` | :ref:`primary_interface<class_ARVRServer_property_primary_interface>` |
|
||||
+-------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVRServer_property_world_scale>` |
|
||||
+-------------------------------------------+-----------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`center_on_hmd<class_ARVRServer_center_on_hmd>` **(** :ref:`RotationMode<enum_ARVRServer_RotationMode>` rotation_mode, :ref:`bool<class_bool>` keep_height **)** |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ARVRInterface<class_ARVRInterface>` | :ref:`find_interface<class_ARVRServer_find_interface>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`get_hmd_transform<class_ARVRServer_get_hmd_transform>` **(** **)** |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ARVRInterface<class_ARVRInterface>` | :ref:`get_interface<class_ARVRServer_get_interface>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_interface_count<class_ARVRServer_get_interface_count>` **(** **)** const |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_interfaces<class_ARVRServer_get_interfaces>` **(** **)** const |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_last_commit_usec<class_ARVRServer_get_last_commit_usec>` **(** **)** |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_last_frame_usec<class_ARVRServer_get_last_frame_usec>` **(** **)** |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_last_process_usec<class_ARVRServer_get_last_process_usec>` **(** **)** |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`get_reference_frame<class_ARVRServer_get_reference_frame>` **(** **)** const |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>` | :ref:`get_tracker<class_ARVRServer_get_tracker>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_tracker_count<class_ARVRServer_get_tracker_count>` **(** **)** const |
|
||||
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`center_on_hmd<class_ARVRServer_method_center_on_hmd>` **(** :ref:`RotationMode<enum_ARVRServer_RotationMode>` rotation_mode, :ref:`bool<class_bool>` keep_height **)** |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ARVRInterface<class_ARVRInterface>` | :ref:`find_interface<class_ARVRServer_method_find_interface>` **(** :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`get_hmd_transform<class_ARVRServer_method_get_hmd_transform>` **(** **)** |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ARVRInterface<class_ARVRInterface>` | :ref:`get_interface<class_ARVRServer_method_get_interface>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_interface_count<class_ARVRServer_method_get_interface_count>` **(** **)** const |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_interfaces<class_ARVRServer_method_get_interfaces>` **(** **)** const |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_last_commit_usec<class_ARVRServer_method_get_last_commit_usec>` **(** **)** |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_last_frame_usec<class_ARVRServer_method_get_last_frame_usec>` **(** **)** |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_last_process_usec<class_ARVRServer_method_get_last_process_usec>` **(** **)** |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`get_reference_frame<class_ARVRServer_method_get_reference_frame>` **(** **)** const |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>` | :ref:`get_tracker<class_ARVRServer_method_get_tracker>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_tracker_count<class_ARVRServer_method_get_tracker_count>` **(** **)** const |
|
||||
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_ARVRServer_interface_added:
|
||||
.. _class_ARVRServer_signal_interface_added:
|
||||
|
||||
- **interface_added** **(** :ref:`String<class_String>` interface_name **)**
|
||||
|
||||
Signal send when a new interface has been added.
|
||||
|
||||
.. _class_ARVRServer_interface_removed:
|
||||
.. _class_ARVRServer_signal_interface_removed:
|
||||
|
||||
- **interface_removed** **(** :ref:`String<class_String>` interface_name **)**
|
||||
|
||||
Signal send when an interface is removed.
|
||||
|
||||
.. _class_ARVRServer_tracker_added:
|
||||
.. _class_ARVRServer_signal_tracker_added:
|
||||
|
||||
- **tracker_added** **(** :ref:`String<class_String>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
|
||||
|
||||
Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker.
|
||||
|
||||
.. _class_ARVRServer_tracker_removed:
|
||||
.. _class_ARVRServer_signal_tracker_removed:
|
||||
|
||||
- **tracker_removed** **(** :ref:`String<class_String>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
|
||||
|
||||
@@ -86,6 +86,18 @@ Enumerations
|
||||
|
||||
.. _enum_ARVRServer_TrackerType:
|
||||
|
||||
.. _class_ARVRServer_constant_TRACKER_CONTROLLER:
|
||||
|
||||
.. _class_ARVRServer_constant_TRACKER_BASESTATION:
|
||||
|
||||
.. _class_ARVRServer_constant_TRACKER_ANCHOR:
|
||||
|
||||
.. _class_ARVRServer_constant_TRACKER_ANY_KNOWN:
|
||||
|
||||
.. _class_ARVRServer_constant_TRACKER_UNKNOWN:
|
||||
|
||||
.. _class_ARVRServer_constant_TRACKER_ANY:
|
||||
|
||||
enum **TrackerType**:
|
||||
|
||||
- **TRACKER_CONTROLLER** = **1** --- Our tracker tracks the location of a controller.
|
||||
@@ -102,6 +114,12 @@ enum **TrackerType**:
|
||||
|
||||
.. _enum_ARVRServer_RotationMode:
|
||||
|
||||
.. _class_ARVRServer_constant_RESET_FULL_ROTATION:
|
||||
|
||||
.. _class_ARVRServer_constant_RESET_BUT_KEEP_TILT:
|
||||
|
||||
.. _class_ARVRServer_constant_DONT_RESET_ROTATION:
|
||||
|
||||
enum **RotationMode**:
|
||||
|
||||
- **RESET_FULL_ROTATION** = **0** --- Fully reset the orientation of the HMD. Regardless of what direction the user is looking to in the real world. The user will look dead ahead in the virtual world.
|
||||
@@ -118,7 +136,7 @@ The AR/VR Server is the heart of our AR/VR solution and handles all the processi
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_ARVRServer_primary_interface:
|
||||
.. _class_ARVRServer_property_primary_interface:
|
||||
|
||||
- :ref:`ARVRInterface<class_ARVRInterface>` **primary_interface**
|
||||
|
||||
@@ -128,7 +146,7 @@ Property Descriptions
|
||||
| *Getter* | get_primary_interface() |
|
||||
+----------+------------------------------+
|
||||
|
||||
.. _class_ARVRServer_world_scale:
|
||||
.. _class_ARVRServer_property_world_scale:
|
||||
|
||||
- :ref:`float<class_float>` **world_scale**
|
||||
|
||||
@@ -143,7 +161,7 @@ Allows you to adjust the scale to your game's units. Most AR/VR platforms assume
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_ARVRServer_center_on_hmd:
|
||||
.. _class_ARVRServer_method_center_on_hmd:
|
||||
|
||||
- void **center_on_hmd** **(** :ref:`RotationMode<enum_ARVRServer_RotationMode>` rotation_mode, :ref:`bool<class_bool>` keep_height **)**
|
||||
|
||||
@@ -159,61 +177,61 @@ For this method to produce usable results tracking information should be availab
|
||||
|
||||
You should call this method after a few seconds have passed, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, and when implementing a teleport mechanism.
|
||||
|
||||
.. _class_ARVRServer_find_interface:
|
||||
.. _class_ARVRServer_method_find_interface:
|
||||
|
||||
- :ref:`ARVRInterface<class_ARVRInterface>` **find_interface** **(** :ref:`String<class_String>` name **)** const
|
||||
|
||||
Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it.
|
||||
|
||||
.. _class_ARVRServer_get_hmd_transform:
|
||||
.. _class_ARVRServer_method_get_hmd_transform:
|
||||
|
||||
- :ref:`Transform<class_Transform>` **get_hmd_transform** **(** **)**
|
||||
|
||||
Returns the primary interface's transformation.
|
||||
|
||||
.. _class_ARVRServer_get_interface:
|
||||
.. _class_ARVRServer_method_get_interface:
|
||||
|
||||
- :ref:`ARVRInterface<class_ARVRInterface>` **get_interface** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Get the interface registered at a given index in our list of interfaces.
|
||||
|
||||
.. _class_ARVRServer_get_interface_count:
|
||||
.. _class_ARVRServer_method_get_interface_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_interface_count** **(** **)** const
|
||||
|
||||
Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look through the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true.
|
||||
|
||||
.. _class_ARVRServer_get_interfaces:
|
||||
.. _class_ARVRServer_method_get_interfaces:
|
||||
|
||||
- :ref:`Array<class_Array>` **get_interfaces** **(** **)** const
|
||||
|
||||
Returns a list of available interfaces with both id and name of the interface.
|
||||
|
||||
.. _class_ARVRServer_get_last_commit_usec:
|
||||
.. _class_ARVRServer_method_get_last_commit_usec:
|
||||
|
||||
- :ref:`int<class_int>` **get_last_commit_usec** **(** **)**
|
||||
|
||||
.. _class_ARVRServer_get_last_frame_usec:
|
||||
.. _class_ARVRServer_method_get_last_frame_usec:
|
||||
|
||||
- :ref:`int<class_int>` **get_last_frame_usec** **(** **)**
|
||||
|
||||
.. _class_ARVRServer_get_last_process_usec:
|
||||
.. _class_ARVRServer_method_get_last_process_usec:
|
||||
|
||||
- :ref:`int<class_int>` **get_last_process_usec** **(** **)**
|
||||
|
||||
.. _class_ARVRServer_get_reference_frame:
|
||||
.. _class_ARVRServer_method_get_reference_frame:
|
||||
|
||||
- :ref:`Transform<class_Transform>` **get_reference_frame** **(** **)** const
|
||||
|
||||
Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces.
|
||||
|
||||
.. _class_ARVRServer_get_tracker:
|
||||
.. _class_ARVRServer_method_get_tracker:
|
||||
|
||||
- :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>` **get_tracker** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Get the positional tracker at the given ID.
|
||||
|
||||
.. _class_ARVRServer_get_tracker_count:
|
||||
.. _class_ARVRServer_method_get_tracker_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_tracker_count** **(** **)** const
|
||||
|
||||
|
||||
@@ -19,71 +19,71 @@ AStar class representation that uses vectors as edges.
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`_compute_cost<class_AStar__compute_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`_estimate_cost<class_AStar__estimate_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_AStar_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position, :ref:`float<class_float>` weight_scale=1.0 **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_AStar_clear>` **(** **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_points<class_AStar_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_get_available_point_id>` **(** **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_get_closest_point>` **(** :ref:`Vector3<class_Vector3>` to_position **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_closest_position_in_segment<class_AStar_get_closest_position_in_segment>` **(** :ref:`Vector3<class_Vector3>` to_position **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_id_path<class_AStar_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_point_connections<class_AStar_get_point_connections>` **(** :ref:`int<class_int>` id **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_point_path<class_AStar_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_position<class_AStar_get_point_position>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_points<class_AStar_get_points>` **(** **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_AStar_set_point_position>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_weight_scale<class_AStar_set_point_weight_scale>` **(** :ref:`int<class_int>` id, :ref:`float<class_float>` weight_scale **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`_compute_cost<class_AStar_method__compute_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`_estimate_cost<class_AStar_method__estimate_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_AStar_method_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position, :ref:`float<class_float>` weight_scale=1.0 **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_method_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_AStar_method_clear>` **(** **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_points<class_AStar_method_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_points<class_AStar_method_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_method_get_available_point_id>` **(** **)** const |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_method_get_closest_point>` **(** :ref:`Vector3<class_Vector3>` to_position **)** const |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_closest_position_in_segment<class_AStar_method_get_closest_position_in_segment>` **(** :ref:`Vector3<class_Vector3>` to_position **)** const |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_id_path<class_AStar_method_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_point_connections<class_AStar_method_get_point_connections>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_point_path<class_AStar_method_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_position<class_AStar_method_get_point_position>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_method_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_points<class_AStar_method_get_points>` **(** **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_AStar_method_has_point>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_AStar_method_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_AStar_method_set_point_position>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_weight_scale<class_AStar_method_set_point_weight_scale>` **(** :ref:`int<class_int>` id, :ref:`float<class_float>` weight_scale **)** |
|
||||
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
A\* (A star) is a computer algorithm that is widely used in pathfinding and graph traversal, the process of plotting an efficiently directed path between multiple points. It enjoys widespread use due to its performance and accuracy. Godot's A\* implementation make use of vectors as points.
|
||||
|
||||
You must add points manually with :ref:`AStar.add_point<class_AStar_add_point>` and create segments manually with :ref:`AStar.connect_points<class_AStar_connect_points>`. So you can test if there is a path between two points with the :ref:`AStar.are_points_connected<class_AStar_are_points_connected>` function, get the list of existing ids in the found path with :ref:`AStar.get_id_path<class_AStar_get_id_path>`, or the points list with :ref:`AStar.get_point_path<class_AStar_get_point_path>`.
|
||||
You must add points manually with :ref:`add_point<class_AStar_method_add_point>` and create segments manually with :ref:`connect_points<class_AStar_method_connect_points>`. So you can test if there is a path between two points with the :ref:`are_points_connected<class_AStar_method_are_points_connected>` function, get the list of existing ids in the found path with :ref:`get_id_path<class_AStar_method_get_id_path>`, or the points list with :ref:`get_point_path<class_AStar_method_get_point_path>`.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AStar__compute_cost:
|
||||
.. _class_AStar_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.
|
||||
|
||||
.. _class_AStar__estimate_cost:
|
||||
.. _class_AStar_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.
|
||||
|
||||
.. _class_AStar_add_point:
|
||||
.. _class_AStar_method_add_point:
|
||||
|
||||
- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position, :ref:`float<class_float>` weight_scale=1.0 **)**
|
||||
|
||||
@@ -96,19 +96,19 @@ Adds a new point at the given position with the given identifier. The algorithm
|
||||
|
||||
If there already exists a point for the given id, its position and weight scale are updated to the given values.
|
||||
|
||||
.. _class_AStar_are_points_connected:
|
||||
.. _class_AStar_method_are_points_connected:
|
||||
|
||||
- :ref:`bool<class_bool>` **are_points_connected** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const
|
||||
|
||||
Returns whether there is a connection/segment between the given points.
|
||||
|
||||
.. _class_AStar_clear:
|
||||
.. _class_AStar_method_clear:
|
||||
|
||||
- void **clear** **(** **)**
|
||||
|
||||
Clears all the points and segments.
|
||||
|
||||
.. _class_AStar_connect_points:
|
||||
.. _class_AStar_method_connect_points:
|
||||
|
||||
- void **connect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)**
|
||||
|
||||
@@ -121,25 +121,25 @@ Creates a segment between the given points. If ``bidirectional`` is ``false``, o
|
||||
as.add_point(2, Vector3(0, 5, 0))
|
||||
as.connect_points(1, 2, false)
|
||||
|
||||
.. _class_AStar_disconnect_points:
|
||||
.. _class_AStar_method_disconnect_points:
|
||||
|
||||
- void **disconnect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)**
|
||||
|
||||
Deletes the segment between the given points.
|
||||
|
||||
.. _class_AStar_get_available_point_id:
|
||||
.. _class_AStar_method_get_available_point_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_available_point_id** **(** **)** const
|
||||
|
||||
Returns the next available point id with no point associated to it.
|
||||
|
||||
.. _class_AStar_get_closest_point:
|
||||
.. _class_AStar_method_get_closest_point:
|
||||
|
||||
- :ref:`int<class_int>` **get_closest_point** **(** :ref:`Vector3<class_Vector3>` to_position **)** const
|
||||
|
||||
Returns the id of the closest point to ``to_position``. Returns -1 if there are no points in the points pool.
|
||||
|
||||
.. _class_AStar_get_closest_position_in_segment:
|
||||
.. _class_AStar_method_get_closest_position_in_segment:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **get_closest_position_in_segment** **(** :ref:`Vector3<class_Vector3>` to_position **)** const
|
||||
|
||||
@@ -155,7 +155,7 @@ Returns the closest position to ``to_position`` that resides inside a segment be
|
||||
|
||||
The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the closest position in the segment to the given point.
|
||||
|
||||
.. _class_AStar_get_id_path:
|
||||
.. _class_AStar_method_get_id_path:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
|
||||
@@ -179,7 +179,7 @@ Returns an array with the ids of the points that form the path found by AStar be
|
||||
|
||||
If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2.
|
||||
|
||||
.. _class_AStar_get_point_connections:
|
||||
.. _class_AStar_method_get_point_connections:
|
||||
|
||||
- :ref:`PoolIntArray<class_PoolIntArray>` **get_point_connections** **(** :ref:`int<class_int>` id **)**
|
||||
|
||||
@@ -198,49 +198,49 @@ Returns an array with the ids of the points that form the connect with the given
|
||||
|
||||
var neighbors = as.get_point_connections(1) # returns [2, 3]
|
||||
|
||||
.. _class_AStar_get_point_path:
|
||||
.. _class_AStar_method_get_point_path:
|
||||
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
|
||||
Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.
|
||||
|
||||
.. _class_AStar_get_point_position:
|
||||
.. _class_AStar_method_get_point_position:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **get_point_position** **(** :ref:`int<class_int>` id **)** const
|
||||
|
||||
Returns the position of the point associated with the given id.
|
||||
|
||||
.. _class_AStar_get_point_weight_scale:
|
||||
.. _class_AStar_method_get_point_weight_scale:
|
||||
|
||||
- :ref:`float<class_float>` **get_point_weight_scale** **(** :ref:`int<class_int>` id **)** const
|
||||
|
||||
Returns the weight scale of the point associated with the given id.
|
||||
|
||||
.. _class_AStar_get_points:
|
||||
.. _class_AStar_method_get_points:
|
||||
|
||||
- :ref:`Array<class_Array>` **get_points** **(** **)**
|
||||
|
||||
Returns an array of all points.
|
||||
|
||||
.. _class_AStar_has_point:
|
||||
.. _class_AStar_method_has_point:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_point** **(** :ref:`int<class_int>` id **)** const
|
||||
|
||||
Returns whether a point associated with the given id exists.
|
||||
|
||||
.. _class_AStar_remove_point:
|
||||
.. _class_AStar_method_remove_point:
|
||||
|
||||
- void **remove_point** **(** :ref:`int<class_int>` id **)**
|
||||
|
||||
Removes the point associated with the given id from the points pool.
|
||||
|
||||
.. _class_AStar_set_point_position:
|
||||
.. _class_AStar_method_set_point_position:
|
||||
|
||||
- void **set_point_position** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_Vector3>` position **)**
|
||||
|
||||
Sets the position for the point with the given id.
|
||||
|
||||
.. _class_AStar_set_point_weight_scale:
|
||||
.. _class_AStar_method_set_point_weight_scale:
|
||||
|
||||
- void **set_point_weight_scale** **(** :ref:`int<class_int>` id, :ref:`float<class_float>` weight_scale **)**
|
||||
|
||||
|
||||
@@ -19,15 +19,15 @@ Packs multiple small textures in a single, bigger one. Helps to optimize video m
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+----------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`atlas<class_AtlasTexture_atlas>` |
|
||||
+-------------------------------+----------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_filter_clip>` |
|
||||
+-------------------------------+----------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`margin<class_AtlasTexture_margin>` |
|
||||
+-------------------------------+----------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`region<class_AtlasTexture_region>` |
|
||||
+-------------------------------+----------------------------------------------------+
|
||||
+-------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`atlas<class_AtlasTexture_property_atlas>` |
|
||||
+-------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_property_filter_clip>` |
|
||||
+-------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`margin<class_AtlasTexture_property_margin>` |
|
||||
+-------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`region<class_AtlasTexture_property_region>` |
|
||||
+-------------------------------+-------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -39,7 +39,7 @@ and a region that defines the actual area of the AtlasTexture.
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AtlasTexture_atlas:
|
||||
.. _class_AtlasTexture_property_atlas:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **atlas**
|
||||
|
||||
@@ -51,7 +51,7 @@ Property Descriptions
|
||||
|
||||
The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` subtype.
|
||||
|
||||
.. _class_AtlasTexture_filter_clip:
|
||||
.. _class_AtlasTexture_property_filter_clip:
|
||||
|
||||
- :ref:`bool<class_bool>` **filter_clip**
|
||||
|
||||
@@ -63,7 +63,7 @@ The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` su
|
||||
|
||||
If ``true``, clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
|
||||
|
||||
.. _class_AtlasTexture_margin:
|
||||
.. _class_AtlasTexture_property_margin:
|
||||
|
||||
- :ref:`Rect2<class_Rect2>` **margin**
|
||||
|
||||
@@ -75,7 +75,7 @@ If ``true``, clips the area outside of the region to avoid bleeding of the surro
|
||||
|
||||
The margin around the region. The :ref:`Rect2<class_Rect2>`'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin.
|
||||
|
||||
.. _class_AtlasTexture_region:
|
||||
.. _class_AtlasTexture_property_region:
|
||||
|
||||
- :ref:`Rect2<class_Rect2>` **region**
|
||||
|
||||
|
||||
@@ -21,9 +21,9 @@ Increases or decreases the volume of the selected audio bus.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioEffectAmplify_volume_db>` |
|
||||
+---------------------------+------------------------------------------------------+
|
||||
+---------------------------+---------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioEffectAmplify_property_volume_db>` |
|
||||
+---------------------------+---------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -33,7 +33,7 @@ Increases or decreases the volume being routed through the audio bus.
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectAmplify_volume_db:
|
||||
.. _class_AudioEffectAmplify_property_volume_db:
|
||||
|
||||
- :ref:`float<class_float>` **volume_db**
|
||||
|
||||
|
||||
@@ -19,5 +19,5 @@ Adds a band limit filter to the Audio Bus.
|
||||
Description
|
||||
-----------
|
||||
|
||||
Limits the frequencies in a range around the :ref:`AudioEffectFilter.cutoff_hz<class_AudioEffectFilter_cutoff_hz>` and allows frequencies outside of this range to pass.
|
||||
Limits the frequencies in a range around the :ref:`AudioEffectFilter.cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` and allows frequencies outside of this range to pass.
|
||||
|
||||
|
||||
@@ -19,5 +19,5 @@ Adds a band pass filter to the Audio Bus.
|
||||
Description
|
||||
-----------
|
||||
|
||||
Attenuates the frequencies inside of a range around the :ref:`AudioEffectFilter.cutoff_hz<class_AudioEffectFilter_cutoff_hz>` and cuts frequencies outside of this band.
|
||||
Attenuates the frequencies inside of a range around the :ref:`AudioEffectFilter.cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` and cuts frequencies outside of this band.
|
||||
|
||||
|
||||
@@ -19,61 +19,61 @@ Adds a chorus audio effect.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectChorus_dry>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/cutoff_hz<class_AudioEffectChorus_voice/1/cutoff_hz>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/delay_ms<class_AudioEffectChorus_voice/1/delay_ms>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/depth_ms<class_AudioEffectChorus_voice/1/depth_ms>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/level_db<class_AudioEffectChorus_voice/1/level_db>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/pan<class_AudioEffectChorus_voice/1/pan>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/rate_hz<class_AudioEffectChorus_voice/1/rate_hz>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/cutoff_hz<class_AudioEffectChorus_voice/2/cutoff_hz>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/delay_ms<class_AudioEffectChorus_voice/2/delay_ms>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/depth_ms<class_AudioEffectChorus_voice/2/depth_ms>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/level_db<class_AudioEffectChorus_voice/2/level_db>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/pan<class_AudioEffectChorus_voice/2/pan>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/rate_hz<class_AudioEffectChorus_voice/2/rate_hz>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/cutoff_hz<class_AudioEffectChorus_voice/3/cutoff_hz>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/delay_ms<class_AudioEffectChorus_voice/3/delay_ms>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/depth_ms<class_AudioEffectChorus_voice/3/depth_ms>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/level_db<class_AudioEffectChorus_voice/3/level_db>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/pan<class_AudioEffectChorus_voice/3/pan>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/rate_hz<class_AudioEffectChorus_voice/3/rate_hz>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/cutoff_hz<class_AudioEffectChorus_voice/4/cutoff_hz>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/delay_ms<class_AudioEffectChorus_voice/4/delay_ms>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/depth_ms<class_AudioEffectChorus_voice/4/depth_ms>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/level_db<class_AudioEffectChorus_voice/4/level_db>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/pan<class_AudioEffectChorus_voice/4/pan>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/rate_hz<class_AudioEffectChorus_voice/4/rate_hz>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`voice_count<class_AudioEffectChorus_voice_count>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectChorus_wet>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectChorus_property_dry>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/cutoff_hz<class_AudioEffectChorus_property_voice/1/cutoff_hz>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/delay_ms<class_AudioEffectChorus_property_voice/1/delay_ms>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/depth_ms<class_AudioEffectChorus_property_voice/1/depth_ms>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/level_db<class_AudioEffectChorus_property_voice/1/level_db>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/pan<class_AudioEffectChorus_property_voice/1/pan>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/rate_hz<class_AudioEffectChorus_property_voice/1/rate_hz>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/cutoff_hz<class_AudioEffectChorus_property_voice/2/cutoff_hz>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/delay_ms<class_AudioEffectChorus_property_voice/2/delay_ms>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/depth_ms<class_AudioEffectChorus_property_voice/2/depth_ms>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/level_db<class_AudioEffectChorus_property_voice/2/level_db>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/pan<class_AudioEffectChorus_property_voice/2/pan>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/rate_hz<class_AudioEffectChorus_property_voice/2/rate_hz>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/cutoff_hz<class_AudioEffectChorus_property_voice/3/cutoff_hz>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/delay_ms<class_AudioEffectChorus_property_voice/3/delay_ms>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/depth_ms<class_AudioEffectChorus_property_voice/3/depth_ms>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/level_db<class_AudioEffectChorus_property_voice/3/level_db>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/pan<class_AudioEffectChorus_property_voice/3/pan>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/3/rate_hz<class_AudioEffectChorus_property_voice/3/rate_hz>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/cutoff_hz<class_AudioEffectChorus_property_voice/4/cutoff_hz>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/delay_ms<class_AudioEffectChorus_property_voice/4/delay_ms>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/depth_ms<class_AudioEffectChorus_property_voice/4/depth_ms>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/level_db<class_AudioEffectChorus_property_voice/4/level_db>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/pan<class_AudioEffectChorus_property_voice/4/pan>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/4/rate_hz<class_AudioEffectChorus_property_voice/4/rate_hz>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`voice_count<class_AudioEffectChorus_property_voice_count>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectChorus_property_wet>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -83,7 +83,7 @@ Adds a chorus audio effect. The effect applies a filter with voices to duplicate
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectChorus_dry:
|
||||
.. _class_AudioEffectChorus_property_dry:
|
||||
|
||||
- :ref:`float<class_float>` **dry**
|
||||
|
||||
@@ -95,7 +95,7 @@ Property Descriptions
|
||||
|
||||
The effect's raw signal.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/1/cutoff_hz:
|
||||
.. _class_AudioEffectChorus_property_voice/1/cutoff_hz:
|
||||
|
||||
- :ref:`float<class_float>` **voice/1/cutoff_hz**
|
||||
|
||||
@@ -107,7 +107,7 @@ The effect's raw signal.
|
||||
|
||||
The voice's cutoff frequency.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/1/delay_ms:
|
||||
.. _class_AudioEffectChorus_property_voice/1/delay_ms:
|
||||
|
||||
- :ref:`float<class_float>` **voice/1/delay_ms**
|
||||
|
||||
@@ -119,7 +119,7 @@ The voice's cutoff frequency.
|
||||
|
||||
The voice's signal delay.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/1/depth_ms:
|
||||
.. _class_AudioEffectChorus_property_voice/1/depth_ms:
|
||||
|
||||
- :ref:`float<class_float>` **voice/1/depth_ms**
|
||||
|
||||
@@ -131,7 +131,7 @@ The voice's signal delay.
|
||||
|
||||
The voice filter's depth.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/1/level_db:
|
||||
.. _class_AudioEffectChorus_property_voice/1/level_db:
|
||||
|
||||
- :ref:`float<class_float>` **voice/1/level_db**
|
||||
|
||||
@@ -143,7 +143,7 @@ The voice filter's depth.
|
||||
|
||||
The voice's volume.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/1/pan:
|
||||
.. _class_AudioEffectChorus_property_voice/1/pan:
|
||||
|
||||
- :ref:`float<class_float>` **voice/1/pan**
|
||||
|
||||
@@ -155,7 +155,7 @@ The voice's volume.
|
||||
|
||||
The voice's pan level.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/1/rate_hz:
|
||||
.. _class_AudioEffectChorus_property_voice/1/rate_hz:
|
||||
|
||||
- :ref:`float<class_float>` **voice/1/rate_hz**
|
||||
|
||||
@@ -167,7 +167,7 @@ The voice's pan level.
|
||||
|
||||
The voice's filter rate.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/2/cutoff_hz:
|
||||
.. _class_AudioEffectChorus_property_voice/2/cutoff_hz:
|
||||
|
||||
- :ref:`float<class_float>` **voice/2/cutoff_hz**
|
||||
|
||||
@@ -179,7 +179,7 @@ The voice's filter rate.
|
||||
|
||||
The voice's cutoff frequency.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/2/delay_ms:
|
||||
.. _class_AudioEffectChorus_property_voice/2/delay_ms:
|
||||
|
||||
- :ref:`float<class_float>` **voice/2/delay_ms**
|
||||
|
||||
@@ -191,7 +191,7 @@ The voice's cutoff frequency.
|
||||
|
||||
The voice's signal delay.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/2/depth_ms:
|
||||
.. _class_AudioEffectChorus_property_voice/2/depth_ms:
|
||||
|
||||
- :ref:`float<class_float>` **voice/2/depth_ms**
|
||||
|
||||
@@ -203,7 +203,7 @@ The voice's signal delay.
|
||||
|
||||
The voice filter's depth.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/2/level_db:
|
||||
.. _class_AudioEffectChorus_property_voice/2/level_db:
|
||||
|
||||
- :ref:`float<class_float>` **voice/2/level_db**
|
||||
|
||||
@@ -215,7 +215,7 @@ The voice filter's depth.
|
||||
|
||||
The voice's volume.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/2/pan:
|
||||
.. _class_AudioEffectChorus_property_voice/2/pan:
|
||||
|
||||
- :ref:`float<class_float>` **voice/2/pan**
|
||||
|
||||
@@ -227,7 +227,7 @@ The voice's volume.
|
||||
|
||||
The voice's pan level.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/2/rate_hz:
|
||||
.. _class_AudioEffectChorus_property_voice/2/rate_hz:
|
||||
|
||||
- :ref:`float<class_float>` **voice/2/rate_hz**
|
||||
|
||||
@@ -239,7 +239,7 @@ The voice's pan level.
|
||||
|
||||
The voice's filter rate.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/3/cutoff_hz:
|
||||
.. _class_AudioEffectChorus_property_voice/3/cutoff_hz:
|
||||
|
||||
- :ref:`float<class_float>` **voice/3/cutoff_hz**
|
||||
|
||||
@@ -251,7 +251,7 @@ The voice's filter rate.
|
||||
|
||||
The voice's cutoff frequency.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/3/delay_ms:
|
||||
.. _class_AudioEffectChorus_property_voice/3/delay_ms:
|
||||
|
||||
- :ref:`float<class_float>` **voice/3/delay_ms**
|
||||
|
||||
@@ -263,7 +263,7 @@ The voice's cutoff frequency.
|
||||
|
||||
The voice's signal delay.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/3/depth_ms:
|
||||
.. _class_AudioEffectChorus_property_voice/3/depth_ms:
|
||||
|
||||
- :ref:`float<class_float>` **voice/3/depth_ms**
|
||||
|
||||
@@ -275,7 +275,7 @@ The voice's signal delay.
|
||||
|
||||
The voice filter's depth.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/3/level_db:
|
||||
.. _class_AudioEffectChorus_property_voice/3/level_db:
|
||||
|
||||
- :ref:`float<class_float>` **voice/3/level_db**
|
||||
|
||||
@@ -287,7 +287,7 @@ The voice filter's depth.
|
||||
|
||||
The voice's volume.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/3/pan:
|
||||
.. _class_AudioEffectChorus_property_voice/3/pan:
|
||||
|
||||
- :ref:`float<class_float>` **voice/3/pan**
|
||||
|
||||
@@ -299,7 +299,7 @@ The voice's volume.
|
||||
|
||||
The voice's pan level.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/3/rate_hz:
|
||||
.. _class_AudioEffectChorus_property_voice/3/rate_hz:
|
||||
|
||||
- :ref:`float<class_float>` **voice/3/rate_hz**
|
||||
|
||||
@@ -311,7 +311,7 @@ The voice's pan level.
|
||||
|
||||
The voice's filter rate.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/4/cutoff_hz:
|
||||
.. _class_AudioEffectChorus_property_voice/4/cutoff_hz:
|
||||
|
||||
- :ref:`float<class_float>` **voice/4/cutoff_hz**
|
||||
|
||||
@@ -323,7 +323,7 @@ The voice's filter rate.
|
||||
|
||||
The voice's cutoff frequency.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/4/delay_ms:
|
||||
.. _class_AudioEffectChorus_property_voice/4/delay_ms:
|
||||
|
||||
- :ref:`float<class_float>` **voice/4/delay_ms**
|
||||
|
||||
@@ -335,7 +335,7 @@ The voice's cutoff frequency.
|
||||
|
||||
The voice's signal delay.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/4/depth_ms:
|
||||
.. _class_AudioEffectChorus_property_voice/4/depth_ms:
|
||||
|
||||
- :ref:`float<class_float>` **voice/4/depth_ms**
|
||||
|
||||
@@ -347,7 +347,7 @@ The voice's signal delay.
|
||||
|
||||
The voice filter's depth.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/4/level_db:
|
||||
.. _class_AudioEffectChorus_property_voice/4/level_db:
|
||||
|
||||
- :ref:`float<class_float>` **voice/4/level_db**
|
||||
|
||||
@@ -359,7 +359,7 @@ The voice filter's depth.
|
||||
|
||||
The voice's volume.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/4/pan:
|
||||
.. _class_AudioEffectChorus_property_voice/4/pan:
|
||||
|
||||
- :ref:`float<class_float>` **voice/4/pan**
|
||||
|
||||
@@ -371,7 +371,7 @@ The voice's volume.
|
||||
|
||||
The voice's pan level.
|
||||
|
||||
.. _class_AudioEffectChorus_voice/4/rate_hz:
|
||||
.. _class_AudioEffectChorus_property_voice/4/rate_hz:
|
||||
|
||||
- :ref:`float<class_float>` **voice/4/rate_hz**
|
||||
|
||||
@@ -383,7 +383,7 @@ The voice's pan level.
|
||||
|
||||
The voice's filter rate.
|
||||
|
||||
.. _class_AudioEffectChorus_voice_count:
|
||||
.. _class_AudioEffectChorus_property_voice_count:
|
||||
|
||||
- :ref:`int<class_int>` **voice_count**
|
||||
|
||||
@@ -395,7 +395,7 @@ The voice's filter rate.
|
||||
|
||||
The amount of voices in the effect.
|
||||
|
||||
.. _class_AudioEffectChorus_wet:
|
||||
.. _class_AudioEffectChorus_property_wet:
|
||||
|
||||
- :ref:`float<class_float>` **wet**
|
||||
|
||||
|
||||
@@ -21,21 +21,21 @@ Reduces sounds that exceed a certain threshold level, smooths out the dynamics a
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`attack_us<class_AudioEffectCompressor_attack_us>` |
|
||||
+-----------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectCompressor_gain>` |
|
||||
+-----------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`mix<class_AudioEffectCompressor_mix>` |
|
||||
+-----------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`ratio<class_AudioEffectCompressor_ratio>` |
|
||||
+-----------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`release_ms<class_AudioEffectCompressor_release_ms>` |
|
||||
+-----------------------------+-----------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`sidechain<class_AudioEffectCompressor_sidechain>` |
|
||||
+-----------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`threshold<class_AudioEffectCompressor_threshold>` |
|
||||
+-----------------------------+-----------------------------------------------------------+
|
||||
+-----------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`attack_us<class_AudioEffectCompressor_property_attack_us>` |
|
||||
+-----------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectCompressor_property_gain>` |
|
||||
+-----------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`mix<class_AudioEffectCompressor_property_mix>` |
|
||||
+-----------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`ratio<class_AudioEffectCompressor_property_ratio>` |
|
||||
+-----------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`release_ms<class_AudioEffectCompressor_property_release_ms>` |
|
||||
+-----------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`sidechain<class_AudioEffectCompressor_property_sidechain>` |
|
||||
+-----------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`threshold<class_AudioEffectCompressor_property_threshold>` |
|
||||
+-----------------------------+--------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -55,7 +55,7 @@ Compressor has many uses in the mix:
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectCompressor_attack_us:
|
||||
.. _class_AudioEffectCompressor_property_attack_us:
|
||||
|
||||
- :ref:`float<class_float>` **attack_us**
|
||||
|
||||
@@ -67,7 +67,7 @@ Property Descriptions
|
||||
|
||||
Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: ``20ms``.
|
||||
|
||||
.. _class_AudioEffectCompressor_gain:
|
||||
.. _class_AudioEffectCompressor_property_gain:
|
||||
|
||||
- :ref:`float<class_float>` **gain**
|
||||
|
||||
@@ -79,7 +79,7 @@ Compressor's reaction time when the signal exceeds the threshold. Value can rang
|
||||
|
||||
Gain applied to the output signal.
|
||||
|
||||
.. _class_AudioEffectCompressor_mix:
|
||||
.. _class_AudioEffectCompressor_property_mix:
|
||||
|
||||
- :ref:`float<class_float>` **mix**
|
||||
|
||||
@@ -91,7 +91,7 @@ Gain applied to the output signal.
|
||||
|
||||
Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: ``1``.
|
||||
|
||||
.. _class_AudioEffectCompressor_ratio:
|
||||
.. _class_AudioEffectCompressor_property_ratio:
|
||||
|
||||
- :ref:`float<class_float>` **ratio**
|
||||
|
||||
@@ -103,7 +103,7 @@ Balance between original signal and effect signal. Value can range from 0 (total
|
||||
|
||||
Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: ``4``.
|
||||
|
||||
.. _class_AudioEffectCompressor_release_ms:
|
||||
.. _class_AudioEffectCompressor_property_release_ms:
|
||||
|
||||
- :ref:`float<class_float>` **release_ms**
|
||||
|
||||
@@ -115,7 +115,7 @@ Amount of compression applied to the audio once it passes the threshold level. T
|
||||
|
||||
Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: ``250ms``.
|
||||
|
||||
.. _class_AudioEffectCompressor_sidechain:
|
||||
.. _class_AudioEffectCompressor_property_sidechain:
|
||||
|
||||
- :ref:`String<class_String>` **sidechain**
|
||||
|
||||
@@ -127,7 +127,7 @@ Compressor's delay time to stop reducing the signal after the signal level falls
|
||||
|
||||
Reduce the sound level using another audio bus for threshold detection.
|
||||
|
||||
.. _class_AudioEffectCompressor_threshold:
|
||||
.. _class_AudioEffectCompressor_property_threshold:
|
||||
|
||||
- :ref:`float<class_float>` **threshold**
|
||||
|
||||
|
||||
@@ -21,33 +21,33 @@ Two tap delay and feedback options.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectDelay_dry>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`feedback/active<class_AudioEffectDelay_feedback/active>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/delay_ms<class_AudioEffectDelay_feedback/delay_ms>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/level_db<class_AudioEffectDelay_feedback/level_db>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/lowpass<class_AudioEffectDelay_feedback/lowpass>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`tap1/active<class_AudioEffectDelay_tap1/active>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/delay_ms<class_AudioEffectDelay_tap1/delay_ms>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/level_db<class_AudioEffectDelay_tap1/level_db>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/pan<class_AudioEffectDelay_tap1/pan>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`tap2/active<class_AudioEffectDelay_tap2/active>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/delay_ms<class_AudioEffectDelay_tap2/delay_ms>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/level_db<class_AudioEffectDelay_tap2/level_db>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/pan<class_AudioEffectDelay_tap2/pan>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectDelay_property_dry>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`feedback/active<class_AudioEffectDelay_property_feedback/active>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/delay_ms<class_AudioEffectDelay_property_feedback/delay_ms>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/level_db<class_AudioEffectDelay_property_feedback/level_db>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/lowpass<class_AudioEffectDelay_property_feedback/lowpass>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`tap1/active<class_AudioEffectDelay_property_tap1/active>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/delay_ms<class_AudioEffectDelay_property_tap1/delay_ms>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/level_db<class_AudioEffectDelay_property_tap1/level_db>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/pan<class_AudioEffectDelay_property_tap1/pan>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`tap2/active<class_AudioEffectDelay_property_tap2/active>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/delay_ms<class_AudioEffectDelay_property_tap2/delay_ms>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/level_db<class_AudioEffectDelay_property_tap2/level_db>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/pan<class_AudioEffectDelay_property_tap2/pan>` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -57,7 +57,7 @@ Plays input signal back after a period of time. The delayed signal may be played
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectDelay_dry:
|
||||
.. _class_AudioEffectDelay_property_dry:
|
||||
|
||||
- :ref:`float<class_float>` **dry**
|
||||
|
||||
@@ -69,7 +69,7 @@ Property Descriptions
|
||||
|
||||
Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: ``1``.
|
||||
|
||||
.. _class_AudioEffectDelay_feedback/active:
|
||||
.. _class_AudioEffectDelay_property_feedback/active:
|
||||
|
||||
- :ref:`bool<class_bool>` **feedback/active**
|
||||
|
||||
@@ -81,7 +81,7 @@ Output percent of original sound. At 0, only delayed sounds are output. Value ca
|
||||
|
||||
If ``true``, feedback is enabled. Default value: ``false``.
|
||||
|
||||
.. _class_AudioEffectDelay_feedback/delay_ms:
|
||||
.. _class_AudioEffectDelay_property_feedback/delay_ms:
|
||||
|
||||
- :ref:`float<class_float>` **feedback/delay_ms**
|
||||
|
||||
@@ -93,7 +93,7 @@ If ``true``, feedback is enabled. Default value: ``false``.
|
||||
|
||||
Feedback delay time in milliseconds. Default value: ``340``.
|
||||
|
||||
.. _class_AudioEffectDelay_feedback/level_db:
|
||||
.. _class_AudioEffectDelay_property_feedback/level_db:
|
||||
|
||||
- :ref:`float<class_float>` **feedback/level_db**
|
||||
|
||||
@@ -105,7 +105,7 @@ Feedback delay time in milliseconds. Default value: ``340``.
|
||||
|
||||
Sound level for ``tap1``. Default value: ``-6 dB``.
|
||||
|
||||
.. _class_AudioEffectDelay_feedback/lowpass:
|
||||
.. _class_AudioEffectDelay_property_feedback/lowpass:
|
||||
|
||||
- :ref:`float<class_float>` **feedback/lowpass**
|
||||
|
||||
@@ -117,7 +117,7 @@ Sound level for ``tap1``. Default value: ``-6 dB``.
|
||||
|
||||
Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: ``16000``.
|
||||
|
||||
.. _class_AudioEffectDelay_tap1/active:
|
||||
.. _class_AudioEffectDelay_property_tap1/active:
|
||||
|
||||
- :ref:`bool<class_bool>` **tap1/active**
|
||||
|
||||
@@ -129,7 +129,7 @@ Low-pass filter for feedback. Frequencies below the Low Cut value are filtered o
|
||||
|
||||
If ``true``, ``tap1`` will be enabled. Default value: ``true``.
|
||||
|
||||
.. _class_AudioEffectDelay_tap1/delay_ms:
|
||||
.. _class_AudioEffectDelay_property_tap1/delay_ms:
|
||||
|
||||
- :ref:`float<class_float>` **tap1/delay_ms**
|
||||
|
||||
@@ -141,7 +141,7 @@ If ``true``, ``tap1`` will be enabled. Default value: ``true``.
|
||||
|
||||
**Tap1** delay time in milliseconds. Default value: ``250ms``.
|
||||
|
||||
.. _class_AudioEffectDelay_tap1/level_db:
|
||||
.. _class_AudioEffectDelay_property_tap1/level_db:
|
||||
|
||||
- :ref:`float<class_float>` **tap1/level_db**
|
||||
|
||||
@@ -153,7 +153,7 @@ If ``true``, ``tap1`` will be enabled. Default value: ``true``.
|
||||
|
||||
Sound level for ``tap1``. Default value: ``-6 dB``.
|
||||
|
||||
.. _class_AudioEffectDelay_tap1/pan:
|
||||
.. _class_AudioEffectDelay_property_tap1/pan:
|
||||
|
||||
- :ref:`float<class_float>` **tap1/pan**
|
||||
|
||||
@@ -165,7 +165,7 @@ Sound level for ``tap1``. Default value: ``-6 dB``.
|
||||
|
||||
Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``0.2``.
|
||||
|
||||
.. _class_AudioEffectDelay_tap2/active:
|
||||
.. _class_AudioEffectDelay_property_tap2/active:
|
||||
|
||||
- :ref:`bool<class_bool>` **tap2/active**
|
||||
|
||||
@@ -177,7 +177,7 @@ Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully righ
|
||||
|
||||
If ``true``, ``tap2`` will be enabled. Default value: ``true``.
|
||||
|
||||
.. _class_AudioEffectDelay_tap2/delay_ms:
|
||||
.. _class_AudioEffectDelay_property_tap2/delay_ms:
|
||||
|
||||
- :ref:`float<class_float>` **tap2/delay_ms**
|
||||
|
||||
@@ -189,7 +189,7 @@ If ``true``, ``tap2`` will be enabled. Default value: ``true``.
|
||||
|
||||
**Tap2** delay time in milliseconds. Default value: ``500ms``.
|
||||
|
||||
.. _class_AudioEffectDelay_tap2/level_db:
|
||||
.. _class_AudioEffectDelay_property_tap2/level_db:
|
||||
|
||||
- :ref:`float<class_float>` **tap2/level_db**
|
||||
|
||||
@@ -201,7 +201,7 @@ If ``true``, ``tap2`` will be enabled. Default value: ``true``.
|
||||
|
||||
Sound level for ``tap2``. Default value: ``-12 dB``.
|
||||
|
||||
.. _class_AudioEffectDelay_tap2/pan:
|
||||
.. _class_AudioEffectDelay_property_tap2/pan:
|
||||
|
||||
- :ref:`float<class_float>` **tap2/pan**
|
||||
|
||||
|
||||
@@ -21,23 +21,33 @@ Modify the sound to make it dirty.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drive<class_AudioEffectDistortion_drive>` |
|
||||
+----------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`keep_hf_hz<class_AudioEffectDistortion_keep_hf_hz>` |
|
||||
+----------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`Mode<enum_AudioEffectDistortion_Mode>` | :ref:`mode<class_AudioEffectDistortion_mode>` |
|
||||
+----------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`post_gain<class_AudioEffectDistortion_post_gain>` |
|
||||
+----------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pre_gain<class_AudioEffectDistortion_pre_gain>` |
|
||||
+----------------------------------------------+-----------------------------------------------------------+
|
||||
+----------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drive<class_AudioEffectDistortion_property_drive>` |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`keep_hf_hz<class_AudioEffectDistortion_property_keep_hf_hz>` |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`Mode<enum_AudioEffectDistortion_Mode>` | :ref:`mode<class_AudioEffectDistortion_property_mode>` |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`post_gain<class_AudioEffectDistortion_property_post_gain>` |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pre_gain<class_AudioEffectDistortion_property_pre_gain>` |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_AudioEffectDistortion_Mode:
|
||||
|
||||
.. _class_AudioEffectDistortion_constant_MODE_CLIP:
|
||||
|
||||
.. _class_AudioEffectDistortion_constant_MODE_ATAN:
|
||||
|
||||
.. _class_AudioEffectDistortion_constant_MODE_LOFI:
|
||||
|
||||
.. _class_AudioEffectDistortion_constant_MODE_OVERDRIVE:
|
||||
|
||||
.. _class_AudioEffectDistortion_constant_MODE_WAVESHAPE:
|
||||
|
||||
enum **Mode**:
|
||||
|
||||
- **MODE_CLIP** = **0** --- Digital distortion effect which cuts off peaks at the top and bottom of the waveform.
|
||||
@@ -60,7 +70,7 @@ By distorting the waveform the frequency content change, which will often make t
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectDistortion_drive:
|
||||
.. _class_AudioEffectDistortion_property_drive:
|
||||
|
||||
- :ref:`float<class_float>` **drive**
|
||||
|
||||
@@ -72,7 +82,7 @@ Property Descriptions
|
||||
|
||||
Distortion power. Value can range from 0 to 1. Default value: ``0``.
|
||||
|
||||
.. _class_AudioEffectDistortion_keep_hf_hz:
|
||||
.. _class_AudioEffectDistortion_property_keep_hf_hz:
|
||||
|
||||
- :ref:`float<class_float>` **keep_hf_hz**
|
||||
|
||||
@@ -84,7 +94,7 @@ Distortion power. Value can range from 0 to 1. Default value: ``0``.
|
||||
|
||||
High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: ``16000``.
|
||||
|
||||
.. _class_AudioEffectDistortion_mode:
|
||||
.. _class_AudioEffectDistortion_property_mode:
|
||||
|
||||
- :ref:`Mode<enum_AudioEffectDistortion_Mode>` **mode**
|
||||
|
||||
@@ -96,7 +106,7 @@ High-pass filter. Frequencies higher than this value will not be affected by the
|
||||
|
||||
Distortion type. Default value: ``MODE_CLIP``.
|
||||
|
||||
.. _class_AudioEffectDistortion_post_gain:
|
||||
.. _class_AudioEffectDistortion_property_post_gain:
|
||||
|
||||
- :ref:`float<class_float>` **post_gain**
|
||||
|
||||
@@ -108,7 +118,7 @@ Distortion type. Default value: ``MODE_CLIP``.
|
||||
|
||||
Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: ``0``.
|
||||
|
||||
.. _class_AudioEffectDistortion_pre_gain:
|
||||
.. _class_AudioEffectDistortion_property_pre_gain:
|
||||
|
||||
- :ref:`float<class_float>` **pre_gain**
|
||||
|
||||
|
||||
@@ -23,13 +23,13 @@ Use it to create a custom equalizer if :ref:`AudioEffectEQ6<class_AudioEffectEQ6
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_band_count<class_AudioEffectEQ_get_band_count>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_band_gain_db<class_AudioEffectEQ_get_band_gain_db>` **(** :ref:`int<class_int>` band_idx **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_band_gain_db<class_AudioEffectEQ_set_band_gain_db>` **(** :ref:`int<class_int>` band_idx, :ref:`float<class_float>` volume_db **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_band_count<class_AudioEffectEQ_method_get_band_count>` **(** **)** const |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_band_gain_db<class_AudioEffectEQ_method_get_band_gain_db>` **(** :ref:`int<class_int>` band_idx **)** const |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_band_gain_db<class_AudioEffectEQ_method_set_band_gain_db>` **(** :ref:`int<class_int>` band_idx, :ref:`float<class_float>` volume_db **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -39,19 +39,19 @@ AudioEffectEQ gives you control over frequencies. Use it to compensate for exist
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AudioEffectEQ_get_band_count:
|
||||
.. _class_AudioEffectEQ_method_get_band_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_band_count** **(** **)** const
|
||||
|
||||
Returns the number of bands of the equalizer.
|
||||
|
||||
.. _class_AudioEffectEQ_get_band_gain_db:
|
||||
.. _class_AudioEffectEQ_method_get_band_gain_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_band_gain_db** **(** :ref:`int<class_int>` band_idx **)** const
|
||||
|
||||
Returns the band's gain at the specified index, in dB.
|
||||
|
||||
.. _class_AudioEffectEQ_set_band_gain_db:
|
||||
.. _class_AudioEffectEQ_method_set_band_gain_db:
|
||||
|
||||
- void **set_band_gain_db** **(** :ref:`int<class_int>` band_idx, :ref:`float<class_float>` volume_db **)**
|
||||
|
||||
|
||||
@@ -21,21 +21,29 @@ Adds a filter to the Audio Bus.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+--------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`cutoff_hz<class_AudioEffectFilter_cutoff_hz>` |
|
||||
+--------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` | :ref:`db<class_AudioEffectFilter_db>` |
|
||||
+--------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectFilter_gain>` |
|
||||
+--------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`resonance<class_AudioEffectFilter_resonance>` |
|
||||
+--------------------------------------------------+-----------------------------------------------------+
|
||||
+--------------------------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` | :ref:`db<class_AudioEffectFilter_property_db>` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectFilter_property_gain>` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`resonance<class_AudioEffectFilter_property_resonance>` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_AudioEffectFilter_FilterDB:
|
||||
|
||||
.. _class_AudioEffectFilter_constant_FILTER_6DB:
|
||||
|
||||
.. _class_AudioEffectFilter_constant_FILTER_12DB:
|
||||
|
||||
.. _class_AudioEffectFilter_constant_FILTER_18DB:
|
||||
|
||||
.. _class_AudioEffectFilter_constant_FILTER_24DB:
|
||||
|
||||
enum **FilterDB**:
|
||||
|
||||
- **FILTER_6DB** = **0**
|
||||
@@ -49,12 +57,12 @@ enum **FilterDB**:
|
||||
Description
|
||||
-----------
|
||||
|
||||
Allows frequencies other than the :ref:`cutoff_hz<class_AudioEffectFilter_cutoff_hz>` to pass.
|
||||
Allows frequencies other than the :ref:`cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` to pass.
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectFilter_cutoff_hz:
|
||||
.. _class_AudioEffectFilter_property_cutoff_hz:
|
||||
|
||||
- :ref:`float<class_float>` **cutoff_hz**
|
||||
|
||||
@@ -66,7 +74,7 @@ Property Descriptions
|
||||
|
||||
Threshold frequency for the filter.
|
||||
|
||||
.. _class_AudioEffectFilter_db:
|
||||
.. _class_AudioEffectFilter_property_db:
|
||||
|
||||
- :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **db**
|
||||
|
||||
@@ -76,7 +84,7 @@ Threshold frequency for the filter.
|
||||
| *Getter* | get_db() |
|
||||
+----------+---------------+
|
||||
|
||||
.. _class_AudioEffectFilter_gain:
|
||||
.. _class_AudioEffectFilter_property_gain:
|
||||
|
||||
- :ref:`float<class_float>` **gain**
|
||||
|
||||
@@ -88,7 +96,7 @@ Threshold frequency for the filter.
|
||||
|
||||
Gain amount of the frequencies after the filter.
|
||||
|
||||
.. _class_AudioEffectFilter_resonance:
|
||||
.. _class_AudioEffectFilter_property_resonance:
|
||||
|
||||
- :ref:`float<class_float>` **resonance**
|
||||
|
||||
|
||||
@@ -19,5 +19,5 @@ Adds a high pass filter to the Audio Bus.
|
||||
Description
|
||||
-----------
|
||||
|
||||
Cuts frequencies lower than the :ref:`AudioEffectFilter.cutoff_hz<class_AudioEffectFilter_cutoff_hz>` and allows higher frequencies to pass.
|
||||
Cuts frequencies lower than the :ref:`AudioEffectFilter.cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` and allows higher frequencies to pass.
|
||||
|
||||
|
||||
@@ -19,15 +19,15 @@ Adds a soft clip Limiter audio effect to an Audio bus.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`ceiling_db<class_AudioEffectLimiter_ceiling_db>` |
|
||||
+---------------------------+------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`soft_clip_db<class_AudioEffectLimiter_soft_clip_db>` |
|
||||
+---------------------------+------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`soft_clip_ratio<class_AudioEffectLimiter_soft_clip_ratio>` |
|
||||
+---------------------------+------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`threshold_db<class_AudioEffectLimiter_threshold_db>` |
|
||||
+---------------------------+------------------------------------------------------------------+
|
||||
+---------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`ceiling_db<class_AudioEffectLimiter_property_ceiling_db>` |
|
||||
+---------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`soft_clip_db<class_AudioEffectLimiter_property_soft_clip_db>` |
|
||||
+---------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`soft_clip_ratio<class_AudioEffectLimiter_property_soft_clip_ratio>` |
|
||||
+---------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`threshold_db<class_AudioEffectLimiter_property_threshold_db>` |
|
||||
+---------------------------+---------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -39,7 +39,7 @@ Soft clipping starts to reduce the peaks a little below the threshold level and
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectLimiter_ceiling_db:
|
||||
.. _class_AudioEffectLimiter_property_ceiling_db:
|
||||
|
||||
- :ref:`float<class_float>` **ceiling_db**
|
||||
|
||||
@@ -51,7 +51,7 @@ Property Descriptions
|
||||
|
||||
The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``.
|
||||
|
||||
.. _class_AudioEffectLimiter_soft_clip_db:
|
||||
.. _class_AudioEffectLimiter_property_soft_clip_db:
|
||||
|
||||
- :ref:`float<class_float>` **soft_clip_db**
|
||||
|
||||
@@ -63,7 +63,7 @@ The waveform's maximum allowed value. Value can range from -20 to -0.1. Default
|
||||
|
||||
Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``.
|
||||
|
||||
.. _class_AudioEffectLimiter_soft_clip_ratio:
|
||||
.. _class_AudioEffectLimiter_property_soft_clip_ratio:
|
||||
|
||||
- :ref:`float<class_float>` **soft_clip_ratio**
|
||||
|
||||
@@ -73,7 +73,7 @@ Applies a gain to the limited waves. Value can range from 0 to 6. Default value:
|
||||
| *Getter* | get_soft_clip_ratio() |
|
||||
+----------+----------------------------+
|
||||
|
||||
.. _class_AudioEffectLimiter_threshold_db:
|
||||
.. _class_AudioEffectLimiter_property_threshold_db:
|
||||
|
||||
- :ref:`float<class_float>` **threshold_db**
|
||||
|
||||
|
||||
@@ -19,5 +19,5 @@ Adds a low pass filter to the Audio Bus.
|
||||
Description
|
||||
-----------
|
||||
|
||||
Cuts frequencies higher than the :ref:`AudioEffectFilter.cutoff_hz<class_AudioEffectFilter_cutoff_hz>` and allows lower frequencies to pass.
|
||||
Cuts frequencies higher than the :ref:`AudioEffectFilter.cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` and allows lower frequencies to pass.
|
||||
|
||||
|
||||
@@ -19,5 +19,5 @@ Adds a notch filter to the Audio Bus.
|
||||
Description
|
||||
-----------
|
||||
|
||||
Attenuates frequencies in a narrow band around the :ref:`AudioEffectFilter.cutoff_hz<class_AudioEffectFilter_cutoff_hz>` and cuts frequencies outside of this range.
|
||||
Attenuates frequencies in a narrow band around the :ref:`AudioEffectFilter.cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` and cuts frequencies outside of this range.
|
||||
|
||||
|
||||
@@ -19,9 +19,9 @@ Adds a Panner audio effect to an Audio bus. Pans sound left or right.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-----------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pan<class_AudioEffectPanner_pan>` |
|
||||
+---------------------------+-----------------------------------------+
|
||||
+---------------------------+--------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pan<class_AudioEffectPanner_property_pan>` |
|
||||
+---------------------------+--------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -31,7 +31,7 @@ Determines how much of an audio signal is sent to the left and right buses.
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectPanner_pan:
|
||||
.. _class_AudioEffectPanner_property_pan:
|
||||
|
||||
- :ref:`float<class_float>` **pan**
|
||||
|
||||
|
||||
@@ -21,17 +21,17 @@ Combines the original signal with a copy that is slightly out of phase with the
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_AudioEffectPhaser_depth>` |
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback<class_AudioEffectPhaser_feedback>` |
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`range_max_hz<class_AudioEffectPhaser_range_max_hz>` |
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`range_min_hz<class_AudioEffectPhaser_range_min_hz>` |
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rate_hz<class_AudioEffectPhaser_rate_hz>` |
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_AudioEffectPhaser_property_depth>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback<class_AudioEffectPhaser_property_feedback>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`range_max_hz<class_AudioEffectPhaser_property_range_max_hz>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`range_min_hz<class_AudioEffectPhaser_property_range_min_hz>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rate_hz<class_AudioEffectPhaser_property_rate_hz>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -41,7 +41,7 @@ Combines phase-shifted signals with the original signal. The movement of the pha
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectPhaser_depth:
|
||||
.. _class_AudioEffectPhaser_property_depth:
|
||||
|
||||
- :ref:`float<class_float>` **depth**
|
||||
|
||||
@@ -53,7 +53,7 @@ Property Descriptions
|
||||
|
||||
Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: ``1``.
|
||||
|
||||
.. _class_AudioEffectPhaser_feedback:
|
||||
.. _class_AudioEffectPhaser_property_feedback:
|
||||
|
||||
- :ref:`float<class_float>` **feedback**
|
||||
|
||||
@@ -65,7 +65,7 @@ Governs how high the filter frequencies sweep. Low value will primarily affect b
|
||||
|
||||
Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: ``0.7``.
|
||||
|
||||
.. _class_AudioEffectPhaser_range_max_hz:
|
||||
.. _class_AudioEffectPhaser_property_range_max_hz:
|
||||
|
||||
- :ref:`float<class_float>` **range_max_hz**
|
||||
|
||||
@@ -77,7 +77,7 @@ Output percent of modified sound. Value can range from 0.1 to 0.9. Default value
|
||||
|
||||
Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``1600hz``.
|
||||
|
||||
.. _class_AudioEffectPhaser_range_min_hz:
|
||||
.. _class_AudioEffectPhaser_property_range_min_hz:
|
||||
|
||||
- :ref:`float<class_float>` **range_min_hz**
|
||||
|
||||
@@ -89,7 +89,7 @@ Determines the maximum frequency affected by the LFO modulations. Value can rang
|
||||
|
||||
Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``440hz``.
|
||||
|
||||
.. _class_AudioEffectPhaser_rate_hz:
|
||||
.. _class_AudioEffectPhaser_property_rate_hz:
|
||||
|
||||
- :ref:`float<class_float>` **rate_hz**
|
||||
|
||||
|
||||
@@ -21,9 +21,9 @@ Raises or lowers the pitch of original sound.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioEffectPitchShift_pitch_scale>` |
|
||||
+---------------------------+-------------------------------------------------------------+
|
||||
+---------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` |
|
||||
+---------------------------+----------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -33,7 +33,7 @@ Allows modulation of pitch independently of tempo. All frequencies can be increa
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectPitchShift_pitch_scale:
|
||||
.. _class_AudioEffectPitchShift_property_pitch_scale:
|
||||
|
||||
- :ref:`float<class_float>` **pitch_scale**
|
||||
|
||||
|
||||
@@ -19,25 +19,25 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------+-----------------------------------------------+
|
||||
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioEffectRecord_format>` |
|
||||
+----------------------------------------------+-----------------------------------------------+
|
||||
+----------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioEffectRecord_property_format>` |
|
||||
+----------------------------------------------+--------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioStreamSample<class_AudioStreamSample>` | :ref:`get_recording<class_AudioEffectRecord_get_recording>` **(** **)** const |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_recording_active<class_AudioEffectRecord_is_recording_active>` **(** **)** const |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_recording_active<class_AudioEffectRecord_set_recording_active>` **(** :ref:`bool<class_bool>` record **)** |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioStreamSample<class_AudioStreamSample>` | :ref:`get_recording<class_AudioEffectRecord_method_get_recording>` **(** **)** const |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_recording_active<class_AudioEffectRecord_method_is_recording_active>` **(** **)** const |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_recording_active<class_AudioEffectRecord_method_set_recording_active>` **(** :ref:`bool<class_bool>` record **)** |
|
||||
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectRecord_format:
|
||||
.. _class_AudioEffectRecord_property_format:
|
||||
|
||||
- :ref:`Format<enum_AudioStreamSample_Format>` **format**
|
||||
|
||||
@@ -50,15 +50,15 @@ Property Descriptions
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AudioEffectRecord_get_recording:
|
||||
.. _class_AudioEffectRecord_method_get_recording:
|
||||
|
||||
- :ref:`AudioStreamSample<class_AudioStreamSample>` **get_recording** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectRecord_is_recording_active:
|
||||
.. _class_AudioEffectRecord_method_is_recording_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_recording_active** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectRecord_set_recording_active:
|
||||
.. _class_AudioEffectRecord_method_set_recording_active:
|
||||
|
||||
- void **set_recording_active** **(** :ref:`bool<class_bool>` record **)**
|
||||
|
||||
|
||||
@@ -21,23 +21,23 @@ Simulates the sound of acoustic environments such as rooms, concert halls, caver
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping<class_AudioEffectReverb_damping>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectReverb_dry>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hipass<class_AudioEffectReverb_hipass>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`predelay_feedback<class_AudioEffectReverb_predelay_feedback>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`predelay_msec<class_AudioEffectReverb_predelay_msec>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`room_size<class_AudioEffectReverb_room_size>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`spread<class_AudioEffectReverb_spread>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectReverb_wet>` |
|
||||
+---------------------------+---------------------------------------------------------------------+
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping<class_AudioEffectReverb_property_damping>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectReverb_property_dry>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hipass<class_AudioEffectReverb_property_hipass>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`predelay_feedback<class_AudioEffectReverb_property_predelay_feedback>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`predelay_msec<class_AudioEffectReverb_property_predelay_msec>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`room_size<class_AudioEffectReverb_property_room_size>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`spread<class_AudioEffectReverb_property_spread>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectReverb_property_wet>` |
|
||||
+---------------------------+------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -47,7 +47,7 @@ Simulates rooms of different sizes. Its parameters can be adjusted to simulate t
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectReverb_damping:
|
||||
.. _class_AudioEffectReverb_property_damping:
|
||||
|
||||
- :ref:`float<class_float>` **damping**
|
||||
|
||||
@@ -59,7 +59,7 @@ Property Descriptions
|
||||
|
||||
Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: ``1``.
|
||||
|
||||
.. _class_AudioEffectReverb_dry:
|
||||
.. _class_AudioEffectReverb_property_dry:
|
||||
|
||||
- :ref:`float<class_float>` **dry**
|
||||
|
||||
@@ -71,7 +71,7 @@ Defines how reflective the imaginary room's walls are. Value can range from 0 to
|
||||
|
||||
Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: ``1``.
|
||||
|
||||
.. _class_AudioEffectReverb_hipass:
|
||||
.. _class_AudioEffectReverb_property_hipass:
|
||||
|
||||
- :ref:`float<class_float>` **hipass**
|
||||
|
||||
@@ -83,7 +83,7 @@ Output percent of original sound. At 0, only modified sound is outputted. Value
|
||||
|
||||
High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: ``0``.
|
||||
|
||||
.. _class_AudioEffectReverb_predelay_feedback:
|
||||
.. _class_AudioEffectReverb_property_predelay_feedback:
|
||||
|
||||
- :ref:`float<class_float>` **predelay_feedback**
|
||||
|
||||
@@ -95,7 +95,7 @@ High-pass filter passes signals with a frequency higher than a certain cutoff fr
|
||||
|
||||
Output percent of predelay. Value can range from 0 to 1. Default value: ``1``.
|
||||
|
||||
.. _class_AudioEffectReverb_predelay_msec:
|
||||
.. _class_AudioEffectReverb_property_predelay_msec:
|
||||
|
||||
- :ref:`float<class_float>` **predelay_msec**
|
||||
|
||||
@@ -107,7 +107,7 @@ Output percent of predelay. Value can range from 0 to 1. Default value: ``1``.
|
||||
|
||||
Time between the original signal and the early reflections of the reverb signal. Default value: ``150ms``.
|
||||
|
||||
.. _class_AudioEffectReverb_room_size:
|
||||
.. _class_AudioEffectReverb_property_room_size:
|
||||
|
||||
- :ref:`float<class_float>` **room_size**
|
||||
|
||||
@@ -119,7 +119,7 @@ Time between the original signal and the early reflections of the reverb signal.
|
||||
|
||||
Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: ``0.8``.
|
||||
|
||||
.. _class_AudioEffectReverb_spread:
|
||||
.. _class_AudioEffectReverb_property_spread:
|
||||
|
||||
- :ref:`float<class_float>` **spread**
|
||||
|
||||
@@ -131,7 +131,7 @@ Dimensions of simulated room. Bigger means more echoes. Value can range from 0 t
|
||||
|
||||
Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: ``1``.
|
||||
|
||||
.. _class_AudioEffectReverb_wet:
|
||||
.. _class_AudioEffectReverb_property_wet:
|
||||
|
||||
- :ref:`float<class_float>` **wet**
|
||||
|
||||
|
||||
@@ -19,18 +19,18 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pan_pullout<class_AudioEffectStereoEnhance_pan_pullout>` |
|
||||
+---------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`surround<class_AudioEffectStereoEnhance_surround>` |
|
||||
+---------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`time_pullout_ms<class_AudioEffectStereoEnhance_time_pullout_ms>` |
|
||||
+---------------------------+------------------------------------------------------------------------+
|
||||
+---------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pan_pullout<class_AudioEffectStereoEnhance_property_pan_pullout>` |
|
||||
+---------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`surround<class_AudioEffectStereoEnhance_property_surround>` |
|
||||
+---------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`time_pullout_ms<class_AudioEffectStereoEnhance_property_time_pullout_ms>` |
|
||||
+---------------------------+---------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioEffectStereoEnhance_pan_pullout:
|
||||
.. _class_AudioEffectStereoEnhance_property_pan_pullout:
|
||||
|
||||
- :ref:`float<class_float>` **pan_pullout**
|
||||
|
||||
@@ -40,7 +40,7 @@ Property Descriptions
|
||||
| *Getter* | get_pan_pullout() |
|
||||
+----------+------------------------+
|
||||
|
||||
.. _class_AudioEffectStereoEnhance_surround:
|
||||
.. _class_AudioEffectStereoEnhance_property_surround:
|
||||
|
||||
- :ref:`float<class_float>` **surround**
|
||||
|
||||
@@ -50,7 +50,7 @@ Property Descriptions
|
||||
| *Getter* | get_surround() |
|
||||
+----------+---------------------+
|
||||
|
||||
.. _class_AudioEffectStereoEnhance_time_pullout_ms:
|
||||
.. _class_AudioEffectStereoEnhance_property_time_pullout_ms:
|
||||
|
||||
- :ref:`float<class_float>` **time_pullout_ms**
|
||||
|
||||
|
||||
@@ -19,92 +19,92 @@ Server interface for low level audio access.
|
||||
Methods
|
||||
-------
|
||||
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_bus<class_AudioServer_add_bus>` **(** :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_bus_effect<class_AudioServer_add_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_AudioEffect>` effect, :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`capture_get_device<class_AudioServer_capture_get_device>` **(** **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`capture_get_device_list<class_AudioServer_capture_get_device_list>` **(** **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`capture_set_device<class_AudioServer_capture_set_device>` **(** :ref:`String<class_String>` name **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioBusLayout<class_AudioBusLayout>` | :ref:`generate_bus_layout<class_AudioServer_generate_bus_layout>` **(** **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_channels<class_AudioServer_get_bus_channels>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_count<class_AudioServer_get_bus_count>` **(** **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioEffect<class_AudioEffect>` | :ref:`get_bus_effect<class_AudioServer_get_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_effect_count<class_AudioServer_get_bus_effect_count>` **(** :ref:`int<class_int>` bus_idx **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_index<class_AudioServer_get_bus_index>` **(** :ref:`String<class_String>` bus_name **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_bus_name<class_AudioServer_get_bus_name>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_left_db<class_AudioServer_get_bus_peak_volume_left_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_right_db<class_AudioServer_get_bus_peak_volume_right_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_bus_send<class_AudioServer_get_bus_send>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_get_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_device<class_AudioServer_get_device>` **(** **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_device_list<class_AudioServer_get_device_list>` **(** **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_get_mix_rate>` **(** **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` | :ref:`get_speaker_mode<class_AudioServer_get_speaker_mode>` **(** **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_bypassing_effects<class_AudioServer_is_bus_bypassing_effects>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_effect_enabled<class_AudioServer_is_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_mute<class_AudioServer_is_bus_mute>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_solo<class_AudioServer_is_bus_solo>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`lock<class_AudioServer_lock>` **(** **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`move_bus<class_AudioServer_move_bus>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_bus<class_AudioServer_remove_bus>` **(** :ref:`int<class_int>` index **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_bus_effect<class_AudioServer_remove_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_bypass_effects<class_AudioServer_set_bus_bypass_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_count<class_AudioServer_set_bus_count>` **(** :ref:`int<class_int>` amount **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_effect_enabled<class_AudioServer_set_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_layout<class_AudioServer_set_bus_layout>` **(** :ref:`AudioBusLayout<class_AudioBusLayout>` bus_layout **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_mute<class_AudioServer_set_bus_mute>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_name<class_AudioServer_set_bus_name>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` name **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_send<class_AudioServer_set_bus_send>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` send **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_solo<class_AudioServer_set_bus_solo>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_volume_db<class_AudioServer_set_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_device<class_AudioServer_set_device>` **(** :ref:`String<class_String>` device **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`swap_bus_effects<class_AudioServer_swap_bus_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`unlock<class_AudioServer_unlock>` **(** **)** |
|
||||
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_bus<class_AudioServer_method_add_bus>` **(** :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_bus_effect<class_AudioServer_method_add_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_AudioEffect>` effect, :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`capture_get_device<class_AudioServer_method_capture_get_device>` **(** **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`capture_get_device_list<class_AudioServer_method_capture_get_device_list>` **(** **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`capture_set_device<class_AudioServer_method_capture_set_device>` **(** :ref:`String<class_String>` name **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioBusLayout<class_AudioBusLayout>` | :ref:`generate_bus_layout<class_AudioServer_method_generate_bus_layout>` **(** **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_channels<class_AudioServer_method_get_bus_channels>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_count<class_AudioServer_method_get_bus_count>` **(** **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioEffect<class_AudioEffect>` | :ref:`get_bus_effect<class_AudioServer_method_get_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_effect_count<class_AudioServer_method_get_bus_effect_count>` **(** :ref:`int<class_int>` bus_idx **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_index<class_AudioServer_method_get_bus_index>` **(** :ref:`String<class_String>` bus_name **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_bus_name<class_AudioServer_method_get_bus_name>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_left_db<class_AudioServer_method_get_bus_peak_volume_left_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_right_db<class_AudioServer_method_get_bus_peak_volume_right_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_bus_send<class_AudioServer_method_get_bus_send>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_method_get_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_device<class_AudioServer_method_get_device>` **(** **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_device_list<class_AudioServer_method_get_device_list>` **(** **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_method_get_mix_rate>` **(** **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` | :ref:`get_speaker_mode<class_AudioServer_method_get_speaker_mode>` **(** **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_bypassing_effects<class_AudioServer_method_is_bus_bypassing_effects>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_effect_enabled<class_AudioServer_method_is_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_mute<class_AudioServer_method_is_bus_mute>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_solo<class_AudioServer_method_is_bus_solo>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`lock<class_AudioServer_method_lock>` **(** **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`move_bus<class_AudioServer_method_move_bus>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_bus<class_AudioServer_method_remove_bus>` **(** :ref:`int<class_int>` index **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_bus_effect<class_AudioServer_method_remove_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_bypass_effects<class_AudioServer_method_set_bus_bypass_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_count<class_AudioServer_method_set_bus_count>` **(** :ref:`int<class_int>` amount **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_effect_enabled<class_AudioServer_method_set_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_layout<class_AudioServer_method_set_bus_layout>` **(** :ref:`AudioBusLayout<class_AudioBusLayout>` bus_layout **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_mute<class_AudioServer_method_set_bus_mute>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_name<class_AudioServer_method_set_bus_name>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` name **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_send<class_AudioServer_method_set_bus_send>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` send **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_solo<class_AudioServer_method_set_bus_solo>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_volume_db<class_AudioServer_method_set_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_device<class_AudioServer_method_set_device>` **(** :ref:`String<class_String>` device **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`swap_bus_effects<class_AudioServer_method_swap_bus_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`unlock<class_AudioServer_method_unlock>` **(** **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AudioServer_bus_layout_changed:
|
||||
.. _class_AudioServer_signal_bus_layout_changed:
|
||||
|
||||
- **bus_layout_changed** **(** **)**
|
||||
|
||||
@@ -115,6 +115,14 @@ Enumerations
|
||||
|
||||
.. _enum_AudioServer_SpeakerMode:
|
||||
|
||||
.. _class_AudioServer_constant_SPEAKER_MODE_STEREO:
|
||||
|
||||
.. _class_AudioServer_constant_SPEAKER_SURROUND_31:
|
||||
|
||||
.. _class_AudioServer_constant_SPEAKER_SURROUND_51:
|
||||
|
||||
.. _class_AudioServer_constant_SPEAKER_SURROUND_71:
|
||||
|
||||
enum **SpeakerMode**:
|
||||
|
||||
- **SPEAKER_MODE_STEREO** = **0** --- Two or fewer speakers are detected.
|
||||
@@ -138,229 +146,229 @@ Tutorials
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AudioServer_add_bus:
|
||||
.. _class_AudioServer_method_add_bus:
|
||||
|
||||
- void **add_bus** **(** :ref:`int<class_int>` at_position=-1 **)**
|
||||
|
||||
Adds a bus at ``at_position``.
|
||||
|
||||
.. _class_AudioServer_add_bus_effect:
|
||||
.. _class_AudioServer_method_add_bus_effect:
|
||||
|
||||
- void **add_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_AudioEffect>` effect, :ref:`int<class_int>` at_position=-1 **)**
|
||||
|
||||
Adds an :ref:`AudioEffect<class_AudioEffect>` effect to the bus ``bus_idx`` at ``at_position``.
|
||||
|
||||
.. _class_AudioServer_capture_get_device:
|
||||
.. _class_AudioServer_method_capture_get_device:
|
||||
|
||||
- :ref:`String<class_String>` **capture_get_device** **(** **)**
|
||||
|
||||
.. _class_AudioServer_capture_get_device_list:
|
||||
.. _class_AudioServer_method_capture_get_device_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **capture_get_device_list** **(** **)**
|
||||
|
||||
.. _class_AudioServer_capture_set_device:
|
||||
.. _class_AudioServer_method_capture_set_device:
|
||||
|
||||
- void **capture_set_device** **(** :ref:`String<class_String>` name **)**
|
||||
|
||||
.. _class_AudioServer_generate_bus_layout:
|
||||
.. _class_AudioServer_method_generate_bus_layout:
|
||||
|
||||
- :ref:`AudioBusLayout<class_AudioBusLayout>` **generate_bus_layout** **(** **)** const
|
||||
|
||||
Generates an :ref:`AudioBusLayout<class_AudioBusLayout>` using the available busses and effects.
|
||||
|
||||
.. _class_AudioServer_get_bus_channels:
|
||||
.. _class_AudioServer_method_get_bus_channels:
|
||||
|
||||
- :ref:`int<class_int>` **get_bus_channels** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
Returns the amount of channels of the bus at index ``bus_idx``.
|
||||
|
||||
.. _class_AudioServer_get_bus_count:
|
||||
.. _class_AudioServer_method_get_bus_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_bus_count** **(** **)** const
|
||||
|
||||
Returns the number of available busses.
|
||||
|
||||
.. _class_AudioServer_get_bus_effect:
|
||||
.. _class_AudioServer_method_get_bus_effect:
|
||||
|
||||
- :ref:`AudioEffect<class_AudioEffect>` **get_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
|
||||
|
||||
Returns the :ref:`AudioEffect<class_AudioEffect>` at position ``effect_idx`` in bus ``bus_idx``.
|
||||
|
||||
.. _class_AudioServer_get_bus_effect_count:
|
||||
.. _class_AudioServer_method_get_bus_effect_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_bus_effect_count** **(** :ref:`int<class_int>` bus_idx **)**
|
||||
|
||||
Returns the number of effects on the bus at ``bus_idx``.
|
||||
|
||||
.. _class_AudioServer_get_bus_index:
|
||||
.. _class_AudioServer_method_get_bus_index:
|
||||
|
||||
- :ref:`int<class_int>` **get_bus_index** **(** :ref:`String<class_String>` bus_name **)** const
|
||||
|
||||
Returns the index of the bus with the name ``bus_name``.
|
||||
|
||||
.. _class_AudioServer_get_bus_name:
|
||||
.. _class_AudioServer_method_get_bus_name:
|
||||
|
||||
- :ref:`String<class_String>` **get_bus_name** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
Returns the name of the bus with the index ``bus_idx``.
|
||||
|
||||
.. _class_AudioServer_get_bus_peak_volume_left_db:
|
||||
.. _class_AudioServer_method_get_bus_peak_volume_left_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_bus_peak_volume_left_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
|
||||
|
||||
Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel index ``channel``.
|
||||
|
||||
.. _class_AudioServer_get_bus_peak_volume_right_db:
|
||||
.. _class_AudioServer_method_get_bus_peak_volume_right_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_bus_peak_volume_right_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
|
||||
|
||||
Returns the peak volume of the right speaker at bus index ``bus_idx`` and channel index ``channel``.
|
||||
|
||||
.. _class_AudioServer_get_bus_send:
|
||||
.. _class_AudioServer_method_get_bus_send:
|
||||
|
||||
- :ref:`String<class_String>` **get_bus_send** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
Returns the name of the bus that the bus at index ``bus_idx`` sends to.
|
||||
|
||||
.. _class_AudioServer_get_bus_volume_db:
|
||||
.. _class_AudioServer_method_get_bus_volume_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_bus_volume_db** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
Returns the volume of the bus at index ``bus_idx`` in dB.
|
||||
|
||||
.. _class_AudioServer_get_device:
|
||||
.. _class_AudioServer_method_get_device:
|
||||
|
||||
- :ref:`String<class_String>` **get_device** **(** **)**
|
||||
|
||||
.. _class_AudioServer_get_device_list:
|
||||
.. _class_AudioServer_method_get_device_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **get_device_list** **(** **)**
|
||||
|
||||
.. _class_AudioServer_get_mix_rate:
|
||||
.. _class_AudioServer_method_get_mix_rate:
|
||||
|
||||
- :ref:`float<class_float>` **get_mix_rate** **(** **)** const
|
||||
|
||||
Returns the sample rate at the output of the audioserver.
|
||||
|
||||
.. _class_AudioServer_get_speaker_mode:
|
||||
.. _class_AudioServer_method_get_speaker_mode:
|
||||
|
||||
- :ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` **get_speaker_mode** **(** **)** const
|
||||
|
||||
Returns the speaker configuration.
|
||||
|
||||
.. _class_AudioServer_is_bus_bypassing_effects:
|
||||
.. _class_AudioServer_method_is_bus_bypassing_effects:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_bus_bypassing_effects** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
If ``true``, the bus at index ``bus_idx`` is bypassing effects.
|
||||
|
||||
.. _class_AudioServer_is_bus_effect_enabled:
|
||||
.. _class_AudioServer_method_is_bus_effect_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const
|
||||
|
||||
If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled.
|
||||
|
||||
.. _class_AudioServer_is_bus_mute:
|
||||
.. _class_AudioServer_method_is_bus_mute:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_bus_mute** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
If ``true``, the bus at index ``bus_idx`` is muted.
|
||||
|
||||
.. _class_AudioServer_is_bus_solo:
|
||||
.. _class_AudioServer_method_is_bus_solo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_bus_solo** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
If ``true``, the bus at index ``bus_idx`` is in solo mode.
|
||||
|
||||
.. _class_AudioServer_lock:
|
||||
.. _class_AudioServer_method_lock:
|
||||
|
||||
- void **lock** **(** **)**
|
||||
|
||||
Locks the audio drivers mainloop. Remember to unlock it afterwards.
|
||||
|
||||
.. _class_AudioServer_move_bus:
|
||||
.. _class_AudioServer_method_move_bus:
|
||||
|
||||
- void **move_bus** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)**
|
||||
|
||||
Moves the bus from index ``index`` to index ``to_index``.
|
||||
|
||||
.. _class_AudioServer_remove_bus:
|
||||
.. _class_AudioServer_method_remove_bus:
|
||||
|
||||
- void **remove_bus** **(** :ref:`int<class_int>` index **)**
|
||||
|
||||
Removes the bus at index ``index``.
|
||||
|
||||
.. _class_AudioServer_remove_bus_effect:
|
||||
.. _class_AudioServer_method_remove_bus_effect:
|
||||
|
||||
- void **remove_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
|
||||
|
||||
Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``.
|
||||
|
||||
.. _class_AudioServer_set_bus_bypass_effects:
|
||||
.. _class_AudioServer_method_set_bus_bypass_effects:
|
||||
|
||||
- void **set_bus_bypass_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``true``, the bus at index ``bus_idx`` is bypassing effects.
|
||||
|
||||
.. _class_AudioServer_set_bus_count:
|
||||
.. _class_AudioServer_method_set_bus_count:
|
||||
|
||||
- void **set_bus_count** **(** :ref:`int<class_int>` amount **)**
|
||||
|
||||
Adds and removes busses to make the number of busses match ``amount``.
|
||||
|
||||
.. _class_AudioServer_set_bus_effect_enabled:
|
||||
.. _class_AudioServer_method_set_bus_effect_enabled:
|
||||
|
||||
- void **set_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled.
|
||||
|
||||
.. _class_AudioServer_set_bus_layout:
|
||||
.. _class_AudioServer_method_set_bus_layout:
|
||||
|
||||
- void **set_bus_layout** **(** :ref:`AudioBusLayout<class_AudioBusLayout>` bus_layout **)**
|
||||
|
||||
Overwrites the currently used :ref:`AudioBusLayout<class_AudioBusLayout>`.
|
||||
|
||||
.. _class_AudioServer_set_bus_mute:
|
||||
.. _class_AudioServer_method_set_bus_mute:
|
||||
|
||||
- void **set_bus_mute** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``true``, the bus at index ``bus_idx`` is muted.
|
||||
|
||||
.. _class_AudioServer_set_bus_name:
|
||||
.. _class_AudioServer_method_set_bus_name:
|
||||
|
||||
- void **set_bus_name** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` name **)**
|
||||
|
||||
Sets the name of the bus at index ``bus_idx`` to ``name``.
|
||||
|
||||
.. _class_AudioServer_set_bus_send:
|
||||
.. _class_AudioServer_method_set_bus_send:
|
||||
|
||||
- void **set_bus_send** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` send **)**
|
||||
|
||||
Connects the output of the bus at ``bus_idx`` to the bus named ``send``.
|
||||
|
||||
.. _class_AudioServer_set_bus_solo:
|
||||
.. _class_AudioServer_method_set_bus_solo:
|
||||
|
||||
- void **set_bus_solo** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``true``, the bus at index ``bus_idx`` is in solo mode.
|
||||
|
||||
.. _class_AudioServer_set_bus_volume_db:
|
||||
.. _class_AudioServer_method_set_bus_volume_db:
|
||||
|
||||
- void **set_bus_volume_db** **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)**
|
||||
|
||||
Sets the volume of the bus at index ``bus_idx`` to ``volume_db``.
|
||||
|
||||
.. _class_AudioServer_set_device:
|
||||
.. _class_AudioServer_method_set_device:
|
||||
|
||||
- void **set_device** **(** :ref:`String<class_String>` device **)**
|
||||
|
||||
.. _class_AudioServer_swap_bus_effects:
|
||||
.. _class_AudioServer_method_swap_bus_effects:
|
||||
|
||||
- void **swap_bus_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)**
|
||||
|
||||
Swaps the position of two effects in bus ``bus_idx``.
|
||||
|
||||
.. _class_AudioServer_unlock:
|
||||
.. _class_AudioServer_method_unlock:
|
||||
|
||||
- void **unlock** **(** **)**
|
||||
|
||||
|
||||
@@ -21,9 +21,9 @@ Base class for audio streams.
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------+-------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_length<class_AudioStream_get_length>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------+
|
||||
+---------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_length<class_AudioStream_method_get_length>` **(** **)** const |
|
||||
+---------------------------+--------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -38,7 +38,7 @@ Tutorials
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AudioStream_get_length:
|
||||
.. _class_AudioStream_method_get_length:
|
||||
|
||||
- :ref:`float<class_float>` **get_length** **(** **)** const
|
||||
|
||||
|
||||
@@ -19,13 +19,13 @@ OGG Vorbis audio stream driver.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------+------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamOGGVorbis_data>` |
|
||||
+-------------------------------------------+------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`loop<class_AudioStreamOGGVorbis_loop>` |
|
||||
+-------------------------------------------+------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`loop_offset<class_AudioStreamOGGVorbis_loop_offset>` |
|
||||
+-------------------------------------------+------------------------------------------------------------+
|
||||
+-------------------------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamOGGVorbis_property_data>` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`loop<class_AudioStreamOGGVorbis_property_loop>` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`loop_offset<class_AudioStreamOGGVorbis_property_loop_offset>` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -35,7 +35,7 @@ OGG Vorbis audio stream driver.
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioStreamOGGVorbis_data:
|
||||
.. _class_AudioStreamOGGVorbis_property_data:
|
||||
|
||||
- :ref:`PoolByteArray<class_PoolByteArray>` **data**
|
||||
|
||||
@@ -47,7 +47,7 @@ Property Descriptions
|
||||
|
||||
Contains the audio data in bytes.
|
||||
|
||||
.. _class_AudioStreamOGGVorbis_loop:
|
||||
.. _class_AudioStreamOGGVorbis_property_loop:
|
||||
|
||||
- :ref:`bool<class_bool>` **loop**
|
||||
|
||||
@@ -57,7 +57,7 @@ Contains the audio data in bytes.
|
||||
| *Getter* | has_loop() |
|
||||
+----------+-----------------+
|
||||
|
||||
.. _class_AudioStreamOGGVorbis_loop_offset:
|
||||
.. _class_AudioStreamOGGVorbis_property_loop_offset:
|
||||
|
||||
- :ref:`float<class_float>` **loop_offset**
|
||||
|
||||
|
||||
@@ -19,41 +19,41 @@ Plays back audio.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer_autoplay>` |
|
||||
+----------------------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer_bus>` |
|
||||
+----------------------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` | :ref:`mix_target<class_AudioStreamPlayer_mix_target>` |
|
||||
+----------------------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer_pitch_scale>` |
|
||||
+----------------------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer_playing>` |
|
||||
+----------------------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer_stream>` |
|
||||
+----------------------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer_stream_paused>` |
|
||||
+----------------------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer_volume_db>` |
|
||||
+----------------------------------------------------+-------------------------------------------------------------+
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer_property_autoplay>` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer_property_bus>` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` | :ref:`mix_target<class_AudioStreamPlayer_property_mix_target>` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer_property_pitch_scale>` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer_property_playing>` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer_property_stream>` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer_property_stream_paused>` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer_property_volume_db>` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer_get_playback_position>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AudioStreamPlayer_stop>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer_method_get_playback_position>` **(** **)** |
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer_method_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer_method_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AudioStreamPlayer_method_stop>` **(** **)** |
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AudioStreamPlayer_finished:
|
||||
.. _class_AudioStreamPlayer_signal_finished:
|
||||
|
||||
- **finished** **(** **)**
|
||||
|
||||
@@ -64,6 +64,12 @@ Enumerations
|
||||
|
||||
.. _enum_AudioStreamPlayer_MixTarget:
|
||||
|
||||
.. _class_AudioStreamPlayer_constant_MIX_TARGET_STEREO:
|
||||
|
||||
.. _class_AudioStreamPlayer_constant_MIX_TARGET_SURROUND:
|
||||
|
||||
.. _class_AudioStreamPlayer_constant_MIX_TARGET_CENTER:
|
||||
|
||||
enum **MixTarget**:
|
||||
|
||||
- **MIX_TARGET_STEREO** = **0** --- The audio will be played only on the first channel.
|
||||
@@ -87,7 +93,7 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioStreamPlayer_autoplay:
|
||||
.. _class_AudioStreamPlayer_property_autoplay:
|
||||
|
||||
- :ref:`bool<class_bool>` **autoplay**
|
||||
|
||||
@@ -99,7 +105,7 @@ Property Descriptions
|
||||
|
||||
If ``true``, audio plays when added to scene tree. Default value: ``false``.
|
||||
|
||||
.. _class_AudioStreamPlayer_bus:
|
||||
.. _class_AudioStreamPlayer_property_bus:
|
||||
|
||||
- :ref:`String<class_String>` **bus**
|
||||
|
||||
@@ -111,7 +117,7 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``.
|
||||
|
||||
Bus on which this audio is playing.
|
||||
|
||||
.. _class_AudioStreamPlayer_mix_target:
|
||||
.. _class_AudioStreamPlayer_property_mix_target:
|
||||
|
||||
- :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` **mix_target**
|
||||
|
||||
@@ -123,7 +129,7 @@ Bus on which this audio is playing.
|
||||
|
||||
If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants.
|
||||
|
||||
.. _class_AudioStreamPlayer_pitch_scale:
|
||||
.. _class_AudioStreamPlayer_property_pitch_scale:
|
||||
|
||||
- :ref:`float<class_float>` **pitch_scale**
|
||||
|
||||
@@ -135,7 +141,7 @@ If the audio configuration has more than two speakers, this sets the target chan
|
||||
|
||||
Changes the pitch and the tempo of the audio.
|
||||
|
||||
.. _class_AudioStreamPlayer_playing:
|
||||
.. _class_AudioStreamPlayer_property_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **playing**
|
||||
|
||||
@@ -145,7 +151,7 @@ Changes the pitch and the tempo of the audio.
|
||||
|
||||
If ``true``, audio is playing.
|
||||
|
||||
.. _class_AudioStreamPlayer_stream:
|
||||
.. _class_AudioStreamPlayer_property_stream:
|
||||
|
||||
- :ref:`AudioStream<class_AudioStream>` **stream**
|
||||
|
||||
@@ -157,7 +163,7 @@ If ``true``, audio is playing.
|
||||
|
||||
The :ref:`AudioStream<class_AudioStream>` object to be played.
|
||||
|
||||
.. _class_AudioStreamPlayer_stream_paused:
|
||||
.. _class_AudioStreamPlayer_property_stream_paused:
|
||||
|
||||
- :ref:`bool<class_bool>` **stream_paused**
|
||||
|
||||
@@ -167,7 +173,7 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
|
||||
| *Getter* | get_stream_paused() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AudioStreamPlayer_volume_db:
|
||||
.. _class_AudioStreamPlayer_property_volume_db:
|
||||
|
||||
- :ref:`float<class_float>` **volume_db**
|
||||
|
||||
@@ -182,25 +188,25 @@ Volume of sound, in dB.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AudioStreamPlayer_get_playback_position:
|
||||
.. _class_AudioStreamPlayer_method_get_playback_position:
|
||||
|
||||
- :ref:`float<class_float>` **get_playback_position** **(** **)**
|
||||
|
||||
Returns the position in the :ref:`AudioStream<class_AudioStream>` in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer_play:
|
||||
.. _class_AudioStreamPlayer_method_play:
|
||||
|
||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||
|
||||
Plays the audio from the given position 'from_position', in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer_seek:
|
||||
.. _class_AudioStreamPlayer_method_seek:
|
||||
|
||||
- void **seek** **(** :ref:`float<class_float>` to_position **)**
|
||||
|
||||
Sets the position from which audio will be played, in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer_stop:
|
||||
.. _class_AudioStreamPlayer_method_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
|
||||
|
||||
@@ -19,45 +19,45 @@ Plays audio in 2D.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer2D_area_mask>` |
|
||||
+---------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation<class_AudioStreamPlayer2D_attenuation>` |
|
||||
+---------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer2D_autoplay>` |
|
||||
+---------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer2D_bus>` |
|
||||
+---------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer2D_max_distance>` |
|
||||
+---------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer2D_pitch_scale>` |
|
||||
+---------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer2D_playing>` |
|
||||
+---------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer2D_stream>` |
|
||||
+---------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer2D_stream_paused>` |
|
||||
+---------------------------------------+---------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer2D_volume_db>` |
|
||||
+---------------------------------------+---------------------------------------------------------------+
|
||||
+---------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer2D_property_area_mask>` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation<class_AudioStreamPlayer2D_property_attenuation>` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer2D_property_autoplay>` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer2D_property_bus>` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer2D_property_max_distance>` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer2D_property_pitch_scale>` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer2D_property_playing>` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer2D_property_stream>` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer2D_property_stream_paused>` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer2D_property_volume_db>` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer2D_get_playback_position>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer2D_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer2D_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AudioStreamPlayer2D_stop>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer2D_method_get_playback_position>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer2D_method_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer2D_method_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AudioStreamPlayer2D_method_stop>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AudioStreamPlayer2D_finished:
|
||||
.. _class_AudioStreamPlayer2D_signal_finished:
|
||||
|
||||
- **finished** **(** **)**
|
||||
|
||||
@@ -78,7 +78,7 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioStreamPlayer2D_area_mask:
|
||||
.. _class_AudioStreamPlayer2D_property_area_mask:
|
||||
|
||||
- :ref:`int<class_int>` **area_mask**
|
||||
|
||||
@@ -90,7 +90,7 @@ Property Descriptions
|
||||
|
||||
Areas in which this sound plays.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_attenuation:
|
||||
.. _class_AudioStreamPlayer2D_property_attenuation:
|
||||
|
||||
- :ref:`float<class_float>` **attenuation**
|
||||
|
||||
@@ -102,7 +102,7 @@ Areas in which this sound plays.
|
||||
|
||||
Dampens audio over distance with this as an exponent.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_autoplay:
|
||||
.. _class_AudioStreamPlayer2D_property_autoplay:
|
||||
|
||||
- :ref:`bool<class_bool>` **autoplay**
|
||||
|
||||
@@ -114,7 +114,7 @@ Dampens audio over distance with this as an exponent.
|
||||
|
||||
If ``true``, audio plays when added to scene tree. Default value: ``false``.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_bus:
|
||||
.. _class_AudioStreamPlayer2D_property_bus:
|
||||
|
||||
- :ref:`String<class_String>` **bus**
|
||||
|
||||
@@ -126,7 +126,7 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``.
|
||||
|
||||
Bus on which this audio is playing.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_max_distance:
|
||||
.. _class_AudioStreamPlayer2D_property_max_distance:
|
||||
|
||||
- :ref:`float<class_float>` **max_distance**
|
||||
|
||||
@@ -138,7 +138,7 @@ Bus on which this audio is playing.
|
||||
|
||||
Maximum distance from which audio is still hearable.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_pitch_scale:
|
||||
.. _class_AudioStreamPlayer2D_property_pitch_scale:
|
||||
|
||||
- :ref:`float<class_float>` **pitch_scale**
|
||||
|
||||
@@ -150,7 +150,7 @@ Maximum distance from which audio is still hearable.
|
||||
|
||||
Changes the pitch and the tempo of the audio.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_playing:
|
||||
.. _class_AudioStreamPlayer2D_property_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **playing**
|
||||
|
||||
@@ -160,7 +160,7 @@ Changes the pitch and the tempo of the audio.
|
||||
|
||||
If ``true``, audio is playing.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_stream:
|
||||
.. _class_AudioStreamPlayer2D_property_stream:
|
||||
|
||||
- :ref:`AudioStream<class_AudioStream>` **stream**
|
||||
|
||||
@@ -172,7 +172,7 @@ If ``true``, audio is playing.
|
||||
|
||||
The :ref:`AudioStream<class_AudioStream>` object to be played.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_stream_paused:
|
||||
.. _class_AudioStreamPlayer2D_property_stream_paused:
|
||||
|
||||
- :ref:`bool<class_bool>` **stream_paused**
|
||||
|
||||
@@ -182,7 +182,7 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
|
||||
| *Getter* | get_stream_paused() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AudioStreamPlayer2D_volume_db:
|
||||
.. _class_AudioStreamPlayer2D_property_volume_db:
|
||||
|
||||
- :ref:`float<class_float>` **volume_db**
|
||||
|
||||
@@ -197,25 +197,25 @@ Base volume without dampening.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AudioStreamPlayer2D_get_playback_position:
|
||||
.. _class_AudioStreamPlayer2D_method_get_playback_position:
|
||||
|
||||
- :ref:`float<class_float>` **get_playback_position** **(** **)**
|
||||
|
||||
Returns the position in the :ref:`AudioStream<class_AudioStream>`.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_play:
|
||||
.. _class_AudioStreamPlayer2D_method_play:
|
||||
|
||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||
|
||||
Plays the audio from the given position 'from_position', in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_seek:
|
||||
.. _class_AudioStreamPlayer2D_method_seek:
|
||||
|
||||
- void **seek** **(** :ref:`float<class_float>` to_position **)**
|
||||
|
||||
Sets the position from which audio will be played, in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_stop:
|
||||
.. _class_AudioStreamPlayer2D_method_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
|
||||
|
||||
@@ -19,63 +19,63 @@ Plays 3D sound in 3D space.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer3D_area_mask>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_attenuation_filter_cutoff_hz>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_db<class_AudioStreamPlayer3D_attenuation_filter_db>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` | :ref:`attenuation_model<class_AudioStreamPlayer3D_attenuation_model>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer3D_autoplay>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer3D_bus>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` | :ref:`doppler_tracking<class_AudioStreamPlayer3D_doppler_tracking>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_degrees<class_AudioStreamPlayer3D_emission_angle_degrees>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emission_angle_enabled<class_AudioStreamPlayer3D_emission_angle_enabled>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_emission_angle_filter_attenuation_db>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_db<class_AudioStreamPlayer3D_max_db>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer3D_max_distance>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` | :ref:`out_of_range_mode<class_AudioStreamPlayer3D_out_of_range_mode>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer3D_pitch_scale>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer3D_playing>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer3D_stream>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer3D_stream_paused>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_db<class_AudioStreamPlayer3D_unit_db>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_size<class_AudioStreamPlayer3D_unit_size>` |
|
||||
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer3D_property_area_mask>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_db<class_AudioStreamPlayer3D_property_attenuation_filter_db>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` | :ref:`attenuation_model<class_AudioStreamPlayer3D_property_attenuation_model>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer3D_property_autoplay>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer3D_property_bus>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` | :ref:`doppler_tracking<class_AudioStreamPlayer3D_property_doppler_tracking>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_degrees<class_AudioStreamPlayer3D_property_emission_angle_degrees>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emission_angle_enabled<class_AudioStreamPlayer3D_property_emission_angle_enabled>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_db<class_AudioStreamPlayer3D_property_max_db>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` | :ref:`out_of_range_mode<class_AudioStreamPlayer3D_property_out_of_range_mode>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer3D_property_pitch_scale>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer3D_property_playing>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer3D_property_stream>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer3D_property_stream_paused>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_db<class_AudioStreamPlayer3D_property_unit_db>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_size<class_AudioStreamPlayer3D_property_unit_size>` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer3D_get_playback_position>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer3D_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer3D_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AudioStreamPlayer3D_stop>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer3D_method_get_playback_position>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer3D_method_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer3D_method_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AudioStreamPlayer3D_method_stop>` **(** **)** |
|
||||
+---------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AudioStreamPlayer3D_finished:
|
||||
.. _class_AudioStreamPlayer3D_signal_finished:
|
||||
|
||||
- **finished** **(** **)**
|
||||
|
||||
@@ -86,6 +86,12 @@ Enumerations
|
||||
|
||||
.. _enum_AudioStreamPlayer3D_AttenuationModel:
|
||||
|
||||
.. _class_AudioStreamPlayer3D_constant_ATTENUATION_INVERSE_DISTANCE:
|
||||
|
||||
.. _class_AudioStreamPlayer3D_constant_ATTENUATION_INVERSE_SQUARE_DISTANCE:
|
||||
|
||||
.. _class_AudioStreamPlayer3D_constant_ATTENUATION_LOGARITHMIC:
|
||||
|
||||
enum **AttenuationModel**:
|
||||
|
||||
- **ATTENUATION_INVERSE_DISTANCE** = **0** --- Linear dampening of loudness according to distance.
|
||||
@@ -96,6 +102,10 @@ enum **AttenuationModel**:
|
||||
|
||||
.. _enum_AudioStreamPlayer3D_OutOfRangeMode:
|
||||
|
||||
.. _class_AudioStreamPlayer3D_constant_OUT_OF_RANGE_MIX:
|
||||
|
||||
.. _class_AudioStreamPlayer3D_constant_OUT_OF_RANGE_PAUSE:
|
||||
|
||||
enum **OutOfRangeMode**:
|
||||
|
||||
- **OUT_OF_RANGE_MIX** = **0** --- Mix this audio in, even when it's out of range.
|
||||
@@ -104,6 +114,12 @@ enum **OutOfRangeMode**:
|
||||
|
||||
.. _enum_AudioStreamPlayer3D_DopplerTracking:
|
||||
|
||||
.. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_DISABLED:
|
||||
|
||||
.. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_IDLE_STEP:
|
||||
|
||||
.. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_PHYSICS_STEP:
|
||||
|
||||
enum **DopplerTracking**:
|
||||
|
||||
- **DOPPLER_TRACKING_DISABLED** = **0** --- Disables doppler tracking.
|
||||
@@ -127,7 +143,7 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioStreamPlayer3D_area_mask:
|
||||
.. _class_AudioStreamPlayer3D_property_area_mask:
|
||||
|
||||
- :ref:`int<class_int>` **area_mask**
|
||||
|
||||
@@ -139,7 +155,7 @@ Property Descriptions
|
||||
|
||||
Areas in which this sound plays.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_attenuation_filter_cutoff_hz:
|
||||
.. _class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz:
|
||||
|
||||
- :ref:`float<class_float>` **attenuation_filter_cutoff_hz**
|
||||
|
||||
@@ -151,7 +167,7 @@ Areas in which this sound plays.
|
||||
|
||||
Dampens audio above this frequency, in Hz.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_attenuation_filter_db:
|
||||
.. _class_AudioStreamPlayer3D_property_attenuation_filter_db:
|
||||
|
||||
- :ref:`float<class_float>` **attenuation_filter_db**
|
||||
|
||||
@@ -163,7 +179,7 @@ Dampens audio above this frequency, in Hz.
|
||||
|
||||
Amount how much the filter affects the loudness, in dB.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_attenuation_model:
|
||||
.. _class_AudioStreamPlayer3D_property_attenuation_model:
|
||||
|
||||
- :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` **attenuation_model**
|
||||
|
||||
@@ -175,7 +191,7 @@ Amount how much the filter affects the loudness, in dB.
|
||||
|
||||
Decides if audio should get quieter with distance linearly, quadratically or logarithmically.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_autoplay:
|
||||
.. _class_AudioStreamPlayer3D_property_autoplay:
|
||||
|
||||
- :ref:`bool<class_bool>` **autoplay**
|
||||
|
||||
@@ -187,7 +203,7 @@ Decides if audio should get quieter with distance linearly, quadratically or log
|
||||
|
||||
If ``true``, audio plays when added to scene tree. Default value: ``false``.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_bus:
|
||||
.. _class_AudioStreamPlayer3D_property_bus:
|
||||
|
||||
- :ref:`String<class_String>` **bus**
|
||||
|
||||
@@ -199,7 +215,7 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``.
|
||||
|
||||
Bus on which this audio is playing.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_doppler_tracking:
|
||||
.. _class_AudioStreamPlayer3D_property_doppler_tracking:
|
||||
|
||||
- :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` **doppler_tracking**
|
||||
|
||||
@@ -211,7 +227,7 @@ Bus on which this audio is playing.
|
||||
|
||||
Decides in which step the Doppler effect should be calculated.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_emission_angle_degrees:
|
||||
.. _class_AudioStreamPlayer3D_property_emission_angle_degrees:
|
||||
|
||||
- :ref:`float<class_float>` **emission_angle_degrees**
|
||||
|
||||
@@ -223,7 +239,7 @@ Decides in which step the Doppler effect should be calculated.
|
||||
|
||||
The angle in which the audio reaches cameras undampened.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_emission_angle_enabled:
|
||||
.. _class_AudioStreamPlayer3D_property_emission_angle_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **emission_angle_enabled**
|
||||
|
||||
@@ -235,7 +251,7 @@ The angle in which the audio reaches cameras undampened.
|
||||
|
||||
If ``true``, the audio should be dampened according to the direction of the sound.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_emission_angle_filter_attenuation_db:
|
||||
.. _class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db:
|
||||
|
||||
- :ref:`float<class_float>` **emission_angle_filter_attenuation_db**
|
||||
|
||||
@@ -247,7 +263,7 @@ If ``true``, the audio should be dampened according to the direction of the soun
|
||||
|
||||
dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_max_db:
|
||||
.. _class_AudioStreamPlayer3D_property_max_db:
|
||||
|
||||
- :ref:`float<class_float>` **max_db**
|
||||
|
||||
@@ -259,7 +275,7 @@ dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_ang
|
||||
|
||||
Sets the absolute maximum of the soundlevel, in dB.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_max_distance:
|
||||
.. _class_AudioStreamPlayer3D_property_max_distance:
|
||||
|
||||
- :ref:`float<class_float>` **max_distance**
|
||||
|
||||
@@ -271,7 +287,7 @@ Sets the absolute maximum of the soundlevel, in dB.
|
||||
|
||||
Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_out_of_range_mode:
|
||||
.. _class_AudioStreamPlayer3D_property_out_of_range_mode:
|
||||
|
||||
- :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` **out_of_range_mode**
|
||||
|
||||
@@ -283,7 +299,7 @@ Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect
|
||||
|
||||
Decides if audio should pause when source is outside of 'max_distance' range.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_pitch_scale:
|
||||
.. _class_AudioStreamPlayer3D_property_pitch_scale:
|
||||
|
||||
- :ref:`float<class_float>` **pitch_scale**
|
||||
|
||||
@@ -295,7 +311,7 @@ Decides if audio should pause when source is outside of 'max_distance' range.
|
||||
|
||||
Changes the pitch and the tempo of the audio.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_playing:
|
||||
.. _class_AudioStreamPlayer3D_property_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **playing**
|
||||
|
||||
@@ -305,7 +321,7 @@ Changes the pitch and the tempo of the audio.
|
||||
|
||||
If ``true``, audio is playing.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_stream:
|
||||
.. _class_AudioStreamPlayer3D_property_stream:
|
||||
|
||||
- :ref:`AudioStream<class_AudioStream>` **stream**
|
||||
|
||||
@@ -317,7 +333,7 @@ If ``true``, audio is playing.
|
||||
|
||||
The :ref:`AudioStream<class_AudioStream>` object to be played.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_stream_paused:
|
||||
.. _class_AudioStreamPlayer3D_property_stream_paused:
|
||||
|
||||
- :ref:`bool<class_bool>` **stream_paused**
|
||||
|
||||
@@ -327,7 +343,7 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
|
||||
| *Getter* | get_stream_paused() |
|
||||
+----------+--------------------------+
|
||||
|
||||
.. _class_AudioStreamPlayer3D_unit_db:
|
||||
.. _class_AudioStreamPlayer3D_property_unit_db:
|
||||
|
||||
- :ref:`float<class_float>` **unit_db**
|
||||
|
||||
@@ -339,7 +355,7 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
|
||||
|
||||
Base sound level unaffected by dampening, in dB.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_unit_size:
|
||||
.. _class_AudioStreamPlayer3D_property_unit_size:
|
||||
|
||||
- :ref:`float<class_float>` **unit_size**
|
||||
|
||||
@@ -354,25 +370,25 @@ Factor for the attenuation effect.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_playback_position:
|
||||
.. _class_AudioStreamPlayer3D_method_get_playback_position:
|
||||
|
||||
- :ref:`float<class_float>` **get_playback_position** **(** **)**
|
||||
|
||||
Returns the position in the :ref:`AudioStream<class_AudioStream>`.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_play:
|
||||
.. _class_AudioStreamPlayer3D_method_play:
|
||||
|
||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||
|
||||
Plays the audio from the given position 'from_position', in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_seek:
|
||||
.. _class_AudioStreamPlayer3D_method_seek:
|
||||
|
||||
- void **seek** **(** :ref:`float<class_float>` to_position **)**
|
||||
|
||||
Sets the position from which audio will be played, in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_stop:
|
||||
.. _class_AudioStreamPlayer3D_method_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Plays audio with random pitch tweaking.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------+----------------------------------------------------------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_audio_stream>` |
|
||||
+---------------------------------------+----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_random_pitch>` |
|
||||
+---------------------------------------+----------------------------------------------------------------+
|
||||
+---------------------------------------+-------------------------------------------------------------------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_property_audio_stream>` |
|
||||
+---------------------------------------+-------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_property_random_pitch>` |
|
||||
+---------------------------------------+-------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -33,7 +33,7 @@ Randomly varies pitch on each start.
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioStreamRandomPitch_audio_stream:
|
||||
.. _class_AudioStreamRandomPitch_property_audio_stream:
|
||||
|
||||
- :ref:`AudioStream<class_AudioStream>` **audio_stream**
|
||||
|
||||
@@ -45,7 +45,7 @@ Property Descriptions
|
||||
|
||||
The current :ref:`AudioStream<class_AudioStream>`.
|
||||
|
||||
.. _class_AudioStreamRandomPitch_random_pitch:
|
||||
.. _class_AudioStreamRandomPitch_property_random_pitch:
|
||||
|
||||
- :ref:`float<class_float>` **random_pitch**
|
||||
|
||||
|
||||
@@ -19,34 +19,40 @@ Plays audio.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+--------------------------------------------------+-------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamSample_data>` |
|
||||
+--------------------------------------------------+-------------------------------------------------------+
|
||||
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioStreamSample_format>` |
|
||||
+--------------------------------------------------+-------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_begin<class_AudioStreamSample_loop_begin>` |
|
||||
+--------------------------------------------------+-------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_end<class_AudioStreamSample_loop_end>` |
|
||||
+--------------------------------------------------+-------------------------------------------------------+
|
||||
| :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` | :ref:`loop_mode<class_AudioStreamSample_loop_mode>` |
|
||||
+--------------------------------------------------+-------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`mix_rate<class_AudioStreamSample_mix_rate>` |
|
||||
+--------------------------------------------------+-------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stereo<class_AudioStreamSample_stereo>` |
|
||||
+--------------------------------------------------+-------------------------------------------------------+
|
||||
+--------------------------------------------------+----------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamSample_property_data>` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+
|
||||
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioStreamSample_property_format>` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_begin<class_AudioStreamSample_property_loop_begin>` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_end<class_AudioStreamSample_property_loop_end>` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+
|
||||
| :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` | :ref:`loop_mode<class_AudioStreamSample_property_loop_mode>` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`mix_rate<class_AudioStreamSample_property_mix_rate>` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stereo<class_AudioStreamSample_property_stereo>` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------+------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`save_to_wav<class_AudioStreamSample_save_to_wav>` **(** :ref:`String<class_String>` path **)** |
|
||||
+-------+------------------------------------------------------------------------------------------------------+
|
||||
+------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`save_to_wav<class_AudioStreamSample_method_save_to_wav>` **(** :ref:`String<class_String>` path **)** |
|
||||
+------+-------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_AudioStreamSample_Format:
|
||||
|
||||
.. _class_AudioStreamSample_constant_FORMAT_8_BITS:
|
||||
|
||||
.. _class_AudioStreamSample_constant_FORMAT_16_BITS:
|
||||
|
||||
.. _class_AudioStreamSample_constant_FORMAT_IMA_ADPCM:
|
||||
|
||||
enum **Format**:
|
||||
|
||||
- **FORMAT_8_BITS** = **0** --- Audio codec 8 bit.
|
||||
@@ -57,6 +63,14 @@ enum **Format**:
|
||||
|
||||
.. _enum_AudioStreamSample_LoopMode:
|
||||
|
||||
.. _class_AudioStreamSample_constant_LOOP_DISABLED:
|
||||
|
||||
.. _class_AudioStreamSample_constant_LOOP_FORWARD:
|
||||
|
||||
.. _class_AudioStreamSample_constant_LOOP_PING_PONG:
|
||||
|
||||
.. _class_AudioStreamSample_constant_LOOP_BACKWARD:
|
||||
|
||||
enum **LoopMode**:
|
||||
|
||||
- **LOOP_DISABLED** = **0** --- Audio does not loop.
|
||||
@@ -75,7 +89,7 @@ Plays audio, can loop.
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_AudioStreamSample_data:
|
||||
.. _class_AudioStreamSample_property_data:
|
||||
|
||||
- :ref:`PoolByteArray<class_PoolByteArray>` **data**
|
||||
|
||||
@@ -87,7 +101,7 @@ Property Descriptions
|
||||
|
||||
Contains the audio data in bytes.
|
||||
|
||||
.. _class_AudioStreamSample_format:
|
||||
.. _class_AudioStreamSample_property_format:
|
||||
|
||||
- :ref:`Format<enum_AudioStreamSample_Format>` **format**
|
||||
|
||||
@@ -99,7 +113,7 @@ Contains the audio data in bytes.
|
||||
|
||||
Audio format. See FORMAT\_\* constants for values.
|
||||
|
||||
.. _class_AudioStreamSample_loop_begin:
|
||||
.. _class_AudioStreamSample_property_loop_begin:
|
||||
|
||||
- :ref:`int<class_int>` **loop_begin**
|
||||
|
||||
@@ -111,7 +125,7 @@ Audio format. See FORMAT\_\* constants for values.
|
||||
|
||||
Loop start in bytes.
|
||||
|
||||
.. _class_AudioStreamSample_loop_end:
|
||||
.. _class_AudioStreamSample_property_loop_end:
|
||||
|
||||
- :ref:`int<class_int>` **loop_end**
|
||||
|
||||
@@ -123,7 +137,7 @@ Loop start in bytes.
|
||||
|
||||
Loop end in bytes.
|
||||
|
||||
.. _class_AudioStreamSample_loop_mode:
|
||||
.. _class_AudioStreamSample_property_loop_mode:
|
||||
|
||||
- :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` **loop_mode**
|
||||
|
||||
@@ -135,7 +149,7 @@ Loop end in bytes.
|
||||
|
||||
Loop mode. See LOOP\_\* constants for values.
|
||||
|
||||
.. _class_AudioStreamSample_mix_rate:
|
||||
.. _class_AudioStreamSample_property_mix_rate:
|
||||
|
||||
- :ref:`int<class_int>` **mix_rate**
|
||||
|
||||
@@ -147,7 +161,7 @@ Loop mode. See LOOP\_\* constants for values.
|
||||
|
||||
The sample rate for mixing this audio.
|
||||
|
||||
.. _class_AudioStreamSample_stereo:
|
||||
.. _class_AudioStreamSample_property_stereo:
|
||||
|
||||
- :ref:`bool<class_bool>` **stereo**
|
||||
|
||||
@@ -162,7 +176,7 @@ If ``true``, audio is stereo. Default value: ``false``.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_AudioStreamSample_save_to_wav:
|
||||
.. _class_AudioStreamSample_method_save_to_wav:
|
||||
|
||||
- void **save_to_wav** **(** :ref:`String<class_String>` path **)**
|
||||
|
||||
|
||||
@@ -19,17 +19,23 @@ Copies a region of the screen (or the whole screen) to a buffer so it can be acc
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` | :ref:`copy_mode<class_BackBufferCopy_copy_mode>` |
|
||||
+-----------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`rect<class_BackBufferCopy_rect>` |
|
||||
+-----------------------------------------------+--------------------------------------------------+
|
||||
+-----------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` | :ref:`copy_mode<class_BackBufferCopy_property_copy_mode>` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`rect<class_BackBufferCopy_property_rect>` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_BackBufferCopy_CopyMode:
|
||||
|
||||
.. _class_BackBufferCopy_constant_COPY_MODE_DISABLED:
|
||||
|
||||
.. _class_BackBufferCopy_constant_COPY_MODE_RECT:
|
||||
|
||||
.. _class_BackBufferCopy_constant_COPY_MODE_VIEWPORT:
|
||||
|
||||
enum **CopyMode**:
|
||||
|
||||
- **COPY_MODE_DISABLED** = **0** --- Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers.
|
||||
@@ -46,7 +52,7 @@ Node for back-buffering the currently displayed screen. The region defined in th
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_BackBufferCopy_copy_mode:
|
||||
.. _class_BackBufferCopy_property_copy_mode:
|
||||
|
||||
- :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` **copy_mode**
|
||||
|
||||
@@ -58,7 +64,7 @@ Property Descriptions
|
||||
|
||||
Buffer mode. See ``COPY_MODE_*`` constants.
|
||||
|
||||
.. _class_BackBufferCopy_rect:
|
||||
.. _class_BackBufferCopy_property_rect:
|
||||
|
||||
- :ref:`Rect2<class_Rect2>` **rect**
|
||||
|
||||
|
||||
@@ -19,42 +19,48 @@ Prerendered indirect light map for a scene.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_cell_size<class_BakedLightmap_bake_cell_size>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_energy<class_BakedLightmap_bake_energy>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`bake_extents<class_BakedLightmap_bake_extents>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bake_hdr<class_BakedLightmap_bake_hdr>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`BakeMode<enum_BakedLightmap_BakeMode>` | :ref:`bake_mode<class_BakedLightmap_bake_mode>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_propagation<class_BakedLightmap_bake_propagation>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` | :ref:`bake_quality<class_BakedLightmap_bake_quality>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`capture_cell_size<class_BakedLightmap_capture_cell_size>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`image_path<class_BakedLightmap_image_path>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`BakedLightmapData<class_BakedLightmapData>` | :ref:`light_data<class_BakedLightmap_light_data>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------------+
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_cell_size<class_BakedLightmap_property_bake_cell_size>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_energy<class_BakedLightmap_property_bake_energy>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`bake_extents<class_BakedLightmap_property_bake_extents>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bake_hdr<class_BakedLightmap_property_bake_hdr>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`BakeMode<enum_BakedLightmap_BakeMode>` | :ref:`bake_mode<class_BakedLightmap_property_bake_mode>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_propagation<class_BakedLightmap_property_bake_propagation>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` | :ref:`bake_quality<class_BakedLightmap_property_bake_quality>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`capture_cell_size<class_BakedLightmap_property_capture_cell_size>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`image_path<class_BakedLightmap_property_image_path>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`BakedLightmapData<class_BakedLightmapData>` | :ref:`light_data<class_BakedLightmap_property_light_data>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`BakeError<enum_BakedLightmap_BakeError>` | :ref:`bake<class_BakedLightmap_bake>` **(** :ref:`Node<class_Node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)** |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`debug_bake<class_BakedLightmap_debug_bake>` **(** **)** |
|
||||
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`BakeError<enum_BakedLightmap_BakeError>` | :ref:`bake<class_BakedLightmap_method_bake>` **(** :ref:`Node<class_Node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`debug_bake<class_BakedLightmap_method_debug_bake>` **(** **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_BakedLightmap_BakeQuality:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_QUALITY_LOW:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_QUALITY_MEDIUM:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_QUALITY_HIGH:
|
||||
|
||||
enum **BakeQuality**:
|
||||
|
||||
- **BAKE_QUALITY_LOW** = **0** --- Lowest bake quality mode. Fastest to calculate.
|
||||
@@ -65,6 +71,10 @@ enum **BakeQuality**:
|
||||
|
||||
.. _enum_BakedLightmap_BakeMode:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_MODE_CONE_TRACE:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_MODE_RAY_TRACE:
|
||||
|
||||
enum **BakeMode**:
|
||||
|
||||
- **BAKE_MODE_CONE_TRACE** = **0** --- Less precise but faster bake mode.
|
||||
@@ -73,6 +83,16 @@ enum **BakeMode**:
|
||||
|
||||
.. _enum_BakedLightmap_BakeError:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_ERROR_OK:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_ERROR_NO_SAVE_PATH:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_ERROR_NO_MESHES:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_ERROR_CANT_CREATE_IMAGE:
|
||||
|
||||
.. _class_BakedLightmap_constant_BAKE_ERROR_USER_ABORTED:
|
||||
|
||||
enum **BakeError**:
|
||||
|
||||
- **BAKE_ERROR_OK** = **0**
|
||||
@@ -98,7 +118,7 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_BakedLightmap_bake_cell_size:
|
||||
.. _class_BakedLightmap_property_bake_cell_size:
|
||||
|
||||
- :ref:`float<class_float>` **bake_cell_size**
|
||||
|
||||
@@ -110,7 +130,7 @@ Property Descriptions
|
||||
|
||||
Grid subdivision size for lightmapper calculation. Default value of ``0.25`` will work for most cases. Increase for better lighting on small details or if your scene is very large.
|
||||
|
||||
.. _class_BakedLightmap_bake_energy:
|
||||
.. _class_BakedLightmap_property_bake_energy:
|
||||
|
||||
- :ref:`float<class_float>` **bake_energy**
|
||||
|
||||
@@ -120,7 +140,7 @@ Grid subdivision size for lightmapper calculation. Default value of ``0.25`` wil
|
||||
| *Getter* | get_energy() |
|
||||
+----------+-------------------+
|
||||
|
||||
.. _class_BakedLightmap_bake_extents:
|
||||
.. _class_BakedLightmap_property_bake_extents:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **bake_extents**
|
||||
|
||||
@@ -132,7 +152,7 @@ Grid subdivision size for lightmapper calculation. Default value of ``0.25`` wil
|
||||
|
||||
Size of affected area.
|
||||
|
||||
.. _class_BakedLightmap_bake_hdr:
|
||||
.. _class_BakedLightmap_property_bake_hdr:
|
||||
|
||||
- :ref:`bool<class_bool>` **bake_hdr**
|
||||
|
||||
@@ -144,7 +164,7 @@ Size of affected area.
|
||||
|
||||
If ``true``, lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller lightmap. Default value:``false``.
|
||||
|
||||
.. _class_BakedLightmap_bake_mode:
|
||||
.. _class_BakedLightmap_property_bake_mode:
|
||||
|
||||
- :ref:`BakeMode<enum_BakedLightmap_BakeMode>` **bake_mode**
|
||||
|
||||
@@ -154,9 +174,9 @@ If ``true``, lightmap can capture light values greater than ``1.0``. Turning thi
|
||||
| *Getter* | get_bake_mode() |
|
||||
+----------+----------------------+
|
||||
|
||||
Lightmapping mode. See :ref:`BakeMode<enum_@GlobalScope_BakeMode>`.
|
||||
Lightmapping mode. See :ref:`BakeMode<enum_BakedLightmap_BakeMode>`.
|
||||
|
||||
.. _class_BakedLightmap_bake_propagation:
|
||||
.. _class_BakedLightmap_property_bake_propagation:
|
||||
|
||||
- :ref:`float<class_float>` **bake_propagation**
|
||||
|
||||
@@ -166,7 +186,7 @@ Lightmapping mode. See :ref:`BakeMode<enum_@GlobalScope_BakeMode>`.
|
||||
| *Getter* | get_propagation() |
|
||||
+----------+------------------------+
|
||||
|
||||
.. _class_BakedLightmap_bake_quality:
|
||||
.. _class_BakedLightmap_property_bake_quality:
|
||||
|
||||
- :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` **bake_quality**
|
||||
|
||||
@@ -176,9 +196,9 @@ Lightmapping mode. See :ref:`BakeMode<enum_@GlobalScope_BakeMode>`.
|
||||
| *Getter* | get_bake_quality() |
|
||||
+----------+-------------------------+
|
||||
|
||||
Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality<enum_@GlobalScope_BakeQuality>`.
|
||||
Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>`.
|
||||
|
||||
.. _class_BakedLightmap_capture_cell_size:
|
||||
.. _class_BakedLightmap_property_capture_cell_size:
|
||||
|
||||
- :ref:`float<class_float>` **capture_cell_size**
|
||||
|
||||
@@ -188,9 +208,9 @@ Three quality modes are available. Higher quality requires more rendering time.
|
||||
| *Getter* | get_capture_cell_size() |
|
||||
+----------+------------------------------+
|
||||
|
||||
Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size<class_BakedLightmap_bake_cell_size>`.
|
||||
Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size<class_BakedLightmap_property_bake_cell_size>`.
|
||||
|
||||
.. _class_BakedLightmap_image_path:
|
||||
.. _class_BakedLightmap_property_image_path:
|
||||
|
||||
- :ref:`String<class_String>` **image_path**
|
||||
|
||||
@@ -202,7 +222,7 @@ Grid size used for real-time capture information on dynamic objects. Cannot be l
|
||||
|
||||
Location where lightmaps will be saved.
|
||||
|
||||
.. _class_BakedLightmap_light_data:
|
||||
.. _class_BakedLightmap_property_light_data:
|
||||
|
||||
- :ref:`BakedLightmapData<class_BakedLightmapData>` **light_data**
|
||||
|
||||
@@ -217,11 +237,11 @@ The calculated light data.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_BakedLightmap_bake:
|
||||
.. _class_BakedLightmap_method_bake:
|
||||
|
||||
- :ref:`BakeError<enum_BakedLightmap_BakeError>` **bake** **(** :ref:`Node<class_Node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)**
|
||||
|
||||
.. _class_BakedLightmap_debug_bake:
|
||||
.. _class_BakedLightmap_method_debug_bake:
|
||||
|
||||
- void **debug_bake** **(** **)**
|
||||
|
||||
|
||||
@@ -19,37 +19,37 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`bounds<class_BakedLightmapData_bounds>` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`cell_space_transform<class_BakedLightmapData_cell_space_transform>` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`cell_subdiv<class_BakedLightmapData_cell_subdiv>` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`energy<class_BakedLightmapData_energy>` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`octree<class_BakedLightmapData_octree>` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------------+
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`bounds<class_BakedLightmapData_property_bounds>` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`cell_space_transform<class_BakedLightmapData_property_cell_space_transform>` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`cell_subdiv<class_BakedLightmapData_property_cell_subdiv>` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`energy<class_BakedLightmapData_property_energy>` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`octree<class_BakedLightmapData_property_octree>` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_user<class_BakedLightmapData_add_user>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_users<class_BakedLightmapData_clear_users>` **(** **)** |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_user_count<class_BakedLightmapData_get_user_count>` **(** **)** const |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`get_user_lightmap<class_BakedLightmapData_get_user_lightmap>` **(** :ref:`int<class_int>` user_idx **)** const |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`get_user_path<class_BakedLightmapData_get_user_path>` **(** :ref:`int<class_int>` user_idx **)** const |
|
||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_user<class_BakedLightmapData_method_add_user>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_users<class_BakedLightmapData_method_clear_users>` **(** **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_user_count<class_BakedLightmapData_method_get_user_count>` **(** **)** const |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`get_user_lightmap<class_BakedLightmapData_method_get_user_lightmap>` **(** :ref:`int<class_int>` user_idx **)** const |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`get_user_path<class_BakedLightmapData_method_get_user_path>` **(** :ref:`int<class_int>` user_idx **)** const |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_BakedLightmapData_bounds:
|
||||
.. _class_BakedLightmapData_property_bounds:
|
||||
|
||||
- :ref:`AABB<class_AABB>` **bounds**
|
||||
|
||||
@@ -59,7 +59,7 @@ Property Descriptions
|
||||
| *Getter* | get_bounds() |
|
||||
+----------+-------------------+
|
||||
|
||||
.. _class_BakedLightmapData_cell_space_transform:
|
||||
.. _class_BakedLightmapData_property_cell_space_transform:
|
||||
|
||||
- :ref:`Transform<class_Transform>` **cell_space_transform**
|
||||
|
||||
@@ -69,7 +69,7 @@ Property Descriptions
|
||||
| *Getter* | get_cell_space_transform() |
|
||||
+----------+---------------------------------+
|
||||
|
||||
.. _class_BakedLightmapData_cell_subdiv:
|
||||
.. _class_BakedLightmapData_property_cell_subdiv:
|
||||
|
||||
- :ref:`int<class_int>` **cell_subdiv**
|
||||
|
||||
@@ -79,7 +79,7 @@ Property Descriptions
|
||||
| *Getter* | get_cell_subdiv() |
|
||||
+----------+------------------------+
|
||||
|
||||
.. _class_BakedLightmapData_energy:
|
||||
.. _class_BakedLightmapData_property_energy:
|
||||
|
||||
- :ref:`float<class_float>` **energy**
|
||||
|
||||
@@ -89,7 +89,7 @@ Property Descriptions
|
||||
| *Getter* | get_energy() |
|
||||
+----------+-------------------+
|
||||
|
||||
.. _class_BakedLightmapData_octree:
|
||||
.. _class_BakedLightmapData_property_octree:
|
||||
|
||||
- :ref:`PoolByteArray<class_PoolByteArray>` **octree**
|
||||
|
||||
@@ -102,23 +102,23 @@ Property Descriptions
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_BakedLightmapData_add_user:
|
||||
.. _class_BakedLightmapData_method_add_user:
|
||||
|
||||
- void **add_user** **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)**
|
||||
|
||||
.. _class_BakedLightmapData_clear_users:
|
||||
.. _class_BakedLightmapData_method_clear_users:
|
||||
|
||||
- void **clear_users** **(** **)**
|
||||
|
||||
.. _class_BakedLightmapData_get_user_count:
|
||||
.. _class_BakedLightmapData_method_get_user_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_user_count** **(** **)** const
|
||||
|
||||
.. _class_BakedLightmapData_get_user_lightmap:
|
||||
.. _class_BakedLightmapData_method_get_user_lightmap:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **get_user_lightmap** **(** :ref:`int<class_int>` user_idx **)** const
|
||||
|
||||
.. _class_BakedLightmapData_get_user_path:
|
||||
.. _class_BakedLightmapData_method_get_user_path:
|
||||
|
||||
- :ref:`NodePath<class_NodePath>` **get_user_path** **(** :ref:`int<class_int>` user_idx **)** const
|
||||
|
||||
|
||||
@@ -21,61 +21,61 @@ Base class for different kinds of buttons.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`ActionMode<enum_BaseButton_ActionMode>` | :ref:`action_mode<class_BaseButton_action_mode>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`button_mask<class_BaseButton_button_mask>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_BaseButton_disabled>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`enabled_focus_mode<class_BaseButton_enabled_focus_mode>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`ButtonGroup<class_ButtonGroup>` | :ref:`group<class_BaseButton_group>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`pressed<class_BaseButton_pressed>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`ShortCut<class_ShortCut>` | :ref:`shortcut<class_BaseButton_shortcut>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shortcut_in_tooltip<class_BaseButton_shortcut_in_tooltip>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`toggle_mode<class_BaseButton_toggle_mode>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------+
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`ActionMode<enum_BaseButton_ActionMode>` | :ref:`action_mode<class_BaseButton_property_action_mode>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`button_mask<class_BaseButton_property_button_mask>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_BaseButton_property_disabled>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`enabled_focus_mode<class_BaseButton_property_enabled_focus_mode>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`ButtonGroup<class_ButtonGroup>` | :ref:`group<class_BaseButton_property_group>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`pressed<class_BaseButton_property_pressed>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`ShortCut<class_ShortCut>` | :ref:`shortcut<class_BaseButton_property_shortcut>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shortcut_in_tooltip<class_BaseButton_property_shortcut_in_tooltip>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_pressed<class_BaseButton__pressed>` **(** **)** virtual |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` button_pressed **)** virtual |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`DrawMode<enum_BaseButton_DrawMode>` | :ref:`get_draw_mode<class_BaseButton_get_draw_mode>` **(** **)** const |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_is_hovered>` **(** **)** const |
|
||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_pressed<class_BaseButton_method__pressed>` **(** **)** virtual |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_toggled<class_BaseButton_method__toggled>` **(** :ref:`bool<class_bool>` button_pressed **)** virtual |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`DrawMode<enum_BaseButton_DrawMode>` | :ref:`get_draw_mode<class_BaseButton_method_get_draw_mode>` **(** **)** const |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_method_is_hovered>` **(** **)** const |
|
||||
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_BaseButton_button_down:
|
||||
.. _class_BaseButton_signal_button_down:
|
||||
|
||||
- **button_down** **(** **)**
|
||||
|
||||
Emitted when the button starts being held down.
|
||||
|
||||
.. _class_BaseButton_button_up:
|
||||
.. _class_BaseButton_signal_button_up:
|
||||
|
||||
- **button_up** **(** **)**
|
||||
|
||||
Emitted when the button stops being held down.
|
||||
|
||||
.. _class_BaseButton_pressed:
|
||||
.. _class_BaseButton_signal_pressed:
|
||||
|
||||
- **pressed** **(** **)**
|
||||
|
||||
This signal is emitted every time the button is toggled or pressed (i.e. activated, so on ``button_down`` if "Click on press" is active and on ``button_up`` otherwise).
|
||||
|
||||
.. _class_BaseButton_toggled:
|
||||
.. _class_BaseButton_signal_toggled:
|
||||
|
||||
- **toggled** **(** :ref:`bool<class_bool>` button_pressed **)**
|
||||
|
||||
@@ -86,6 +86,16 @@ Enumerations
|
||||
|
||||
.. _enum_BaseButton_DrawMode:
|
||||
|
||||
.. _class_BaseButton_constant_DRAW_NORMAL:
|
||||
|
||||
.. _class_BaseButton_constant_DRAW_PRESSED:
|
||||
|
||||
.. _class_BaseButton_constant_DRAW_HOVER:
|
||||
|
||||
.. _class_BaseButton_constant_DRAW_DISABLED:
|
||||
|
||||
.. _class_BaseButton_constant_DRAW_HOVER_PRESSED:
|
||||
|
||||
enum **DrawMode**:
|
||||
|
||||
- **DRAW_NORMAL** = **0** --- The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.
|
||||
@@ -100,6 +110,10 @@ enum **DrawMode**:
|
||||
|
||||
.. _enum_BaseButton_ActionMode:
|
||||
|
||||
.. _class_BaseButton_constant_ACTION_MODE_BUTTON_PRESS:
|
||||
|
||||
.. _class_BaseButton_constant_ACTION_MODE_BUTTON_RELEASE:
|
||||
|
||||
enum **ActionMode**:
|
||||
|
||||
- **ACTION_MODE_BUTTON_PRESS** = **0** --- Require just a press to consider the button clicked.
|
||||
@@ -114,7 +128,7 @@ BaseButton is the abstract base class for buttons, so it shouldn't be used direc
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_BaseButton_action_mode:
|
||||
.. _class_BaseButton_property_action_mode:
|
||||
|
||||
- :ref:`ActionMode<enum_BaseButton_ActionMode>` **action_mode**
|
||||
|
||||
@@ -126,7 +140,7 @@ Property Descriptions
|
||||
|
||||
Determines when the button is considered clicked, one of the ACTION_MODE\_\* constants.
|
||||
|
||||
.. _class_BaseButton_button_mask:
|
||||
.. _class_BaseButton_property_button_mask:
|
||||
|
||||
- :ref:`int<class_int>` **button_mask**
|
||||
|
||||
@@ -140,7 +154,7 @@ Binary mask to choose which mouse buttons this button will respond to.
|
||||
|
||||
To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT.
|
||||
|
||||
.. _class_BaseButton_disabled:
|
||||
.. _class_BaseButton_property_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
@@ -152,7 +166,7 @@ To allow both left-click and right-click, set this to 3, because it's BUTTON_MAS
|
||||
|
||||
If ``true``, the button is in disabled state and can't be clicked or toggled.
|
||||
|
||||
.. _class_BaseButton_enabled_focus_mode:
|
||||
.. _class_BaseButton_property_enabled_focus_mode:
|
||||
|
||||
- :ref:`FocusMode<enum_Control_FocusMode>` **enabled_focus_mode**
|
||||
|
||||
@@ -162,9 +176,9 @@ If ``true``, the button is in disabled state and can't be clicked or toggled.
|
||||
| *Getter* | get_enabled_focus_mode() |
|
||||
+----------+-------------------------------+
|
||||
|
||||
Focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode<class_Control_set_focus_mode>` and :ref:`disabled<class_BaseButton_disabled>`).
|
||||
Focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode<class_Control_method_set_focus_mode>` and :ref:`disabled<class_BaseButton_property_disabled>`).
|
||||
|
||||
.. _class_BaseButton_group:
|
||||
.. _class_BaseButton_property_group:
|
||||
|
||||
- :ref:`ButtonGroup<class_ButtonGroup>` **group**
|
||||
|
||||
@@ -176,7 +190,7 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont
|
||||
|
||||
:ref:`ButtonGroup<class_ButtonGroup>` associated to the button.
|
||||
|
||||
.. _class_BaseButton_pressed:
|
||||
.. _class_BaseButton_property_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **pressed**
|
||||
|
||||
@@ -188,7 +202,7 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont
|
||||
|
||||
If ``true``, the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active).
|
||||
|
||||
.. _class_BaseButton_shortcut:
|
||||
.. _class_BaseButton_property_shortcut:
|
||||
|
||||
- :ref:`ShortCut<class_ShortCut>` **shortcut**
|
||||
|
||||
@@ -200,7 +214,7 @@ If ``true``, the button's state is pressed. Means the button is pressed down or
|
||||
|
||||
:ref:`ShortCut<class_ShortCut>` associated to the button.
|
||||
|
||||
.. _class_BaseButton_shortcut_in_tooltip:
|
||||
.. _class_BaseButton_property_shortcut_in_tooltip:
|
||||
|
||||
- :ref:`bool<class_bool>` **shortcut_in_tooltip**
|
||||
|
||||
@@ -212,7 +226,7 @@ If ``true``, the button's state is pressed. Means the button is pressed down or
|
||||
|
||||
If ``true``, the button will add information about its shortcut in the tooltip.
|
||||
|
||||
.. _class_BaseButton_toggle_mode:
|
||||
.. _class_BaseButton_property_toggle_mode:
|
||||
|
||||
- :ref:`bool<class_bool>` **toggle_mode**
|
||||
|
||||
@@ -227,25 +241,25 @@ If ``true``, the button is in toggle mode. Makes the button flip state between p
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_BaseButton__pressed:
|
||||
.. _class_BaseButton_method__pressed:
|
||||
|
||||
- void **_pressed** **(** **)** virtual
|
||||
|
||||
Called when the button is pressed.
|
||||
|
||||
.. _class_BaseButton__toggled:
|
||||
.. _class_BaseButton_method__toggled:
|
||||
|
||||
- void **_toggled** **(** :ref:`bool<class_bool>` button_pressed **)** virtual
|
||||
|
||||
Called when the button is toggled (only if toggle_mode is active).
|
||||
|
||||
.. _class_BaseButton_get_draw_mode:
|
||||
.. _class_BaseButton_method_get_draw_mode:
|
||||
|
||||
- :ref:`DrawMode<enum_BaseButton_DrawMode>` **get_draw_mode** **(** **)** const
|
||||
|
||||
Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum.
|
||||
|
||||
.. _class_BaseButton_is_hovered:
|
||||
.. _class_BaseButton_method_is_hovered:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_hovered** **(** **)** const
|
||||
|
||||
|
||||
@@ -17,56 +17,56 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+-------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`x<class_Basis_x>` |
|
||||
+-------------------------------+-------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`y<class_Basis_y>` |
|
||||
+-------------------------------+-------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`z<class_Basis_z>` |
|
||||
+-------------------------------+-------------------------+
|
||||
+-------------------------------+----------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`x<class_Basis_property_x>` |
|
||||
+-------------------------------+----------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`y<class_Basis_property_y>` |
|
||||
+-------------------------------+----------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`z<class_Basis_property_z>` |
|
||||
+-------------------------------+----------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Quat<class_Quat>` from **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_Vector3>` from **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_Vector3>` x_axis, :ref:`Vector3<class_Vector3>` y_axis, :ref:`Vector3<class_Vector3>` z_axis **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`determinant<class_Basis_determinant>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_euler<class_Basis_get_euler>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_orthogonal_index<class_Basis_get_orthogonal_index>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_scale<class_Basis_get_scale>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`inverse<class_Basis_inverse>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`orthonormalized<class_Basis_orthonormalized>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`rotated<class_Basis_rotated>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`scaled<class_Basis_scaled>` **(** :ref:`Vector3<class_Vector3>` scale **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`slerp<class_Basis_slerp>` **(** :ref:`Basis<class_Basis>` b, :ref:`float<class_float>` t **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tdotx<class_Basis_tdotx>` **(** :ref:`Vector3<class_Vector3>` with **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tdoty<class_Basis_tdoty>` **(** :ref:`Vector3<class_Vector3>` with **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tdotz<class_Basis_tdotz>` **(** :ref:`Vector3<class_Vector3>` with **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`transposed<class_Basis_transposed>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`xform<class_Basis_xform>` **(** :ref:`Vector3<class_Vector3>` v **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`xform_inv<class_Basis_xform_inv>` **(** :ref:`Vector3<class_Vector3>` v **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_method_Basis>` **(** :ref:`Quat<class_Quat>` from **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_method_Basis>` **(** :ref:`Vector3<class_Vector3>` from **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_method_Basis>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_method_Basis>` **(** :ref:`Vector3<class_Vector3>` x_axis, :ref:`Vector3<class_Vector3>` y_axis, :ref:`Vector3<class_Vector3>` z_axis **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`determinant<class_Basis_method_determinant>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_euler<class_Basis_method_get_euler>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_orthogonal_index<class_Basis_method_get_orthogonal_index>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_scale<class_Basis_method_get_scale>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`inverse<class_Basis_method_inverse>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`orthonormalized<class_Basis_method_orthonormalized>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`rotated<class_Basis_method_rotated>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`scaled<class_Basis_method_scaled>` **(** :ref:`Vector3<class_Vector3>` scale **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`slerp<class_Basis_method_slerp>` **(** :ref:`Basis<class_Basis>` b, :ref:`float<class_float>` t **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tdotx<class_Basis_method_tdotx>` **(** :ref:`Vector3<class_Vector3>` with **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tdoty<class_Basis_method_tdoty>` **(** :ref:`Vector3<class_Vector3>` with **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tdotz<class_Basis_method_tdotz>` **(** :ref:`Vector3<class_Vector3>` with **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_Basis>` | :ref:`transposed<class_Basis_method_transposed>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`xform<class_Basis_method_xform>` **(** :ref:`Vector3<class_Vector3>` v **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`xform_inv<class_Basis_method_xform_inv>` **(** :ref:`Vector3<class_Vector3>` v **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -85,19 +85,19 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Basis_x:
|
||||
.. _class_Basis_property_x:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **x**
|
||||
|
||||
The basis matrix's x vector.
|
||||
|
||||
.. _class_Basis_y:
|
||||
.. _class_Basis_property_y:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **y**
|
||||
|
||||
The basis matrix's y vector.
|
||||
|
||||
.. _class_Basis_z:
|
||||
.. _class_Basis_property_z:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **z**
|
||||
|
||||
@@ -106,115 +106,109 @@ The basis matrix's z vector.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Basis_Basis:
|
||||
.. _class_Basis_method_Basis:
|
||||
|
||||
- :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Quat<class_Quat>` from **)**
|
||||
|
||||
Create a rotation matrix from the given quaternion.
|
||||
|
||||
.. _class_Basis_Basis:
|
||||
|
||||
- :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Vector3<class_Vector3>` from **)**
|
||||
|
||||
Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle).
|
||||
|
||||
.. _class_Basis_Basis:
|
||||
|
||||
- :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)**
|
||||
|
||||
Create a rotation matrix which rotates around the given axis by the specified angle, in radians. The axis must be a normalized vector.
|
||||
|
||||
.. _class_Basis_Basis:
|
||||
|
||||
- :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Vector3<class_Vector3>` x_axis, :ref:`Vector3<class_Vector3>` y_axis, :ref:`Vector3<class_Vector3>` z_axis **)**
|
||||
|
||||
Create a matrix from 3 axis vectors.
|
||||
|
||||
.. _class_Basis_determinant:
|
||||
.. _class_Basis_method_determinant:
|
||||
|
||||
- :ref:`float<class_float>` **determinant** **(** **)**
|
||||
|
||||
Return the determinant of the matrix.
|
||||
|
||||
.. _class_Basis_get_euler:
|
||||
.. _class_Basis_method_get_euler:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **get_euler** **(** **)**
|
||||
|
||||
Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the YXZ convention: first Z, then X, and Y last). Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle).
|
||||
|
||||
.. _class_Basis_get_orthogonal_index:
|
||||
.. _class_Basis_method_get_orthogonal_index:
|
||||
|
||||
- :ref:`int<class_int>` **get_orthogonal_index** **(** **)**
|
||||
|
||||
This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1,0 or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the grid map editor. For further details, refer to Godot source code.
|
||||
|
||||
.. _class_Basis_get_scale:
|
||||
.. _class_Basis_method_get_scale:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **get_scale** **(** **)**
|
||||
|
||||
Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis.
|
||||
|
||||
.. _class_Basis_inverse:
|
||||
.. _class_Basis_method_inverse:
|
||||
|
||||
- :ref:`Basis<class_Basis>` **inverse** **(** **)**
|
||||
|
||||
Return the inverse of the matrix.
|
||||
|
||||
.. _class_Basis_orthonormalized:
|
||||
.. _class_Basis_method_orthonormalized:
|
||||
|
||||
- :ref:`Basis<class_Basis>` **orthonormalized** **(** **)**
|
||||
|
||||
Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix.
|
||||
|
||||
.. _class_Basis_rotated:
|
||||
.. _class_Basis_method_rotated:
|
||||
|
||||
- :ref:`Basis<class_Basis>` **rotated** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)**
|
||||
|
||||
Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector.
|
||||
|
||||
.. _class_Basis_scaled:
|
||||
.. _class_Basis_method_scaled:
|
||||
|
||||
- :ref:`Basis<class_Basis>` **scaled** **(** :ref:`Vector3<class_Vector3>` scale **)**
|
||||
|
||||
Introduce an additional scaling specified by the given 3D scaling factor.
|
||||
|
||||
.. _class_Basis_slerp:
|
||||
.. _class_Basis_method_slerp:
|
||||
|
||||
- :ref:`Basis<class_Basis>` **slerp** **(** :ref:`Basis<class_Basis>` b, :ref:`float<class_float>` t **)**
|
||||
|
||||
Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix.
|
||||
|
||||
.. _class_Basis_tdotx:
|
||||
.. _class_Basis_method_tdotx:
|
||||
|
||||
- :ref:`float<class_float>` **tdotx** **(** :ref:`Vector3<class_Vector3>` with **)**
|
||||
|
||||
Transposed dot product with the x axis of the matrix.
|
||||
|
||||
.. _class_Basis_tdoty:
|
||||
.. _class_Basis_method_tdoty:
|
||||
|
||||
- :ref:`float<class_float>` **tdoty** **(** :ref:`Vector3<class_Vector3>` with **)**
|
||||
|
||||
Transposed dot product with the y axis of the matrix.
|
||||
|
||||
.. _class_Basis_tdotz:
|
||||
.. _class_Basis_method_tdotz:
|
||||
|
||||
- :ref:`float<class_float>` **tdotz** **(** :ref:`Vector3<class_Vector3>` with **)**
|
||||
|
||||
Transposed dot product with the z axis of the matrix.
|
||||
|
||||
.. _class_Basis_transposed:
|
||||
.. _class_Basis_method_transposed:
|
||||
|
||||
- :ref:`Basis<class_Basis>` **transposed** **(** **)**
|
||||
|
||||
Return the transposed version of the matrix.
|
||||
|
||||
.. _class_Basis_xform:
|
||||
.. _class_Basis_method_xform:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **xform** **(** :ref:`Vector3<class_Vector3>` v **)**
|
||||
|
||||
Return a vector transformed (multiplied) by the matrix.
|
||||
|
||||
.. _class_Basis_xform_inv:
|
||||
.. _class_Basis_method_xform_inv:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **xform_inv** **(** :ref:`Vector3<class_Vector3>` v **)**
|
||||
|
||||
|
||||
@@ -19,25 +19,25 @@ Boolean matrix.
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create<class_BitMap_create>` **(** :ref:`Vector2<class_Vector2>` size **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create_from_image_alpha<class_BitMap_create_from_image_alpha>` **(** :ref:`Image<class_Image>` image, :ref:`float<class_float>` threshold=0.1 **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_bit<class_BitMap_get_bit>` **(** :ref:`Vector2<class_Vector2>` position **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_size<class_BitMap_get_size>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_true_bit_count<class_BitMap_get_true_bit_count>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`grow_mask<class_BitMap_grow_mask>` **(** :ref:`int<class_int>` pixels, :ref:`Rect2<class_Rect2>` rect **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`opaque_to_polygons<class_BitMap_opaque_to_polygons>` **(** :ref:`Rect2<class_Rect2>` rect, :ref:`float<class_float>` epsilon=2.0 **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bit<class_BitMap_set_bit>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` bit **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bit_rect<class_BitMap_set_bit_rect>` **(** :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` bit **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create<class_BitMap_method_create>` **(** :ref:`Vector2<class_Vector2>` size **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create_from_image_alpha<class_BitMap_method_create_from_image_alpha>` **(** :ref:`Image<class_Image>` image, :ref:`float<class_float>` threshold=0.1 **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_bit<class_BitMap_method_get_bit>` **(** :ref:`Vector2<class_Vector2>` position **)** const |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_size<class_BitMap_method_get_size>` **(** **)** const |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_true_bit_count<class_BitMap_method_get_true_bit_count>` **(** **)** const |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`grow_mask<class_BitMap_method_grow_mask>` **(** :ref:`int<class_int>` pixels, :ref:`Rect2<class_Rect2>` rect **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`opaque_to_polygons<class_BitMap_method_opaque_to_polygons>` **(** :ref:`Rect2<class_Rect2>` rect, :ref:`float<class_float>` epsilon=2.0 **)** const |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bit<class_BitMap_method_set_bit>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` bit **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bit_rect<class_BitMap_method_set_bit_rect>` **(** :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` bit **)** |
|
||||
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -47,51 +47,51 @@ A two-dimensional array of boolean values, can be used to efficiently store a bi
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_BitMap_create:
|
||||
.. _class_BitMap_method_create:
|
||||
|
||||
- void **create** **(** :ref:`Vector2<class_Vector2>` size **)**
|
||||
|
||||
Creates a bitmap with the specified size, filled with false.
|
||||
|
||||
.. _class_BitMap_create_from_image_alpha:
|
||||
.. _class_BitMap_method_create_from_image_alpha:
|
||||
|
||||
- void **create_from_image_alpha** **(** :ref:`Image<class_Image>` image, :ref:`float<class_float>` threshold=0.1 **)**
|
||||
|
||||
Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is equal to ``threshold`` or less, and true in other case.
|
||||
|
||||
.. _class_BitMap_get_bit:
|
||||
.. _class_BitMap_method_get_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_bit** **(** :ref:`Vector2<class_Vector2>` position **)** const
|
||||
|
||||
Returns bitmap's value at the specified position.
|
||||
|
||||
.. _class_BitMap_get_size:
|
||||
.. _class_BitMap_method_get_size:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_size** **(** **)** const
|
||||
|
||||
Returns bitmap's dimensions.
|
||||
|
||||
.. _class_BitMap_get_true_bit_count:
|
||||
.. _class_BitMap_method_get_true_bit_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_true_bit_count** **(** **)** const
|
||||
|
||||
Returns the amount of bitmap elements that are set to true.
|
||||
|
||||
.. _class_BitMap_grow_mask:
|
||||
.. _class_BitMap_method_grow_mask:
|
||||
|
||||
- void **grow_mask** **(** :ref:`int<class_int>` pixels, :ref:`Rect2<class_Rect2>` rect **)**
|
||||
|
||||
.. _class_BitMap_opaque_to_polygons:
|
||||
.. _class_BitMap_method_opaque_to_polygons:
|
||||
|
||||
- :ref:`Array<class_Array>` **opaque_to_polygons** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`float<class_float>` epsilon=2.0 **)** const
|
||||
|
||||
.. _class_BitMap_set_bit:
|
||||
.. _class_BitMap_method_set_bit:
|
||||
|
||||
- void **set_bit** **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` bit **)**
|
||||
|
||||
Sets the bitmap's element at the specified position, to the specified value.
|
||||
|
||||
.. _class_BitMap_set_bit_rect:
|
||||
.. _class_BitMap_method_set_bit_rect:
|
||||
|
||||
- void **set_bit_rect** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` bit **)**
|
||||
|
||||
|
||||
@@ -19,38 +19,38 @@ Renders text using ``*.fnt`` fonts.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`ascent<class_BitmapFont_ascent>` |
|
||||
+-------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`distance_field<class_BitmapFont_distance_field>` |
|
||||
+-------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`BitmapFont<class_BitmapFont>` | :ref:`fallback<class_BitmapFont_fallback>` |
|
||||
+-------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_BitmapFont_height>` |
|
||||
+-------------------------------------+--------------------------------------------------------+
|
||||
+-------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`ascent<class_BitmapFont_property_ascent>` |
|
||||
+-------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`distance_field<class_BitmapFont_property_distance_field>` |
|
||||
+-------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`BitmapFont<class_BitmapFont>` | :ref:`fallback<class_BitmapFont_property_fallback>` |
|
||||
+-------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_BitmapFont_property_height>` |
|
||||
+-------------------------------------+-----------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_char<class_BitmapFont_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Vector2<class_Vector2>` align=Vector2( 0, 0 ), :ref:`float<class_float>` advance=-1 **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_kerning_pair<class_BitmapFont_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_texture<class_BitmapFont_add_texture>` **(** :ref:`Texture<class_Texture>` texture **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_BitmapFont_clear>` **(** **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`create_from_fnt<class_BitmapFont_create_from_fnt>` **(** :ref:`String<class_String>` path **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_char_size<class_BitmapFont_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`get_texture<class_BitmapFont_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_get_texture_count>` **(** **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_char<class_BitmapFont_method_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Vector2<class_Vector2>` align=Vector2( 0, 0 ), :ref:`float<class_float>` advance=-1 **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_kerning_pair<class_BitmapFont_method_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_texture<class_BitmapFont_method_add_texture>` **(** :ref:`Texture<class_Texture>` texture **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_BitmapFont_method_clear>` **(** **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`create_from_fnt<class_BitmapFont_method_create_from_fnt>` **(** :ref:`String<class_String>` path **)** |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_char_size<class_BitmapFont_method_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_method_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`get_texture<class_BitmapFont_method_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_method_get_texture_count>` **(** **)** const |
|
||||
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -60,7 +60,7 @@ Renders text using ``*.fnt`` fonts containing texture atlases. Supports distance
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_BitmapFont_ascent:
|
||||
.. _class_BitmapFont_property_ascent:
|
||||
|
||||
- :ref:`float<class_float>` **ascent**
|
||||
|
||||
@@ -72,7 +72,7 @@ Property Descriptions
|
||||
|
||||
Ascent (number of pixels above the baseline).
|
||||
|
||||
.. _class_BitmapFont_distance_field:
|
||||
.. _class_BitmapFont_property_distance_field:
|
||||
|
||||
- :ref:`bool<class_bool>` **distance_field**
|
||||
|
||||
@@ -84,7 +84,7 @@ Ascent (number of pixels above the baseline).
|
||||
|
||||
If ``true``, distance field hint is enabled.
|
||||
|
||||
.. _class_BitmapFont_fallback:
|
||||
.. _class_BitmapFont_property_fallback:
|
||||
|
||||
- :ref:`BitmapFont<class_BitmapFont>` **fallback**
|
||||
|
||||
@@ -96,7 +96,7 @@ If ``true``, distance field hint is enabled.
|
||||
|
||||
The fallback font.
|
||||
|
||||
.. _class_BitmapFont_height:
|
||||
.. _class_BitmapFont_property_height:
|
||||
|
||||
- :ref:`float<class_float>` **height**
|
||||
|
||||
@@ -111,55 +111,55 @@ Total font height (ascent plus descent) in pixels.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_BitmapFont_add_char:
|
||||
.. _class_BitmapFont_method_add_char:
|
||||
|
||||
- void **add_char** **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Vector2<class_Vector2>` align=Vector2( 0, 0 ), :ref:`float<class_float>` advance=-1 **)**
|
||||
|
||||
Adds a character to the font, where ``character`` is the unicode value, ``texture`` is the texture index, ``rect`` is the region in the texture (in pixels!), ``align`` is the (optional) alignment for the character and ``advance`` is the (optional) advance.
|
||||
|
||||
.. _class_BitmapFont_add_kerning_pair:
|
||||
.. _class_BitmapFont_method_add_kerning_pair:
|
||||
|
||||
- void **add_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)**
|
||||
|
||||
Adds a kerning pair to the ``BitmapFont`` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
|
||||
|
||||
.. _class_BitmapFont_add_texture:
|
||||
.. _class_BitmapFont_method_add_texture:
|
||||
|
||||
- void **add_texture** **(** :ref:`Texture<class_Texture>` texture **)**
|
||||
|
||||
Adds a texture to the ``BitmapFont``.
|
||||
|
||||
.. _class_BitmapFont_clear:
|
||||
.. _class_BitmapFont_method_clear:
|
||||
|
||||
- void **clear** **(** **)**
|
||||
|
||||
Clears all the font data and settings.
|
||||
|
||||
.. _class_BitmapFont_create_from_fnt:
|
||||
.. _class_BitmapFont_method_create_from_fnt:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **create_from_fnt** **(** :ref:`String<class_String>` path **)**
|
||||
|
||||
Creates a BitmapFont from the ``*.fnt`` file at ``path``.
|
||||
|
||||
.. _class_BitmapFont_get_char_size:
|
||||
.. _class_BitmapFont_method_get_char_size:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const
|
||||
|
||||
Returns the size of a character, optionally taking kerning into account if the next character is provided.
|
||||
|
||||
.. _class_BitmapFont_get_kerning_pair:
|
||||
.. _class_BitmapFont_method_get_kerning_pair:
|
||||
|
||||
- :ref:`int<class_int>` **get_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const
|
||||
|
||||
Returns a kerning pair as a difference.
|
||||
|
||||
.. _class_BitmapFont_get_texture:
|
||||
.. _class_BitmapFont_method_get_texture:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **get_texture** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the font atlas texture at index ``idx``.
|
||||
|
||||
.. _class_BitmapFont_get_texture_count:
|
||||
.. _class_BitmapFont_method_get_texture_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_texture_count** **(** **)** const
|
||||
|
||||
|
||||
@@ -19,27 +19,27 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------+----------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`default_length<class_Bone2D_default_length>` |
|
||||
+---------------------------------------+----------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`rest<class_Bone2D_rest>` |
|
||||
+---------------------------------------+----------------------------------------------------+
|
||||
+---------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`default_length<class_Bone2D_property_default_length>` |
|
||||
+---------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`rest<class_Bone2D_property_rest>` |
|
||||
+---------------------------------------+-------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------------------+------------------------------------------------------------------------------------+
|
||||
| void | :ref:`apply_rest<class_Bone2D_apply_rest>` **(** **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_index_in_skeleton<class_Bone2D_get_index_in_skeleton>` **(** **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_skeleton_rest<class_Bone2D_get_skeleton_rest>` **(** **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------+
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`apply_rest<class_Bone2D_method_apply_rest>` **(** **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_index_in_skeleton<class_Bone2D_method_get_index_in_skeleton>` **(** **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_skeleton_rest<class_Bone2D_method_get_skeleton_rest>` **(** **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Bone2D_default_length:
|
||||
.. _class_Bone2D_property_default_length:
|
||||
|
||||
- :ref:`float<class_float>` **default_length**
|
||||
|
||||
@@ -49,7 +49,7 @@ Property Descriptions
|
||||
| *Getter* | get_default_length() |
|
||||
+----------+---------------------------+
|
||||
|
||||
.. _class_Bone2D_rest:
|
||||
.. _class_Bone2D_property_rest:
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **rest**
|
||||
|
||||
@@ -62,15 +62,15 @@ Property Descriptions
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Bone2D_apply_rest:
|
||||
.. _class_Bone2D_method_apply_rest:
|
||||
|
||||
- void **apply_rest** **(** **)**
|
||||
|
||||
.. _class_Bone2D_get_index_in_skeleton:
|
||||
.. _class_Bone2D_method_get_index_in_skeleton:
|
||||
|
||||
- :ref:`int<class_int>` **get_index_in_skeleton** **(** **)** const
|
||||
|
||||
.. _class_Bone2D_get_skeleton_rest:
|
||||
.. _class_Bone2D_method_get_skeleton_rest:
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **get_skeleton_rest** **(** **)** const
|
||||
|
||||
|
||||
@@ -19,9 +19,9 @@ A node that will attach to a bone.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+--------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`bone_name<class_BoneAttachment_bone_name>` |
|
||||
+-----------------------------+--------------------------------------------------+
|
||||
+-----------------------------+-----------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`bone_name<class_BoneAttachment_property_bone_name>` |
|
||||
+-----------------------------+-----------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -31,7 +31,7 @@ This node must be the child of a :ref:`Skeleton<class_Skeleton>` node. You can t
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_BoneAttachment_bone_name:
|
||||
.. _class_BoneAttachment_property_bone_name:
|
||||
|
||||
- :ref:`String<class_String>` **bone_name**
|
||||
|
||||
|
||||
@@ -17,13 +17,13 @@ Boolean built-in type
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`int<class_int>` from **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`float<class_float>` from **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`String<class_String>` from **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------+
|
||||
+-------------------------+----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_method_bool>` **(** :ref:`int<class_int>` from **)** |
|
||||
+-------------------------+----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_method_bool>` **(** :ref:`float<class_float>` from **)** |
|
||||
+-------------------------+----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_method_bool>` **(** :ref:`String<class_String>` from **)** |
|
||||
+-------------------------+----------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -33,20 +33,16 @@ Boolean built-in type.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_bool_bool:
|
||||
.. _class_bool_method_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **bool** **(** :ref:`int<class_int>` from **)**
|
||||
|
||||
Cast an :ref:`int<class_int>` value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case.
|
||||
|
||||
.. _class_bool_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **bool** **(** :ref:`float<class_float>` from **)**
|
||||
|
||||
Cast a :ref:`float<class_float>` value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case.
|
||||
|
||||
.. _class_bool_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **bool** **(** :ref:`String<class_String>` from **)**
|
||||
|
||||
Cast a :ref:`String<class_String>` value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: ``bool('False')`` returns true, ``bool('')``. returns false
|
||||
|
||||
@@ -21,22 +21,28 @@ Base class for box containers.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+------------------------------------------------+
|
||||
| :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_alignment>` |
|
||||
+-----------------------------------------------+------------------------------------------------+
|
||||
+-----------------------------------------------+---------------------------------------------------------+
|
||||
| :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_property_alignment>` |
|
||||
+-----------------------------------------------+---------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------+--------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_spacer<class_BoxContainer_add_spacer>` **(** :ref:`bool<class_bool>` begin **)** |
|
||||
+-------+--------------------------------------------------------------------------------------------+
|
||||
+------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_spacer<class_BoxContainer_method_add_spacer>` **(** :ref:`bool<class_bool>` begin **)** |
|
||||
+------+---------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_BoxContainer_AlignMode:
|
||||
|
||||
.. _class_BoxContainer_constant_ALIGN_BEGIN:
|
||||
|
||||
.. _class_BoxContainer_constant_ALIGN_CENTER:
|
||||
|
||||
.. _class_BoxContainer_constant_ALIGN_END:
|
||||
|
||||
enum **AlignMode**:
|
||||
|
||||
- **ALIGN_BEGIN** = **0** --- Aligns children with the beginning of the container.
|
||||
@@ -53,7 +59,7 @@ Arranges child controls vertically or horizontally, and rearranges the controls
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_BoxContainer_alignment:
|
||||
.. _class_BoxContainer_property_alignment:
|
||||
|
||||
- :ref:`AlignMode<enum_BoxContainer_AlignMode>` **alignment**
|
||||
|
||||
@@ -68,7 +74,7 @@ The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CEN
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_BoxContainer_add_spacer:
|
||||
.. _class_BoxContainer_method_add_spacer:
|
||||
|
||||
- void **add_spacer** **(** :ref:`bool<class_bool>` begin **)**
|
||||
|
||||
|
||||
@@ -19,9 +19,9 @@ Box shape resource.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+----------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`extents<class_BoxShape_extents>` |
|
||||
+-------------------------------+----------------------------------------+
|
||||
+-------------------------------+-------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`extents<class_BoxShape_property_extents>` |
|
||||
+-------------------------------+-------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -31,7 +31,7 @@ Description
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_BoxShape_extents:
|
||||
.. _class_BoxShape_property_extents:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **extents**
|
||||
|
||||
|
||||
@@ -21,50 +21,56 @@ Standard themed Button.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------+------------------------------------------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | :ref:`align<class_Button_align>` |
|
||||
+-----------------------------------------+------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_text<class_Button_clip_text>` |
|
||||
+-----------------------------------------+------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flat<class_Button_flat>` |
|
||||
+-----------------------------------------+------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_icon>` |
|
||||
+-----------------------------------------+------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`text<class_Button_text>` |
|
||||
+-----------------------------------------+------------------------------------------+
|
||||
+-----------------------------------------+---------------------------------------------------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | :ref:`align<class_Button_property_align>` |
|
||||
+-----------------------------------------+---------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_text<class_Button_property_clip_text>` |
|
||||
+-----------------------------------------+---------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flat<class_Button_property_flat>` |
|
||||
+-----------------------------------------+---------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` |
|
||||
+-----------------------------------------+---------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`text<class_Button_property_text>` |
|
||||
+-----------------------------------------+---------------------------------------------------+
|
||||
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_Button_disabled>` |
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_Button_focus>` |
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`Font<class_Font>` | :ref:`font<class_Button_font>` |
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color<class_Button_font_color>` |
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_Button_font_color_disabled>` |
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_hover<class_Button_font_color_hover>` |
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_Button_font_color_pressed>` |
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_Button_hover>` |
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hseparation<class_Button_hseparation>` |
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_Button_normal>` |
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_Button_pressed>` |
|
||||
+---------------------------------+--------------------------------------------------------------+
|
||||
+---------------------------------+---------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | disabled |
|
||||
+---------------------------------+---------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | focus |
|
||||
+---------------------------------+---------------------+
|
||||
| :ref:`Font<class_Font>` | font |
|
||||
+---------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | font_color |
|
||||
+---------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_disabled |
|
||||
+---------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_hover |
|
||||
+---------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_pressed |
|
||||
+---------------------------------+---------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | hover |
|
||||
+---------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | hseparation |
|
||||
+---------------------------------+---------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | normal |
|
||||
+---------------------------------+---------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | pressed |
|
||||
+---------------------------------+---------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_Button_TextAlign:
|
||||
|
||||
.. _class_Button_constant_ALIGN_LEFT:
|
||||
|
||||
.. _class_Button_constant_ALIGN_CENTER:
|
||||
|
||||
.. _class_Button_constant_ALIGN_RIGHT:
|
||||
|
||||
enum **TextAlign**:
|
||||
|
||||
- **ALIGN_LEFT** = **0** --- Align the text to the left.
|
||||
@@ -81,7 +87,7 @@ Button is the standard themed button. It can contain text and an icon, and will
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Button_align:
|
||||
.. _class_Button_property_align:
|
||||
|
||||
- :ref:`TextAlign<enum_Button_TextAlign>` **align**
|
||||
|
||||
@@ -93,7 +99,7 @@ Property Descriptions
|
||||
|
||||
Text alignment policy for the button's text, use one of the ALIGN\_\* constants.
|
||||
|
||||
.. _class_Button_clip_text:
|
||||
.. _class_Button_property_clip_text:
|
||||
|
||||
- :ref:`bool<class_bool>` **clip_text**
|
||||
|
||||
@@ -105,7 +111,7 @@ Text alignment policy for the button's text, use one of the ALIGN\_\* constants.
|
||||
|
||||
When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default.
|
||||
|
||||
.. _class_Button_flat:
|
||||
.. _class_Button_property_flat:
|
||||
|
||||
- :ref:`bool<class_bool>` **flat**
|
||||
|
||||
@@ -117,7 +123,7 @@ When this property is enabled, text that is too large to fit the button is clipp
|
||||
|
||||
Flat buttons don't display decoration.
|
||||
|
||||
.. _class_Button_icon:
|
||||
.. _class_Button_property_icon:
|
||||
|
||||
- :ref:`Texture<class_Texture>` **icon**
|
||||
|
||||
@@ -129,7 +135,7 @@ Flat buttons don't display decoration.
|
||||
|
||||
Button's icon, if text is present the icon will be placed before the text.
|
||||
|
||||
.. _class_Button_text:
|
||||
.. _class_Button_property_text:
|
||||
|
||||
- :ref:`String<class_String>` **text**
|
||||
|
||||
|
||||
@@ -19,29 +19,29 @@ Group of Buttons.
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_buttons<class_ButtonGroup_get_buttons>` **(** **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`BaseButton<class_BaseButton>` | :ref:`get_pressed_button<class_ButtonGroup_get_pressed_button>` **(** **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------+
|
||||
+-------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_buttons<class_ButtonGroup_method_get_buttons>` **(** **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`BaseButton<class_BaseButton>` | :ref:`get_pressed_button<class_ButtonGroup_method_get_pressed_button>` **(** **)** |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Group of :ref:`Button<class_Button>`. All direct and indirect children buttons become radios. Only one allows being pressed.
|
||||
|
||||
:ref:`BaseButton.toggle_mode<class_BaseButton_toggle_mode>` should be ``true``.
|
||||
:ref:`BaseButton.toggle_mode<class_BaseButton_property_toggle_mode>` should be ``true``.
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_ButtonGroup_get_buttons:
|
||||
.. _class_ButtonGroup_method_get_buttons:
|
||||
|
||||
- :ref:`Array<class_Array>` **get_buttons** **(** **)**
|
||||
|
||||
Returns an :ref:`Array<class_Array>` of :ref:`Button<class_Button>`\ s who have this as their ``ButtonGroup`` (see :ref:`BaseButton.group<class_BaseButton_group>`).
|
||||
Returns an :ref:`Array<class_Array>` of :ref:`Button<class_Button>`\ s who have this as their ``ButtonGroup`` (see :ref:`BaseButton.group<class_BaseButton_property_group>`).
|
||||
|
||||
.. _class_ButtonGroup_get_pressed_button:
|
||||
.. _class_ButtonGroup_method_get_pressed_button:
|
||||
|
||||
- :ref:`BaseButton<class_BaseButton>` **get_pressed_button** **(** **)**
|
||||
|
||||
|
||||
@@ -21,68 +21,72 @@ Camera node, displays from a point of view.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`cull_mask<class_Camera_cull_mask>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`current<class_Camera_current>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`DopplerTracking<enum_Camera_DopplerTracking>` | :ref:`doppler_tracking<class_Camera_doppler_tracking>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`Environment<class_Environment>` | :ref:`environment<class_Camera_environment>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`far<class_Camera_far>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fov<class_Camera_fov>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`h_offset<class_Camera_h_offset>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`KeepAspect<enum_Camera_KeepAspect>` | :ref:`keep_aspect<class_Camera_keep_aspect>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`near<class_Camera_near>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`Projection<enum_Camera_Projection>` | :ref:`projection<class_Camera_projection>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`size<class_Camera_size>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`v_offset<class_Camera_v_offset>` |
|
||||
+-----------------------------------------------------+--------------------------------------------------------+
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`cull_mask<class_Camera_property_cull_mask>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`current<class_Camera_property_current>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`DopplerTracking<enum_Camera_DopplerTracking>` | :ref:`doppler_tracking<class_Camera_property_doppler_tracking>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`Environment<class_Environment>` | :ref:`environment<class_Camera_property_environment>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`far<class_Camera_property_far>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fov<class_Camera_property_fov>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`h_offset<class_Camera_property_h_offset>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`KeepAspect<enum_Camera_KeepAspect>` | :ref:`keep_aspect<class_Camera_property_keep_aspect>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`near<class_Camera_property_near>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`Projection<enum_Camera_Projection>` | :ref:`projection<class_Camera_property_projection>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`size<class_Camera_property_size>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`v_offset<class_Camera_property_v_offset>` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_current<class_Camera_clear_current>` **(** :ref:`bool<class_bool>` enable_next=true **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`get_camera_transform<class_Camera_get_camera_transform>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_cull_mask_bit<class_Camera_get_cull_mask_bit>` **(** :ref:`int<class_int>` layer **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_position_behind<class_Camera_is_position_behind>` **(** :ref:`Vector3<class_Vector3>` world_point **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_current<class_Camera_make_current>` **(** **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`project_local_ray_normal<class_Camera_project_local_ray_normal>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`project_position<class_Camera_project_position>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`project_ray_normal<class_Camera_project_ray_normal>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`project_ray_origin<class_Camera_project_ray_origin>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_cull_mask_bit<class_Camera_set_cull_mask_bit>` **(** :ref:`int<class_int>` layer, :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_orthogonal<class_Camera_set_orthogonal>` **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_perspective<class_Camera_set_perspective>` **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`unproject_position<class_Camera_unproject_position>` **(** :ref:`Vector3<class_Vector3>` world_point **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_current<class_Camera_method_clear_current>` **(** :ref:`bool<class_bool>` enable_next=true **)** |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`get_camera_transform<class_Camera_method_get_camera_transform>` **(** **)** const |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_cull_mask_bit<class_Camera_method_get_cull_mask_bit>` **(** :ref:`int<class_int>` layer **)** const |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_position_behind<class_Camera_method_is_position_behind>` **(** :ref:`Vector3<class_Vector3>` world_point **)** const |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_current<class_Camera_method_make_current>` **(** **)** |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`project_local_ray_normal<class_Camera_method_project_local_ray_normal>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`project_position<class_Camera_method_project_position>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`project_ray_normal<class_Camera_method_project_ray_normal>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`project_ray_origin<class_Camera_method_project_ray_origin>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_cull_mask_bit<class_Camera_method_set_cull_mask_bit>` **(** :ref:`int<class_int>` layer, :ref:`bool<class_bool>` enable **)** |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_orthogonal<class_Camera_method_set_orthogonal>` **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_perspective<class_Camera_method_set_perspective>` **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`unproject_position<class_Camera_method_unproject_position>` **(** :ref:`Vector3<class_Vector3>` world_point **)** const |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_Camera_Projection:
|
||||
|
||||
.. _class_Camera_constant_PROJECTION_PERSPECTIVE:
|
||||
|
||||
.. _class_Camera_constant_PROJECTION_ORTHOGONAL:
|
||||
|
||||
enum **Projection**:
|
||||
|
||||
- **PROJECTION_PERSPECTIVE** = **0** --- Perspective Projection (object's size on the screen becomes smaller when far away).
|
||||
@@ -91,6 +95,10 @@ enum **Projection**:
|
||||
|
||||
.. _enum_Camera_KeepAspect:
|
||||
|
||||
.. _class_Camera_constant_KEEP_WIDTH:
|
||||
|
||||
.. _class_Camera_constant_KEEP_HEIGHT:
|
||||
|
||||
enum **KeepAspect**:
|
||||
|
||||
- **KEEP_WIDTH** = **0** --- Preserves the horizontal aspect ratio.
|
||||
@@ -99,6 +107,12 @@ enum **KeepAspect**:
|
||||
|
||||
.. _enum_Camera_DopplerTracking:
|
||||
|
||||
.. _class_Camera_constant_DOPPLER_TRACKING_DISABLED:
|
||||
|
||||
.. _class_Camera_constant_DOPPLER_TRACKING_IDLE_STEP:
|
||||
|
||||
.. _class_Camera_constant_DOPPLER_TRACKING_PHYSICS_STEP:
|
||||
|
||||
enum **DopplerTracking**:
|
||||
|
||||
- **DOPPLER_TRACKING_DISABLED** = **0** --- Disable Doppler effect simulation (default).
|
||||
@@ -115,7 +129,7 @@ Camera is a special node that displays what is visible from its current location
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Camera_cull_mask:
|
||||
.. _class_Camera_property_cull_mask:
|
||||
|
||||
- :ref:`int<class_int>` **cull_mask**
|
||||
|
||||
@@ -127,7 +141,7 @@ Property Descriptions
|
||||
|
||||
The culling mask that describes which 3D render layers are rendered by this camera.
|
||||
|
||||
.. _class_Camera_current:
|
||||
.. _class_Camera_property_current:
|
||||
|
||||
- :ref:`bool<class_bool>` **current**
|
||||
|
||||
@@ -139,7 +153,7 @@ The culling mask that describes which 3D render layers are rendered by this came
|
||||
|
||||
If ``true``, the ancestor :ref:`Viewport<class_Viewport>` is currently using this Camera. Default value: ``false``.
|
||||
|
||||
.. _class_Camera_doppler_tracking:
|
||||
.. _class_Camera_property_doppler_tracking:
|
||||
|
||||
- :ref:`DopplerTracking<enum_Camera_DopplerTracking>` **doppler_tracking**
|
||||
|
||||
@@ -151,7 +165,7 @@ If ``true``, the ancestor :ref:`Viewport<class_Viewport>` is currently using thi
|
||||
|
||||
If not ``DOPPLER_TRACKING_DISABLED`` this Camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. Default value: ``DOPPLER_TRACKING_DISABLED``.
|
||||
|
||||
.. _class_Camera_environment:
|
||||
.. _class_Camera_property_environment:
|
||||
|
||||
- :ref:`Environment<class_Environment>` **environment**
|
||||
|
||||
@@ -163,7 +177,7 @@ If not ``DOPPLER_TRACKING_DISABLED`` this Camera will simulate the Doppler effec
|
||||
|
||||
The :ref:`Environment<class_Environment>` to use for this Camera.
|
||||
|
||||
.. _class_Camera_far:
|
||||
.. _class_Camera_property_far:
|
||||
|
||||
- :ref:`float<class_float>` **far**
|
||||
|
||||
@@ -175,7 +189,7 @@ The :ref:`Environment<class_Environment>` to use for this Camera.
|
||||
|
||||
The distance to the far culling boundary for this Camera relative to its local z-axis.
|
||||
|
||||
.. _class_Camera_fov:
|
||||
.. _class_Camera_property_fov:
|
||||
|
||||
- :ref:`float<class_float>` **fov**
|
||||
|
||||
@@ -185,9 +199,9 @@ The distance to the far culling boundary for this Camera relative to its local z
|
||||
| *Getter* | get_fov() |
|
||||
+----------+----------------+
|
||||
|
||||
The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect<class_Camera_keep_aspect>` locks one axis, ``fov`` sets the other axis' field of view angle.
|
||||
The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect<class_Camera_property_keep_aspect>` locks one axis, ``fov`` sets the other axis' field of view angle.
|
||||
|
||||
.. _class_Camera_h_offset:
|
||||
.. _class_Camera_property_h_offset:
|
||||
|
||||
- :ref:`float<class_float>` **h_offset**
|
||||
|
||||
@@ -199,7 +213,7 @@ The camera's field of view angle (in degrees). Only applicable in perspective mo
|
||||
|
||||
The horizontal (X) offset of the Camera viewport.
|
||||
|
||||
.. _class_Camera_keep_aspect:
|
||||
.. _class_Camera_property_keep_aspect:
|
||||
|
||||
- :ref:`KeepAspect<enum_Camera_KeepAspect>` **keep_aspect**
|
||||
|
||||
@@ -209,9 +223,9 @@ The horizontal (X) offset of the Camera viewport.
|
||||
| *Getter* | get_keep_aspect_mode() |
|
||||
+----------+-----------------------------+
|
||||
|
||||
The axis to lock during :ref:`fov<class_Camera_fov>`/:ref:`size<class_Camera_size>` adjustments. Can be either ``KEEP_WIDTH`` or ``KEEP_HEIGHT``.
|
||||
The axis to lock during :ref:`fov<class_Camera_property_fov>`/:ref:`size<class_Camera_property_size>` adjustments. Can be either ``KEEP_WIDTH`` or ``KEEP_HEIGHT``.
|
||||
|
||||
.. _class_Camera_near:
|
||||
.. _class_Camera_property_near:
|
||||
|
||||
- :ref:`float<class_float>` **near**
|
||||
|
||||
@@ -223,7 +237,7 @@ The axis to lock during :ref:`fov<class_Camera_fov>`/:ref:`size<class_Camera_siz
|
||||
|
||||
The distance to the near culling boundary for this Camera relative to its local z-axis.
|
||||
|
||||
.. _class_Camera_projection:
|
||||
.. _class_Camera_property_projection:
|
||||
|
||||
- :ref:`Projection<enum_Camera_Projection>` **projection**
|
||||
|
||||
@@ -235,7 +249,7 @@ The distance to the near culling boundary for this Camera relative to its local
|
||||
|
||||
The camera's projection mode. In ``PROJECTION_PERSPECTIVE`` mode, objects' z-distance from the camera's local space scales their perceived size.
|
||||
|
||||
.. _class_Camera_size:
|
||||
.. _class_Camera_property_size:
|
||||
|
||||
- :ref:`float<class_float>` **size**
|
||||
|
||||
@@ -245,9 +259,9 @@ The camera's projection mode. In ``PROJECTION_PERSPECTIVE`` mode, objects' z-dis
|
||||
| *Getter* | get_size() |
|
||||
+----------+-----------------+
|
||||
|
||||
The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since :ref:`keep_aspect<class_Camera_keep_aspect>` locks on axis, ``size`` sets the other axis' size length.
|
||||
The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since :ref:`keep_aspect<class_Camera_property_keep_aspect>` locks on axis, ``size`` sets the other axis' size length.
|
||||
|
||||
.. _class_Camera_v_offset:
|
||||
.. _class_Camera_property_v_offset:
|
||||
|
||||
- :ref:`float<class_float>` **v_offset**
|
||||
|
||||
@@ -262,75 +276,75 @@ The vertical (Y) offset of the Camera viewport.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Camera_clear_current:
|
||||
.. _class_Camera_method_clear_current:
|
||||
|
||||
- void **clear_current** **(** :ref:`bool<class_bool>` enable_next=true **)**
|
||||
|
||||
If this is the current Camera, remove it from being current. If ``enable_next`` is true, request to make the next Camera current, if any.
|
||||
|
||||
.. _class_Camera_get_camera_transform:
|
||||
.. _class_Camera_method_get_camera_transform:
|
||||
|
||||
- :ref:`Transform<class_Transform>` **get_camera_transform** **(** **)** const
|
||||
|
||||
Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node<class_Node>` transform.
|
||||
|
||||
.. _class_Camera_get_cull_mask_bit:
|
||||
.. _class_Camera_method_get_cull_mask_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_cull_mask_bit** **(** :ref:`int<class_int>` layer **)** const
|
||||
|
||||
.. _class_Camera_is_position_behind:
|
||||
.. _class_Camera_method_is_position_behind:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_position_behind** **(** :ref:`Vector3<class_Vector3>` world_point **)** const
|
||||
|
||||
Returns ``true`` if the given position is behind the Camera. Note that a position which returns ``false`` may still be outside the Camera's field of view.
|
||||
|
||||
.. _class_Camera_make_current:
|
||||
.. _class_Camera_method_make_current:
|
||||
|
||||
- void **make_current** **(** **)**
|
||||
|
||||
Makes this camera the current Camera for the :ref:`Viewport<class_Viewport>` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.
|
||||
|
||||
.. _class_Camera_project_local_ray_normal:
|
||||
.. _class_Camera_method_project_local_ray_normal:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **project_local_ray_normal** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const
|
||||
|
||||
Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc.
|
||||
|
||||
.. _class_Camera_project_position:
|
||||
.. _class_Camera_method_project_position:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **project_position** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const
|
||||
|
||||
Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport<class_Viewport>` rectangle.
|
||||
|
||||
.. _class_Camera_project_ray_normal:
|
||||
.. _class_Camera_method_project_ray_normal:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **project_ray_normal** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const
|
||||
|
||||
Returns a normal vector in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_Viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.
|
||||
|
||||
.. _class_Camera_project_ray_origin:
|
||||
.. _class_Camera_method_project_ray_origin:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **project_ray_origin** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const
|
||||
|
||||
Returns a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_Viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.
|
||||
|
||||
.. _class_Camera_set_cull_mask_bit:
|
||||
.. _class_Camera_method_set_cull_mask_bit:
|
||||
|
||||
- void **set_cull_mask_bit** **(** :ref:`int<class_int>` layer, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_Camera_set_orthogonal:
|
||||
.. _class_Camera_method_set_orthogonal:
|
||||
|
||||
- void **set_orthogonal** **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
||||
|
||||
Sets the camera projection to orthogonal mode, by specifying a width and the *near* and *far* clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)
|
||||
|
||||
.. _class_Camera_set_perspective:
|
||||
.. _class_Camera_method_set_perspective:
|
||||
|
||||
- void **set_perspective** **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
||||
|
||||
Sets the camera projection to perspective mode, by specifying a *FOV* Y angle in degrees (FOV means Field of View), and the *near* and *far* clip planes in worldspace units.
|
||||
|
||||
.. _class_Camera_unproject_position:
|
||||
.. _class_Camera_method_unproject_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **unproject_position** **(** :ref:`Vector3<class_Vector3>` world_point **)** const
|
||||
|
||||
|
||||
@@ -19,82 +19,86 @@ Camera node for 2D scenes.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`AnchorMode<enum_Camera2D_AnchorMode>` | :ref:`anchor_mode<class_Camera2D_anchor_mode>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`current<class_Camera2D_current>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_Camera2D_custom_viewport>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_bottom<class_Camera2D_drag_margin_bottom>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_margin_h_enabled<class_Camera2D_drag_margin_h_enabled>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_left<class_Camera2D_drag_margin_left>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_right<class_Camera2D_drag_margin_right>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_top<class_Camera2D_drag_margin_top>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_margin_v_enabled<class_Camera2D_drag_margin_v_enabled>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_drag_margin<class_Camera2D_editor_draw_drag_margin>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_limits<class_Camera2D_editor_draw_limits>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_screen<class_Camera2D_editor_draw_screen>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_bottom<class_Camera2D_limit_bottom>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_left<class_Camera2D_limit_left>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_right<class_Camera2D_limit_right>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`limit_smoothed<class_Camera2D_limit_smoothed>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_top<class_Camera2D_limit_top>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_Camera2D_offset>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`offset_h<class_Camera2D_offset_h>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`offset_v<class_Camera2D_offset_v>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` | :ref:`process_mode<class_Camera2D_process_mode>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`rotating<class_Camera2D_rotating>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`smoothing_enabled<class_Camera2D_smoothing_enabled>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`smoothing_speed<class_Camera2D_smoothing_speed>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`zoom<class_Camera2D_zoom>` |
|
||||
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`AnchorMode<enum_Camera2D_AnchorMode>` | :ref:`anchor_mode<class_Camera2D_property_anchor_mode>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`current<class_Camera2D_property_current>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_Camera2D_property_custom_viewport>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_bottom<class_Camera2D_property_drag_margin_bottom>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_margin_h_enabled<class_Camera2D_property_drag_margin_h_enabled>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_left<class_Camera2D_property_drag_margin_left>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_right<class_Camera2D_property_drag_margin_right>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_top<class_Camera2D_property_drag_margin_top>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_margin_v_enabled<class_Camera2D_property_drag_margin_v_enabled>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_drag_margin<class_Camera2D_property_editor_draw_drag_margin>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_limits<class_Camera2D_property_editor_draw_limits>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_screen<class_Camera2D_property_editor_draw_screen>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_bottom<class_Camera2D_property_limit_bottom>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_left<class_Camera2D_property_limit_left>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_right<class_Camera2D_property_limit_right>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`limit_smoothed<class_Camera2D_property_limit_smoothed>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_top<class_Camera2D_property_limit_top>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_Camera2D_property_offset>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`offset_h<class_Camera2D_property_offset_h>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`offset_v<class_Camera2D_property_offset_v>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` | :ref:`process_mode<class_Camera2D_property_process_mode>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`rotating<class_Camera2D_property_rotating>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`smoothing_enabled<class_Camera2D_property_smoothing_enabled>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`smoothing_speed<class_Camera2D_property_smoothing_speed>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`zoom<class_Camera2D_property_zoom>` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`align<class_Camera2D_align>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_camera_position<class_Camera2D_get_camera_position>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_current<class_Camera2D_make_current>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reset_smoothing<class_Camera2D_reset_smoothing>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------+
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`align<class_Camera2D_method_align>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_current<class_Camera2D_method_clear_current>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`force_update_scroll<class_Camera2D_method_force_update_scroll>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_camera_position<class_Camera2D_method_get_camera_position>` **(** **)** const |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_camera_screen_center<class_Camera2D_method_get_camera_screen_center>` **(** **)** const |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_current<class_Camera2D_method_make_current>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reset_smoothing<class_Camera2D_method_reset_smoothing>` **(** **)** |
|
||||
+-------------------------------+---------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_Camera2D_AnchorMode:
|
||||
|
||||
.. _class_Camera2D_constant_ANCHOR_MODE_FIXED_TOP_LEFT:
|
||||
|
||||
.. _class_Camera2D_constant_ANCHOR_MODE_DRAG_CENTER:
|
||||
|
||||
enum **AnchorMode**:
|
||||
|
||||
- **ANCHOR_MODE_FIXED_TOP_LEFT** = **0** --- The camera's position is fixed so that the top-left corner is always at the origin.
|
||||
@@ -103,6 +107,10 @@ enum **AnchorMode**:
|
||||
|
||||
.. _enum_Camera2D_Camera2DProcessMode:
|
||||
|
||||
.. _class_Camera2D_constant_CAMERA2D_PROCESS_PHYSICS:
|
||||
|
||||
.. _class_Camera2D_constant_CAMERA2D_PROCESS_IDLE:
|
||||
|
||||
enum **Camera2DProcessMode**:
|
||||
|
||||
- **CAMERA2D_PROCESS_PHYSICS** = **0**
|
||||
@@ -119,7 +127,7 @@ This node is intended to be a simple helper to get things going quickly and it m
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Camera2D_anchor_mode:
|
||||
.. _class_Camera2D_property_anchor_mode:
|
||||
|
||||
- :ref:`AnchorMode<enum_Camera2D_AnchorMode>` **anchor_mode**
|
||||
|
||||
@@ -131,7 +139,7 @@ Property Descriptions
|
||||
|
||||
The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants.
|
||||
|
||||
.. _class_Camera2D_current:
|
||||
.. _class_Camera2D_property_current:
|
||||
|
||||
- :ref:`bool<class_bool>` **current**
|
||||
|
||||
@@ -141,7 +149,7 @@ The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants.
|
||||
|
||||
If ``true``, the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one.
|
||||
|
||||
.. _class_Camera2D_custom_viewport:
|
||||
.. _class_Camera2D_property_custom_viewport:
|
||||
|
||||
- :ref:`Node<class_Node>` **custom_viewport**
|
||||
|
||||
@@ -153,7 +161,7 @@ If ``true``, the camera is the active camera for the current scene. Only one cam
|
||||
|
||||
The custom :ref:`Viewport<class_Viewport>` node attached to the ``Camera2D``. If null or not a :ref:`Viewport<class_Viewport>`, uses the default viewport instead.
|
||||
|
||||
.. _class_Camera2D_drag_margin_bottom:
|
||||
.. _class_Camera2D_property_drag_margin_bottom:
|
||||
|
||||
- :ref:`float<class_float>` **drag_margin_bottom**
|
||||
|
||||
@@ -165,7 +173,7 @@ The custom :ref:`Viewport<class_Viewport>` node attached to the ``Camera2D``. If
|
||||
|
||||
Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
|
||||
|
||||
.. _class_Camera2D_drag_margin_h_enabled:
|
||||
.. _class_Camera2D_property_drag_margin_h_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **drag_margin_h_enabled**
|
||||
|
||||
@@ -177,7 +185,7 @@ Bottom margin needed to drag the camera. A value of ``1`` makes the camera move
|
||||
|
||||
If ``true``, the camera only moves when reaching the horizontal drag margins. If ``false``, the camera moves horizontally regardless of margins. Default value: ``true``.
|
||||
|
||||
.. _class_Camera2D_drag_margin_left:
|
||||
.. _class_Camera2D_property_drag_margin_left:
|
||||
|
||||
- :ref:`float<class_float>` **drag_margin_left**
|
||||
|
||||
@@ -189,7 +197,7 @@ If ``true``, the camera only moves when reaching the horizontal drag margins. If
|
||||
|
||||
Left margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
|
||||
|
||||
.. _class_Camera2D_drag_margin_right:
|
||||
.. _class_Camera2D_property_drag_margin_right:
|
||||
|
||||
- :ref:`float<class_float>` **drag_margin_right**
|
||||
|
||||
@@ -201,7 +209,7 @@ Left margin needed to drag the camera. A value of ``1`` makes the camera move on
|
||||
|
||||
Right margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
|
||||
|
||||
.. _class_Camera2D_drag_margin_top:
|
||||
.. _class_Camera2D_property_drag_margin_top:
|
||||
|
||||
- :ref:`float<class_float>` **drag_margin_top**
|
||||
|
||||
@@ -213,7 +221,7 @@ Right margin needed to drag the camera. A value of ``1`` makes the camera move o
|
||||
|
||||
Top margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
|
||||
|
||||
.. _class_Camera2D_drag_margin_v_enabled:
|
||||
.. _class_Camera2D_property_drag_margin_v_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **drag_margin_v_enabled**
|
||||
|
||||
@@ -225,7 +233,7 @@ Top margin needed to drag the camera. A value of ``1`` makes the camera move onl
|
||||
|
||||
If ``true``, the camera only moves when reaching the vertical drag margins. If ``false``, the camera moves vertically regardless of margins. Default value: ``true``.
|
||||
|
||||
.. _class_Camera2D_editor_draw_drag_margin:
|
||||
.. _class_Camera2D_property_editor_draw_drag_margin:
|
||||
|
||||
- :ref:`bool<class_bool>` **editor_draw_drag_margin**
|
||||
|
||||
@@ -237,7 +245,7 @@ If ``true``, the camera only moves when reaching the vertical drag margins. If `
|
||||
|
||||
If ``true``, draws the camera's drag margin rectangle in the editor. Default value: ``false``
|
||||
|
||||
.. _class_Camera2D_editor_draw_limits:
|
||||
.. _class_Camera2D_property_editor_draw_limits:
|
||||
|
||||
- :ref:`bool<class_bool>` **editor_draw_limits**
|
||||
|
||||
@@ -249,7 +257,7 @@ If ``true``, draws the camera's drag margin rectangle in the editor. Default val
|
||||
|
||||
If ``true``, draws the camera's limits rectangle in the editor. Default value: ``true``
|
||||
|
||||
.. _class_Camera2D_editor_draw_screen:
|
||||
.. _class_Camera2D_property_editor_draw_screen:
|
||||
|
||||
- :ref:`bool<class_bool>` **editor_draw_screen**
|
||||
|
||||
@@ -261,7 +269,7 @@ If ``true``, draws the camera's limits rectangle in the editor. Default value: `
|
||||
|
||||
If ``true``, draws the camera's screen rectangle in the editor. Default value: ``false``
|
||||
|
||||
.. _class_Camera2D_limit_bottom:
|
||||
.. _class_Camera2D_property_limit_bottom:
|
||||
|
||||
- :ref:`int<class_int>` **limit_bottom**
|
||||
|
||||
@@ -273,7 +281,7 @@ If ``true``, draws the camera's screen rectangle in the editor. Default value: `
|
||||
|
||||
Bottom scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
|
||||
.. _class_Camera2D_limit_left:
|
||||
.. _class_Camera2D_property_limit_left:
|
||||
|
||||
- :ref:`int<class_int>` **limit_left**
|
||||
|
||||
@@ -285,7 +293,7 @@ Bottom scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
|
||||
Left scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
|
||||
.. _class_Camera2D_limit_right:
|
||||
.. _class_Camera2D_property_limit_right:
|
||||
|
||||
- :ref:`int<class_int>` **limit_right**
|
||||
|
||||
@@ -297,7 +305,7 @@ Left scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
|
||||
Right scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
|
||||
.. _class_Camera2D_limit_smoothed:
|
||||
.. _class_Camera2D_property_limit_smoothed:
|
||||
|
||||
- :ref:`bool<class_bool>` **limit_smoothed**
|
||||
|
||||
@@ -309,7 +317,7 @@ Right scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
|
||||
If ``true``, the camera smoothly stops when reaches its limits. Default value: ``false``
|
||||
|
||||
.. _class_Camera2D_limit_top:
|
||||
.. _class_Camera2D_property_limit_top:
|
||||
|
||||
- :ref:`int<class_int>` **limit_top**
|
||||
|
||||
@@ -321,7 +329,7 @@ If ``true``, the camera smoothly stops when reaches its limits. Default value: `
|
||||
|
||||
Top scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
|
||||
.. _class_Camera2D_offset:
|
||||
.. _class_Camera2D_property_offset:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **offset**
|
||||
|
||||
@@ -333,7 +341,7 @@ Top scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
|
||||
The camera's offset, useful for looking around or camera shake animations.
|
||||
|
||||
.. _class_Camera2D_offset_h:
|
||||
.. _class_Camera2D_property_offset_h:
|
||||
|
||||
- :ref:`float<class_float>` **offset_h**
|
||||
|
||||
@@ -345,7 +353,7 @@ The camera's offset, useful for looking around or camera shake animations.
|
||||
|
||||
The horizontal offset of the camera, relative to the drag margins. Default value: ``0``
|
||||
|
||||
.. _class_Camera2D_offset_v:
|
||||
.. _class_Camera2D_property_offset_v:
|
||||
|
||||
- :ref:`float<class_float>` **offset_v**
|
||||
|
||||
@@ -357,7 +365,7 @@ The horizontal offset of the camera, relative to the drag margins. Default value
|
||||
|
||||
The vertical offset of the camera, relative to the drag margins. Default value: ``0``
|
||||
|
||||
.. _class_Camera2D_process_mode:
|
||||
.. _class_Camera2D_property_process_mode:
|
||||
|
||||
- :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` **process_mode**
|
||||
|
||||
@@ -367,7 +375,7 @@ The vertical offset of the camera, relative to the drag margins. Default value:
|
||||
| *Getter* | get_process_mode() |
|
||||
+----------+-------------------------+
|
||||
|
||||
.. _class_Camera2D_rotating:
|
||||
.. _class_Camera2D_property_rotating:
|
||||
|
||||
- :ref:`bool<class_bool>` **rotating**
|
||||
|
||||
@@ -379,7 +387,7 @@ The vertical offset of the camera, relative to the drag margins. Default value:
|
||||
|
||||
If ``true``, the camera rotates with the target. Default value: ``false``
|
||||
|
||||
.. _class_Camera2D_smoothing_enabled:
|
||||
.. _class_Camera2D_property_smoothing_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **smoothing_enabled**
|
||||
|
||||
@@ -389,9 +397,9 @@ If ``true``, the camera rotates with the target. Default value: ``false``
|
||||
| *Getter* | is_follow_smoothing_enabled() |
|
||||
+----------+------------------------------------+
|
||||
|
||||
If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_speed<class_Camera2D_smoothing_speed>`. Default value: ``false``
|
||||
If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_speed<class_Camera2D_property_smoothing_speed>`. Default value: ``false``
|
||||
|
||||
.. _class_Camera2D_smoothing_speed:
|
||||
.. _class_Camera2D_property_smoothing_speed:
|
||||
|
||||
- :ref:`float<class_float>` **smoothing_speed**
|
||||
|
||||
@@ -401,9 +409,9 @@ If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_spe
|
||||
| *Getter* | get_follow_smoothing() |
|
||||
+----------+-----------------------------+
|
||||
|
||||
Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled<class_Camera2D_smoothing_enabled>` is ``true``
|
||||
Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled<class_Camera2D_property_smoothing_enabled>` is ``true``
|
||||
|
||||
.. _class_Camera2D_zoom:
|
||||
.. _class_Camera2D_property_zoom:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **zoom**
|
||||
|
||||
@@ -418,43 +426,43 @@ The camera's zoom relative to the viewport. Values larger than ``Vector2(1, 1)``
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Camera2D_align:
|
||||
.. _class_Camera2D_method_align:
|
||||
|
||||
- void **align** **(** **)**
|
||||
|
||||
Align the camera to the tracked node
|
||||
|
||||
.. _class_Camera2D_clear_current:
|
||||
.. _class_Camera2D_method_clear_current:
|
||||
|
||||
- void **clear_current** **(** **)**
|
||||
|
||||
Removes any ``Camera2D`` from the ancestor :ref:`Viewport<class_Viewport>`'s internal currently-assigned camera.
|
||||
|
||||
.. _class_Camera2D_force_update_scroll:
|
||||
.. _class_Camera2D_method_force_update_scroll:
|
||||
|
||||
- void **force_update_scroll** **(** **)**
|
||||
|
||||
Force the camera to update scroll immediately.
|
||||
|
||||
.. _class_Camera2D_get_camera_position:
|
||||
.. _class_Camera2D_method_get_camera_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_camera_position** **(** **)** const
|
||||
|
||||
Return the camera position.
|
||||
|
||||
.. _class_Camera2D_get_camera_screen_center:
|
||||
.. _class_Camera2D_method_get_camera_screen_center:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_camera_screen_center** **(** **)** const
|
||||
|
||||
Returns the location of the ``Camera2D``'s screen-center, relative to the origin.
|
||||
|
||||
.. _class_Camera2D_make_current:
|
||||
.. _class_Camera2D_method_make_current:
|
||||
|
||||
- void **make_current** **(** **)**
|
||||
|
||||
Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.
|
||||
|
||||
.. _class_Camera2D_reset_smoothing:
|
||||
.. _class_Camera2D_method_reset_smoothing:
|
||||
|
||||
- void **reset_smoothing** **(** **)**
|
||||
|
||||
|
||||
@@ -21,141 +21,141 @@ Base class of anything 2D.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`light_mask<class_CanvasItem_light_mask>` |
|
||||
+---------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`Material<class_Material>` | :ref:`material<class_CanvasItem_material>` |
|
||||
+---------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`modulate<class_CanvasItem_modulate>` |
|
||||
+---------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`self_modulate<class_CanvasItem_self_modulate>` |
|
||||
+---------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`show_behind_parent<class_CanvasItem_show_behind_parent>` |
|
||||
+---------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`show_on_top<class_CanvasItem_show_on_top>` |
|
||||
+---------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`use_parent_material<class_CanvasItem_use_parent_material>` |
|
||||
+---------------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`visible<class_CanvasItem_visible>` |
|
||||
+---------------------------------+------------------------------------------------------------------+
|
||||
+---------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`light_mask<class_CanvasItem_property_light_mask>` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`Material<class_Material>` | :ref:`material<class_CanvasItem_property_material>` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`modulate<class_CanvasItem_property_modulate>` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`self_modulate<class_CanvasItem_property_self_modulate>` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`show_behind_parent<class_CanvasItem_property_show_behind_parent>` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`show_on_top<class_CanvasItem_property_show_on_top>` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`use_parent_material<class_CanvasItem_property_use_parent_material>` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`visible<class_CanvasItem_property_visible>` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_draw<class_CanvasItem__draw>` **(** **)** virtual |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`draw_char<class_CanvasItem_draw_char>` **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` char, :ref:`String<class_String>` next, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_circle<class_CanvasItem_draw_circle>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_colored_polygon<class_CanvasItem_draw_colored_polygon>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_line<class_CanvasItem_draw_line>` **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_mesh<class_CanvasItem_draw_mesh>` **(** :ref:`Mesh<class_Mesh>` mesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multiline<class_CanvasItem_draw_multiline>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multiline_colors<class_CanvasItem_draw_multiline_colors>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multimesh<class_CanvasItem_draw_multimesh>` **(** :ref:`MultiMesh<class_MultiMesh>` multimesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polygon<class_CanvasItem_draw_polygon>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polyline<class_CanvasItem_draw_polyline>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polyline_colors<class_CanvasItem_draw_polyline_colors>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_primitive<class_CanvasItem_draw_primitive>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs, :ref:`Texture<class_Texture>` texture=null, :ref:`float<class_float>` width=1.0, :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_rect<class_CanvasItem_draw_rect>` **(** :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` filled=true **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_set_transform<class_CanvasItem_draw_set_transform>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` rotation, :ref:`Vector2<class_Vector2>` scale **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_set_transform_matrix<class_CanvasItem_draw_set_transform_matrix>` **(** :ref:`Transform2D<class_Transform2D>` xform **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_string<class_CanvasItem_draw_string>` **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` text, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_style_box<class_CanvasItem_draw_style_box>` **(** :ref:`StyleBox<class_StyleBox>` style_box, :ref:`Rect2<class_Rect2>` rect **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture<class_CanvasItem_draw_texture>` **(** :ref:`Texture<class_Texture>` texture, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture_rect<class_CanvasItem_draw_texture_rect>` **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture_rect_region<class_CanvasItem_draw_texture_rect_region>` **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=true **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`force_update_transform<class_CanvasItem_force_update_transform>` **(** **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_canvas<class_CanvasItem_get_canvas>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_canvas_item<class_CanvasItem_get_canvas_item>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_canvas_transform<class_CanvasItem_get_canvas_transform>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_global_mouse_position<class_CanvasItem_get_global_mouse_position>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_global_transform<class_CanvasItem_get_global_transform>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_get_global_transform_with_canvas>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_local_mouse_position<class_CanvasItem_get_local_mouse_position>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_transform<class_CanvasItem_get_transform>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`get_viewport_rect<class_CanvasItem_get_viewport_rect>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_viewport_transform<class_CanvasItem_get_viewport_transform>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`World2D<class_World2D>` | :ref:`get_world_2d<class_CanvasItem_get_world_2d>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`hide<class_CanvasItem_hide>` **(** **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_CanvasItem_is_local_transform_notification_enabled>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_is_set_as_toplevel>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_CanvasItem_is_transform_notification_enabled>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_CanvasItem_is_visible_in_tree>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`make_canvas_position_local<class_CanvasItem_make_canvas_position_local>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`InputEvent<class_InputEvent>` | :ref:`make_input_local<class_CanvasItem_make_input_local>` **(** :ref:`InputEvent<class_InputEvent>` event **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_notify_local_transform<class_CanvasItem_set_notify_local_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_notify_transform<class_CanvasItem_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`show<class_CanvasItem_show>` **(** **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update<class_CanvasItem_update>` **(** **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_draw<class_CanvasItem_method__draw>` **(** **)** virtual |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`draw_char<class_CanvasItem_method_draw_char>` **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` char, :ref:`String<class_String>` next, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_circle<class_CanvasItem_method_draw_circle>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_colored_polygon<class_CanvasItem_method_draw_colored_polygon>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_line<class_CanvasItem_method_draw_line>` **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_mesh<class_CanvasItem_method_draw_mesh>` **(** :ref:`Mesh<class_Mesh>` mesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multiline<class_CanvasItem_method_draw_multiline>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multiline_colors<class_CanvasItem_method_draw_multiline_colors>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_multimesh<class_CanvasItem_method_draw_multimesh>` **(** :ref:`MultiMesh<class_MultiMesh>` multimesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polygon<class_CanvasItem_method_draw_polygon>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polyline<class_CanvasItem_method_draw_polyline>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_polyline_colors<class_CanvasItem_method_draw_polyline_colors>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_primitive<class_CanvasItem_method_draw_primitive>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs, :ref:`Texture<class_Texture>` texture=null, :ref:`float<class_float>` width=1.0, :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_rect<class_CanvasItem_method_draw_rect>` **(** :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` filled=true **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_set_transform<class_CanvasItem_method_draw_set_transform>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` rotation, :ref:`Vector2<class_Vector2>` scale **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_set_transform_matrix<class_CanvasItem_method_draw_set_transform_matrix>` **(** :ref:`Transform2D<class_Transform2D>` xform **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_string<class_CanvasItem_method_draw_string>` **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` text, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_style_box<class_CanvasItem_method_draw_style_box>` **(** :ref:`StyleBox<class_StyleBox>` style_box, :ref:`Rect2<class_Rect2>` rect **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture<class_CanvasItem_method_draw_texture>` **(** :ref:`Texture<class_Texture>` texture, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture_rect<class_CanvasItem_method_draw_texture_rect>` **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture_rect_region<class_CanvasItem_method_draw_texture_rect_region>` **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=true **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`force_update_transform<class_CanvasItem_method_force_update_transform>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_canvas<class_CanvasItem_method_get_canvas>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_canvas_item<class_CanvasItem_method_get_canvas_item>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_canvas_transform<class_CanvasItem_method_get_canvas_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_global_mouse_position<class_CanvasItem_method_get_global_mouse_position>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_global_transform<class_CanvasItem_method_get_global_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_method_get_global_transform_with_canvas>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`get_local_mouse_position<class_CanvasItem_method_get_local_mouse_position>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_transform<class_CanvasItem_method_get_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`get_viewport_rect<class_CanvasItem_method_get_viewport_rect>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_viewport_transform<class_CanvasItem_method_get_viewport_transform>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`World2D<class_World2D>` | :ref:`get_world_2d<class_CanvasItem_method_get_world_2d>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`hide<class_CanvasItem_method_hide>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_CanvasItem_method_is_local_transform_notification_enabled>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_method_is_set_as_toplevel>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_CanvasItem_method_is_transform_notification_enabled>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_CanvasItem_method_is_visible_in_tree>` **(** **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`make_canvas_position_local<class_CanvasItem_method_make_canvas_position_local>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`InputEvent<class_InputEvent>` | :ref:`make_input_local<class_CanvasItem_method_make_input_local>` **(** :ref:`InputEvent<class_InputEvent>` event **)** const |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_toplevel<class_CanvasItem_method_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_notify_local_transform<class_CanvasItem_method_set_notify_local_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_notify_transform<class_CanvasItem_method_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`show<class_CanvasItem_method_show>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update<class_CanvasItem_method_update>` **(** **)** |
|
||||
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_CanvasItem_draw:
|
||||
.. _class_CanvasItem_signal_draw:
|
||||
|
||||
- **draw** **(** **)**
|
||||
|
||||
Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing.
|
||||
|
||||
.. _class_CanvasItem_hide:
|
||||
.. _class_CanvasItem_signal_hide:
|
||||
|
||||
- **hide** **(** **)**
|
||||
|
||||
Emitted when becoming hidden.
|
||||
|
||||
.. _class_CanvasItem_item_rect_changed:
|
||||
.. _class_CanvasItem_signal_item_rect_changed:
|
||||
|
||||
- **item_rect_changed** **(** **)**
|
||||
|
||||
Emitted when the item rect has changed.
|
||||
|
||||
.. _class_CanvasItem_visibility_changed:
|
||||
.. _class_CanvasItem_signal_visibility_changed:
|
||||
|
||||
- **visibility_changed** **(** **)**
|
||||
|
||||
@@ -166,6 +166,18 @@ Enumerations
|
||||
|
||||
.. _enum_CanvasItem_BlendMode:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_MIX:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_ADD:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_SUB:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_MUL:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_PREMULT_ALPHA:
|
||||
|
||||
.. _class_CanvasItem_constant_BLEND_MODE_DISABLED:
|
||||
|
||||
enum **BlendMode**:
|
||||
|
||||
- **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.
|
||||
@@ -183,7 +195,17 @@ enum **BlendMode**:
|
||||
Constants
|
||||
---------
|
||||
|
||||
- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Canvas item transform has changed. Notification is only received if enabled by :ref:`set_notify_transform<class_CanvasItem_set_notify_transform>` or :ref:`set_notify_local_transform<class_CanvasItem_set_notify_local_transform>`.
|
||||
.. _class_CanvasItem_constant_NOTIFICATION_TRANSFORM_CHANGED:
|
||||
|
||||
.. _class_CanvasItem_constant_NOTIFICATION_DRAW:
|
||||
|
||||
.. _class_CanvasItem_constant_NOTIFICATION_VISIBILITY_CHANGED:
|
||||
|
||||
.. _class_CanvasItem_constant_NOTIFICATION_ENTER_CANVAS:
|
||||
|
||||
.. _class_CanvasItem_constant_NOTIFICATION_EXIT_CANVAS:
|
||||
|
||||
- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Canvas item transform has changed. Notification is only received if enabled by :ref:`set_notify_transform<class_CanvasItem_method_set_notify_transform>` or :ref:`set_notify_local_transform<class_CanvasItem_method_set_notify_local_transform>`.
|
||||
|
||||
- **NOTIFICATION_DRAW** = **30** --- CanvasItem is requested to draw.
|
||||
|
||||
@@ -216,7 +238,7 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CanvasItem_light_mask:
|
||||
.. _class_CanvasItem_property_light_mask:
|
||||
|
||||
- :ref:`int<class_int>` **light_mask**
|
||||
|
||||
@@ -228,7 +250,7 @@ Property Descriptions
|
||||
|
||||
The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D<class_Light2D>` nodes. Default value: ``1``.
|
||||
|
||||
.. _class_CanvasItem_material:
|
||||
.. _class_CanvasItem_property_material:
|
||||
|
||||
- :ref:`Material<class_Material>` **material**
|
||||
|
||||
@@ -240,7 +262,7 @@ The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D<clas
|
||||
|
||||
The material applied to textures on this ``CanvasItem``. Default value: ``null``.
|
||||
|
||||
.. _class_CanvasItem_modulate:
|
||||
.. _class_CanvasItem_property_modulate:
|
||||
|
||||
- :ref:`Color<class_Color>` **modulate**
|
||||
|
||||
@@ -252,7 +274,7 @@ The material applied to textures on this ``CanvasItem``. Default value: ``null``
|
||||
|
||||
The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white").
|
||||
|
||||
.. _class_CanvasItem_self_modulate:
|
||||
.. _class_CanvasItem_property_self_modulate:
|
||||
|
||||
- :ref:`Color<class_Color>` **self_modulate**
|
||||
|
||||
@@ -264,7 +286,7 @@ The color applied to textures on this ``CanvasItem``. Default value: ``Color(1,
|
||||
|
||||
The color applied to textures on this ``CanvasItem``. This is not inherited by children ``CanvasItem``\ s. Default value: ``Color(1, 1, 1, 1)`` (opaque "white")..
|
||||
|
||||
.. _class_CanvasItem_show_behind_parent:
|
||||
.. _class_CanvasItem_property_show_behind_parent:
|
||||
|
||||
- :ref:`bool<class_bool>` **show_behind_parent**
|
||||
|
||||
@@ -276,13 +298,13 @@ The color applied to textures on this ``CanvasItem``. This is not inherited by c
|
||||
|
||||
If ``true``, the object draws behind its parent. Default value: ``false``.
|
||||
|
||||
.. _class_CanvasItem_show_on_top:
|
||||
.. _class_CanvasItem_property_show_on_top:
|
||||
|
||||
- :ref:`bool<class_bool>` **show_on_top**
|
||||
|
||||
If ``true``, the object draws on top of its parent. Default value: ``true``.
|
||||
|
||||
.. _class_CanvasItem_use_parent_material:
|
||||
.. _class_CanvasItem_property_use_parent_material:
|
||||
|
||||
- :ref:`bool<class_bool>` **use_parent_material**
|
||||
|
||||
@@ -292,9 +314,9 @@ If ``true``, the object draws on top of its parent. Default value: ``true``.
|
||||
| *Getter* | get_use_parent_material() |
|
||||
+----------+--------------------------------+
|
||||
|
||||
If ``true``, the parent ``CanvasItem``'s :ref:`material<class_CanvasItem_material>` property is used as this one's material. Default value: ``false``.
|
||||
If ``true``, the parent ``CanvasItem``'s :ref:`material<class_CanvasItem_property_material>` property is used as this one's material. Default value: ``false``.
|
||||
|
||||
.. _class_CanvasItem_visible:
|
||||
.. _class_CanvasItem_property_visible:
|
||||
|
||||
- :ref:`bool<class_bool>` **visible**
|
||||
|
||||
@@ -309,265 +331,265 @@ If ``true``, this ``CanvasItem`` is drawn. Default value: ``true``. For controls
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_CanvasItem__draw:
|
||||
.. _class_CanvasItem_method__draw:
|
||||
|
||||
- void **_draw** **(** **)** virtual
|
||||
|
||||
Called (if exists) to draw the canvas item.
|
||||
|
||||
.. _class_CanvasItem_draw_char:
|
||||
.. _class_CanvasItem_method_draw_char:
|
||||
|
||||
- :ref:`float<class_float>` **draw_char** **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` char, :ref:`String<class_String>` next, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)**
|
||||
|
||||
Draws a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
|
||||
|
||||
.. _class_CanvasItem_draw_circle:
|
||||
.. _class_CanvasItem_method_draw_circle:
|
||||
|
||||
- void **draw_circle** **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)**
|
||||
|
||||
Draws a colored circle.
|
||||
|
||||
.. _class_CanvasItem_draw_colored_polygon:
|
||||
.. _class_CanvasItem_method_draw_colored_polygon:
|
||||
|
||||
- void **draw_colored_polygon** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
Draws a colored polygon of any amount of points, convex or concave.
|
||||
|
||||
.. _class_CanvasItem_draw_line:
|
||||
.. _class_CanvasItem_method_draw_line:
|
||||
|
||||
- void **draw_line** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
|
||||
|
||||
.. _class_CanvasItem_draw_mesh:
|
||||
.. _class_CanvasItem_method_draw_mesh:
|
||||
|
||||
- void **draw_mesh** **(** :ref:`Mesh<class_Mesh>` mesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)**
|
||||
|
||||
.. _class_CanvasItem_draw_multiline:
|
||||
.. _class_CanvasItem_method_draw_multiline:
|
||||
|
||||
- void **draw_multiline** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
Draws multiple, parallel lines with a uniform ``color`` and ``width`` and optional antialiasing.
|
||||
|
||||
.. _class_CanvasItem_draw_multiline_colors:
|
||||
.. _class_CanvasItem_method_draw_multiline_colors:
|
||||
|
||||
- void **draw_multiline_colors** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
Draws multiple, parallel lines with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``.
|
||||
|
||||
.. _class_CanvasItem_draw_multimesh:
|
||||
.. _class_CanvasItem_method_draw_multimesh:
|
||||
|
||||
- void **draw_multimesh** **(** :ref:`MultiMesh<class_MultiMesh>` multimesh, :ref:`Texture<class_Texture>` texture, :ref:`Texture<class_Texture>` normal_map=null **)**
|
||||
|
||||
.. _class_CanvasItem_draw_polygon:
|
||||
.. _class_CanvasItem_method_draw_polygon:
|
||||
|
||||
- void **draw_polygon** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs=PoolVector2Array( ), :ref:`Texture<class_Texture>` texture=null, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
Draws a polygon of any amount of points, convex or concave.
|
||||
|
||||
.. _class_CanvasItem_draw_polyline:
|
||||
.. _class_CanvasItem_method_draw_polyline:
|
||||
|
||||
- void **draw_polyline** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing.
|
||||
|
||||
.. _class_CanvasItem_draw_polyline_colors:
|
||||
.. _class_CanvasItem_method_draw_polyline_colors:
|
||||
|
||||
- void **draw_polyline_colors** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
Draws interconnected line segments with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``.
|
||||
|
||||
.. _class_CanvasItem_draw_primitive:
|
||||
.. _class_CanvasItem_method_draw_primitive:
|
||||
|
||||
- void **draw_primitive** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolColorArray<class_PoolColorArray>` colors, :ref:`PoolVector2Array<class_PoolVector2Array>` uvs, :ref:`Texture<class_Texture>` texture=null, :ref:`float<class_float>` width=1.0, :ref:`Texture<class_Texture>` normal_map=null **)**
|
||||
|
||||
Draws a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
|
||||
|
||||
.. _class_CanvasItem_draw_rect:
|
||||
.. _class_CanvasItem_method_draw_rect:
|
||||
|
||||
- void **draw_rect** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` filled=true **)**
|
||||
|
||||
Draws a colored rectangle.
|
||||
|
||||
.. _class_CanvasItem_draw_set_transform:
|
||||
.. _class_CanvasItem_method_draw_set_transform:
|
||||
|
||||
- void **draw_set_transform** **(** :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` rotation, :ref:`Vector2<class_Vector2>` scale **)**
|
||||
|
||||
Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this.
|
||||
|
||||
.. _class_CanvasItem_draw_set_transform_matrix:
|
||||
.. _class_CanvasItem_method_draw_set_transform_matrix:
|
||||
|
||||
- void **draw_set_transform_matrix** **(** :ref:`Transform2D<class_Transform2D>` xform **)**
|
||||
|
||||
Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this.
|
||||
|
||||
.. _class_CanvasItem_draw_string:
|
||||
.. _class_CanvasItem_method_draw_string:
|
||||
|
||||
- void **draw_string** **(** :ref:`Font<class_Font>` font, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` text, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)**
|
||||
|
||||
Draws a string using a custom font.
|
||||
|
||||
.. _class_CanvasItem_draw_style_box:
|
||||
.. _class_CanvasItem_method_draw_style_box:
|
||||
|
||||
- void **draw_style_box** **(** :ref:`StyleBox<class_StyleBox>` style_box, :ref:`Rect2<class_Rect2>` rect **)**
|
||||
|
||||
Draws a styled rectangle.
|
||||
|
||||
.. _class_CanvasItem_draw_texture:
|
||||
.. _class_CanvasItem_method_draw_texture:
|
||||
|
||||
- void **draw_texture** **(** :ref:`Texture<class_Texture>` texture, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture<class_Texture>` normal_map=null **)**
|
||||
|
||||
Draws a texture at a given position.
|
||||
|
||||
.. _class_CanvasItem_draw_texture_rect:
|
||||
.. _class_CanvasItem_method_draw_texture_rect:
|
||||
|
||||
- void **draw_texture_rect** **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null **)**
|
||||
|
||||
Draws a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
|
||||
|
||||
.. _class_CanvasItem_draw_texture_rect_region:
|
||||
.. _class_CanvasItem_method_draw_texture_rect_region:
|
||||
|
||||
- void **draw_texture_rect_region** **(** :ref:`Texture<class_Texture>` texture, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=true **)**
|
||||
|
||||
Draws a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
|
||||
|
||||
.. _class_CanvasItem_force_update_transform:
|
||||
.. _class_CanvasItem_method_force_update_transform:
|
||||
|
||||
- void **force_update_transform** **(** **)**
|
||||
|
||||
.. _class_CanvasItem_get_canvas:
|
||||
.. _class_CanvasItem_method_get_canvas:
|
||||
|
||||
- :ref:`RID<class_RID>` **get_canvas** **(** **)** const
|
||||
|
||||
Return the :ref:`RID<class_RID>` of the :ref:`World2D<class_World2D>` canvas where this item is in.
|
||||
|
||||
.. _class_CanvasItem_get_canvas_item:
|
||||
.. _class_CanvasItem_method_get_canvas_item:
|
||||
|
||||
- :ref:`RID<class_RID>` **get_canvas_item** **(** **)** const
|
||||
|
||||
Return the canvas item RID used by :ref:`VisualServer<class_VisualServer>` for this item.
|
||||
|
||||
.. _class_CanvasItem_get_canvas_transform:
|
||||
.. _class_CanvasItem_method_get_canvas_transform:
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **get_canvas_transform** **(** **)** const
|
||||
|
||||
Get the transform matrix of this item's canvas.
|
||||
|
||||
.. _class_CanvasItem_get_global_mouse_position:
|
||||
.. _class_CanvasItem_method_get_global_mouse_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_global_mouse_position** **(** **)** const
|
||||
|
||||
Get the global position of the mouse.
|
||||
|
||||
.. _class_CanvasItem_get_global_transform:
|
||||
.. _class_CanvasItem_method_get_global_transform:
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **get_global_transform** **(** **)** const
|
||||
|
||||
Get the global transform matrix of this item.
|
||||
|
||||
.. _class_CanvasItem_get_global_transform_with_canvas:
|
||||
.. _class_CanvasItem_method_get_global_transform_with_canvas:
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **get_global_transform_with_canvas** **(** **)** const
|
||||
|
||||
Get the global transform matrix of this item in relation to the canvas.
|
||||
|
||||
.. _class_CanvasItem_get_local_mouse_position:
|
||||
.. _class_CanvasItem_method_get_local_mouse_position:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_local_mouse_position** **(** **)** const
|
||||
|
||||
Get the mouse position relative to this item's position.
|
||||
|
||||
.. _class_CanvasItem_get_transform:
|
||||
.. _class_CanvasItem_method_get_transform:
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **get_transform** **(** **)** const
|
||||
|
||||
Get the transform matrix of this item.
|
||||
|
||||
.. _class_CanvasItem_get_viewport_rect:
|
||||
.. _class_CanvasItem_method_get_viewport_rect:
|
||||
|
||||
- :ref:`Rect2<class_Rect2>` **get_viewport_rect** **(** **)** const
|
||||
|
||||
Get the viewport's boundaries as a :ref:`Rect2<class_Rect2>`.
|
||||
|
||||
.. _class_CanvasItem_get_viewport_transform:
|
||||
.. _class_CanvasItem_method_get_viewport_transform:
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **get_viewport_transform** **(** **)** const
|
||||
|
||||
Get this item's transform in relation to the viewport.
|
||||
|
||||
.. _class_CanvasItem_get_world_2d:
|
||||
.. _class_CanvasItem_method_get_world_2d:
|
||||
|
||||
- :ref:`World2D<class_World2D>` **get_world_2d** **(** **)** const
|
||||
|
||||
Get the :ref:`World2D<class_World2D>` where this item is in.
|
||||
|
||||
.. _class_CanvasItem_hide:
|
||||
.. _class_CanvasItem_method_hide:
|
||||
|
||||
- void **hide** **(** **)**
|
||||
|
||||
Hide the CanvasItem currently visible.
|
||||
|
||||
.. _class_CanvasItem_is_local_transform_notification_enabled:
|
||||
.. _class_CanvasItem_method_is_local_transform_notification_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_local_transform_notification_enabled** **(** **)** const
|
||||
|
||||
Returns ``true`` if local transform notifications are communicated to children.
|
||||
|
||||
.. _class_CanvasItem_is_set_as_toplevel:
|
||||
.. _class_CanvasItem_method_is_set_as_toplevel:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_set_as_toplevel** **(** **)** const
|
||||
|
||||
Return if set as toplevel. See :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>`.
|
||||
Return if set as toplevel. See :ref:`set_as_toplevel<class_CanvasItem_method_set_as_toplevel>`.
|
||||
|
||||
.. _class_CanvasItem_is_transform_notification_enabled:
|
||||
.. _class_CanvasItem_method_is_transform_notification_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_transform_notification_enabled** **(** **)** const
|
||||
|
||||
Returns ``true`` if global transform notifications are communicated to children.
|
||||
|
||||
.. _class_CanvasItem_is_visible_in_tree:
|
||||
.. _class_CanvasItem_method_is_visible_in_tree:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_visible_in_tree** **(** **)** const
|
||||
|
||||
Returns ``true`` if the node is present in the :ref:`SceneTree<class_SceneTree>`, its :ref:`visible<class_CanvasItem_visible>` property is ``true`` and its inherited visibility is also ``true``.
|
||||
Returns ``true`` if the node is present in the :ref:`SceneTree<class_SceneTree>`, its :ref:`visible<class_CanvasItem_property_visible>` property is ``true`` and its inherited visibility is also ``true``.
|
||||
|
||||
.. _class_CanvasItem_make_canvas_position_local:
|
||||
.. _class_CanvasItem_method_make_canvas_position_local:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **make_canvas_position_local** **(** :ref:`Vector2<class_Vector2>` screen_point **)** const
|
||||
|
||||
Assigns ``screen_point`` as this node's new local transform.
|
||||
|
||||
.. _class_CanvasItem_make_input_local:
|
||||
.. _class_CanvasItem_method_make_input_local:
|
||||
|
||||
- :ref:`InputEvent<class_InputEvent>` **make_input_local** **(** :ref:`InputEvent<class_InputEvent>` event **)** const
|
||||
|
||||
Transformations issued by ``event``'s inputs are applied in local space instead of global space.
|
||||
|
||||
.. _class_CanvasItem_set_as_toplevel:
|
||||
.. _class_CanvasItem_method_set_as_toplevel:
|
||||
|
||||
- void **set_as_toplevel** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Sets as top level. This means that it will not inherit transform from parent canvas items.
|
||||
|
||||
.. _class_CanvasItem_set_notify_local_transform:
|
||||
.. _class_CanvasItem_method_set_notify_local_transform:
|
||||
|
||||
- void **set_notify_local_transform** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``enable`` is ``true``, children will be updated with local transform data.
|
||||
|
||||
.. _class_CanvasItem_set_notify_transform:
|
||||
.. _class_CanvasItem_method_set_notify_transform:
|
||||
|
||||
- void **set_notify_transform** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``enable`` is ``true``, children will be updated with global transform data.
|
||||
|
||||
.. _class_CanvasItem_show:
|
||||
.. _class_CanvasItem_method_show:
|
||||
|
||||
- void **show** **(** **)**
|
||||
|
||||
Show the CanvasItem currently hidden. For controls that inherit :ref:`Popup<class_Popup>`, the correct way to make them visible is to call one of the multiple popup\*() functions instead.
|
||||
|
||||
.. _class_CanvasItem_update:
|
||||
.. _class_CanvasItem_method_update:
|
||||
|
||||
- void **update** **(** **)**
|
||||
|
||||
|
||||
@@ -19,25 +19,35 @@ A material for :ref:`CanvasItem<class_CanvasItem>`\ s.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
| :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` | :ref:`blend_mode<class_CanvasItemMaterial_blend_mode>` |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
| :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` | :ref:`light_mode<class_CanvasItemMaterial_light_mode>` |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`particles_anim_h_frames<class_CanvasItemMaterial_particles_anim_h_frames>` |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`particles_anim_loop<class_CanvasItemMaterial_particles_anim_loop>` |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`particles_anim_v_frames<class_CanvasItemMaterial_particles_anim_v_frames>` |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`particles_animation<class_CanvasItemMaterial_particles_animation>` |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
|
||||
| :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` | :ref:`blend_mode<class_CanvasItemMaterial_property_blend_mode>` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
|
||||
| :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` | :ref:`light_mode<class_CanvasItemMaterial_property_light_mode>` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`particles_anim_h_frames<class_CanvasItemMaterial_property_particles_anim_h_frames>` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`particles_anim_loop<class_CanvasItemMaterial_property_particles_anim_loop>` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`particles_anim_v_frames<class_CanvasItemMaterial_property_particles_anim_v_frames>` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`particles_animation<class_CanvasItemMaterial_property_particles_animation>` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_CanvasItemMaterial_BlendMode:
|
||||
|
||||
.. _class_CanvasItemMaterial_constant_BLEND_MODE_MIX:
|
||||
|
||||
.. _class_CanvasItemMaterial_constant_BLEND_MODE_ADD:
|
||||
|
||||
.. _class_CanvasItemMaterial_constant_BLEND_MODE_SUB:
|
||||
|
||||
.. _class_CanvasItemMaterial_constant_BLEND_MODE_MUL:
|
||||
|
||||
.. _class_CanvasItemMaterial_constant_BLEND_MODE_PREMULT_ALPHA:
|
||||
|
||||
enum **BlendMode**:
|
||||
|
||||
- **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.
|
||||
@@ -52,6 +62,12 @@ enum **BlendMode**:
|
||||
|
||||
.. _enum_CanvasItemMaterial_LightMode:
|
||||
|
||||
.. _class_CanvasItemMaterial_constant_LIGHT_MODE_NORMAL:
|
||||
|
||||
.. _class_CanvasItemMaterial_constant_LIGHT_MODE_UNSHADED:
|
||||
|
||||
.. _class_CanvasItemMaterial_constant_LIGHT_MODE_LIGHT_ONLY:
|
||||
|
||||
enum **LightMode**:
|
||||
|
||||
- **LIGHT_MODE_NORMAL** = **0** --- Render the material using both light and non-light sensitive material properties.
|
||||
@@ -68,7 +84,7 @@ Description
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CanvasItemMaterial_blend_mode:
|
||||
.. _class_CanvasItemMaterial_property_blend_mode:
|
||||
|
||||
- :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` **blend_mode**
|
||||
|
||||
@@ -80,7 +96,7 @@ Property Descriptions
|
||||
|
||||
The manner in which a material's rendering is applied to underlying textures.
|
||||
|
||||
.. _class_CanvasItemMaterial_light_mode:
|
||||
.. _class_CanvasItemMaterial_property_light_mode:
|
||||
|
||||
- :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` **light_mode**
|
||||
|
||||
@@ -92,7 +108,7 @@ The manner in which a material's rendering is applied to underlying textures.
|
||||
|
||||
The manner in which material reacts to lighting.
|
||||
|
||||
.. _class_CanvasItemMaterial_particles_anim_h_frames:
|
||||
.. _class_CanvasItemMaterial_property_particles_anim_h_frames:
|
||||
|
||||
- :ref:`int<class_int>` **particles_anim_h_frames**
|
||||
|
||||
@@ -102,7 +118,7 @@ The manner in which material reacts to lighting.
|
||||
| *Getter* | get_particles_anim_h_frames() |
|
||||
+----------+------------------------------------+
|
||||
|
||||
.. _class_CanvasItemMaterial_particles_anim_loop:
|
||||
.. _class_CanvasItemMaterial_property_particles_anim_loop:
|
||||
|
||||
- :ref:`bool<class_bool>` **particles_anim_loop**
|
||||
|
||||
@@ -112,7 +128,7 @@ The manner in which material reacts to lighting.
|
||||
| *Getter* | get_particles_anim_loop() |
|
||||
+----------+--------------------------------+
|
||||
|
||||
.. _class_CanvasItemMaterial_particles_anim_v_frames:
|
||||
.. _class_CanvasItemMaterial_property_particles_anim_v_frames:
|
||||
|
||||
- :ref:`int<class_int>` **particles_anim_v_frames**
|
||||
|
||||
@@ -122,7 +138,7 @@ The manner in which material reacts to lighting.
|
||||
| *Getter* | get_particles_anim_v_frames() |
|
||||
+----------+------------------------------------+
|
||||
|
||||
.. _class_CanvasItemMaterial_particles_animation:
|
||||
.. _class_CanvasItemMaterial_property_particles_animation:
|
||||
|
||||
- :ref:`bool<class_bool>` **particles_animation**
|
||||
|
||||
|
||||
@@ -21,28 +21,28 @@ Canvas drawing layer.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_CanvasLayer_custom_viewport>` |
|
||||
+---------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`layer<class_CanvasLayer_layer>` |
|
||||
+---------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_CanvasLayer_offset>` |
|
||||
+---------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rotation<class_CanvasLayer_rotation>` |
|
||||
+---------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rotation_degrees<class_CanvasLayer_rotation_degrees>` |
|
||||
+---------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`scale<class_CanvasLayer_scale>` |
|
||||
+---------------------------------------+-------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`transform<class_CanvasLayer_transform>` |
|
||||
+---------------------------------------+-------------------------------------------------------------+
|
||||
+---------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_CanvasLayer_property_custom_viewport>` |
|
||||
+---------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`layer<class_CanvasLayer_property_layer>` |
|
||||
+---------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_CanvasLayer_property_offset>` |
|
||||
+---------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rotation<class_CanvasLayer_property_rotation>` |
|
||||
+---------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rotation_degrees<class_CanvasLayer_property_rotation_degrees>` |
|
||||
+---------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`scale<class_CanvasLayer_property_scale>` |
|
||||
+---------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`transform<class_CanvasLayer_property_transform>` |
|
||||
+---------------------------------------+----------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------+-------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_canvas<class_CanvasLayer_get_canvas>` **(** **)** const |
|
||||
+------------------------+-------------------------------------------------------------------+
|
||||
+-----------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_canvas<class_CanvasLayer_method_get_canvas>` **(** **)** const |
|
||||
+-----------------------+--------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -59,7 +59,7 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CanvasLayer_custom_viewport:
|
||||
.. _class_CanvasLayer_property_custom_viewport:
|
||||
|
||||
- :ref:`Node<class_Node>` **custom_viewport**
|
||||
|
||||
@@ -71,7 +71,7 @@ Property Descriptions
|
||||
|
||||
The custom :ref:`Viewport<class_Viewport>` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead.
|
||||
|
||||
.. _class_CanvasLayer_layer:
|
||||
.. _class_CanvasLayer_property_layer:
|
||||
|
||||
- :ref:`int<class_int>` **layer**
|
||||
|
||||
@@ -83,7 +83,7 @@ The custom :ref:`Viewport<class_Viewport>` node assigned to the ``CanvasLayer``.
|
||||
|
||||
Layer index for draw order. Lower values are drawn first. Default value: ``1``.
|
||||
|
||||
.. _class_CanvasLayer_offset:
|
||||
.. _class_CanvasLayer_property_offset:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **offset**
|
||||
|
||||
@@ -95,7 +95,7 @@ Layer index for draw order. Lower values are drawn first. Default value: ``1``.
|
||||
|
||||
The layer's base offset.
|
||||
|
||||
.. _class_CanvasLayer_rotation:
|
||||
.. _class_CanvasLayer_property_rotation:
|
||||
|
||||
- :ref:`float<class_float>` **rotation**
|
||||
|
||||
@@ -107,7 +107,7 @@ The layer's base offset.
|
||||
|
||||
The layer's rotation in radians.
|
||||
|
||||
.. _class_CanvasLayer_rotation_degrees:
|
||||
.. _class_CanvasLayer_property_rotation_degrees:
|
||||
|
||||
- :ref:`float<class_float>` **rotation_degrees**
|
||||
|
||||
@@ -119,7 +119,7 @@ The layer's rotation in radians.
|
||||
|
||||
The layer's rotation in degrees.
|
||||
|
||||
.. _class_CanvasLayer_scale:
|
||||
.. _class_CanvasLayer_property_scale:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **scale**
|
||||
|
||||
@@ -131,7 +131,7 @@ The layer's rotation in degrees.
|
||||
|
||||
The layer's scale.
|
||||
|
||||
.. _class_CanvasLayer_transform:
|
||||
.. _class_CanvasLayer_property_transform:
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **transform**
|
||||
|
||||
@@ -146,7 +146,7 @@ The layer's transform.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_CanvasLayer_get_canvas:
|
||||
.. _class_CanvasLayer_method_get_canvas:
|
||||
|
||||
- :ref:`RID<class_RID>` **get_canvas** **(** **)** const
|
||||
|
||||
|
||||
@@ -19,9 +19,9 @@ Tint the entire canvas.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_CanvasModulate_color>` |
|
||||
+---------------------------+------------------------------------------+
|
||||
+---------------------------+---------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_CanvasModulate_property_color>` |
|
||||
+---------------------------+---------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -31,7 +31,7 @@ Description
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CanvasModulate_color:
|
||||
.. _class_CanvasModulate_property_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **color**
|
||||
|
||||
|
||||
@@ -19,15 +19,15 @@ Class representing a capsule-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleMesh_mid_height>` |
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`radial_segments<class_CapsuleMesh_radial_segments>` |
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleMesh_radius>` |
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`rings<class_CapsuleMesh_rings>` |
|
||||
+---------------------------+-----------------------------------------------------------+
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleMesh_property_mid_height>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`radial_segments<class_CapsuleMesh_property_radial_segments>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleMesh_property_radius>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`rings<class_CapsuleMesh_property_rings>` |
|
||||
+---------------------------+--------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -37,7 +37,7 @@ Class representing a capsule-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CapsuleMesh_mid_height:
|
||||
.. _class_CapsuleMesh_property_mid_height:
|
||||
|
||||
- :ref:`float<class_float>` **mid_height**
|
||||
|
||||
@@ -49,7 +49,7 @@ Property Descriptions
|
||||
|
||||
Height of the capsule mesh from the center point. Defaults to 1.0.
|
||||
|
||||
.. _class_CapsuleMesh_radial_segments:
|
||||
.. _class_CapsuleMesh_property_radial_segments:
|
||||
|
||||
- :ref:`int<class_int>` **radial_segments**
|
||||
|
||||
@@ -61,7 +61,7 @@ Height of the capsule mesh from the center point. Defaults to 1.0.
|
||||
|
||||
Number of radial segments on the capsule mesh. Defaults to 64.
|
||||
|
||||
.. _class_CapsuleMesh_radius:
|
||||
.. _class_CapsuleMesh_property_radius:
|
||||
|
||||
- :ref:`float<class_float>` **radius**
|
||||
|
||||
@@ -73,7 +73,7 @@ Number of radial segments on the capsule mesh. Defaults to 64.
|
||||
|
||||
Radius of the capsule mesh. Defaults to 1.0.
|
||||
|
||||
.. _class_CapsuleMesh_rings:
|
||||
.. _class_CapsuleMesh_property_rings:
|
||||
|
||||
- :ref:`int<class_int>` **rings**
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Capsule shape for collisions.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape_height>` |
|
||||
+---------------------------+------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape_radius>` |
|
||||
+---------------------------+------------------------------------------+
|
||||
+---------------------------+---------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape_property_height>` |
|
||||
+---------------------------+---------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape_property_radius>` |
|
||||
+---------------------------+---------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -33,7 +33,7 @@ Capsule shape for collisions.
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CapsuleShape_height:
|
||||
.. _class_CapsuleShape_property_height:
|
||||
|
||||
- :ref:`float<class_float>` **height**
|
||||
|
||||
@@ -45,7 +45,7 @@ Property Descriptions
|
||||
|
||||
The capsule's height.
|
||||
|
||||
.. _class_CapsuleShape_radius:
|
||||
.. _class_CapsuleShape_property_radius:
|
||||
|
||||
- :ref:`float<class_float>` **radius**
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Capsule shape for 2D collisions.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+--------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_height>` |
|
||||
+---------------------------+--------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_radius>` |
|
||||
+---------------------------+--------------------------------------------+
|
||||
+---------------------------+-----------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>` |
|
||||
+---------------------------+-----------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>` |
|
||||
+---------------------------+-----------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -33,7 +33,7 @@ Capsule shape for 2D collisions.
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CapsuleShape2D_height:
|
||||
.. _class_CapsuleShape2D_property_height:
|
||||
|
||||
- :ref:`float<class_float>` **height**
|
||||
|
||||
@@ -45,7 +45,7 @@ Property Descriptions
|
||||
|
||||
The capsule's height.
|
||||
|
||||
.. _class_CapsuleShape2D_radius:
|
||||
.. _class_CapsuleShape2D_property_radius:
|
||||
|
||||
- :ref:`float<class_float>` **radius**
|
||||
|
||||
|
||||
@@ -19,9 +19,9 @@ Keeps children controls centered.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+---------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`use_top_left<class_CenterContainer_use_top_left>` |
|
||||
+-------------------------+---------------------------------------------------------+
|
||||
+-------------------------+------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`use_top_left<class_CenterContainer_property_use_top_left>` |
|
||||
+-------------------------+------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -31,7 +31,7 @@ CenterContainer Keeps children controls centered. This container keeps all child
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CenterContainer_use_top_left:
|
||||
.. _class_CenterContainer_property_use_top_left:
|
||||
|
||||
- :ref:`bool<class_bool>` **use_top_left**
|
||||
|
||||
|
||||
@@ -19,43 +19,43 @@ Binary choice user interface widget.
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`check_vadjust<class_CheckBox_check_vadjust>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`checked<class_CheckBox_checked>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_CheckBox_disabled>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_CheckBox_focus>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`Font<class_Font>` | :ref:`font<class_CheckBox_font>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color<class_CheckBox_font_color>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_CheckBox_font_color_disabled>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_hover<class_CheckBox_font_color_hover>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_hover_pressed<class_CheckBox_font_color_hover_pressed>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_CheckBox_font_color_pressed>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_CheckBox_hover>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover_pressed<class_CheckBox_hover_pressed>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hseparation<class_CheckBox_hseparation>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_CheckBox_normal>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_CheckBox_pressed>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`radio_checked<class_CheckBox_radio_checked>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`radio_unchecked<class_CheckBox_radio_unchecked>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`unchecked<class_CheckBox_unchecked>` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`int<class_int>` | check_vadjust |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Texture<class_Texture>` | checked |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | disabled |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | focus |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Font<class_Font>` | font |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_disabled |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_hover |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_hover_pressed |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_pressed |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | hover |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | hover_pressed |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`int<class_int>` | hseparation |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | normal |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | pressed |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Texture<class_Texture>` | radio_checked |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Texture<class_Texture>` | radio_unchecked |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Texture<class_Texture>` | unchecked |
|
||||
+---------------------------------+--------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -19,39 +19,39 @@ Checkable button.
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`check_vadjust<class_CheckButton_check_vadjust>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_CheckButton_disabled>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_CheckButton_focus>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`Font<class_Font>` | :ref:`font<class_CheckButton_font>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color<class_CheckButton_font_color>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_CheckButton_font_color_disabled>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_hover<class_CheckButton_font_color_hover>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_hover_pressed<class_CheckButton_font_color_hover_pressed>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_CheckButton_font_color_pressed>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_CheckButton_hover>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover_pressed<class_CheckButton_hover_pressed>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hseparation<class_CheckButton_hseparation>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_CheckButton_normal>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`off<class_CheckButton_off>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`on<class_CheckButton_on>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_CheckButton_pressed>` |
|
||||
+---------------------------------+-----------------------------------------------------------------------------+
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`int<class_int>` | check_vadjust |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | disabled |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | focus |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Font<class_Font>` | font |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_disabled |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_hover |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_hover_pressed |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Color<class_Color>` | font_color_pressed |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | hover |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | hover_pressed |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`int<class_int>` | hseparation |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | normal |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Texture<class_Texture>` | off |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`Texture<class_Texture>` | on |
|
||||
+---------------------------------+--------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | pressed |
|
||||
+---------------------------------+--------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -19,9 +19,9 @@ Circular shape for 2D collisions.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CircleShape2D_radius>` |
|
||||
+---------------------------+-------------------------------------------+
|
||||
+---------------------------+----------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CircleShape2D_property_radius>` |
|
||||
+---------------------------+----------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -31,7 +31,7 @@ Circular shape for 2D collisions. This shape is useful for modeling balls or sma
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CircleShape2D_radius:
|
||||
.. _class_CircleShape2D_property_radius:
|
||||
|
||||
- :ref:`float<class_float>` **radius**
|
||||
|
||||
|
||||
@@ -19,47 +19,47 @@ Class information repository.
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_instance<class_ClassDB_can_instance>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_exists<class_ClassDB_class_exists>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`class_get_category<class_ClassDB_class_get_category>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`class_get_integer_constant<class_ClassDB_class_get_integer_constant>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`class_get_integer_constant_list<class_ClassDB_class_get_integer_constant_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_method_list<class_ClassDB_class_get_method_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`class_get_property<class_ClassDB_class_get_property>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_property_list<class_ClassDB_class_get_property_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`class_get_signal<class_ClassDB_class_get_signal>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_signal_list<class_ClassDB_class_get_signal_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_integer_constant<class_ClassDB_class_has_integer_constant>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_method<class_ClassDB_class_has_method>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_signal<class_ClassDB_class_has_signal>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`class_set_property<class_ClassDB_class_set_property>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_class_list<class_ClassDB_get_class_list>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_inheriters_from_class<class_ClassDB_get_inheriters_from_class>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_parent_class<class_ClassDB_get_parent_class>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`instance<class_ClassDB_instance>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class_enabled<class_ClassDB_is_class_enabled>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_parent_class<class_ClassDB_is_parent_class>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` inherits **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_instance<class_ClassDB_method_can_instance>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_exists<class_ClassDB_method_class_exists>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`class_get_category<class_ClassDB_method_class_get_category>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`class_get_integer_constant<class_ClassDB_method_class_get_integer_constant>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`class_get_integer_constant_list<class_ClassDB_method_class_get_integer_constant_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_method_list<class_ClassDB_method_class_get_method_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`class_get_property<class_ClassDB_method_class_get_property>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_property_list<class_ClassDB_method_class_get_property_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`class_get_signal<class_ClassDB_method_class_get_signal>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`class_get_signal_list<class_ClassDB_method_class_get_signal_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_integer_constant<class_ClassDB_method_class_has_integer_constant>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_method<class_ClassDB_method_class_has_method>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_signal<class_ClassDB_method_class_has_signal>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`class_set_property<class_ClassDB_method_class_set_property>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_class_list<class_ClassDB_method_get_class_list>` **(** **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_inheriters_from_class<class_ClassDB_method_get_inheriters_from_class>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`get_parent_class<class_ClassDB_method_get_parent_class>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`instance<class_ClassDB_method_instance>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class_enabled<class_ClassDB_method_is_class_enabled>` **(** :ref:`String<class_String>` class **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_parent_class<class_ClassDB_method_is_parent_class>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` inherits **)** const |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -69,121 +69,121 @@ Provides access to metadata stored for every available class.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_ClassDB_can_instance:
|
||||
.. _class_ClassDB_method_can_instance:
|
||||
|
||||
- :ref:`bool<class_bool>` **can_instance** **(** :ref:`String<class_String>` class **)** const
|
||||
|
||||
Returns true if you can instance objects from the specified 'class', false in other case.
|
||||
|
||||
.. _class_ClassDB_class_exists:
|
||||
.. _class_ClassDB_method_class_exists:
|
||||
|
||||
- :ref:`bool<class_bool>` **class_exists** **(** :ref:`String<class_String>` class **)** const
|
||||
|
||||
Returns whether the specified 'class' is available or not.
|
||||
|
||||
.. _class_ClassDB_class_get_category:
|
||||
.. _class_ClassDB_method_class_get_category:
|
||||
|
||||
- :ref:`String<class_String>` **class_get_category** **(** :ref:`String<class_String>` class **)** const
|
||||
|
||||
Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required.
|
||||
|
||||
.. _class_ClassDB_class_get_integer_constant:
|
||||
.. _class_ClassDB_method_class_get_integer_constant:
|
||||
|
||||
- :ref:`int<class_int>` **class_get_integer_constant** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const
|
||||
|
||||
Returns the value of the integer constant 'name' of 'class' or its ancestry. Always returns 0 when the constant could not be found.
|
||||
|
||||
.. _class_ClassDB_class_get_integer_constant_list:
|
||||
.. _class_ClassDB_method_class_get_integer_constant_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **class_get_integer_constant_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
|
||||
Returns an array with the names all the integer constants of 'class' or its ancestry.
|
||||
|
||||
.. _class_ClassDB_class_get_method_list:
|
||||
.. _class_ClassDB_method_class_get_method_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **class_get_method_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
|
||||
Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary<class_Dictionary>` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).
|
||||
|
||||
.. _class_ClassDB_class_get_property:
|
||||
.. _class_ClassDB_method_class_get_property:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **class_get_property** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property **)** const
|
||||
|
||||
Returns the value of 'property' of 'class' or its ancestry.
|
||||
|
||||
.. _class_ClassDB_class_get_property_list:
|
||||
.. _class_ClassDB_method_class_get_property_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **class_get_property_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
|
||||
Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is false.
|
||||
|
||||
.. _class_ClassDB_class_get_signal:
|
||||
.. _class_ClassDB_method_class_get_signal:
|
||||
|
||||
- :ref:`Dictionary<class_Dictionary>` **class_get_signal** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const
|
||||
|
||||
Returns the 'signal' data of 'class' or its ancestry. The returned value is a :ref:`Dictionary<class_Dictionary>` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).
|
||||
|
||||
.. _class_ClassDB_class_get_signal_list:
|
||||
.. _class_ClassDB_method_class_get_signal_list:
|
||||
|
||||
- :ref:`Array<class_Array>` **class_get_signal_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
|
||||
Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary<class_Dictionary>` as described in :ref:`class_get_signal<class_ClassDB_class_get_signal>`.
|
||||
Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary<class_Dictionary>` as described in :ref:`class_get_signal<class_ClassDB_method_class_get_signal>`.
|
||||
|
||||
.. _class_ClassDB_class_has_integer_constant:
|
||||
.. _class_ClassDB_method_class_has_integer_constant:
|
||||
|
||||
- :ref:`bool<class_bool>` **class_has_integer_constant** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** const
|
||||
|
||||
Return whether 'class' or its ancestry has an integer constant called 'name' or not.
|
||||
|
||||
.. _class_ClassDB_class_has_method:
|
||||
.. _class_ClassDB_method_class_has_method:
|
||||
|
||||
- :ref:`bool<class_bool>` **class_has_method** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
|
||||
Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not.
|
||||
|
||||
.. _class_ClassDB_class_has_signal:
|
||||
.. _class_ClassDB_method_class_has_signal:
|
||||
|
||||
- :ref:`bool<class_bool>` **class_has_signal** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** const
|
||||
|
||||
Return whether 'class' or its ancestry has a signal called 'signal' or not.
|
||||
|
||||
.. _class_ClassDB_class_set_property:
|
||||
.. _class_ClassDB_method_class_set_property:
|
||||
|
||||
- :ref:`Error<enum_@GlobalScope_Error>` **class_set_property** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** const
|
||||
|
||||
Sets 'property' value of 'class' to 'value'.
|
||||
|
||||
.. _class_ClassDB_get_class_list:
|
||||
.. _class_ClassDB_method_get_class_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_class_list** **(** **)** const
|
||||
|
||||
Returns the names of all the classes available.
|
||||
|
||||
.. _class_ClassDB_get_inheriters_from_class:
|
||||
.. _class_ClassDB_method_get_inheriters_from_class:
|
||||
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_inheriters_from_class** **(** :ref:`String<class_String>` class **)** const
|
||||
|
||||
Returns the names of all the classes that directly or indirectly inherit from 'class'.
|
||||
|
||||
.. _class_ClassDB_get_parent_class:
|
||||
.. _class_ClassDB_method_get_parent_class:
|
||||
|
||||
- :ref:`String<class_String>` **get_parent_class** **(** :ref:`String<class_String>` class **)** const
|
||||
|
||||
Returns the parent class of 'class'.
|
||||
|
||||
.. _class_ClassDB_instance:
|
||||
.. _class_ClassDB_method_instance:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **instance** **(** :ref:`String<class_String>` class **)** const
|
||||
|
||||
Creates an instance of 'class'.
|
||||
|
||||
.. _class_ClassDB_is_class_enabled:
|
||||
.. _class_ClassDB_method_is_class_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_class_enabled** **(** :ref:`String<class_String>` class **)** const
|
||||
|
||||
Returns whether this class is enabled or not.
|
||||
|
||||
.. _class_ClassDB_is_parent_class:
|
||||
.. _class_ClassDB_method_is_parent_class:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_parent_class** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` inherits **)** const
|
||||
|
||||
|
||||
@@ -19,42 +19,46 @@ Brief Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_to_areas<class_ClippedCamera_clip_to_areas>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_to_bodies<class_ClippedCamera_clip_to_bodies>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_ClippedCamera_collision_mask>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`margin<class_ClippedCamera_margin>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`ProcessMode<enum_ClippedCamera_ProcessMode>` | :ref:`process_mode<class_ClippedCamera_process_mode>` |
|
||||
+----------------------------------------------------+-----------------------------------------------------------+
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_to_areas<class_ClippedCamera_property_clip_to_areas>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_to_bodies<class_ClippedCamera_property_clip_to_bodies>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_ClippedCamera_property_collision_mask>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`margin<class_ClippedCamera_property_margin>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`ProcessMode<enum_ClippedCamera_ProcessMode>` | :ref:`process_mode<class_ClippedCamera_property_process_mode>` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_exception<class_ClippedCamera_add_exception>` **(** :ref:`Object<class_Object>` node **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_exception_rid<class_ClippedCamera_add_exception_rid>` **(** :ref:`RID<class_RID>` rid **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_exceptions<class_ClippedCamera_clear_exceptions>` **(** **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_ClippedCamera_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_exception<class_ClippedCamera_remove_exception>` **(** :ref:`Object<class_Object>` node **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_exception_rid<class_ClippedCamera_remove_exception_rid>` **(** :ref:`RID<class_RID>` rid **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_ClippedCamera_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_exception<class_ClippedCamera_method_add_exception>` **(** :ref:`Object<class_Object>` node **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_exception_rid<class_ClippedCamera_method_add_exception_rid>` **(** :ref:`RID<class_RID>` rid **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_exceptions<class_ClippedCamera_method_clear_exceptions>` **(** **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_ClippedCamera_method_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_exception<class_ClippedCamera_method_remove_exception>` **(** :ref:`Object<class_Object>` node **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_exception_rid<class_ClippedCamera_method_remove_exception_rid>` **(** :ref:`RID<class_RID>` rid **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_ClippedCamera_method_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_ClippedCamera_ProcessMode:
|
||||
|
||||
.. _class_ClippedCamera_constant_CLIP_PROCESS_PHYSICS:
|
||||
|
||||
.. _class_ClippedCamera_constant_CLIP_PROCESS_IDLE:
|
||||
|
||||
enum **ProcessMode**:
|
||||
|
||||
- **CLIP_PROCESS_PHYSICS** = **0**
|
||||
@@ -64,7 +68,7 @@ enum **ProcessMode**:
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_ClippedCamera_clip_to_areas:
|
||||
.. _class_ClippedCamera_property_clip_to_areas:
|
||||
|
||||
- :ref:`bool<class_bool>` **clip_to_areas**
|
||||
|
||||
@@ -74,7 +78,7 @@ Property Descriptions
|
||||
| *Getter* | is_clip_to_areas_enabled() |
|
||||
+----------+----------------------------+
|
||||
|
||||
.. _class_ClippedCamera_clip_to_bodies:
|
||||
.. _class_ClippedCamera_property_clip_to_bodies:
|
||||
|
||||
- :ref:`bool<class_bool>` **clip_to_bodies**
|
||||
|
||||
@@ -84,7 +88,7 @@ Property Descriptions
|
||||
| *Getter* | is_clip_to_bodies_enabled() |
|
||||
+----------+-----------------------------+
|
||||
|
||||
.. _class_ClippedCamera_collision_mask:
|
||||
.. _class_ClippedCamera_property_collision_mask:
|
||||
|
||||
- :ref:`int<class_int>` **collision_mask**
|
||||
|
||||
@@ -94,7 +98,7 @@ Property Descriptions
|
||||
| *Getter* | get_collision_mask() |
|
||||
+----------+---------------------------+
|
||||
|
||||
.. _class_ClippedCamera_margin:
|
||||
.. _class_ClippedCamera_property_margin:
|
||||
|
||||
- :ref:`float<class_float>` **margin**
|
||||
|
||||
@@ -104,7 +108,7 @@ Property Descriptions
|
||||
| *Getter* | get_margin() |
|
||||
+----------+-------------------+
|
||||
|
||||
.. _class_ClippedCamera_process_mode:
|
||||
.. _class_ClippedCamera_property_process_mode:
|
||||
|
||||
- :ref:`ProcessMode<enum_ClippedCamera_ProcessMode>` **process_mode**
|
||||
|
||||
@@ -117,31 +121,31 @@ Property Descriptions
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_ClippedCamera_add_exception:
|
||||
.. _class_ClippedCamera_method_add_exception:
|
||||
|
||||
- void **add_exception** **(** :ref:`Object<class_Object>` node **)**
|
||||
|
||||
.. _class_ClippedCamera_add_exception_rid:
|
||||
.. _class_ClippedCamera_method_add_exception_rid:
|
||||
|
||||
- void **add_exception_rid** **(** :ref:`RID<class_RID>` rid **)**
|
||||
|
||||
.. _class_ClippedCamera_clear_exceptions:
|
||||
.. _class_ClippedCamera_method_clear_exceptions:
|
||||
|
||||
- void **clear_exceptions** **(** **)**
|
||||
|
||||
.. _class_ClippedCamera_get_collision_mask_bit:
|
||||
.. _class_ClippedCamera_method_get_collision_mask_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
.. _class_ClippedCamera_remove_exception:
|
||||
.. _class_ClippedCamera_method_remove_exception:
|
||||
|
||||
- void **remove_exception** **(** :ref:`Object<class_Object>` node **)**
|
||||
|
||||
.. _class_ClippedCamera_remove_exception_rid:
|
||||
.. _class_ClippedCamera_method_remove_exception_rid:
|
||||
|
||||
- void **remove_exception_rid** **(** :ref:`RID<class_RID>` rid **)**
|
||||
|
||||
.. _class_ClippedCamera_set_collision_mask_bit:
|
||||
.. _class_ClippedCamera_method_set_collision_mask_bit:
|
||||
|
||||
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
|
||||
@@ -21,67 +21,67 @@ Base node for collision objects.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_capture_on_drag<class_CollisionObject_input_capture_on_drag>` |
|
||||
+-------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_ray_pickable<class_CollisionObject_input_ray_pickable>` |
|
||||
+-------------------------+---------------------------------------------------------------------------+
|
||||
+-------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_capture_on_drag<class_CollisionObject_property_input_capture_on_drag>` |
|
||||
+-------------------------+------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_ray_pickable<class_CollisionObject_property_input_ray_pickable>` |
|
||||
+-------------------------+------------------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_input_event<class_CollisionObject__input_event>` **(** :ref:`Object<class_Object>` camera, :ref:`InputEvent<class_InputEvent>` event, :ref:`Vector3<class_Vector3>` click_position, :ref:`Vector3<class_Vector3>` click_normal, :ref:`int<class_int>` shape_idx **)** virtual |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject_create_shape_owner>` **(** :ref:`Object<class_Object>` owner **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_rid<class_CollisionObject_get_rid>` **(** **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_shape_owners<class_CollisionObject_get_shape_owners>` **(** **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_shape_owner_disabled<class_CollisionObject_is_shape_owner_disabled>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_shape_owner<class_CollisionObject_remove_shape_owner>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_find_owner<class_CollisionObject_shape_find_owner>` **(** :ref:`int<class_int>` shape_index **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_add_shape<class_CollisionObject_shape_owner_add_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_Shape>` shape **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_clear_shapes<class_CollisionObject_shape_owner_clear_shapes>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`shape_owner_get_owner<class_CollisionObject_shape_owner_get_owner>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Shape<class_Shape>` | :ref:`shape_owner_get_shape<class_CollisionObject_shape_owner_get_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_count<class_CollisionObject_shape_owner_get_shape_count>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_index<class_CollisionObject_shape_owner_get_shape_index>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`shape_owner_get_transform<class_CollisionObject_shape_owner_get_transform>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_remove_shape<class_CollisionObject_shape_owner_remove_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_set_disabled<class_CollisionObject_shape_owner_set_disabled>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_set_transform<class_CollisionObject_shape_owner_set_transform>` **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_Transform>` transform **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_input_event<class_CollisionObject_method__input_event>` **(** :ref:`Object<class_Object>` camera, :ref:`InputEvent<class_InputEvent>` event, :ref:`Vector3<class_Vector3>` click_position, :ref:`Vector3<class_Vector3>` click_normal, :ref:`int<class_int>` shape_idx **)** virtual |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject_method_create_shape_owner>` **(** :ref:`Object<class_Object>` owner **)** |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_rid<class_CollisionObject_method_get_rid>` **(** **)** const |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_shape_owners<class_CollisionObject_method_get_shape_owners>` **(** **)** |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_shape_owner_disabled<class_CollisionObject_method_is_shape_owner_disabled>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_shape_owner<class_CollisionObject_method_remove_shape_owner>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_find_owner<class_CollisionObject_method_shape_find_owner>` **(** :ref:`int<class_int>` shape_index **)** const |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_add_shape<class_CollisionObject_method_shape_owner_add_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_Shape>` shape **)** |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_clear_shapes<class_CollisionObject_method_shape_owner_clear_shapes>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`shape_owner_get_owner<class_CollisionObject_method_shape_owner_get_owner>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Shape<class_Shape>` | :ref:`shape_owner_get_shape<class_CollisionObject_method_shape_owner_get_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_count<class_CollisionObject_method_shape_owner_get_shape_count>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_index<class_CollisionObject_method_shape_owner_get_shape_index>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`shape_owner_get_transform<class_CollisionObject_method_shape_owner_get_transform>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_remove_shape<class_CollisionObject_method_shape_owner_remove_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_set_disabled<class_CollisionObject_method_shape_owner_set_disabled>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_set_transform<class_CollisionObject_method_shape_owner_set_transform>` **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_Transform>` transform **)** |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_CollisionObject_input_event:
|
||||
.. _class_CollisionObject_signal_input_event:
|
||||
|
||||
- **input_event** **(** :ref:`Node<class_Node>` camera, :ref:`InputEvent<class_InputEvent>` event, :ref:`Vector3<class_Vector3>` click_position, :ref:`Vector3<class_Vector3>` click_normal, :ref:`int<class_int>` shape_idx **)**
|
||||
|
||||
Emitted when :ref:`_input_event<class_CollisionObject__input_event>` receives an event. See its description for details.
|
||||
Emitted when :ref:`_input_event<class_CollisionObject_method__input_event>` receives an event. See its description for details.
|
||||
|
||||
.. _class_CollisionObject_mouse_entered:
|
||||
.. _class_CollisionObject_signal_mouse_entered:
|
||||
|
||||
- **mouse_entered** **(** **)**
|
||||
|
||||
Emitted when the mouse pointer enters any of this object's shapes.
|
||||
|
||||
.. _class_CollisionObject_mouse_exited:
|
||||
.. _class_CollisionObject_signal_mouse_exited:
|
||||
|
||||
- **mouse_exited** **(** **)**
|
||||
|
||||
@@ -95,7 +95,7 @@ CollisionObject is the base class for physics objects. It can hold any number of
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CollisionObject_input_capture_on_drag:
|
||||
.. _class_CollisionObject_property_input_capture_on_drag:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_capture_on_drag**
|
||||
|
||||
@@ -107,7 +107,7 @@ Property Descriptions
|
||||
|
||||
If ``true``, the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``.
|
||||
|
||||
.. _class_CollisionObject_input_ray_pickable:
|
||||
.. _class_CollisionObject_property_input_ray_pickable:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_ray_pickable**
|
||||
|
||||
@@ -122,103 +122,103 @@ If ``true``, the :ref:`CollisionObject<class_CollisionObject>`'s shapes will res
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_CollisionObject__input_event:
|
||||
.. _class_CollisionObject_method__input_event:
|
||||
|
||||
- void **_input_event** **(** :ref:`Object<class_Object>` camera, :ref:`InputEvent<class_InputEvent>` event, :ref:`Vector3<class_Vector3>` click_position, :ref:`Vector3<class_Vector3>` click_normal, :ref:`int<class_int>` shape_idx **)** virtual
|
||||
|
||||
Accepts unhandled :ref:`InputEvent<class_InputEvent>`\ s. ``click_position`` is the clicked location in world space and ``click_normal`` is the normal vector extending from the clicked surface of the :ref:`Shape<class_Shape>` at ``shape_idx``. Connect to the ``input_event`` signal to easily pick up these events.
|
||||
|
||||
.. _class_CollisionObject_create_shape_owner:
|
||||
.. _class_CollisionObject_method_create_shape_owner:
|
||||
|
||||
- :ref:`int<class_int>` **create_shape_owner** **(** :ref:`Object<class_Object>` owner **)**
|
||||
|
||||
Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference.
|
||||
|
||||
.. _class_CollisionObject_get_rid:
|
||||
.. _class_CollisionObject_method_get_rid:
|
||||
|
||||
- :ref:`RID<class_RID>` **get_rid** **(** **)** const
|
||||
|
||||
Returns the object's :ref:`RID<class_RID>`.
|
||||
|
||||
.. _class_CollisionObject_get_shape_owners:
|
||||
.. _class_CollisionObject_method_get_shape_owners:
|
||||
|
||||
- :ref:`Array<class_Array>` **get_shape_owners** **(** **)**
|
||||
|
||||
Returns an :ref:`Array<class_Array>` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument.
|
||||
|
||||
.. _class_CollisionObject_is_shape_owner_disabled:
|
||||
.. _class_CollisionObject_method_is_shape_owner_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
If ``true``, the shape owner and its shapes are disabled.
|
||||
|
||||
.. _class_CollisionObject_remove_shape_owner:
|
||||
.. _class_CollisionObject_method_remove_shape_owner:
|
||||
|
||||
- void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)**
|
||||
|
||||
Removes the given shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_find_owner:
|
||||
.. _class_CollisionObject_method_shape_find_owner:
|
||||
|
||||
- :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** const
|
||||
|
||||
Returns the ``owner_id`` of the given shape.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_add_shape:
|
||||
.. _class_CollisionObject_method_shape_owner_add_shape:
|
||||
|
||||
- void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_Shape>` shape **)**
|
||||
|
||||
Adds a :ref:`Shape<class_Shape>` to the shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_clear_shapes:
|
||||
.. _class_CollisionObject_method_shape_owner_clear_shapes:
|
||||
|
||||
- void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)**
|
||||
|
||||
Removes all shapes from the shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_get_owner:
|
||||
.. _class_CollisionObject_method_shape_owner_get_owner:
|
||||
|
||||
- :ref:`Object<class_Object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the parent object of the given shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_get_shape:
|
||||
.. _class_CollisionObject_method_shape_owner_get_shape:
|
||||
|
||||
- :ref:`Shape<class_Shape>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
|
||||
|
||||
Returns the :ref:`Shape<class_Shape>` with the given id from the given shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_get_shape_count:
|
||||
.. _class_CollisionObject_method_shape_owner_get_shape_count:
|
||||
|
||||
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the number of shapes the given shape owner contains.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_get_shape_index:
|
||||
.. _class_CollisionObject_method_shape_owner_get_shape_index:
|
||||
|
||||
- :ref:`int<class_int>` **shape_owner_get_shape_index** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
|
||||
|
||||
Returns the child index of the :ref:`Shape<class_Shape>` with the given id from the given shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_get_transform:
|
||||
.. _class_CollisionObject_method_shape_owner_get_transform:
|
||||
|
||||
- :ref:`Transform<class_Transform>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the shape owner's :ref:`Transform<class_Transform>`.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_remove_shape:
|
||||
.. _class_CollisionObject_method_shape_owner_remove_shape:
|
||||
|
||||
- void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
|
||||
|
||||
Removes a shape from the given shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_set_disabled:
|
||||
.. _class_CollisionObject_method_shape_owner_set_disabled:
|
||||
|
||||
- void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
|
||||
|
||||
If ``true``, disables the given shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_set_transform:
|
||||
.. _class_CollisionObject_method_shape_owner_set_transform:
|
||||
|
||||
- void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_Transform>` transform **)**
|
||||
|
||||
|
||||
@@ -21,69 +21,69 @@ Base node for 2D collision objects.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+---------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_pickable<class_CollisionObject2D_input_pickable>` |
|
||||
+-------------------------+---------------------------------------------------------------+
|
||||
+-------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_pickable<class_CollisionObject2D_property_input_pickable>` |
|
||||
+-------------------------+------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_input_event<class_CollisionObject2D__input_event>` **(** :ref:`Object<class_Object>` viewport, :ref:`InputEvent<class_InputEvent>` event, :ref:`int<class_int>` shape_idx **)** virtual |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject2D_create_shape_owner>` **(** :ref:`Object<class_Object>` owner **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_rid<class_CollisionObject2D_get_rid>` **(** **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_shape_owners<class_CollisionObject2D_get_shape_owners>` **(** **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_shape_owner_disabled<class_CollisionObject2D_is_shape_owner_disabled>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_shape_owner_one_way_collision_enabled<class_CollisionObject2D_is_shape_owner_one_way_collision_enabled>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_shape_owner<class_CollisionObject2D_remove_shape_owner>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_find_owner<class_CollisionObject2D_shape_find_owner>` **(** :ref:`int<class_int>` shape_index **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_add_shape<class_CollisionObject2D_shape_owner_add_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`Shape2D<class_Shape2D>` shape **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_clear_shapes<class_CollisionObject2D_shape_owner_clear_shapes>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`shape_owner_get_owner<class_CollisionObject2D_shape_owner_get_owner>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape_owner_get_shape<class_CollisionObject2D_shape_owner_get_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_count<class_CollisionObject2D_shape_owner_get_shape_count>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_index<class_CollisionObject2D_shape_owner_get_shape_index>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`shape_owner_get_transform<class_CollisionObject2D_shape_owner_get_transform>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_remove_shape<class_CollisionObject2D_shape_owner_remove_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_set_disabled<class_CollisionObject2D_shape_owner_set_disabled>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_set_one_way_collision<class_CollisionObject2D_shape_owner_set_one_way_collision>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_set_transform<class_CollisionObject2D_shape_owner_set_transform>` **(** :ref:`int<class_int>` owner_id, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_input_event<class_CollisionObject2D_method__input_event>` **(** :ref:`Object<class_Object>` viewport, :ref:`InputEvent<class_InputEvent>` event, :ref:`int<class_int>` shape_idx **)** virtual |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject2D_method_create_shape_owner>` **(** :ref:`Object<class_Object>` owner **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_RID>` | :ref:`get_rid<class_CollisionObject2D_method_get_rid>` **(** **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_Array>` | :ref:`get_shape_owners<class_CollisionObject2D_method_get_shape_owners>` **(** **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_shape_owner_disabled<class_CollisionObject2D_method_is_shape_owner_disabled>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_shape_owner_one_way_collision_enabled<class_CollisionObject2D_method_is_shape_owner_one_way_collision_enabled>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_shape_owner<class_CollisionObject2D_method_remove_shape_owner>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_find_owner<class_CollisionObject2D_method_shape_find_owner>` **(** :ref:`int<class_int>` shape_index **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_add_shape<class_CollisionObject2D_method_shape_owner_add_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`Shape2D<class_Shape2D>` shape **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_clear_shapes<class_CollisionObject2D_method_shape_owner_clear_shapes>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_Object>` | :ref:`shape_owner_get_owner<class_CollisionObject2D_method_shape_owner_get_owner>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape_owner_get_shape<class_CollisionObject2D_method_shape_owner_get_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_count<class_CollisionObject2D_method_shape_owner_get_shape_count>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_index<class_CollisionObject2D_method_shape_owner_get_shape_index>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`shape_owner_get_transform<class_CollisionObject2D_method_shape_owner_get_transform>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_remove_shape<class_CollisionObject2D_method_shape_owner_remove_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_set_disabled<class_CollisionObject2D_method_shape_owner_set_disabled>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_set_one_way_collision<class_CollisionObject2D_method_shape_owner_set_one_way_collision>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` enable **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shape_owner_set_transform<class_CollisionObject2D_method_shape_owner_set_transform>` **(** :ref:`int<class_int>` owner_id, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
||||
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_CollisionObject2D_input_event:
|
||||
.. _class_CollisionObject2D_signal_input_event:
|
||||
|
||||
- **input_event** **(** :ref:`Node<class_Node>` viewport, :ref:`InputEvent<class_InputEvent>` event, :ref:`int<class_int>` shape_idx **)**
|
||||
|
||||
Emitted when an input event occurs and ``input_pickable`` is ``true``. See :ref:`_input_event<class_CollisionObject2D__input_event>` for details.
|
||||
Emitted when an input event occurs and ``input_pickable`` is ``true``. See :ref:`_input_event<class_CollisionObject2D_method__input_event>` for details.
|
||||
|
||||
.. _class_CollisionObject2D_mouse_entered:
|
||||
.. _class_CollisionObject2D_signal_mouse_entered:
|
||||
|
||||
- **mouse_entered** **(** **)**
|
||||
|
||||
Emitted when the mouse pointer enters any of this object's shapes.
|
||||
|
||||
.. _class_CollisionObject2D_mouse_exited:
|
||||
.. _class_CollisionObject2D_signal_mouse_exited:
|
||||
|
||||
- **mouse_exited** **(** **)**
|
||||
|
||||
@@ -97,7 +97,7 @@ CollisionObject2D is the base class for 2D physics objects. It can hold any numb
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CollisionObject2D_input_pickable:
|
||||
.. _class_CollisionObject2D_property_input_pickable:
|
||||
|
||||
- :ref:`bool<class_bool>` **input_pickable**
|
||||
|
||||
@@ -112,115 +112,115 @@ If ``true``, this object is pickable. A pickable object can detect the mouse poi
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_CollisionObject2D__input_event:
|
||||
.. _class_CollisionObject2D_method__input_event:
|
||||
|
||||
- void **_input_event** **(** :ref:`Object<class_Object>` viewport, :ref:`InputEvent<class_InputEvent>` event, :ref:`int<class_int>` shape_idx **)** virtual
|
||||
|
||||
Accepts unhandled :ref:`InputEvent<class_InputEvent>`\ s. ``shape_idx`` is the child index of the clicked :ref:`Shape2D<class_Shape2D>`. Connect to the ``input_event`` signal to easily pick up these events.
|
||||
|
||||
.. _class_CollisionObject2D_create_shape_owner:
|
||||
.. _class_CollisionObject2D_method_create_shape_owner:
|
||||
|
||||
- :ref:`int<class_int>` **create_shape_owner** **(** :ref:`Object<class_Object>` owner **)**
|
||||
|
||||
Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference.
|
||||
|
||||
.. _class_CollisionObject2D_get_rid:
|
||||
.. _class_CollisionObject2D_method_get_rid:
|
||||
|
||||
- :ref:`RID<class_RID>` **get_rid** **(** **)** const
|
||||
|
||||
Returns the object's :ref:`RID<class_RID>`.
|
||||
|
||||
.. _class_CollisionObject2D_get_shape_owners:
|
||||
.. _class_CollisionObject2D_method_get_shape_owners:
|
||||
|
||||
- :ref:`Array<class_Array>` **get_shape_owners** **(** **)**
|
||||
|
||||
Returns an :ref:`Array<class_Array>` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument.
|
||||
|
||||
.. _class_CollisionObject2D_is_shape_owner_disabled:
|
||||
.. _class_CollisionObject2D_method_is_shape_owner_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
If ``true``, the shape owner and its shapes are disabled.
|
||||
|
||||
.. _class_CollisionObject2D_is_shape_owner_one_way_collision_enabled:
|
||||
.. _class_CollisionObject2D_method_is_shape_owner_one_way_collision_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns ``true`` if collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s.
|
||||
|
||||
.. _class_CollisionObject2D_remove_shape_owner:
|
||||
.. _class_CollisionObject2D_method_remove_shape_owner:
|
||||
|
||||
- void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)**
|
||||
|
||||
Removes the given shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_find_owner:
|
||||
.. _class_CollisionObject2D_method_shape_find_owner:
|
||||
|
||||
- :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** const
|
||||
|
||||
Returns the ``owner_id`` of the given shape.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_add_shape:
|
||||
.. _class_CollisionObject2D_method_shape_owner_add_shape:
|
||||
|
||||
- void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape2D<class_Shape2D>` shape **)**
|
||||
|
||||
Adds a :ref:`Shape2D<class_Shape2D>` to the shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_clear_shapes:
|
||||
.. _class_CollisionObject2D_method_shape_owner_clear_shapes:
|
||||
|
||||
- void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)**
|
||||
|
||||
Removes all shapes from the shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_get_owner:
|
||||
.. _class_CollisionObject2D_method_shape_owner_get_owner:
|
||||
|
||||
- :ref:`Object<class_Object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the parent object of the given shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_get_shape:
|
||||
.. _class_CollisionObject2D_method_shape_owner_get_shape:
|
||||
|
||||
- :ref:`Shape2D<class_Shape2D>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
|
||||
|
||||
Returns the :ref:`Shape2D<class_Shape2D>` with the given id from the given shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_get_shape_count:
|
||||
.. _class_CollisionObject2D_method_shape_owner_get_shape_count:
|
||||
|
||||
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the number of shapes the given shape owner contains.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_get_shape_index:
|
||||
.. _class_CollisionObject2D_method_shape_owner_get_shape_index:
|
||||
|
||||
- :ref:`int<class_int>` **shape_owner_get_shape_index** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
|
||||
|
||||
Returns the child index of the :ref:`Shape2D<class_Shape2D>` with the given id from the given shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_get_transform:
|
||||
.. _class_CollisionObject2D_method_shape_owner_get_transform:
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the shape owner's :ref:`Transform2D<class_Transform2D>`.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_remove_shape:
|
||||
.. _class_CollisionObject2D_method_shape_owner_remove_shape:
|
||||
|
||||
- void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
|
||||
|
||||
Removes a shape from the given shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_set_disabled:
|
||||
.. _class_CollisionObject2D_method_shape_owner_set_disabled:
|
||||
|
||||
- void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
|
||||
|
||||
If ``true``, disables the given shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_set_one_way_collision:
|
||||
.. _class_CollisionObject2D_method_shape_owner_set_one_way_collision:
|
||||
|
||||
- void **shape_owner_set_one_way_collision** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``enable`` is ``true``, collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_set_transform:
|
||||
.. _class_CollisionObject2D_method_shape_owner_set_transform:
|
||||
|
||||
- void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform2D<class_Transform2D>` transform **)**
|
||||
|
||||
|
||||
@@ -19,13 +19,13 @@ Editor-only class for defining a collision polygon in 3D space.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_CollisionPolygon_depth>` |
|
||||
+-------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon_disabled>` |
|
||||
+-------------------------------------------------+--------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon_polygon>` |
|
||||
+-------------------------------------------------+--------------------------------------------------+
|
||||
+-------------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_CollisionPolygon_property_depth>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon_property_disabled>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon_property_polygon>` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -35,7 +35,7 @@ Allows editing a collision polygon's vertices on a selected plane. Can also set
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CollisionPolygon_depth:
|
||||
.. _class_CollisionPolygon_property_depth:
|
||||
|
||||
- :ref:`float<class_float>` **depth**
|
||||
|
||||
@@ -47,7 +47,7 @@ Property Descriptions
|
||||
|
||||
Length that the resulting collision extends in either direction perpendicular to its polygon.
|
||||
|
||||
.. _class_CollisionPolygon_disabled:
|
||||
.. _class_CollisionPolygon_property_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
@@ -59,7 +59,7 @@ Length that the resulting collision extends in either direction perpendicular to
|
||||
|
||||
If true, no collision will be produced.
|
||||
|
||||
.. _class_CollisionPolygon_polygon:
|
||||
.. _class_CollisionPolygon_property_polygon:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
|
||||
|
||||
|
||||
@@ -19,21 +19,25 @@ Defines a 2D collision polygon.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` | :ref:`build_mode<class_CollisionPolygon2D_build_mode>` |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon2D_disabled>` |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionPolygon2D_one_way_collision>` |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon2D_polygon>` |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------+
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
| :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` | :ref:`build_mode<class_CollisionPolygon2D_property_build_mode>` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon2D_property_disabled>` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionPolygon2D_property_one_way_collision>` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon2D_property_polygon>` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_CollisionPolygon2D_BuildMode:
|
||||
|
||||
.. _class_CollisionPolygon2D_constant_BUILD_SOLIDS:
|
||||
|
||||
.. _class_CollisionPolygon2D_constant_BUILD_SEGMENTS:
|
||||
|
||||
enum **BuildMode**:
|
||||
|
||||
- **BUILD_SOLIDS** = **0** --- Collisions will include the polygon and its contained area.
|
||||
@@ -48,7 +52,7 @@ Provides a 2D collision polygon to a :ref:`CollisionObject2D<class_CollisionObje
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CollisionPolygon2D_build_mode:
|
||||
.. _class_CollisionPolygon2D_property_build_mode:
|
||||
|
||||
- :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` **build_mode**
|
||||
|
||||
@@ -60,7 +64,7 @@ Property Descriptions
|
||||
|
||||
Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUILD_SOLIDS``.
|
||||
|
||||
.. _class_CollisionPolygon2D_disabled:
|
||||
.. _class_CollisionPolygon2D_property_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
@@ -72,7 +76,7 @@ Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUI
|
||||
|
||||
If ``true``, no collisions will be detected.
|
||||
|
||||
.. _class_CollisionPolygon2D_one_way_collision:
|
||||
.. _class_CollisionPolygon2D_property_one_way_collision:
|
||||
|
||||
- :ref:`bool<class_bool>` **one_way_collision**
|
||||
|
||||
@@ -84,7 +88,7 @@ If ``true``, no collisions will be detected.
|
||||
|
||||
If ``true``, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects.
|
||||
|
||||
.. _class_CollisionPolygon2D_polygon:
|
||||
.. _class_CollisionPolygon2D_property_polygon:
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
|
||||
|
||||
|
||||
@@ -19,25 +19,25 @@ Node that represents collision shape data in 3D space.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape_disabled>` |
|
||||
+---------------------------+------------------------------------------------+
|
||||
| :ref:`Shape<class_Shape>` | :ref:`shape<class_CollisionShape_shape>` |
|
||||
+---------------------------+------------------------------------------------+
|
||||
+---------------------------+---------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape_property_disabled>` |
|
||||
+---------------------------+---------------------------------------------------------+
|
||||
| :ref:`Shape<class_Shape>` | :ref:`shape<class_CollisionShape_property_shape>` |
|
||||
+---------------------------+---------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_convex_from_brothers<class_CollisionShape_make_convex_from_brothers>` **(** **)** |
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resource_changed<class_CollisionShape_resource_changed>` **(** :ref:`Resource<class_Resource>` resource **)** |
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------+
|
||||
+------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_convex_from_brothers<class_CollisionShape_method_make_convex_from_brothers>` **(** **)** |
|
||||
+------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resource_changed<class_CollisionShape_method_resource_changed>` **(** :ref:`Resource<class_Resource>` resource **)** |
|
||||
+------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area<class_Area>` to give it a detection shape, or add it to a :ref:`PhysicsBody<class_PhysicsBody>` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject.shape_owner_get_shape<class_CollisionObject_shape_owner_get_shape>` to get the actual shape.
|
||||
Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area<class_Area>` to give it a detection shape, or add it to a :ref:`PhysicsBody<class_PhysicsBody>` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject.shape_owner_get_shape<class_CollisionObject_method_shape_owner_get_shape>` to get the actual shape.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
@@ -47,7 +47,7 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CollisionShape_disabled:
|
||||
.. _class_CollisionShape_property_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
@@ -59,7 +59,7 @@ Property Descriptions
|
||||
|
||||
A disabled collision shape has no effect in the world.
|
||||
|
||||
.. _class_CollisionShape_shape:
|
||||
.. _class_CollisionShape_property_shape:
|
||||
|
||||
- :ref:`Shape<class_Shape>` **shape**
|
||||
|
||||
@@ -74,13 +74,13 @@ The actual shape owned by this collision shape.
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_CollisionShape_make_convex_from_brothers:
|
||||
.. _class_CollisionShape_method_make_convex_from_brothers:
|
||||
|
||||
- void **make_convex_from_brothers** **(** **)**
|
||||
|
||||
Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance<class_MeshInstance>` siblings geometry.
|
||||
|
||||
.. _class_CollisionShape_resource_changed:
|
||||
.. _class_CollisionShape_method_resource_changed:
|
||||
|
||||
- void **resource_changed** **(** :ref:`Resource<class_Resource>` resource **)**
|
||||
|
||||
|
||||
@@ -19,18 +19,18 @@ Node that represents collision shape data in 2D space.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape2D_disabled>` |
|
||||
+-------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionShape2D_one_way_collision>` |
|
||||
+-------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_CollisionShape2D_shape>` |
|
||||
+-------------------------------+--------------------------------------------------------------------+
|
||||
+-------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape2D_property_disabled>` |
|
||||
+-------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionShape2D_property_one_way_collision>` |
|
||||
+-------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_CollisionShape2D_property_shape>` |
|
||||
+-------------------------------+-----------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D<class_Area2D>` to give it a detection shape, or add it to a :ref:`PhysicsBody2D<class_PhysicsBody2D>` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject2D.shape_owner_get_shape<class_CollisionObject2D_shape_owner_get_shape>` to get the actual shape.
|
||||
Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D<class_Area2D>` to give it a detection shape, or add it to a :ref:`PhysicsBody2D<class_PhysicsBody2D>` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject2D.shape_owner_get_shape<class_CollisionObject2D_method_shape_owner_get_shape>` to get the actual shape.
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
@@ -40,7 +40,7 @@ Tutorials
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CollisionShape2D_disabled:
|
||||
.. _class_CollisionShape2D_property_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
@@ -52,7 +52,7 @@ Property Descriptions
|
||||
|
||||
A disabled collision shape has no effect in the world.
|
||||
|
||||
.. _class_CollisionShape2D_one_way_collision:
|
||||
.. _class_CollisionShape2D_property_one_way_collision:
|
||||
|
||||
- :ref:`bool<class_bool>` **one_way_collision**
|
||||
|
||||
@@ -64,7 +64,7 @@ A disabled collision shape has no effect in the world.
|
||||
|
||||
Sets whether this collision shape should only detect collision on one side (top or bottom).
|
||||
|
||||
.. _class_CollisionShape2D_shape:
|
||||
.. _class_CollisionShape2D_property_shape:
|
||||
|
||||
- :ref:`Shape2D<class_Shape2D>` **shape**
|
||||
|
||||
|
||||
@@ -17,76 +17,366 @@ Color in RGBA format with some support for ARGB format.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`a<class_Color_a>` |
|
||||
+---------------------------+---------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`a8<class_Color_a8>` |
|
||||
+---------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`b<class_Color_b>` |
|
||||
+---------------------------+---------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`b8<class_Color_b8>` |
|
||||
+---------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`g<class_Color_g>` |
|
||||
+---------------------------+---------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`g8<class_Color_g8>` |
|
||||
+---------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`h<class_Color_h>` |
|
||||
+---------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`r<class_Color_r>` |
|
||||
+---------------------------+---------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`r8<class_Color_r8>` |
|
||||
+---------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`s<class_Color_s>` |
|
||||
+---------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`v<class_Color_v>` |
|
||||
+---------------------------+---------------------------+
|
||||
+---------------------------+------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`a<class_Color_property_a>` |
|
||||
+---------------------------+------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`a8<class_Color_property_a8>` |
|
||||
+---------------------------+------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`b<class_Color_property_b>` |
|
||||
+---------------------------+------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`b8<class_Color_property_b8>` |
|
||||
+---------------------------+------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`g<class_Color_property_g>` |
|
||||
+---------------------------+------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`g8<class_Color_property_g8>` |
|
||||
+---------------------------+------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`h<class_Color_property_h>` |
|
||||
+---------------------------+------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`r<class_Color_property_r>` |
|
||||
+---------------------------+------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`r8<class_Color_property_r8>` |
|
||||
+---------------------------+------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`s<class_Color_property_s>` |
|
||||
+---------------------------+------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`v<class_Color_property_v>` |
|
||||
+---------------------------+------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_Color>` **(** :ref:`String<class_String>` from **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_Color>` **(** :ref:`int<class_int>` from **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`blend<class_Color_blend>` **(** :ref:`Color<class_Color>` over **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`contrasted<class_Color_contrasted>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`darkened<class_Color_darkened>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`from_hsv<class_Color_from_hsv>` **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` a=1 **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gray<class_Color_gray>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`inverted<class_Color_inverted>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`lightened<class_Color_lightened>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`linear_interpolate<class_Color_linear_interpolate>` **(** :ref:`Color<class_Color>` b, :ref:`float<class_float>` t **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_abgr32<class_Color_to_abgr32>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_abgr64<class_Color_to_abgr64>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_argb32<class_Color_to_argb32>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_argb64<class_Color_to_argb64>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`to_html<class_Color_to_html>` **(** :ref:`bool<class_bool>` with_alpha=True **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_to_rgba32>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_rgba64<class_Color_to_rgba64>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`String<class_String>` from **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`int<class_int>` from **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`blend<class_Color_method_blend>` **(** :ref:`Color<class_Color>` over **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`contrasted<class_Color_method_contrasted>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`darkened<class_Color_method_darkened>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`from_hsv<class_Color_method_from_hsv>` **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` a=1 **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gray<class_Color_method_gray>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`inverted<class_Color_method_inverted>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`lightened<class_Color_method_lightened>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`linear_interpolate<class_Color_method_linear_interpolate>` **(** :ref:`Color<class_Color>` b, :ref:`float<class_float>` t **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_abgr32<class_Color_method_to_abgr32>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_abgr64<class_Color_method_to_abgr64>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_argb32<class_Color_method_to_argb32>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_argb64<class_Color_method_to_argb64>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`to_html<class_Color_method_to_html>` **(** :ref:`bool<class_bool>` with_alpha=True **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_method_to_rgba32>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_rgba64<class_Color_method_to_rgba64>` **(** **)** |
|
||||
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Constants
|
||||
---------
|
||||
|
||||
.. _class_Color_constant_gray:
|
||||
|
||||
.. _class_Color_constant_aliceblue:
|
||||
|
||||
.. _class_Color_constant_antiquewhite:
|
||||
|
||||
.. _class_Color_constant_aqua:
|
||||
|
||||
.. _class_Color_constant_aquamarine:
|
||||
|
||||
.. _class_Color_constant_azure:
|
||||
|
||||
.. _class_Color_constant_beige:
|
||||
|
||||
.. _class_Color_constant_bisque:
|
||||
|
||||
.. _class_Color_constant_black:
|
||||
|
||||
.. _class_Color_constant_blanchedalmond:
|
||||
|
||||
.. _class_Color_constant_blue:
|
||||
|
||||
.. _class_Color_constant_blueviolet:
|
||||
|
||||
.. _class_Color_constant_brown:
|
||||
|
||||
.. _class_Color_constant_burlywood:
|
||||
|
||||
.. _class_Color_constant_cadetblue:
|
||||
|
||||
.. _class_Color_constant_chartreuse:
|
||||
|
||||
.. _class_Color_constant_chocolate:
|
||||
|
||||
.. _class_Color_constant_coral:
|
||||
|
||||
.. _class_Color_constant_cornflower:
|
||||
|
||||
.. _class_Color_constant_cornsilk:
|
||||
|
||||
.. _class_Color_constant_crimson:
|
||||
|
||||
.. _class_Color_constant_cyan:
|
||||
|
||||
.. _class_Color_constant_darkblue:
|
||||
|
||||
.. _class_Color_constant_darkcyan:
|
||||
|
||||
.. _class_Color_constant_darkgoldenrod:
|
||||
|
||||
.. _class_Color_constant_darkgray:
|
||||
|
||||
.. _class_Color_constant_darkgreen:
|
||||
|
||||
.. _class_Color_constant_darkkhaki:
|
||||
|
||||
.. _class_Color_constant_darkmagenta:
|
||||
|
||||
.. _class_Color_constant_darkolivegreen:
|
||||
|
||||
.. _class_Color_constant_darkorange:
|
||||
|
||||
.. _class_Color_constant_darkorchid:
|
||||
|
||||
.. _class_Color_constant_darkred:
|
||||
|
||||
.. _class_Color_constant_darksalmon:
|
||||
|
||||
.. _class_Color_constant_darkseagreen:
|
||||
|
||||
.. _class_Color_constant_darkslateblue:
|
||||
|
||||
.. _class_Color_constant_darkslategray:
|
||||
|
||||
.. _class_Color_constant_darkturquoise:
|
||||
|
||||
.. _class_Color_constant_darkviolet:
|
||||
|
||||
.. _class_Color_constant_deeppink:
|
||||
|
||||
.. _class_Color_constant_deepskyblue:
|
||||
|
||||
.. _class_Color_constant_dimgray:
|
||||
|
||||
.. _class_Color_constant_dodgerblue:
|
||||
|
||||
.. _class_Color_constant_firebrick:
|
||||
|
||||
.. _class_Color_constant_floralwhite:
|
||||
|
||||
.. _class_Color_constant_forestgreen:
|
||||
|
||||
.. _class_Color_constant_fuchsia:
|
||||
|
||||
.. _class_Color_constant_gainsboro:
|
||||
|
||||
.. _class_Color_constant_ghostwhite:
|
||||
|
||||
.. _class_Color_constant_gold:
|
||||
|
||||
.. _class_Color_constant_goldenrod:
|
||||
|
||||
.. _class_Color_constant_green:
|
||||
|
||||
.. _class_Color_constant_greenyellow:
|
||||
|
||||
.. _class_Color_constant_honeydew:
|
||||
|
||||
.. _class_Color_constant_hotpink:
|
||||
|
||||
.. _class_Color_constant_indianred:
|
||||
|
||||
.. _class_Color_constant_indigo:
|
||||
|
||||
.. _class_Color_constant_ivory:
|
||||
|
||||
.. _class_Color_constant_khaki:
|
||||
|
||||
.. _class_Color_constant_lavender:
|
||||
|
||||
.. _class_Color_constant_lavenderblush:
|
||||
|
||||
.. _class_Color_constant_lawngreen:
|
||||
|
||||
.. _class_Color_constant_lemonchiffon:
|
||||
|
||||
.. _class_Color_constant_lightblue:
|
||||
|
||||
.. _class_Color_constant_lightcoral:
|
||||
|
||||
.. _class_Color_constant_lightcyan:
|
||||
|
||||
.. _class_Color_constant_lightgoldenrod:
|
||||
|
||||
.. _class_Color_constant_lightgray:
|
||||
|
||||
.. _class_Color_constant_lightgreen:
|
||||
|
||||
.. _class_Color_constant_lightpink:
|
||||
|
||||
.. _class_Color_constant_lightsalmon:
|
||||
|
||||
.. _class_Color_constant_lightseagreen:
|
||||
|
||||
.. _class_Color_constant_lightskyblue:
|
||||
|
||||
.. _class_Color_constant_lightslategray:
|
||||
|
||||
.. _class_Color_constant_lightsteelblue:
|
||||
|
||||
.. _class_Color_constant_lightyellow:
|
||||
|
||||
.. _class_Color_constant_lime:
|
||||
|
||||
.. _class_Color_constant_limegreen:
|
||||
|
||||
.. _class_Color_constant_linen:
|
||||
|
||||
.. _class_Color_constant_magenta:
|
||||
|
||||
.. _class_Color_constant_maroon:
|
||||
|
||||
.. _class_Color_constant_mediumaquamarine:
|
||||
|
||||
.. _class_Color_constant_mediumblue:
|
||||
|
||||
.. _class_Color_constant_mediumorchid:
|
||||
|
||||
.. _class_Color_constant_mediumpurple:
|
||||
|
||||
.. _class_Color_constant_mediumseagreen:
|
||||
|
||||
.. _class_Color_constant_mediumslateblue:
|
||||
|
||||
.. _class_Color_constant_mediumspringgreen:
|
||||
|
||||
.. _class_Color_constant_mediumturquoise:
|
||||
|
||||
.. _class_Color_constant_mediumvioletred:
|
||||
|
||||
.. _class_Color_constant_midnightblue:
|
||||
|
||||
.. _class_Color_constant_mintcream:
|
||||
|
||||
.. _class_Color_constant_mistyrose:
|
||||
|
||||
.. _class_Color_constant_moccasin:
|
||||
|
||||
.. _class_Color_constant_navajowhite:
|
||||
|
||||
.. _class_Color_constant_navyblue:
|
||||
|
||||
.. _class_Color_constant_oldlace:
|
||||
|
||||
.. _class_Color_constant_olive:
|
||||
|
||||
.. _class_Color_constant_olivedrab:
|
||||
|
||||
.. _class_Color_constant_orange:
|
||||
|
||||
.. _class_Color_constant_orangered:
|
||||
|
||||
.. _class_Color_constant_orchid:
|
||||
|
||||
.. _class_Color_constant_palegoldenrod:
|
||||
|
||||
.. _class_Color_constant_palegreen:
|
||||
|
||||
.. _class_Color_constant_paleturquoise:
|
||||
|
||||
.. _class_Color_constant_palevioletred:
|
||||
|
||||
.. _class_Color_constant_papayawhip:
|
||||
|
||||
.. _class_Color_constant_peachpuff:
|
||||
|
||||
.. _class_Color_constant_peru:
|
||||
|
||||
.. _class_Color_constant_pink:
|
||||
|
||||
.. _class_Color_constant_plum:
|
||||
|
||||
.. _class_Color_constant_powderblue:
|
||||
|
||||
.. _class_Color_constant_purple:
|
||||
|
||||
.. _class_Color_constant_rebeccapurple:
|
||||
|
||||
.. _class_Color_constant_red:
|
||||
|
||||
.. _class_Color_constant_rosybrown:
|
||||
|
||||
.. _class_Color_constant_royalblue:
|
||||
|
||||
.. _class_Color_constant_saddlebrown:
|
||||
|
||||
.. _class_Color_constant_salmon:
|
||||
|
||||
.. _class_Color_constant_sandybrown:
|
||||
|
||||
.. _class_Color_constant_seagreen:
|
||||
|
||||
.. _class_Color_constant_seashell:
|
||||
|
||||
.. _class_Color_constant_sienna:
|
||||
|
||||
.. _class_Color_constant_silver:
|
||||
|
||||
.. _class_Color_constant_skyblue:
|
||||
|
||||
.. _class_Color_constant_slateblue:
|
||||
|
||||
.. _class_Color_constant_slategray:
|
||||
|
||||
.. _class_Color_constant_snow:
|
||||
|
||||
.. _class_Color_constant_springgreen:
|
||||
|
||||
.. _class_Color_constant_steelblue:
|
||||
|
||||
.. _class_Color_constant_tan:
|
||||
|
||||
.. _class_Color_constant_teal:
|
||||
|
||||
.. _class_Color_constant_thistle:
|
||||
|
||||
.. _class_Color_constant_tomato:
|
||||
|
||||
.. _class_Color_constant_turquoise:
|
||||
|
||||
.. _class_Color_constant_violet:
|
||||
|
||||
.. _class_Color_constant_webgray:
|
||||
|
||||
.. _class_Color_constant_webgreen:
|
||||
|
||||
.. _class_Color_constant_webmaroon:
|
||||
|
||||
.. _class_Color_constant_webpurple:
|
||||
|
||||
.. _class_Color_constant_wheat:
|
||||
|
||||
.. _class_Color_constant_white:
|
||||
|
||||
.. _class_Color_constant_whitesmoke:
|
||||
|
||||
.. _class_Color_constant_yellow:
|
||||
|
||||
.. _class_Color_constant_yellowgreen:
|
||||
|
||||
- **gray** = **Color( 0.75, 0.75, 0.75, 1 )**
|
||||
|
||||
- **aliceblue** = **Color( 0.94, 0.97, 1, 1 )**
|
||||
@@ -380,74 +670,74 @@ Constants
|
||||
Description
|
||||
-----------
|
||||
|
||||
A color is represented by red, green, and blue ``(r, g, b)`` components. Additionally, ``a`` represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some properties (such as :ref:`CanvasItem.modulate<class_CanvasItem_modulate>`) may accept values > 1.
|
||||
A color is represented by red, green, and blue ``(r, g, b)`` components. Additionally, ``a`` represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some properties (such as :ref:`CanvasItem.modulate<class_CanvasItem_property_modulate>`) may accept values > 1.
|
||||
|
||||
You can also create a color from standardized color names by using :ref:`@GDScript.ColorN<class_@GDScript_ColorN>`.
|
||||
You can also create a color from standardized color names by using :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>`.
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Color_a:
|
||||
.. _class_Color_property_a:
|
||||
|
||||
- :ref:`float<class_float>` **a**
|
||||
|
||||
Alpha value (range 0 to 1).
|
||||
|
||||
.. _class_Color_a8:
|
||||
.. _class_Color_property_a8:
|
||||
|
||||
- :ref:`int<class_int>` **a8**
|
||||
|
||||
Alpha value (range 0 to 255).
|
||||
|
||||
.. _class_Color_b:
|
||||
.. _class_Color_property_b:
|
||||
|
||||
- :ref:`float<class_float>` **b**
|
||||
|
||||
Blue value (range 0 to 1).
|
||||
|
||||
.. _class_Color_b8:
|
||||
.. _class_Color_property_b8:
|
||||
|
||||
- :ref:`int<class_int>` **b8**
|
||||
|
||||
Blue value (range 0 to 255).
|
||||
|
||||
.. _class_Color_g:
|
||||
.. _class_Color_property_g:
|
||||
|
||||
- :ref:`float<class_float>` **g**
|
||||
|
||||
Green value (range 0 to 1).
|
||||
|
||||
.. _class_Color_g8:
|
||||
.. _class_Color_property_g8:
|
||||
|
||||
- :ref:`int<class_int>` **g8**
|
||||
|
||||
Green value (range 0 to 255).
|
||||
|
||||
.. _class_Color_h:
|
||||
.. _class_Color_property_h:
|
||||
|
||||
- :ref:`float<class_float>` **h**
|
||||
|
||||
HSV hue value (range 0 to 1).
|
||||
|
||||
.. _class_Color_r:
|
||||
.. _class_Color_property_r:
|
||||
|
||||
- :ref:`float<class_float>` **r**
|
||||
|
||||
Red value (range 0 to 1).
|
||||
|
||||
.. _class_Color_r8:
|
||||
.. _class_Color_property_r8:
|
||||
|
||||
- :ref:`int<class_int>` **r8**
|
||||
|
||||
Red value (range 0 to 255).
|
||||
|
||||
.. _class_Color_s:
|
||||
.. _class_Color_property_s:
|
||||
|
||||
- :ref:`float<class_float>` **s**
|
||||
|
||||
HSV saturation value (range 0 to 1).
|
||||
|
||||
.. _class_Color_v:
|
||||
.. _class_Color_property_v:
|
||||
|
||||
- :ref:`float<class_float>` **v**
|
||||
|
||||
@@ -456,11 +746,11 @@ HSV value (range 0 to 1).
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Color_Color:
|
||||
.. _class_Color_method_Color:
|
||||
|
||||
- :ref:`Color<class_Color>` **Color** **(** :ref:`String<class_String>` from **)**
|
||||
|
||||
Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also :ref:`@GDScript.ColorN<class_@GDScript_ColorN>`.
|
||||
Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>`.
|
||||
|
||||
::
|
||||
|
||||
@@ -470,8 +760,6 @@ Constructs a color from an HTML hexadecimal color string in ARGB or RGB format.
|
||||
var c3 = Color("#b2d90a") # RGB format with '#'
|
||||
var c4 = Color("b2d90a") # RGB format
|
||||
|
||||
.. _class_Color_Color:
|
||||
|
||||
- :ref:`Color<class_Color>` **Color** **(** :ref:`int<class_int>` from **)**
|
||||
|
||||
Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile).
|
||||
@@ -480,8 +768,6 @@ Constructs a color from a 32-bit integer (each byte represents a component of th
|
||||
|
||||
var c = Color(274) # Equivalent to RGBA(0, 0, 1, 18)
|
||||
|
||||
.. _class_Color_Color:
|
||||
|
||||
- :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**
|
||||
|
||||
Constructs a color from an RGB profile using values between 0 and 1. Alpha will always be 1.
|
||||
@@ -490,8 +776,6 @@ Constructs a color from an RGB profile using values between 0 and 1. Alpha will
|
||||
|
||||
var c = Color(0.2, 1.0, 0.7) # Equivalent to RGBA(51, 255, 178, 255)
|
||||
|
||||
.. _class_Color_Color:
|
||||
|
||||
- :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)**
|
||||
|
||||
Constructs a color from an RGBA profile using values between 0 and 1.
|
||||
@@ -500,7 +784,7 @@ Constructs a color from an RGBA profile using values between 0 and 1.
|
||||
|
||||
var c = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204)
|
||||
|
||||
.. _class_Color_blend:
|
||||
.. _class_Color_method_blend:
|
||||
|
||||
- :ref:`Color<class_Color>` **blend** **(** :ref:`Color<class_Color>` over **)**
|
||||
|
||||
@@ -512,7 +796,7 @@ Returns a new color resulting from blending this color over another. If the colo
|
||||
var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50%
|
||||
var blended_color = bg.blend(fg) # Brown with alpha of 75%
|
||||
|
||||
.. _class_Color_contrasted:
|
||||
.. _class_Color_method_contrasted:
|
||||
|
||||
- :ref:`Color<class_Color>` **contrasted** **(** **)**
|
||||
|
||||
@@ -523,7 +807,7 @@ Returns the most contrasting color.
|
||||
var c = Color(0.3, 0.4, 0.9)
|
||||
var contrasted_color = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255)
|
||||
|
||||
.. _class_Color_darkened:
|
||||
.. _class_Color_method_darkened:
|
||||
|
||||
- :ref:`Color<class_Color>` **darkened** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
@@ -534,7 +818,7 @@ Returns a new color resulting from making this color darker by the specified per
|
||||
var green = Color(0.0, 1.0, 0.0)
|
||||
var darkgreen = green.darkened(0.2) # 20% darker than regular green
|
||||
|
||||
.. _class_Color_from_hsv:
|
||||
.. _class_Color_method_from_hsv:
|
||||
|
||||
- :ref:`Color<class_Color>` **from_hsv** **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` a=1 **)**
|
||||
|
||||
@@ -544,7 +828,7 @@ Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values betwe
|
||||
|
||||
var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # Equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8)
|
||||
|
||||
.. _class_Color_gray:
|
||||
.. _class_Color_method_gray:
|
||||
|
||||
- :ref:`float<class_float>` **gray** **(** **)**
|
||||
|
||||
@@ -557,7 +841,7 @@ The gray value is calculated as ``(r + g + b) / 3``.
|
||||
var c = Color(0.2, 0.45, 0.82)
|
||||
var gray = c.gray() # a value of 0.466667
|
||||
|
||||
.. _class_Color_inverted:
|
||||
.. _class_Color_method_inverted:
|
||||
|
||||
- :ref:`Color<class_Color>` **inverted** **(** **)**
|
||||
|
||||
@@ -568,7 +852,7 @@ Returns the inverted color ``(1 - r, 1 - g, 1 - b, 1 - a)``.
|
||||
var c = Color(0.3, 0.4, 0.9)
|
||||
var inverted_color = c.inverted() # a color of an RGBA(178, 153, 26, 255)
|
||||
|
||||
.. _class_Color_lightened:
|
||||
.. _class_Color_method_lightened:
|
||||
|
||||
- :ref:`Color<class_Color>` **lightened** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
@@ -579,7 +863,7 @@ Returns a new color resulting from making this color lighter by the specified pe
|
||||
var green = Color(0.0, 1.0, 0.0)
|
||||
var lightgreen = green.lightened(0.2) # 20% lighter than regular green
|
||||
|
||||
.. _class_Color_linear_interpolate:
|
||||
.. _class_Color_method_linear_interpolate:
|
||||
|
||||
- :ref:`Color<class_Color>` **linear_interpolate** **(** :ref:`Color<class_Color>` b, :ref:`float<class_float>` t **)**
|
||||
|
||||
@@ -591,7 +875,7 @@ Returns the linear interpolation with another color. The interpolation factor ``
|
||||
var c2 = Color(0.0, 1.0, 0.0)
|
||||
var li_c = c1.linear_interpolate(c2, 0.5) # a color of an RGBA(128, 128, 0, 255)
|
||||
|
||||
.. _class_Color_to_abgr32:
|
||||
.. _class_Color_method_to_abgr32:
|
||||
|
||||
- :ref:`int<class_int>` **to_abgr32** **(** **)**
|
||||
|
||||
@@ -602,7 +886,7 @@ Returns the color's 32-bit integer in ABGR format (each byte represents a compon
|
||||
var c = Color(1, 0.5, 0.2)
|
||||
print(c.to_abgr32()) # Prints 4281565439
|
||||
|
||||
.. _class_Color_to_abgr64:
|
||||
.. _class_Color_method_to_abgr64:
|
||||
|
||||
- :ref:`int<class_int>` **to_abgr64** **(** **)**
|
||||
|
||||
@@ -613,7 +897,7 @@ Returns the color's 64-bit integer in ABGR format (each word represents a compon
|
||||
var c = Color(1, 0.5, 0.2)
|
||||
print(c.to_abgr64()) # Prints -225178692812801
|
||||
|
||||
.. _class_Color_to_argb32:
|
||||
.. _class_Color_method_to_argb32:
|
||||
|
||||
- :ref:`int<class_int>` **to_argb32** **(** **)**
|
||||
|
||||
@@ -624,7 +908,7 @@ Returns the color's 32-bit integer in ARGB format (each byte represents a compon
|
||||
var c = Color(1, 0.5, 0.2)
|
||||
print(c.to_argb32()) # Prints 4294934323
|
||||
|
||||
.. _class_Color_to_argb64:
|
||||
.. _class_Color_method_to_argb64:
|
||||
|
||||
- :ref:`int<class_int>` **to_argb64** **(** **)**
|
||||
|
||||
@@ -635,7 +919,7 @@ Returns the color's 64-bit integer in ARGB format (each word represents a compon
|
||||
var c = Color(1, 0.5, 0.2)
|
||||
print(c.to_argb64()) # Prints -2147470541
|
||||
|
||||
.. _class_Color_to_html:
|
||||
.. _class_Color_method_to_html:
|
||||
|
||||
- :ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=True **)**
|
||||
|
||||
@@ -649,7 +933,7 @@ Setting ``with_alpha`` to ``false`` excludes alpha from the hexadecimal string.
|
||||
var s1 = c.to_html() # Results "7fffffff"
|
||||
var s2 = c.to_html(false) # Results 'ffffff'
|
||||
|
||||
.. _class_Color_to_rgba32:
|
||||
.. _class_Color_method_to_rgba32:
|
||||
|
||||
- :ref:`int<class_int>` **to_rgba32** **(** **)**
|
||||
|
||||
@@ -660,7 +944,7 @@ Returns the color's 32-bit integer in RGBA format (each byte represents a compon
|
||||
var c = Color(1, 0.5, 0.2)
|
||||
print(c.to_rgba32()) # Prints 4286526463
|
||||
|
||||
.. _class_Color_to_rgba64:
|
||||
.. _class_Color_method_to_rgba64:
|
||||
|
||||
- :ref:`int<class_int>` **to_rgba64** **(** **)**
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user