mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
classref: Use code markup for default values/overrides
Sync with godotengine/godot#35357. Fixes #3071.
This commit is contained in:
Rémi Verschelde
@@ -24,13 +24,13 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+-----------------------------------------------+--------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`end<class_AABB_property_end>` | Vector3( 0, 0, 0 ) |
|
||||
+-------------------------------+-----------------------------------------------+--------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`position<class_AABB_property_position>` | Vector3( 0, 0, 0 ) |
|
||||
+-------------------------------+-----------------------------------------------+--------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`size<class_AABB_property_size>` | Vector3( 0, 0, 0 ) |
|
||||
+-------------------------------+-----------------------------------------------+--------------------+
|
||||
+-------------------------------+-----------------------------------------------+------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`end<class_AABB_property_end>` | ``Vector3( 0, 0, 0 )`` |
|
||||
+-------------------------------+-----------------------------------------------+------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`position<class_AABB_property_position>` | ``Vector3( 0, 0, 0 )`` |
|
||||
+-------------------------------+-----------------------------------------------+------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`size<class_AABB_property_size>` | ``Vector3( 0, 0, 0 )`` |
|
||||
+-------------------------------+-----------------------------------------------+------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -88,9 +88,9 @@ Property Descriptions
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **end**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | Vector3( 0, 0, 0 ) |
|
||||
+-----------+--------------------+
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``Vector3( 0, 0, 0 )`` |
|
||||
+-----------+------------------------+
|
||||
|
||||
Ending corner. This is calculated as ``position + size``. Changing this property changes :ref:`size<class_AABB_property_size>` accordingly.
|
||||
|
||||
@@ -100,9 +100,9 @@ Ending corner. This is calculated as ``position + size``. Changing this property
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **position**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | Vector3( 0, 0, 0 ) |
|
||||
+-----------+--------------------+
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``Vector3( 0, 0, 0 )`` |
|
||||
+-----------+------------------------+
|
||||
|
||||
Beginning corner.
|
||||
|
||||
@@ -112,9 +112,9 @@ Beginning corner.
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **size**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | Vector3( 0, 0, 0 ) |
|
||||
+-----------+--------------------+
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``Vector3( 0, 0, 0 )`` |
|
||||
+-----------+------------------------+
|
||||
|
||||
Size from position to end.
|
||||
|
||||
|
||||
@@ -23,15 +23,15 @@ This dialog is useful for small notifications to the user about an event. It can
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+-------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dialog_autowrap<class_AcceptDialog_property_dialog_autowrap>` | false |
|
||||
+-----------------------------+-------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dialog_hide_on_ok<class_AcceptDialog_property_dialog_hide_on_ok>` | true |
|
||||
+-----------------------------+-------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`String<class_String>` | :ref:`dialog_text<class_AcceptDialog_property_dialog_text>` | "" |
|
||||
+-----------------------------+-------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`String<class_String>` | window_title | **O:** "Alert!" |
|
||||
+-----------------------------+-------------------------------------------------------------------------+-----------------+
|
||||
+-----------------------------+-------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dialog_autowrap<class_AcceptDialog_property_dialog_autowrap>` | ``false`` |
|
||||
+-----------------------------+-------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`dialog_hide_on_ok<class_AcceptDialog_property_dialog_hide_on_ok>` | ``true`` |
|
||||
+-----------------------------+-------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`String<class_String>` | :ref:`dialog_text<class_AcceptDialog_property_dialog_text>` | ``""`` |
|
||||
+-----------------------------+-------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`String<class_String>` | window_title | **O:** ``"Alert!"`` |
|
||||
+-----------------------------+-------------------------------------------------------------------------+---------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -73,7 +73,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **dialog_autowrap**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_autowrap(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -89,7 +89,7 @@ Sets autowrapping for the text in the dialog.
|
||||
- :ref:`bool<class_bool>` **dialog_hide_on_ok**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_hide_on_ok(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -107,7 +107,7 @@ If ``true``, the dialog is hidden when the OK button is pressed. You can set it
|
||||
- :ref:`String<class_String>` **dialog_text**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | "" |
|
||||
| *Default* | ``""`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_text(value) |
|
||||
+-----------+-----------------+
|
||||
|
||||
@@ -21,25 +21,25 @@ Animations are created using a :ref:`SpriteFrames<class_SpriteFrames>` resource,
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------+---------------------------------------------------------------+-----------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite_property_animation>` | "default" |
|
||||
+-----------------------------------------+---------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`centered<class_AnimatedSprite_property_centered>` | true |
|
||||
+-----------------------------------------+---------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_h<class_AnimatedSprite_property_flip_h>` | false |
|
||||
+-----------------------------------------+---------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_v<class_AnimatedSprite_property_flip_v>` | false |
|
||||
+-----------------------------------------+---------------------------------------------------------------+-----------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite_property_frame>` | 0 |
|
||||
+-----------------------------------------+---------------------------------------------------------------+-----------------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite_property_frames>` | |
|
||||
+-----------------------------------------+---------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_AnimatedSprite_property_offset>` | Vector2( 0, 0 ) |
|
||||
+-----------------------------------------+---------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite_property_playing>` | false |
|
||||
+-----------------------------------------+---------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimatedSprite_property_speed_scale>` | 1.0 |
|
||||
+-----------------------------------------+---------------------------------------------------------------+-----------------+
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite_property_animation>` | ``"default"`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`centered<class_AnimatedSprite_property_centered>` | ``true`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_h<class_AnimatedSprite_property_flip_h>` | ``false`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flip_v<class_AnimatedSprite_property_flip_v>` | ``false`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite_property_frame>` | ``0`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite_property_frames>` | |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_AnimatedSprite_property_offset>` | ``Vector2( 0, 0 )`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite_property_playing>` | ``false`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimatedSprite_property_speed_scale>` | ``1.0`` |
|
||||
+-----------------------------------------+---------------------------------------------------------------+---------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -77,7 +77,7 @@ Property Descriptions
|
||||
- :ref:`String<class_String>` **animation**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | "default" |
|
||||
| *Default* | ``"default"`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_animation(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -93,7 +93,7 @@ The current animation from the ``frames`` resource. If this value changes, the `
|
||||
- :ref:`bool<class_bool>` **centered**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_centered(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -109,7 +109,7 @@ If ``true``, texture will be centered.
|
||||
- :ref:`bool<class_bool>` **flip_h**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_flip_h(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -125,7 +125,7 @@ If ``true``, texture is flipped horizontally.
|
||||
- :ref:`bool<class_bool>` **flip_v**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_flip_v(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -141,7 +141,7 @@ If ``true``, texture is flipped vertically.
|
||||
- :ref:`int<class_int>` **frame**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_frame(value) |
|
||||
+-----------+------------------+
|
||||
@@ -170,13 +170,13 @@ The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s)
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **offset**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | Vector2( 0, 0 ) |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_offset(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_offset() |
|
||||
+-----------+-------------------+
|
||||
+-----------+---------------------+
|
||||
| *Default* | ``Vector2( 0, 0 )`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_offset(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_offset() |
|
||||
+-----------+---------------------+
|
||||
|
||||
The texture's drawing offset.
|
||||
|
||||
@@ -186,9 +186,9 @@ The texture's drawing offset.
|
||||
|
||||
- :ref:`bool<class_bool>` **playing**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | false |
|
||||
+-----------+-------+
|
||||
+-----------+-----------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------+
|
||||
|
||||
If ``true``, the :ref:`animation<class_AnimatedSprite_property_animation>` is currently playing.
|
||||
|
||||
@@ -199,7 +199,7 @@ If ``true``, the :ref:`animation<class_AnimatedSprite_property_animation>` is cu
|
||||
- :ref:`float<class_float>` **speed_scale**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_speed_scale(value) |
|
||||
+-----------+------------------------+
|
||||
|
||||
@@ -21,15 +21,15 @@ Animations are created using a :ref:`SpriteFrames<class_SpriteFrames>` resource,
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------+-------------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite3D_property_animation>` | "default" |
|
||||
+-----------------------------------------+-------------------------------------------------------------+-----------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite3D_property_frame>` | 0 |
|
||||
+-----------------------------------------+-------------------------------------------------------------+-----------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite3D_property_frames>` | |
|
||||
+-----------------------------------------+-------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite3D_property_playing>` | false |
|
||||
+-----------------------------------------+-------------------------------------------------------------+-----------+
|
||||
+-----------------------------------------+-------------------------------------------------------------+---------------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite3D_property_animation>` | ``"default"`` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+---------------+
|
||||
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite3D_property_frame>` | ``0`` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+---------------+
|
||||
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite3D_property_frames>` | |
|
||||
+-----------------------------------------+-------------------------------------------------------------+---------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite3D_property_playing>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------------+---------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -59,7 +59,7 @@ Property Descriptions
|
||||
- :ref:`String<class_String>` **animation**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | "default" |
|
||||
| *Default* | ``"default"`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_animation(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -75,7 +75,7 @@ The current animation from the ``frames`` resource. If this value changes, the `
|
||||
- :ref:`int<class_int>` **frame**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_frame(value) |
|
||||
+-----------+------------------+
|
||||
@@ -104,9 +104,9 @@ The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s)
|
||||
|
||||
- :ref:`bool<class_bool>` **playing**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | false |
|
||||
+-----------+-------+
|
||||
+-----------+-----------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------+
|
||||
|
||||
If ``true``, the :ref:`animation<class_AnimatedSprite3D_property_animation>` is currently playing.
|
||||
|
||||
|
||||
@@ -25,13 +25,13 @@ The playback of the animation is controlled by the :ref:`fps<class_AnimatedTextu
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------------------+----------+
|
||||
| :ref:`int<class_int>` | flags | **O:** 0 |
|
||||
+---------------------------+------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`fps<class_AnimatedTexture_property_fps>` | 4.0 |
|
||||
+---------------------------+------------------------------------------------------+----------+
|
||||
| :ref:`int<class_int>` | :ref:`frames<class_AnimatedTexture_property_frames>` | 1 |
|
||||
+---------------------------+------------------------------------------------------+----------+
|
||||
+---------------------------+------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | flags | **O:** ``0`` |
|
||||
+---------------------------+------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`fps<class_AnimatedTexture_property_fps>` | ``4.0`` |
|
||||
+---------------------------+------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | :ref:`frames<class_AnimatedTexture_property_frames>` | ``1`` |
|
||||
+---------------------------+------------------------------------------------------+--------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -61,7 +61,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **fps**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | 4.0 |
|
||||
| *Default* | ``4.0`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_fps(value) |
|
||||
+-----------+----------------+
|
||||
@@ -79,7 +79,7 @@ For example, an animation with 8 frames, no frame delay and a ``fps`` value of 2
|
||||
- :ref:`int<class_int>` **frames**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_frames(value) |
|
||||
+-----------+-------------------+
|
||||
|
||||
@@ -38,13 +38,13 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`length<class_Animation_property_length>` | 1.0 |
|
||||
+---------------------------+------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`loop<class_Animation_property_loop>` | false |
|
||||
+---------------------------+------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`step<class_Animation_property_step>` | 0.1 |
|
||||
+---------------------------+------------------------------------------------+-------+
|
||||
+---------------------------+------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`length<class_Animation_property_length>` | ``1.0`` |
|
||||
+---------------------------+------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`loop<class_Animation_property_loop>` | ``false`` |
|
||||
+---------------------------+------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`step<class_Animation_property_step>` | ``0.1`` |
|
||||
+---------------------------+------------------------------------------------+-----------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -253,7 +253,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **length**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_length(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -271,7 +271,7 @@ The total length of the animation (in seconds).
|
||||
- :ref:`bool<class_bool>` **loop**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_loop(value) |
|
||||
+-----------+-----------------+
|
||||
@@ -287,7 +287,7 @@ A flag indicating that the animation must loop. This is uses for correct interpo
|
||||
- :ref:`float<class_float>` **step**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | 0.1 |
|
||||
| *Default* | ``0.1`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_step(value) |
|
||||
+-----------+-----------------+
|
||||
|
||||
@@ -21,9 +21,9 @@ A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTre
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+----------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd2_property_sync>` | false |
|
||||
+-------------------------+----------------------------------------------------+-------+
|
||||
+-------------------------+----------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd2_property_sync>` | ``false`` |
|
||||
+-------------------------+----------------------------------------------------+-----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -33,7 +33,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **sync**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_use_sync(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -29,9 +29,9 @@ This node has three inputs:
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+----------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd3_property_sync>` | false |
|
||||
+-------------------------+----------------------------------------------------+-------+
|
||||
+-------------------------+----------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd3_property_sync>` | ``false`` |
|
||||
+-------------------------+----------------------------------------------------+-----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -41,7 +41,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **sync**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_use_sync(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -21,9 +21,9 @@ A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTre
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+-------------------------------------------------------------------+----+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` | "" |
|
||||
+-----------------------------+-------------------------------------------------------------------+----+
|
||||
+-----------------------------+-------------------------------------------------------------------+--------+
|
||||
| :ref:`String<class_String>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` | ``""`` |
|
||||
+-----------------------------+-------------------------------------------------------------------+--------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -33,7 +33,7 @@ Property Descriptions
|
||||
- :ref:`String<class_String>` **animation**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | "" |
|
||||
| *Default* | ``""`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_animation(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -21,9 +21,9 @@ A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTre
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend2_property_sync>` | false |
|
||||
+-------------------------+------------------------------------------------------+-------+
|
||||
+-------------------------+------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend2_property_sync>` | ``false`` |
|
||||
+-------------------------+------------------------------------------------------+-----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -33,7 +33,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **sync**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_use_sync(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -29,9 +29,9 @@ This node has three inputs:
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend3_property_sync>` | false |
|
||||
+-------------------------+------------------------------------------------------+-------+
|
||||
+-------------------------+------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend3_property_sync>` | ``false`` |
|
||||
+-------------------------+------------------------------------------------------+-----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -41,7 +41,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **sync**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_use_sync(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -27,15 +27,15 @@ You can set the extents of the axis using the :ref:`min_space<class_AnimationNod
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+--------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`max_space<class_AnimationNodeBlendSpace1D_property_max_space>` | 1.0 |
|
||||
+-----------------------------+--------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`min_space<class_AnimationNodeBlendSpace1D_property_min_space>` | -1.0 |
|
||||
+-----------------------------+--------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`snap<class_AnimationNodeBlendSpace1D_property_snap>` | 0.1 |
|
||||
+-----------------------------+--------------------------------------------------------------------------+---------+
|
||||
| :ref:`String<class_String>` | :ref:`value_label<class_AnimationNodeBlendSpace1D_property_value_label>` | "value" |
|
||||
+-----------------------------+--------------------------------------------------------------------------+---------+
|
||||
+-----------------------------+--------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_space<class_AnimationNodeBlendSpace1D_property_max_space>` | ``1.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`min_space<class_AnimationNodeBlendSpace1D_property_min_space>` | ``-1.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`snap<class_AnimationNodeBlendSpace1D_property_snap>` | ``0.1`` |
|
||||
+-----------------------------+--------------------------------------------------------------------------+-------------+
|
||||
| :ref:`String<class_String>` | :ref:`value_label<class_AnimationNodeBlendSpace1D_property_value_label>` | ``"value"`` |
|
||||
+-----------------------------+--------------------------------------------------------------------------+-------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -64,7 +64,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **max_space**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_max_space(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -80,7 +80,7 @@ The blend space's axis's upper limit for the points' position. See :ref:`add_ble
|
||||
- :ref:`float<class_float>` **min_space**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | -1.0 |
|
||||
| *Default* | ``-1.0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_min_space(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -96,7 +96,7 @@ The blend space's axis's lower limit for the points' position. See :ref:`add_ble
|
||||
- :ref:`float<class_float>` **snap**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | 0.1 |
|
||||
| *Default* | ``0.1`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_snap(value) |
|
||||
+-----------+-----------------+
|
||||
@@ -112,7 +112,7 @@ Position increment to snap to when moving a point on the axis.
|
||||
- :ref:`String<class_String>` **value_label**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | "value" |
|
||||
| *Default* | ``"value"`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_value_label(value) |
|
||||
+-----------+------------------------+
|
||||
|
||||
@@ -25,21 +25,21 @@ You can add vertices to the blend space with :ref:`add_blend_point<class_Animati
|
||||
Properties
|
||||
----------
|
||||
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`auto_triangles<class_AnimationNodeBlendSpace2D_property_auto_triangles>` | true |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` | :ref:`blend_mode<class_AnimationNodeBlendSpace2D_property_blend_mode>` | 0 |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`max_space<class_AnimationNodeBlendSpace2D_property_max_space>` | Vector2( 1, 1 ) |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`min_space<class_AnimationNodeBlendSpace2D_property_min_space>` | Vector2( -1, -1 ) |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`snap<class_AnimationNodeBlendSpace2D_property_snap>` | Vector2( 0.1, 0.1 ) |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`String<class_String>` | :ref:`x_label<class_AnimationNodeBlendSpace2D_property_x_label>` | "x" |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`String<class_String>` | :ref:`y_label<class_AnimationNodeBlendSpace2D_property_y_label>` | "y" |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`auto_triangles<class_AnimationNodeBlendSpace2D_property_auto_triangles>` | ``true`` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` | :ref:`blend_mode<class_AnimationNodeBlendSpace2D_property_blend_mode>` | ``0`` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`max_space<class_AnimationNodeBlendSpace2D_property_max_space>` | ``Vector2( 1, 1 )`` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`min_space<class_AnimationNodeBlendSpace2D_property_min_space>` | ``Vector2( -1, -1 )`` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`snap<class_AnimationNodeBlendSpace2D_property_snap>` | ``Vector2( 0.1, 0.1 )`` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`x_label<class_AnimationNodeBlendSpace2D_property_x_label>` | ``"x"`` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`y_label<class_AnimationNodeBlendSpace2D_property_y_label>` | ``"y"`` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -104,7 +104,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **auto_triangles**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_auto_triangles(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -120,7 +120,7 @@ If ``true``, the blend space is triangulated automatically. The mesh updates eve
|
||||
- :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` **blend_mode**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_blend_mode(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -136,7 +136,7 @@ Controls the interpolation between animations. See :ref:`BlendMode<enum_Animatio
|
||||
- :ref:`Vector2<class_Vector2>` **max_space**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | Vector2( 1, 1 ) |
|
||||
| *Default* | ``Vector2( 1, 1 )`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_max_space(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -151,13 +151,13 @@ The blend space's X and Y axes' upper limit for the points' position. See :ref:`
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **min_space**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | Vector2( -1, -1 ) |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_min_space(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_min_space() |
|
||||
+-----------+----------------------+
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``Vector2( -1, -1 )`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_min_space(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_min_space() |
|
||||
+-----------+-----------------------+
|
||||
|
||||
The blend space's X and Y axes' lower limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>`.
|
||||
|
||||
@@ -167,13 +167,13 @@ The blend space's X and Y axes' lower limit for the points' position. See :ref:`
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **snap**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | Vector2( 0.1, 0.1 ) |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_snap(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_snap() |
|
||||
+-----------+---------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Vector2( 0.1, 0.1 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_snap(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_snap() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
Position increment to snap to when moving a point.
|
||||
|
||||
@@ -184,7 +184,7 @@ Position increment to snap to when moving a point.
|
||||
- :ref:`String<class_String>` **x_label**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | "x" |
|
||||
| *Default* | ``"x"`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_x_label(value) |
|
||||
+-----------+--------------------+
|
||||
@@ -200,7 +200,7 @@ Name of the blend space's X axis.
|
||||
- :ref:`String<class_String>` **y_label**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | "y" |
|
||||
| *Default* | ``"y"`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_y_label(value) |
|
||||
+-----------+--------------------+
|
||||
|
||||
@@ -16,9 +16,9 @@ AnimationNodeBlendTree
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+-------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`graph_offset<class_AnimationNodeBlendTree_property_graph_offset>` | Vector2( 0, 0 ) |
|
||||
+-------------------------------+-------------------------------------------------------------------------+-----------------+
|
||||
+-------------------------------+-------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`graph_offset<class_AnimationNodeBlendTree_property_graph_offset>` | ``Vector2( 0, 0 )`` |
|
||||
+-------------------------------+-------------------------------------------------------------------------+---------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -78,7 +78,7 @@ Property Descriptions
|
||||
- :ref:`Vector2<class_Vector2>` **graph_offset**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | Vector2( 0, 0 ) |
|
||||
| *Default* | ``Vector2( 0, 0 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_graph_offset(value) |
|
||||
+-----------+-------------------------+
|
||||
|
||||
@@ -16,19 +16,19 @@ AnimationNodeOneShot
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autorestart<class_AnimationNodeOneShot_property_autorestart>` | false |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`autorestart_delay<class_AnimationNodeOneShot_property_autorestart_delay>` | 1.0 |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`autorestart_random_delay<class_AnimationNodeOneShot_property_autorestart_random_delay>` | 0.0 |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`fadein_time<class_AnimationNodeOneShot_property_fadein_time>` | 0.1 |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`fadeout_time<class_AnimationNodeOneShot_property_fadeout_time>` | 0.1 |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeOneShot_property_sync>` | false |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-------+
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autorestart<class_AnimationNodeOneShot_property_autorestart>` | ``false`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`autorestart_delay<class_AnimationNodeOneShot_property_autorestart_delay>` | ``1.0`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`autorestart_random_delay<class_AnimationNodeOneShot_property_autorestart_random_delay>` | ``0.0`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`fadein_time<class_AnimationNodeOneShot_property_fadein_time>` | ``0.1`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`fadeout_time<class_AnimationNodeOneShot_property_fadeout_time>` | ``0.1`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeOneShot_property_sync>` | ``false`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------+-----------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -62,7 +62,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **autorestart**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_autorestart(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -76,7 +76,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **autorestart_delay**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_autorestart_delay(value) |
|
||||
+-----------+------------------------------+
|
||||
@@ -90,7 +90,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **autorestart_random_delay**
|
||||
|
||||
+-----------+-------------------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------------------------+
|
||||
| *Setter* | set_autorestart_random_delay(value) |
|
||||
+-----------+-------------------------------------+
|
||||
@@ -104,7 +104,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **fadein_time**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 0.1 |
|
||||
| *Default* | ``0.1`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_fadein_time(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -118,7 +118,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **fadeout_time**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 0.1 |
|
||||
| *Default* | ``0.1`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_fadeout_time(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -132,7 +132,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **sync**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_use_sync(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -28,9 +28,9 @@ Allows control of :ref:`AnimationTree<class_AnimationTree>` state machines creat
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+-------------------------+-------------+
|
||||
| :ref:`bool<class_bool>` | resource_local_to_scene | **O:** true |
|
||||
+-------------------------+-------------------------+-------------+
|
||||
+-------------------------+-------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | resource_local_to_scene | **O:** ``true`` |
|
||||
+-------------------------+-------------------------+-----------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
@@ -16,19 +16,19 @@ AnimationNodeStateMachineTransition
|
||||
Properties
|
||||
----------
|
||||
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`String<class_String>` | :ref:`advance_condition<class_AnimationNodeStateMachineTransition_property_advance_condition>` | "" |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`auto_advance<class_AnimationNodeStateMachineTransition_property_auto_advance>` | false |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_AnimationNodeStateMachineTransition_property_disabled>` | false |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`int<class_int>` | :ref:`priority<class_AnimationNodeStateMachineTransition_property_priority>` | 1 |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`SwitchMode<enum_AnimationNodeStateMachineTransition_SwitchMode>` | :ref:`switch_mode<class_AnimationNodeStateMachineTransition_property_switch_mode>` | 0 |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeStateMachineTransition_property_xfade_time>` | 0.0 |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`advance_condition<class_AnimationNodeStateMachineTransition_property_advance_condition>` | ``""`` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`auto_advance<class_AnimationNodeStateMachineTransition_property_auto_advance>` | ``false`` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_AnimationNodeStateMachineTransition_property_disabled>` | ``false`` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`int<class_int>` | :ref:`priority<class_AnimationNodeStateMachineTransition_property_priority>` | ``1`` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`SwitchMode<enum_AnimationNodeStateMachineTransition_SwitchMode>` | :ref:`switch_mode<class_AnimationNodeStateMachineTransition_property_switch_mode>` | ``0`` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeStateMachineTransition_property_xfade_time>` | ``0.0`` |
|
||||
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -64,7 +64,7 @@ Property Descriptions
|
||||
- :ref:`String<class_String>` **advance_condition**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | "" |
|
||||
| *Default* | ``""`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_advance_condition(value) |
|
||||
+-----------+------------------------------+
|
||||
@@ -84,7 +84,7 @@ Turn on auto advance when this condition is set. The provided name will become a
|
||||
- :ref:`bool<class_bool>` **auto_advance**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_auto_advance(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -100,7 +100,7 @@ Turn on the transition automatically when this state is reached. This works best
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_disabled(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -116,7 +116,7 @@ Don't use this transition during :ref:`AnimationNodeStateMachinePlayback.travel<
|
||||
- :ref:`int<class_int>` **priority**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_priority(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -132,7 +132,7 @@ Lower priority transitions are preferred when travelling through the tree via :r
|
||||
- :ref:`SwitchMode<enum_AnimationNodeStateMachineTransition_SwitchMode>` **switch_mode**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_switch_mode(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -148,7 +148,7 @@ The transition type.
|
||||
- :ref:`float<class_float>` **xfade_time**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_xfade_time(value) |
|
||||
+-----------+-----------------------+
|
||||
|
||||
@@ -16,139 +16,139 @@ AnimationNodeTransition
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
|
||||
| :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>` | 0 |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeTransition_property_xfade_time>` | 0.0 |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+---------+
|
||||
| :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>` | ``0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeTransition_property_xfade_time>` | ``0.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------------------------------+---------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -939,7 +939,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **input_count**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_enabled_inputs(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -953,7 +953,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **xfade_time**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_cross_fade_time(value) |
|
||||
+-----------+----------------------------+
|
||||
|
||||
@@ -30,29 +30,29 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+
|
||||
| :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:`AnimationMethodCallMode<enum_AnimationPlayer_AnimationMethodCallMode>` | :ref:`method_call_mode<class_AnimationPlayer_property_method_call_mode>` | 0 |
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+
|
||||
| :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>` | 0.0 |
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationPlayer_property_playback_process_mode>` | 1 |
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+
|
||||
| :ref:`float<class_float>` | :ref:`playback_speed<class_AnimationPlayer_property_playback_speed>` | 1.0 |
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`root_node<class_AnimationPlayer_property_root_node>` | NodePath("..") |
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+--------------------+
|
||||
| :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:`AnimationMethodCallMode<enum_AnimationPlayer_AnimationMethodCallMode>` | :ref:`method_call_mode<class_AnimationPlayer_property_method_call_mode>` | ``0`` |
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+--------------------+
|
||||
| :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>` | ``0.0`` |
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+--------------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationPlayer_property_playback_process_mode>` | ``1`` |
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+--------------------+
|
||||
| :ref:`float<class_float>` | :ref:`playback_speed<class_AnimationPlayer_property_playback_speed>` | ``1.0`` |
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+--------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`root_node<class_AnimationPlayer_property_root_node>` | ``NodePath("..")`` |
|
||||
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+--------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -191,7 +191,7 @@ If playing, the current animation; otherwise, the animation last played. When se
|
||||
- :ref:`String<class_String>` **autoplay**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | "" |
|
||||
| *Default* | ``""`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_autoplay(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -207,7 +207,7 @@ The name of the animation to play when the scene loads.
|
||||
- :ref:`String<class_String>` **current_animation**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | "" |
|
||||
| *Default* | ``""`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_current_animation(value) |
|
||||
+-----------+------------------------------+
|
||||
@@ -247,7 +247,7 @@ The position (in seconds) of the currently playing animation.
|
||||
- :ref:`AnimationMethodCallMode<enum_AnimationPlayer_AnimationMethodCallMode>` **method_call_mode**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_method_call_mode(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -277,7 +277,7 @@ If ``true``, updates animations in response to process-related notifications.
|
||||
- :ref:`float<class_float>` **playback_default_blend_time**
|
||||
|
||||
+-----------+-------------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------------------+
|
||||
| *Setter* | set_default_blend_time(value) |
|
||||
+-----------+-------------------------------+
|
||||
@@ -293,7 +293,7 @@ The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 p
|
||||
- :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` **playback_process_mode**
|
||||
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-----------------------------------+
|
||||
| *Setter* | set_animation_process_mode(value) |
|
||||
+-----------+-----------------------------------+
|
||||
@@ -309,7 +309,7 @@ The process notification in which to update animations.
|
||||
- :ref:`float<class_float>` **playback_speed**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_speed_scale(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -324,13 +324,13 @@ The speed scaling ratio. For instance, if this value is 1, then the animation pl
|
||||
|
||||
- :ref:`NodePath<class_NodePath>` **root_node**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | NodePath("..") |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_root(value) |
|
||||
+-----------+-----------------+
|
||||
| *Getter* | get_root() |
|
||||
+-----------+-----------------+
|
||||
+-----------+--------------------+
|
||||
| *Default* | ``NodePath("..")`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_root(value) |
|
||||
+-----------+--------------------+
|
||||
| *Getter* | get_root() |
|
||||
+-----------+--------------------+
|
||||
|
||||
The node from which node path references will travel.
|
||||
|
||||
|
||||
@@ -23,17 +23,17 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`active<class_AnimationTree_property_active>` | false |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`anim_player<class_AnimationTree_property_anim_player>` | NodePath("") |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationTree_AnimationProcessMode>` | :ref:`process_mode<class_AnimationTree_property_process_mode>` | 1 |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`root_motion_track<class_AnimationTree_property_root_motion_track>` | NodePath("") |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`tree_root<class_AnimationTree_property_tree_root>` | |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`active<class_AnimationTree_property_active>` | ``false`` |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`anim_player<class_AnimationTree_property_anim_player>` | ``NodePath("")`` |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationTree_AnimationProcessMode>` | :ref:`process_mode<class_AnimationTree_property_process_mode>` | ``1`` |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`root_motion_track<class_AnimationTree_property_root_motion_track>` | ``NodePath("")`` |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
|
||||
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`tree_root<class_AnimationTree_property_tree_root>` | |
|
||||
+----------------------------------------------------------------------+--------------------------------------------------------------------------+------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -73,7 +73,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **active**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_active(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -87,7 +87,7 @@ Property Descriptions
|
||||
- :ref:`NodePath<class_NodePath>` **anim_player**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | NodePath("") |
|
||||
| *Default* | ``NodePath("")`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_animation_player(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -101,7 +101,7 @@ Property Descriptions
|
||||
- :ref:`AnimationProcessMode<enum_AnimationTree_AnimationProcessMode>` **process_mode**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_process_mode(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -115,7 +115,7 @@ Property Descriptions
|
||||
- :ref:`NodePath<class_NodePath>` **root_motion_track**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | NodePath("") |
|
||||
| *Default* | ``NodePath("")`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_root_motion_track(value) |
|
||||
+-----------+------------------------------+
|
||||
|
||||
@@ -23,15 +23,15 @@ It takes :ref:`Animation<class_Animation>`\ s from an :ref:`AnimationPlayer<clas
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`active<class_AnimationTreePlayer_property_active>` | false |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`base_path<class_AnimationTreePlayer_property_base_path>` | NodePath("..") |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`master_player<class_AnimationTreePlayer_property_master_player>` | NodePath("") |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationTreePlayer_property_playback_process_mode>` | 1 |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------+
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`active<class_AnimationTreePlayer_property_active>` | ``false`` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`base_path<class_AnimationTreePlayer_property_base_path>` | ``NodePath("..")`` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`master_player<class_AnimationTreePlayer_property_master_player>` | ``NodePath("")`` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
|
||||
| :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationTreePlayer_property_playback_process_mode>` | ``1`` |
|
||||
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -221,7 +221,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **active**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_active(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -237,7 +237,7 @@ If ``true``, the ``AnimationTreePlayer`` is able to play animations.
|
||||
- :ref:`NodePath<class_NodePath>` **base_path**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | NodePath("..") |
|
||||
| *Default* | ``NodePath("..")`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_base_path(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -255,7 +255,7 @@ It accesses the Bones, so it should point to the same Node the AnimationPlayer w
|
||||
- :ref:`NodePath<class_NodePath>` **master_player**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | NodePath("") |
|
||||
| *Default* | ``NodePath("")`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_master_player(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -273,7 +273,7 @@ Once set, Animation nodes can be added to the AnimationTreePlayer.
|
||||
- :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` **playback_process_mode**
|
||||
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-----------------------------------+
|
||||
| *Setter* | set_animation_process_mode(value) |
|
||||
+-----------+-----------------------------------+
|
||||
|
||||
@@ -21,43 +21,43 @@ Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area_property_angular_damp>` | 0.1 |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area_property_audio_bus_name>` | "Master" |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area_property_audio_bus_override>` | false |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_layer<class_Area_property_collision_layer>` | 1 |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_Area_property_collision_mask>` | 1 |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity<class_Area_property_gravity>` | 9.8 |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area_property_gravity_distance_scale>` | 0.0 |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area_property_gravity_point>` | false |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`gravity_vec<class_Area_property_gravity_vec>` | Vector3( 0, -1, 0 ) |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_damp<class_Area_property_linear_damp>` | 0.1 |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area_property_monitorable>` | true |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area_property_monitoring>` | true |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`priority<class_Area_property_priority>` | 0.0 |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`reverb_bus_amount<class_Area_property_reverb_bus_amount>` | 0.0 |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`reverb_bus_enable<class_Area_property_reverb_bus_enable>` | false |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`String<class_String>` | :ref:`reverb_bus_name<class_Area_property_reverb_bus_name>` | "Master" |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`reverb_bus_uniformity<class_Area_property_reverb_bus_uniformity>` | 0.0 |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`SpaceOverride<enum_Area_SpaceOverride>` | :ref:`space_override<class_Area_property_space_override>` | 0 |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area_property_angular_damp>` | ``0.1`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area_property_audio_bus_name>` | ``"Master"`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area_property_audio_bus_override>` | ``false`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_layer<class_Area_property_collision_layer>` | ``1`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_Area_property_collision_mask>` | ``1`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity<class_Area_property_gravity>` | ``9.8`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area_property_gravity_distance_scale>` | ``0.0`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area_property_gravity_point>` | ``false`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`gravity_vec<class_Area_property_gravity_vec>` | ``Vector3( 0, -1, 0 )`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_damp<class_Area_property_linear_damp>` | ``0.1`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area_property_monitorable>` | ``true`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area_property_monitoring>` | ``true`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`priority<class_Area_property_priority>` | ``0.0`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`reverb_bus_amount<class_Area_property_reverb_bus_amount>` | ``0.0`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`reverb_bus_enable<class_Area_property_reverb_bus_enable>` | ``false`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`reverb_bus_name<class_Area_property_reverb_bus_name>` | ``"Master"`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`reverb_bus_uniformity<class_Area_property_reverb_bus_uniformity>` | ``0.0`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`SpaceOverride<enum_Area_SpaceOverride>` | :ref:`space_override<class_Area_property_space_override>` | ``0`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -188,7 +188,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **angular_damp**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 0.1 |
|
||||
| *Default* | ``0.1`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_angular_damp(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -204,7 +204,7 @@ The rate at which objects stop spinning in this area. Represents the angular vel
|
||||
- :ref:`String<class_String>` **audio_bus_name**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | "Master" |
|
||||
| *Default* | ``"Master"`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_audio_bus(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -220,7 +220,7 @@ The name of the area's audio bus.
|
||||
- :ref:`bool<class_bool>` **audio_bus_override**
|
||||
|
||||
+-----------+-------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------------------+
|
||||
| *Setter* | set_audio_bus_override(value) |
|
||||
+-----------+-------------------------------+
|
||||
@@ -236,7 +236,7 @@ If ``true``, the area's audio bus overrides the default audio bus.
|
||||
- :ref:`int<class_int>` **collision_layer**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_collision_layer(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -252,7 +252,7 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different
|
||||
- :ref:`int<class_int>` **collision_mask**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_collision_mask(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -268,7 +268,7 @@ The physics layers this area scans to determine collision detection.
|
||||
- :ref:`float<class_float>` **gravity**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | 9.8 |
|
||||
| *Default* | ``9.8`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_gravity(value) |
|
||||
+-----------+--------------------+
|
||||
@@ -284,7 +284,7 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies
|
||||
- :ref:`float<class_float>` **gravity_distance_scale**
|
||||
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------------+
|
||||
| *Setter* | set_gravity_distance_scale(value) |
|
||||
+-----------+-----------------------------------+
|
||||
@@ -300,7 +300,7 @@ The falloff factor for point gravity. The greater the value, the faster gravity
|
||||
- :ref:`bool<class_bool>` **gravity_point**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_gravity_is_point(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -316,7 +316,7 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class
|
||||
- :ref:`Vector3<class_Vector3>` **gravity_vec**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | Vector3( 0, -1, 0 ) |
|
||||
| *Default* | ``Vector3( 0, -1, 0 )`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_gravity_vector(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -332,7 +332,7 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra
|
||||
- :ref:`float<class_float>` **linear_damp**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 0.1 |
|
||||
| *Default* | ``0.1`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_linear_damp(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -348,7 +348,7 @@ The rate at which objects stop moving in this area. Represents the linear veloci
|
||||
- :ref:`bool<class_bool>` **monitorable**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_monitorable(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -364,7 +364,7 @@ If ``true``, other monitoring areas can detect this area.
|
||||
- :ref:`bool<class_bool>` **monitoring**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_monitoring(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -380,7 +380,7 @@ If ``true``, the area detects bodies or areas entering and exiting it.
|
||||
- :ref:`float<class_float>` **priority**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_priority(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -396,7 +396,7 @@ The area's priority. Higher priority areas are processed first.
|
||||
- :ref:`float<class_float>` **reverb_bus_amount**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_reverb_amount(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -412,7 +412,7 @@ The degree to which this area applies reverb to its associated audio. Ranges fro
|
||||
- :ref:`bool<class_bool>` **reverb_bus_enable**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_use_reverb_bus(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -428,7 +428,7 @@ If ``true``, the area applies reverb to its associated audio.
|
||||
- :ref:`String<class_String>` **reverb_bus_name**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | "Master" |
|
||||
| *Default* | ``"Master"`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_reverb_bus(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -444,7 +444,7 @@ The reverb bus name to use for this area's associated audio.
|
||||
- :ref:`float<class_float>` **reverb_bus_uniformity**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_reverb_uniformity(value) |
|
||||
+-----------+------------------------------+
|
||||
@@ -460,7 +460,7 @@ The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to
|
||||
- :ref:`SpaceOverride<enum_Area_SpaceOverride>` **space_override**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_space_override_mode(value) |
|
||||
+-----------+--------------------------------+
|
||||
|
||||
@@ -26,35 +26,35 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area2D_property_angular_damp>` | 1.0 |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area2D_property_audio_bus_name>` | "Master" |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area2D_property_audio_bus_override>` | false |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_layer<class_Area2D_property_collision_layer>` | 1 |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_Area2D_property_collision_mask>` | 1 |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity<class_Area2D_property_gravity>` | 98.0 |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area2D_property_gravity_distance_scale>` | 0.0 |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area2D_property_gravity_point>` | false |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`gravity_vec<class_Area2D_property_gravity_vec>` | Vector2( 0, 1 ) |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_damp<class_Area2D_property_linear_damp>` | 0.1 |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area2D_property_monitorable>` | true |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area2D_property_monitoring>` | true |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`priority<class_Area2D_property_priority>` | 0.0 |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` | :ref:`space_override<class_Area2D_property_space_override>` | 0 |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area2D_property_angular_damp>` | ``1.0`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area2D_property_audio_bus_name>` | ``"Master"`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area2D_property_audio_bus_override>` | ``false`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_layer<class_Area2D_property_collision_layer>` | ``1`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_Area2D_property_collision_mask>` | ``1`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity<class_Area2D_property_gravity>` | ``98.0`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area2D_property_gravity_distance_scale>` | ``0.0`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area2D_property_gravity_point>` | ``false`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`gravity_vec<class_Area2D_property_gravity_vec>` | ``Vector2( 0, 1 )`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_damp<class_Area2D_property_linear_damp>` | ``0.1`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area2D_property_monitorable>` | ``true`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area2D_property_monitoring>` | ``true`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`priority<class_Area2D_property_priority>` | ``0.0`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` | :ref:`space_override<class_Area2D_property_space_override>` | ``0`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -185,7 +185,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **angular_damp**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_angular_damp(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -201,7 +201,7 @@ The rate at which objects stop spinning in this area. Represents the angular vel
|
||||
- :ref:`String<class_String>` **audio_bus_name**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | "Master" |
|
||||
| *Default* | ``"Master"`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_audio_bus_name(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -217,7 +217,7 @@ The name of the area's audio bus.
|
||||
- :ref:`bool<class_bool>` **audio_bus_override**
|
||||
|
||||
+-----------+-------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------------------+
|
||||
| *Setter* | set_audio_bus_override(value) |
|
||||
+-----------+-------------------------------+
|
||||
@@ -233,7 +233,7 @@ If ``true``, the area's audio bus overrides the default audio bus.
|
||||
- :ref:`int<class_int>` **collision_layer**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_collision_layer(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -249,7 +249,7 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different
|
||||
- :ref:`int<class_int>` **collision_mask**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_collision_mask(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -265,7 +265,7 @@ The physics layers this area scans to determine collision detection.
|
||||
- :ref:`float<class_float>` **gravity**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | 98.0 |
|
||||
| *Default* | ``98.0`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_gravity(value) |
|
||||
+-----------+--------------------+
|
||||
@@ -281,7 +281,7 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies
|
||||
- :ref:`float<class_float>` **gravity_distance_scale**
|
||||
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------------+
|
||||
| *Setter* | set_gravity_distance_scale(value) |
|
||||
+-----------+-----------------------------------+
|
||||
@@ -297,7 +297,7 @@ The falloff factor for point gravity. The greater the value, the faster gravity
|
||||
- :ref:`bool<class_bool>` **gravity_point**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_gravity_is_point(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -313,7 +313,7 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class
|
||||
- :ref:`Vector2<class_Vector2>` **gravity_vec**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | Vector2( 0, 1 ) |
|
||||
| *Default* | ``Vector2( 0, 1 )`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_gravity_vector(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -329,7 +329,7 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra
|
||||
- :ref:`float<class_float>` **linear_damp**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 0.1 |
|
||||
| *Default* | ``0.1`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_linear_damp(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -345,7 +345,7 @@ The rate at which objects stop moving in this area. Represents the linear veloci
|
||||
- :ref:`bool<class_bool>` **monitorable**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_monitorable(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -361,7 +361,7 @@ If ``true``, other monitoring areas can detect this area.
|
||||
- :ref:`bool<class_bool>` **monitoring**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_monitoring(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -377,7 +377,7 @@ If ``true``, the area detects bodies or areas entering and exiting it.
|
||||
- :ref:`float<class_float>` **priority**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_priority(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -393,7 +393,7 @@ The area's priority. Higher priority areas are processed first.
|
||||
- :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` **space_override**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_space_override_mode(value) |
|
||||
+-----------+--------------------------------+
|
||||
|
||||
@@ -44,11 +44,11 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` | :ref:`blend_shape_mode<class_ArrayMesh_property_blend_shape_mode>` | 1 |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`custom_aabb<class_ArrayMesh_property_custom_aabb>` | AABB( 0, 0, 0, 0, 0, 0 ) |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+--------------------------+
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+------------------------------+
|
||||
| :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` | :ref:`blend_shape_mode<class_ArrayMesh_property_blend_shape_mode>` | ``1`` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`custom_aabb<class_ArrayMesh_property_custom_aabb>` | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
|
||||
+-------------------------------------------------+--------------------------------------------------------------------+------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -197,7 +197,7 @@ Property Descriptions
|
||||
- :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` **blend_shape_mode**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_blend_shape_mode(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -212,13 +212,13 @@ Sets the blend shape mode to one of :ref:`BlendShapeMode<enum_Mesh_BlendShapeMod
|
||||
|
||||
- :ref:`AABB<class_AABB>` **custom_aabb**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | AABB( 0, 0, 0, 0, 0, 0 ) |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_custom_aabb(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_custom_aabb() |
|
||||
+-----------+--------------------------+
|
||||
+-----------+------------------------------+
|
||||
| *Default* | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_custom_aabb(value) |
|
||||
+-----------+------------------------------+
|
||||
| *Getter* | get_custom_aabb() |
|
||||
+-----------+------------------------------+
|
||||
|
||||
Overrides the :ref:`AABB<class_AABB>` with one defined by user for use with frustum culling. Especially useful to avoid unexpected culling when using a shader to offset vertices.
|
||||
|
||||
|
||||
@@ -25,9 +25,9 @@ Keep in mind that, as long as plane detection is enabled, the size, placing and
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------+-------------------------------------------------------+---+
|
||||
| :ref:`int<class_int>` | :ref:`anchor_id<class_ARVRAnchor_property_anchor_id>` | 1 |
|
||||
+-----------------------+-------------------------------------------------------+---+
|
||||
+-----------------------+-------------------------------------------------------+-------+
|
||||
| :ref:`int<class_int>` | :ref:`anchor_id<class_ARVRAnchor_property_anchor_id>` | ``1`` |
|
||||
+-----------------------+-------------------------------------------------------+-------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -61,7 +61,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **anchor_id**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_anchor_id(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -25,11 +25,11 @@ The position of the controller node is automatically updated by the :ref:`ARVRSe
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-------------------------------------------------------------------+-----+
|
||||
| :ref:`int<class_int>` | :ref:`controller_id<class_ARVRController_property_controller_id>` | 1 |
|
||||
+---------------------------+-------------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRController_property_rumble>` | 0.0 |
|
||||
+---------------------------+-------------------------------------------------------------------+-----+
|
||||
+---------------------------+-------------------------------------------------------------------+---------+
|
||||
| :ref:`int<class_int>` | :ref:`controller_id<class_ARVRController_property_controller_id>` | ``1`` |
|
||||
+---------------------------+-------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRController_property_rumble>` | ``0.0`` |
|
||||
+---------------------------+-------------------------------------------------------------------+---------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -83,7 +83,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **controller_id**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_controller_id(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -105,7 +105,7 @@ When a controller is turned off, its slot is freed. This ensures controllers wil
|
||||
- :ref:`float<class_float>` **rumble**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_rumble(value) |
|
||||
+-----------+-------------------+
|
||||
|
||||
@@ -25,13 +25,13 @@ Interfaces should be written in such a way that simply enabling them will give u
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`ar_is_anchor_detection_enabled<class_ARVRInterface_property_ar_is_anchor_detection_enabled>` | false |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`interface_is_initialized<class_ARVRInterface_property_interface_is_initialized>` | false |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`interface_is_primary<class_ARVRInterface_property_interface_is_primary>` | false |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+-------+
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`ar_is_anchor_detection_enabled<class_ARVRInterface_property_ar_is_anchor_detection_enabled>` | ``false`` |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`interface_is_initialized<class_ARVRInterface_property_interface_is_initialized>` | ``false`` |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`interface_is_primary<class_ARVRInterface_property_interface_is_primary>` | ``false`` |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------+-----------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -133,7 +133,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **ar_is_anchor_detection_enabled**
|
||||
|
||||
+-----------+----------------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------------------------------+
|
||||
| *Setter* | set_anchor_detection_is_enabled(value) |
|
||||
+-----------+----------------------------------------+
|
||||
@@ -149,7 +149,7 @@ On an AR interface, ``true`` if anchor detection is enabled.
|
||||
- :ref:`bool<class_bool>` **interface_is_initialized**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_is_initialized(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -165,7 +165,7 @@ On an AR interface, ``true`` if anchor detection is enabled.
|
||||
- :ref:`bool<class_bool>` **interface_is_primary**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_is_primary(value) |
|
||||
+-----------+-----------------------+
|
||||
|
||||
@@ -27,9 +27,9 @@ For example, if your character is driving a car, the ARVROrigin node should be a
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-----------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVROrigin_property_world_scale>` | 1.0 |
|
||||
+---------------------------+-----------------------------------------------------------+-----+
|
||||
+---------------------------+-----------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVROrigin_property_world_scale>` | ``1.0`` |
|
||||
+---------------------------+-----------------------------------------------------------+---------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -39,7 +39,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **world_scale**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_world_scale(value) |
|
||||
+-----------+------------------------+
|
||||
|
||||
@@ -25,9 +25,9 @@ The :ref:`ARVRController<class_ARVRController>` and :ref:`ARVRAnchor<class_ARVRA
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRPositionalTracker_property_rumble>` | 0.0 |
|
||||
+---------------------------+------------------------------------------------------------+-----+
|
||||
+---------------------------+------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRPositionalTracker_property_rumble>` | ``0.0`` |
|
||||
+---------------------------+------------------------------------------------------------+---------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -81,7 +81,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **rumble**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_rumble(value) |
|
||||
+-----------+-------------------+
|
||||
|
||||
@@ -21,11 +21,11 @@ The AR/VR server is the heart of our AR/VR solution and handles all the processi
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------+-----------------------------------------------------------------------+-----+
|
||||
| :ref:`ARVRInterface<class_ARVRInterface>` | :ref:`primary_interface<class_ARVRServer_property_primary_interface>` | |
|
||||
+-------------------------------------------+-----------------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVRServer_property_world_scale>` | 1.0 |
|
||||
+-------------------------------------------+-----------------------------------------------------------------------+-----+
|
||||
+-------------------------------------------+-----------------------------------------------------------------------+---------+
|
||||
| :ref:`ARVRInterface<class_ARVRInterface>` | :ref:`primary_interface<class_ARVRServer_property_primary_interface>` | |
|
||||
+-------------------------------------------+-----------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVRServer_property_world_scale>` | ``1.0`` |
|
||||
+-------------------------------------------+-----------------------------------------------------------------------+---------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -158,7 +158,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **world_scale**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_world_scale(value) |
|
||||
+-----------+------------------------+
|
||||
|
||||
@@ -21,17 +21,17 @@ Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+-------------------------------------------------------------+---------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`atlas<class_AtlasTexture_property_atlas>` | |
|
||||
+-------------------------------+-------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_property_filter_clip>` | false |
|
||||
+-------------------------------+-------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | flags | **O:** 0 |
|
||||
+-------------------------------+-------------------------------------------------------------+---------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`margin<class_AtlasTexture_property_margin>` | Rect2( 0, 0, 0, 0 ) |
|
||||
+-------------------------------+-------------------------------------------------------------+---------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`region<class_AtlasTexture_property_region>` | Rect2( 0, 0, 0, 0 ) |
|
||||
+-------------------------------+-------------------------------------------------------------+---------------------+
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`atlas<class_AtlasTexture_property_atlas>` | |
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_property_filter_clip>` | ``false`` |
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | flags | **O:** ``0`` |
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`margin<class_AtlasTexture_property_margin>` | ``Rect2( 0, 0, 0, 0 )`` |
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`region<class_AtlasTexture_property_region>` | ``Rect2( 0, 0, 0, 0 )`` |
|
||||
+-------------------------------+-------------------------------------------------------------+-------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -55,7 +55,7 @@ The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` su
|
||||
- :ref:`bool<class_bool>` **filter_clip**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_filter_clip(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -70,13 +70,13 @@ If ``true``, clips the area outside of the region to avoid bleeding of the surro
|
||||
|
||||
- :ref:`Rect2<class_Rect2>` **margin**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | Rect2( 0, 0, 0, 0 ) |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_margin(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_margin() |
|
||||
+-----------+---------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Rect2( 0, 0, 0, 0 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_margin(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_margin() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
The margin around the region. The :ref:`Rect2<class_Rect2>`'s :ref:`Rect2.size<class_Rect2_property_size>` parameter ("w" and "h" in the editor) resizes the texture so it fits within the margin.
|
||||
|
||||
@@ -86,13 +86,13 @@ The margin around the region. The :ref:`Rect2<class_Rect2>`'s :ref:`Rect2.size<c
|
||||
|
||||
- :ref:`Rect2<class_Rect2>` **region**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | Rect2( 0, 0, 0, 0 ) |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_region(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_region() |
|
||||
+-----------+---------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Rect2( 0, 0, 0, 0 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_region(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_region() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
The AtlasTexture's used region.
|
||||
|
||||
|
||||
@@ -23,9 +23,9 @@ Increases or decreases the volume being routed through the audio bus.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioEffectAmplify_property_volume_db>` | 0.0 |
|
||||
+---------------------------+---------------------------------------------------------------+-----+
|
||||
+---------------------------+---------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioEffectAmplify_property_volume_db>` | ``0.0`` |
|
||||
+---------------------------+---------------------------------------------------------------+---------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -35,7 +35,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **volume_db**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_volume_db(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -21,61 +21,61 @@ Adds a chorus audio effect. The effect applies a filter with voices to duplicate
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectChorus_property_dry>` | 1.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/cutoff_hz<class_AudioEffectChorus_property_voice/1/cutoff_hz>` | 8000.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/delay_ms<class_AudioEffectChorus_property_voice/1/delay_ms>` | 15.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/depth_ms<class_AudioEffectChorus_property_voice/1/depth_ms>` | 2.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/level_db<class_AudioEffectChorus_property_voice/1/level_db>` | 0.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/pan<class_AudioEffectChorus_property_voice/1/pan>` | -0.5 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/rate_hz<class_AudioEffectChorus_property_voice/1/rate_hz>` | 0.8 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/cutoff_hz<class_AudioEffectChorus_property_voice/2/cutoff_hz>` | 8000.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/delay_ms<class_AudioEffectChorus_property_voice/2/delay_ms>` | 20.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/depth_ms<class_AudioEffectChorus_property_voice/2/depth_ms>` | 3.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/level_db<class_AudioEffectChorus_property_voice/2/level_db>` | 0.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/pan<class_AudioEffectChorus_property_voice/2/pan>` | 0.5 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/rate_hz<class_AudioEffectChorus_property_voice/2/rate_hz>` | 1.2 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :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>` | 2 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectChorus_property_wet>` | 0.5 |
|
||||
+---------------------------+------------------------------------------------------------------------------+--------+
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectChorus_property_dry>` | ``1.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/cutoff_hz<class_AudioEffectChorus_property_voice/1/cutoff_hz>` | ``8000.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/delay_ms<class_AudioEffectChorus_property_voice/1/delay_ms>` | ``15.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/depth_ms<class_AudioEffectChorus_property_voice/1/depth_ms>` | ``2.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/level_db<class_AudioEffectChorus_property_voice/1/level_db>` | ``0.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/pan<class_AudioEffectChorus_property_voice/1/pan>` | ``-0.5`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/1/rate_hz<class_AudioEffectChorus_property_voice/1/rate_hz>` | ``0.8`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/cutoff_hz<class_AudioEffectChorus_property_voice/2/cutoff_hz>` | ``8000.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/delay_ms<class_AudioEffectChorus_property_voice/2/delay_ms>` | ``20.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/depth_ms<class_AudioEffectChorus_property_voice/2/depth_ms>` | ``3.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/level_db<class_AudioEffectChorus_property_voice/2/level_db>` | ``0.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/pan<class_AudioEffectChorus_property_voice/2/pan>` | ``0.5`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`voice/2/rate_hz<class_AudioEffectChorus_property_voice/2/rate_hz>` | ``1.2`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :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>` | ``2`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectChorus_property_wet>` | ``0.5`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -114,7 +114,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **dry**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_dry(value) |
|
||||
+-----------+----------------+
|
||||
@@ -130,7 +130,7 @@ The effect's raw signal.
|
||||
- :ref:`float<class_float>` **voice/1/cutoff_hz**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | 8000.0 |
|
||||
| *Default* | ``8000.0`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_voice_cutoff_hz(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -146,7 +146,7 @@ The voice's cutoff frequency.
|
||||
- :ref:`float<class_float>` **voice/1/delay_ms**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 15.0 |
|
||||
| *Default* | ``15.0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_voice_delay_ms(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -162,7 +162,7 @@ The voice's signal delay.
|
||||
- :ref:`float<class_float>` **voice/1/depth_ms**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 2.0 |
|
||||
| *Default* | ``2.0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_voice_depth_ms(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -178,7 +178,7 @@ The voice filter's depth.
|
||||
- :ref:`float<class_float>` **voice/1/level_db**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_voice_level_db(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -194,7 +194,7 @@ The voice's volume.
|
||||
- :ref:`float<class_float>` **voice/1/pan**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | -0.5 |
|
||||
| *Default* | ``-0.5`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_voice_pan(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -210,7 +210,7 @@ The voice's pan level.
|
||||
- :ref:`float<class_float>` **voice/1/rate_hz**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | 0.8 |
|
||||
| *Default* | ``0.8`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_voice_rate_hz(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -226,7 +226,7 @@ The voice's filter rate.
|
||||
- :ref:`float<class_float>` **voice/2/cutoff_hz**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | 8000.0 |
|
||||
| *Default* | ``8000.0`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_voice_cutoff_hz(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -242,7 +242,7 @@ The voice's cutoff frequency.
|
||||
- :ref:`float<class_float>` **voice/2/delay_ms**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 20.0 |
|
||||
| *Default* | ``20.0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_voice_delay_ms(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -258,7 +258,7 @@ The voice's signal delay.
|
||||
- :ref:`float<class_float>` **voice/2/depth_ms**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 3.0 |
|
||||
| *Default* | ``3.0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_voice_depth_ms(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -274,7 +274,7 @@ The voice filter's depth.
|
||||
- :ref:`float<class_float>` **voice/2/level_db**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_voice_level_db(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -290,7 +290,7 @@ The voice's volume.
|
||||
- :ref:`float<class_float>` **voice/2/pan**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0.5 |
|
||||
| *Default* | ``0.5`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_voice_pan(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -306,7 +306,7 @@ The voice's pan level.
|
||||
- :ref:`float<class_float>` **voice/2/rate_hz**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | 1.2 |
|
||||
| *Default* | ``1.2`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_voice_rate_hz(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -490,7 +490,7 @@ The voice's filter rate.
|
||||
- :ref:`int<class_int>` **voice_count**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 2 |
|
||||
| *Default* | ``2`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_voice_count(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -506,7 +506,7 @@ The amount of voices in the effect.
|
||||
- :ref:`float<class_float>` **wet**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | 0.5 |
|
||||
| *Default* | ``0.5`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_wet(value) |
|
||||
+-----------+----------------+
|
||||
|
||||
@@ -33,21 +33,21 @@ Compressor has many uses in the mix:
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`attack_us<class_AudioEffectCompressor_property_attack_us>` | 20.0 |
|
||||
+-----------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectCompressor_property_gain>` | 0.0 |
|
||||
+-----------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`mix<class_AudioEffectCompressor_property_mix>` | 1.0 |
|
||||
+-----------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`ratio<class_AudioEffectCompressor_property_ratio>` | 4.0 |
|
||||
+-----------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`release_ms<class_AudioEffectCompressor_property_release_ms>` | 250.0 |
|
||||
+-----------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`String<class_String>` | :ref:`sidechain<class_AudioEffectCompressor_property_sidechain>` | "" |
|
||||
+-----------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`threshold<class_AudioEffectCompressor_property_threshold>` | 0.0 |
|
||||
+-----------------------------+--------------------------------------------------------------------+-------+
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`attack_us<class_AudioEffectCompressor_property_attack_us>` | ``20.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectCompressor_property_gain>` | ``0.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`mix<class_AudioEffectCompressor_property_mix>` | ``1.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`ratio<class_AudioEffectCompressor_property_ratio>` | ``4.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`release_ms<class_AudioEffectCompressor_property_release_ms>` | ``250.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`sidechain<class_AudioEffectCompressor_property_sidechain>` | ``""`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`threshold<class_AudioEffectCompressor_property_threshold>` | ``0.0`` |
|
||||
+-----------------------------+--------------------------------------------------------------------+-----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -57,7 +57,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **attack_us**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 20.0 |
|
||||
| *Default* | ``20.0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_attack_us(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -73,7 +73,7 @@ Compressor's reaction time when the signal exceeds the threshold, in microsecond
|
||||
- :ref:`float<class_float>` **gain**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_gain(value) |
|
||||
+-----------+-----------------+
|
||||
@@ -89,7 +89,7 @@ Gain applied to the output signal.
|
||||
- :ref:`float<class_float>` **mix**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_mix(value) |
|
||||
+-----------+----------------+
|
||||
@@ -105,7 +105,7 @@ Balance between original signal and effect signal. Value can range from 0 (total
|
||||
- :ref:`float<class_float>` **ratio**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 4.0 |
|
||||
| *Default* | ``4.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_ratio(value) |
|
||||
+-----------+------------------+
|
||||
@@ -121,7 +121,7 @@ Amount of compression applied to the audio once it passes the threshold level. T
|
||||
- :ref:`float<class_float>` **release_ms**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 250.0 |
|
||||
| *Default* | ``250.0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_release_ms(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -137,7 +137,7 @@ Compressor's delay time to stop reducing the signal after the signal level falls
|
||||
- :ref:`String<class_String>` **sidechain**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | "" |
|
||||
| *Default* | ``""`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_sidechain(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -153,7 +153,7 @@ Reduce the sound level using another audio bus for threshold detection.
|
||||
- :ref:`float<class_float>` **threshold**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_threshold(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -23,33 +23,33 @@ Plays input signal back after a period of time. The delayed signal may be played
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectDelay_property_dry>` | 1.0 |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`bool<class_bool>` | :ref:`feedback/active<class_AudioEffectDelay_property_feedback/active>` | false |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/delay_ms<class_AudioEffectDelay_property_feedback/delay_ms>` | 340.0 |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/level_db<class_AudioEffectDelay_property_feedback/level_db>` | -6.0 |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/lowpass<class_AudioEffectDelay_property_feedback/lowpass>` | 16000.0 |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`bool<class_bool>` | :ref:`tap1/active<class_AudioEffectDelay_property_tap1/active>` | true |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/delay_ms<class_AudioEffectDelay_property_tap1/delay_ms>` | 250.0 |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/level_db<class_AudioEffectDelay_property_tap1/level_db>` | -6.0 |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/pan<class_AudioEffectDelay_property_tap1/pan>` | 0.2 |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`bool<class_bool>` | :ref:`tap2/active<class_AudioEffectDelay_property_tap2/active>` | true |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/delay_ms<class_AudioEffectDelay_property_tap2/delay_ms>` | 500.0 |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/level_db<class_AudioEffectDelay_property_tap2/level_db>` | -12.0 |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/pan<class_AudioEffectDelay_property_tap2/pan>` | -0.4 |
|
||||
+---------------------------+-----------------------------------------------------------------------------+---------+
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectDelay_property_dry>` | ``1.0`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`feedback/active<class_AudioEffectDelay_property_feedback/active>` | ``false`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/delay_ms<class_AudioEffectDelay_property_feedback/delay_ms>` | ``340.0`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/level_db<class_AudioEffectDelay_property_feedback/level_db>` | ``-6.0`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback/lowpass<class_AudioEffectDelay_property_feedback/lowpass>` | ``16000.0`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`tap1/active<class_AudioEffectDelay_property_tap1/active>` | ``true`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/delay_ms<class_AudioEffectDelay_property_tap1/delay_ms>` | ``250.0`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/level_db<class_AudioEffectDelay_property_tap1/level_db>` | ``-6.0`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap1/pan<class_AudioEffectDelay_property_tap1/pan>` | ``0.2`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`tap2/active<class_AudioEffectDelay_property_tap2/active>` | ``true`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/delay_ms<class_AudioEffectDelay_property_tap2/delay_ms>` | ``500.0`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/level_db<class_AudioEffectDelay_property_tap2/level_db>` | ``-12.0`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`tap2/pan<class_AudioEffectDelay_property_tap2/pan>` | ``-0.4`` |
|
||||
+---------------------------+-----------------------------------------------------------------------------+-------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -59,7 +59,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **dry**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_dry(value) |
|
||||
+-----------+----------------+
|
||||
@@ -75,7 +75,7 @@ Output percent of original sound. At 0, only delayed sounds are output. Value ca
|
||||
- :ref:`bool<class_bool>` **feedback/active**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_feedback_active(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -91,7 +91,7 @@ If ``true``, feedback is enabled.
|
||||
- :ref:`float<class_float>` **feedback/delay_ms**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | 340.0 |
|
||||
| *Default* | ``340.0`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_feedback_delay_ms(value) |
|
||||
+-----------+------------------------------+
|
||||
@@ -107,7 +107,7 @@ Feedback delay time in milliseconds.
|
||||
- :ref:`float<class_float>` **feedback/level_db**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | -6.0 |
|
||||
| *Default* | ``-6.0`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_feedback_level_db(value) |
|
||||
+-----------+------------------------------+
|
||||
@@ -123,7 +123,7 @@ Sound level for ``tap1``.
|
||||
- :ref:`float<class_float>` **feedback/lowpass**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 16000.0 |
|
||||
| *Default* | ``16000.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_feedback_lowpass(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -139,7 +139,7 @@ Low-pass filter for feedback, in Hz. Frequencies below this value are filtered o
|
||||
- :ref:`bool<class_bool>` **tap1/active**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_tap1_active(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -155,7 +155,7 @@ If ``true``, ``tap1`` will be enabled.
|
||||
- :ref:`float<class_float>` **tap1/delay_ms**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | 250.0 |
|
||||
| *Default* | ``250.0`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_tap1_delay_ms(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -171,7 +171,7 @@ If ``true``, ``tap1`` will be enabled.
|
||||
- :ref:`float<class_float>` **tap1/level_db**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | -6.0 |
|
||||
| *Default* | ``-6.0`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_tap1_level_db(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -187,7 +187,7 @@ Sound level for ``tap1``.
|
||||
- :ref:`float<class_float>` **tap1/pan**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.2 |
|
||||
| *Default* | ``0.2`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_tap1_pan(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -203,7 +203,7 @@ Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully righ
|
||||
- :ref:`bool<class_bool>` **tap2/active**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_tap2_active(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -219,7 +219,7 @@ If ``true``, ``tap2`` will be enabled.
|
||||
- :ref:`float<class_float>` **tap2/delay_ms**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | 500.0 |
|
||||
| *Default* | ``500.0`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_tap2_delay_ms(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -235,7 +235,7 @@ If ``true``, ``tap2`` will be enabled.
|
||||
- :ref:`float<class_float>` **tap2/level_db**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | -12.0 |
|
||||
| *Default* | ``-12.0`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_tap2_level_db(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -251,7 +251,7 @@ Sound level for ``tap2``.
|
||||
- :ref:`float<class_float>` **tap2/pan**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | -0.4 |
|
||||
| *Default* | ``-0.4`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_tap2_pan(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -25,17 +25,17 @@ By distorting the waveform the frequency content change, which will often make t
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------+--------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`drive<class_AudioEffectDistortion_property_drive>` | 0.0 |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`keep_hf_hz<class_AudioEffectDistortion_property_keep_hf_hz>` | 16000.0 |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+---------+
|
||||
| :ref:`Mode<enum_AudioEffectDistortion_Mode>` | :ref:`mode<class_AudioEffectDistortion_property_mode>` | 0 |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`post_gain<class_AudioEffectDistortion_property_post_gain>` | 0.0 |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`pre_gain<class_AudioEffectDistortion_property_pre_gain>` | 0.0 |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+---------+
|
||||
+----------------------------------------------+--------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`drive<class_AudioEffectDistortion_property_drive>` | ``0.0`` |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`keep_hf_hz<class_AudioEffectDistortion_property_keep_hf_hz>` | ``16000.0`` |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+-------------+
|
||||
| :ref:`Mode<enum_AudioEffectDistortion_Mode>` | :ref:`mode<class_AudioEffectDistortion_property_mode>` | ``0`` |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`post_gain<class_AudioEffectDistortion_property_post_gain>` | ``0.0`` |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`pre_gain<class_AudioEffectDistortion_property_pre_gain>` | ``0.0`` |
|
||||
+----------------------------------------------+--------------------------------------------------------------------+-------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -72,7 +72,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **drive**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_drive(value) |
|
||||
+-----------+------------------+
|
||||
@@ -88,7 +88,7 @@ Distortion power. Value can range from 0 to 1.
|
||||
- :ref:`float<class_float>` **keep_hf_hz**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 16000.0 |
|
||||
| *Default* | ``16000.0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_keep_hf_hz(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -104,7 +104,7 @@ High-pass filter, in Hz. Frequencies higher than this value will not be affected
|
||||
- :ref:`Mode<enum_AudioEffectDistortion_Mode>` **mode**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_mode(value) |
|
||||
+-----------+-----------------+
|
||||
@@ -120,7 +120,7 @@ Distortion type.
|
||||
- :ref:`float<class_float>` **post_gain**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_post_gain(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -136,7 +136,7 @@ Increases or decreases the volume after the effect. Value can range from -80 to
|
||||
- :ref:`float<class_float>` **pre_gain**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_pre_gain(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -23,15 +23,15 @@ Allows frequencies other than the :ref:`cutoff_hz<class_AudioEffectFilter_proper
|
||||
Properties
|
||||
----------
|
||||
|
||||
+--------------------------------------------------+--------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` | 2000.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+--------+
|
||||
| :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` | :ref:`db<class_AudioEffectFilter_property_db>` | 0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectFilter_property_gain>` | 1.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`resonance<class_AudioEffectFilter_property_resonance>` | 0.5 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+--------+
|
||||
+--------------------------------------------------+--------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` | ``2000.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+------------+
|
||||
| :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` | :ref:`db<class_AudioEffectFilter_property_db>` | ``0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectFilter_property_gain>` | ``1.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`resonance<class_AudioEffectFilter_property_resonance>` | ``0.5`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------+------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -64,7 +64,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **cutoff_hz**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 2000.0 |
|
||||
| *Default* | ``2000.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_cutoff(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -80,7 +80,7 @@ Threshold frequency for the filter, in Hz.
|
||||
- :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **db**
|
||||
|
||||
+-----------+---------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------+
|
||||
| *Setter* | set_db(value) |
|
||||
+-----------+---------------+
|
||||
@@ -94,7 +94,7 @@ Threshold frequency for the filter, in Hz.
|
||||
- :ref:`float<class_float>` **gain**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_gain(value) |
|
||||
+-----------+-----------------+
|
||||
@@ -110,7 +110,7 @@ Gain amount of the frequencies after the filter.
|
||||
- :ref:`float<class_float>` **resonance**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0.5 |
|
||||
| *Default* | ``0.5`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_resonance(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -23,15 +23,15 @@ Soft clipping starts to reduce the peaks a little below the threshold level and
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------------------------------------------------------+------+
|
||||
| :ref:`float<class_float>` | :ref:`ceiling_db<class_AudioEffectLimiter_property_ceiling_db>` | -0.1 |
|
||||
+---------------------------+---------------------------------------------------------------------------+------+
|
||||
| :ref:`float<class_float>` | :ref:`soft_clip_db<class_AudioEffectLimiter_property_soft_clip_db>` | 2.0 |
|
||||
+---------------------------+---------------------------------------------------------------------------+------+
|
||||
| :ref:`float<class_float>` | :ref:`soft_clip_ratio<class_AudioEffectLimiter_property_soft_clip_ratio>` | 10.0 |
|
||||
+---------------------------+---------------------------------------------------------------------------+------+
|
||||
| :ref:`float<class_float>` | :ref:`threshold_db<class_AudioEffectLimiter_property_threshold_db>` | 0.0 |
|
||||
+---------------------------+---------------------------------------------------------------------------+------+
|
||||
+---------------------------+---------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`ceiling_db<class_AudioEffectLimiter_property_ceiling_db>` | ``-0.1`` |
|
||||
+---------------------------+---------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`soft_clip_db<class_AudioEffectLimiter_property_soft_clip_db>` | ``2.0`` |
|
||||
+---------------------------+---------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`soft_clip_ratio<class_AudioEffectLimiter_property_soft_clip_ratio>` | ``10.0`` |
|
||||
+---------------------------+---------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`threshold_db<class_AudioEffectLimiter_property_threshold_db>` | ``0.0`` |
|
||||
+---------------------------+---------------------------------------------------------------------------+----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -41,7 +41,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **ceiling_db**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | -0.1 |
|
||||
| *Default* | ``-0.1`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_ceiling_db(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -57,7 +57,7 @@ The waveform's maximum allowed value, in decibels. Value can range from -20 to -
|
||||
- :ref:`float<class_float>` **soft_clip_db**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 2.0 |
|
||||
| *Default* | ``2.0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_soft_clip_db(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -73,7 +73,7 @@ Applies a gain to the limited waves, in decibels. Value can range from 0 to 6.
|
||||
- :ref:`float<class_float>` **soft_clip_ratio**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | 10.0 |
|
||||
| *Default* | ``10.0`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_soft_clip_ratio(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -87,7 +87,7 @@ Applies a gain to the limited waves, in decibels. Value can range from 0 to 6.
|
||||
- :ref:`float<class_float>` **threshold_db**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_threshold_db(value) |
|
||||
+-----------+-------------------------+
|
||||
|
||||
@@ -21,9 +21,9 @@ Determines how much of an audio signal is sent to the left and right buses.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+--------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`pan<class_AudioEffectPanner_property_pan>` | 0.0 |
|
||||
+---------------------------+--------------------------------------------------+-----+
|
||||
+---------------------------+--------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`pan<class_AudioEffectPanner_property_pan>` | ``0.0`` |
|
||||
+---------------------------+--------------------------------------------------+---------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -33,7 +33,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **pan**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_pan(value) |
|
||||
+-----------+----------------+
|
||||
|
||||
@@ -23,17 +23,17 @@ Combines phase-shifted signals with the original signal. The movement of the pha
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+--------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_AudioEffectPhaser_property_depth>` | 1.0 |
|
||||
+---------------------------+--------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback<class_AudioEffectPhaser_property_feedback>` | 0.7 |
|
||||
+---------------------------+--------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`range_max_hz<class_AudioEffectPhaser_property_range_max_hz>` | 1600.0 |
|
||||
+---------------------------+--------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`range_min_hz<class_AudioEffectPhaser_property_range_min_hz>` | 440.0 |
|
||||
+---------------------------+--------------------------------------------------------------------+--------+
|
||||
| :ref:`float<class_float>` | :ref:`rate_hz<class_AudioEffectPhaser_property_rate_hz>` | 0.5 |
|
||||
+---------------------------+--------------------------------------------------------------------+--------+
|
||||
+---------------------------+--------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_AudioEffectPhaser_property_depth>` | ``1.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`feedback<class_AudioEffectPhaser_property_feedback>` | ``0.7`` |
|
||||
+---------------------------+--------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`range_max_hz<class_AudioEffectPhaser_property_range_max_hz>` | ``1600.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`range_min_hz<class_AudioEffectPhaser_property_range_min_hz>` | ``440.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------+------------+
|
||||
| :ref:`float<class_float>` | :ref:`rate_hz<class_AudioEffectPhaser_property_rate_hz>` | ``0.5`` |
|
||||
+---------------------------+--------------------------------------------------------------------+------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -43,7 +43,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **depth**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_depth(value) |
|
||||
+-----------+------------------+
|
||||
@@ -59,7 +59,7 @@ Governs how high the filter frequencies sweep. Low value will primarily affect b
|
||||
- :ref:`float<class_float>` **feedback**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.7 |
|
||||
| *Default* | ``0.7`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_feedback(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -75,7 +75,7 @@ Output percent of modified sound. Value can range from 0.1 to 0.9.
|
||||
- :ref:`float<class_float>` **range_max_hz**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 1600.0 |
|
||||
| *Default* | ``1600.0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_range_max_hz(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -91,7 +91,7 @@ Determines the maximum frequency affected by the LFO modulations, in Hz. Value c
|
||||
- :ref:`float<class_float>` **range_min_hz**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 440.0 |
|
||||
| *Default* | ``440.0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_range_min_hz(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -107,7 +107,7 @@ Determines the minimum frequency affected by the LFO modulations, in Hz. Value c
|
||||
- :ref:`float<class_float>` **rate_hz**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | 0.5 |
|
||||
| *Default* | ``0.5`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_rate_hz(value) |
|
||||
+-----------+--------------------+
|
||||
|
||||
@@ -23,13 +23,13 @@ Allows modulation of pitch independently of tempo. All frequencies can be increa
|
||||
Properties
|
||||
----------
|
||||
|
||||
+------------------------------------------------------+------------------------------------------------------------------------+-----+
|
||||
| :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` | :ref:`fft_size<class_AudioEffectPitchShift_property_fft_size>` | 3 |
|
||||
+------------------------------------------------------+------------------------------------------------------------------------+-----+
|
||||
| :ref:`int<class_int>` | :ref:`oversampling<class_AudioEffectPitchShift_property_oversampling>` | 4 |
|
||||
+------------------------------------------------------+------------------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` | 1.0 |
|
||||
+------------------------------------------------------+------------------------------------------------------------------------+-----+
|
||||
+------------------------------------------------------+------------------------------------------------------------------------+---------+
|
||||
| :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` | :ref:`fft_size<class_AudioEffectPitchShift_property_fft_size>` | ``3`` |
|
||||
+------------------------------------------------------+------------------------------------------------------------------------+---------+
|
||||
| :ref:`int<class_int>` | :ref:`oversampling<class_AudioEffectPitchShift_property_oversampling>` | ``4`` |
|
||||
+------------------------------------------------------+------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` | ``1.0`` |
|
||||
+------------------------------------------------------+------------------------------------------------------------------------+---------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -70,7 +70,7 @@ Property Descriptions
|
||||
- :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` **fft_size**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 3 |
|
||||
| *Default* | ``3`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_fft_size(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -84,7 +84,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **oversampling**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 4 |
|
||||
| *Default* | ``4`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_oversampling(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -98,7 +98,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **pitch_scale**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_pitch_scale(value) |
|
||||
+-----------+------------------------+
|
||||
|
||||
@@ -16,9 +16,9 @@ AudioEffectRecord
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------+--------------------------------------------------------+---+
|
||||
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioEffectRecord_property_format>` | 1 |
|
||||
+----------------------------------------------+--------------------------------------------------------+---+
|
||||
+----------------------------------------------+--------------------------------------------------------+-------+
|
||||
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioEffectRecord_property_format>` | ``1`` |
|
||||
+----------------------------------------------+--------------------------------------------------------+-------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -39,7 +39,7 @@ Property Descriptions
|
||||
- :ref:`Format<enum_AudioStreamSample_Format>` **format**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_format(value) |
|
||||
+-----------+-------------------+
|
||||
|
||||
@@ -23,23 +23,23 @@ Simulates rooms of different sizes. Its parameters can be adjusted to simulate t
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`damping<class_AudioEffectReverb_property_damping>` | 0.5 |
|
||||
+---------------------------+------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectReverb_property_dry>` | 1.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`hipass<class_AudioEffectReverb_property_hipass>` | 0.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`predelay_feedback<class_AudioEffectReverb_property_predelay_feedback>` | 0.4 |
|
||||
+---------------------------+------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`predelay_msec<class_AudioEffectReverb_property_predelay_msec>` | 150.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`room_size<class_AudioEffectReverb_property_room_size>` | 0.8 |
|
||||
+---------------------------+------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`spread<class_AudioEffectReverb_property_spread>` | 1.0 |
|
||||
+---------------------------+------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectReverb_property_wet>` | 0.5 |
|
||||
+---------------------------+------------------------------------------------------------------------------+-------+
|
||||
+---------------------------+------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`damping<class_AudioEffectReverb_property_damping>` | ``0.5`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectReverb_property_dry>` | ``1.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`hipass<class_AudioEffectReverb_property_hipass>` | ``0.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`predelay_feedback<class_AudioEffectReverb_property_predelay_feedback>` | ``0.4`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`predelay_msec<class_AudioEffectReverb_property_predelay_msec>` | ``150.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`room_size<class_AudioEffectReverb_property_room_size>` | ``0.8`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`spread<class_AudioEffectReverb_property_spread>` | ``1.0`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectReverb_property_wet>` | ``0.5`` |
|
||||
+---------------------------+------------------------------------------------------------------------------+-----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -49,7 +49,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **damping**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | 0.5 |
|
||||
| *Default* | ``0.5`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_damping(value) |
|
||||
+-----------+--------------------+
|
||||
@@ -65,7 +65,7 @@ Defines how reflective the imaginary room's walls are. Value can range from 0 to
|
||||
- :ref:`float<class_float>` **dry**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_dry(value) |
|
||||
+-----------+----------------+
|
||||
@@ -81,7 +81,7 @@ Output percent of original sound. At 0, only modified sound is outputted. Value
|
||||
- :ref:`float<class_float>` **hipass**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_hpf(value) |
|
||||
+-----------+----------------+
|
||||
@@ -97,7 +97,7 @@ High-pass filter passes signals with a frequency higher than a certain cutoff fr
|
||||
- :ref:`float<class_float>` **predelay_feedback**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | 0.4 |
|
||||
| *Default* | ``0.4`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_predelay_feedback(value) |
|
||||
+-----------+------------------------------+
|
||||
@@ -113,7 +113,7 @@ Output percent of predelay. Value can range from 0 to 1.
|
||||
- :ref:`float<class_float>` **predelay_msec**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | 150.0 |
|
||||
| *Default* | ``150.0`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_predelay_msec(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -129,7 +129,7 @@ Time between the original signal and the early reflections of the reverb signal,
|
||||
- :ref:`float<class_float>` **room_size**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0.8 |
|
||||
| *Default* | ``0.8`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_room_size(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -145,7 +145,7 @@ Dimensions of simulated room. Bigger means more echoes. Value can range from 0 t
|
||||
- :ref:`float<class_float>` **spread**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_spread(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -161,7 +161,7 @@ Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Val
|
||||
- :ref:`float<class_float>` **wet**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | 0.5 |
|
||||
| *Default* | ``0.5`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_wet(value) |
|
||||
+-----------+----------------+
|
||||
|
||||
@@ -16,13 +16,13 @@ AudioEffectSpectrumAnalyzer
|
||||
Properties
|
||||
----------
|
||||
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+------+
|
||||
| :ref:`float<class_float>` | :ref:`buffer_length<class_AudioEffectSpectrumAnalyzer_property_buffer_length>` | 2.0 |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+------+
|
||||
| :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` | :ref:`fft_size<class_AudioEffectSpectrumAnalyzer_property_fft_size>` | 2 |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+------+
|
||||
| :ref:`float<class_float>` | :ref:`tap_back_pos<class_AudioEffectSpectrumAnalyzer_property_tap_back_pos>` | 0.01 |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+------+
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`buffer_length<class_AudioEffectSpectrumAnalyzer_property_buffer_length>` | ``2.0`` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+----------+
|
||||
| :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` | :ref:`fft_size<class_AudioEffectSpectrumAnalyzer_property_fft_size>` | ``2`` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`tap_back_pos<class_AudioEffectSpectrumAnalyzer_property_tap_back_pos>` | ``0.01`` |
|
||||
+------------------------------------------------------------+--------------------------------------------------------------------------------+----------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -63,7 +63,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **buffer_length**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | 2.0 |
|
||||
| *Default* | ``2.0`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_buffer_length(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -77,7 +77,7 @@ Property Descriptions
|
||||
- :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` **fft_size**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 2 |
|
||||
| *Default* | ``2`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_fft_size(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -91,7 +91,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **tap_back_pos**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 0.01 |
|
||||
| *Default* | ``0.01`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_tap_back_pos(value) |
|
||||
+-----------+-------------------------+
|
||||
|
||||
@@ -16,13 +16,13 @@ AudioEffectStereoEnhance
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`pan_pullout<class_AudioEffectStereoEnhance_property_pan_pullout>` | 1.0 |
|
||||
+---------------------------+---------------------------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`surround<class_AudioEffectStereoEnhance_property_surround>` | 0.0 |
|
||||
+---------------------------+---------------------------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`time_pullout_ms<class_AudioEffectStereoEnhance_property_time_pullout_ms>` | 0.0 |
|
||||
+---------------------------+---------------------------------------------------------------------------------+-----+
|
||||
+---------------------------+---------------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`pan_pullout<class_AudioEffectStereoEnhance_property_pan_pullout>` | ``1.0`` |
|
||||
+---------------------------+---------------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`surround<class_AudioEffectStereoEnhance_property_surround>` | ``0.0`` |
|
||||
+---------------------------+---------------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`time_pullout_ms<class_AudioEffectStereoEnhance_property_time_pullout_ms>` | ``0.0`` |
|
||||
+---------------------------+---------------------------------------------------------------------------------+---------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -32,7 +32,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **pan_pullout**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_pan_pullout(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -46,7 +46,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **surround**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_surround(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -60,7 +60,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **time_pullout_ms**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_time_pullout(value) |
|
||||
+-----------+-------------------------+
|
||||
|
||||
@@ -26,15 +26,15 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`int<class_int>` | :ref:`bus_count<class_AudioServer_property_bus_count>` | 1 |
|
||||
+-----------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`capture_device<class_AudioServer_property_capture_device>` | "" |
|
||||
+-----------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`device<class_AudioServer_property_device>` | "Default" |
|
||||
+-----------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`global_rate_scale<class_AudioServer_property_global_rate_scale>` | 1.0 |
|
||||
+-----------------------------+------------------------------------------------------------------------+-----------+
|
||||
+-----------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`int<class_int>` | :ref:`bus_count<class_AudioServer_property_bus_count>` | ``1`` |
|
||||
+-----------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`String<class_String>` | :ref:`capture_device<class_AudioServer_property_capture_device>` | ``""`` |
|
||||
+-----------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`String<class_String>` | :ref:`device<class_AudioServer_property_device>` | ``"Default"`` |
|
||||
+-----------------------------+------------------------------------------------------------------------+---------------+
|
||||
| :ref:`float<class_float>` | :ref:`global_rate_scale<class_AudioServer_property_global_rate_scale>` | ``1.0`` |
|
||||
+-----------------------------+------------------------------------------------------------------------+---------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -179,7 +179,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **bus_count**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_bus_count(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -195,7 +195,7 @@ Number of available audio buses.
|
||||
- :ref:`String<class_String>` **capture_device**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | "" |
|
||||
| *Default* | ``""`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | capture_set_device(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -211,7 +211,7 @@ Name of the current device for audio input (see :ref:`capture_get_device_list<cl
|
||||
- :ref:`String<class_String>` **device**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | "Default" |
|
||||
| *Default* | ``"Default"`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_device(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -227,7 +227,7 @@ Name of the current device for audio output (see :ref:`get_device_list<class_Aud
|
||||
- :ref:`float<class_float>` **global_rate_scale**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_global_rate_scale(value) |
|
||||
+-----------+------------------------------+
|
||||
|
||||
@@ -21,11 +21,11 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`buffer_length<class_AudioStreamGenerator_property_buffer_length>` | 0.5 |
|
||||
+---------------------------+-------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`mix_rate<class_AudioStreamGenerator_property_mix_rate>` | 44100.0 |
|
||||
+---------------------------+-------------------------------------------------------------------------+---------+
|
||||
+---------------------------+-------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`buffer_length<class_AudioStreamGenerator_property_buffer_length>` | ``0.5`` |
|
||||
+---------------------------+-------------------------------------------------------------------------+-------------+
|
||||
| :ref:`float<class_float>` | :ref:`mix_rate<class_AudioStreamGenerator_property_mix_rate>` | ``44100.0`` |
|
||||
+---------------------------+-------------------------------------------------------------------------+-------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -35,7 +35,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **buffer_length**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | 0.5 |
|
||||
| *Default* | ``0.5`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_buffer_length(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -49,7 +49,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **mix_rate**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 44100.0 |
|
||||
| *Default* | ``44100.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_mix_rate(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -21,13 +21,13 @@ OGG Vorbis audio stream driver.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamOGGVorbis_property_data>` | PoolByteArray( ) |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`loop<class_AudioStreamOGGVorbis_property_loop>` | false |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`loop_offset<class_AudioStreamOGGVorbis_property_loop_offset>` | 0.0 |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-------------------+
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamOGGVorbis_property_data>` | ``PoolByteArray( )`` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`loop<class_AudioStreamOGGVorbis_property_loop>` | ``false`` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`loop_offset<class_AudioStreamOGGVorbis_property_loop_offset>` | ``0.0`` |
|
||||
+-------------------------------------------+---------------------------------------------------------------------+-----------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -36,13 +36,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`PoolByteArray<class_PoolByteArray>` **data**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | PoolByteArray( ) |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_data(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_data() |
|
||||
+-----------+-------------------+
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``PoolByteArray( )`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_data(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_data() |
|
||||
+-----------+-----------------------+
|
||||
|
||||
Contains the audio data in bytes.
|
||||
|
||||
@@ -53,7 +53,7 @@ Contains the audio data in bytes.
|
||||
- :ref:`bool<class_bool>` **loop**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_loop(value) |
|
||||
+-----------+-----------------+
|
||||
@@ -69,7 +69,7 @@ If ``true``, the stream will automatically loop when it reaches the end.
|
||||
- :ref:`float<class_float>` **loop_offset**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_loop_offset(value) |
|
||||
+-----------+------------------------+
|
||||
|
||||
@@ -26,23 +26,23 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer_property_autoplay>` | false |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+----------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer_property_bus>` | "Master" |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+----------+
|
||||
| :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` | :ref:`mix_target<class_AudioStreamPlayer_property_mix_target>` | 0 |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer_property_pitch_scale>` | 1.0 |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer_property_playing>` | false |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+----------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer_property_stream>` | |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer_property_stream_paused>` | false |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer_property_volume_db>` | 0.0 |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+----------+
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer_property_autoplay>` | ``false`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer_property_bus>` | ``"Master"`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` | :ref:`mix_target<class_AudioStreamPlayer_property_mix_target>` | ``0`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer_property_pitch_scale>` | ``1.0`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer_property_playing>` | ``false`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer_property_stream>` | |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer_property_stream_paused>` | ``false`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer_property_volume_db>` | ``0.0`` |
|
||||
+----------------------------------------------------+----------------------------------------------------------------------+--------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -95,7 +95,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **autoplay**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_autoplay(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -111,7 +111,7 @@ If ``true``, audio plays when added to scene tree.
|
||||
- :ref:`String<class_String>` **bus**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | "Master" |
|
||||
| *Default* | ``"Master"`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_bus(value) |
|
||||
+-----------+----------------+
|
||||
@@ -127,7 +127,7 @@ Bus on which this audio is playing.
|
||||
- :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` **mix_target**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_mix_target(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -143,7 +143,7 @@ If the audio configuration has more than two speakers, this sets the target chan
|
||||
- :ref:`float<class_float>` **pitch_scale**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_pitch_scale(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -159,7 +159,7 @@ Changes the pitch and the tempo of the audio.
|
||||
- :ref:`bool<class_bool>` **playing**
|
||||
|
||||
+-----------+--------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------+
|
||||
| *Getter* | is_playing() |
|
||||
+-----------+--------------+
|
||||
@@ -187,7 +187,7 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
|
||||
- :ref:`bool<class_bool>` **stream_paused**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_stream_paused(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -203,7 +203,7 @@ If ``true``, the playback is paused. You can resume it by setting ``stream_pause
|
||||
- :ref:`float<class_float>` **volume_db**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_volume_db(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -26,27 +26,27 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer2D_property_area_mask>` | 1 |
|
||||
+---------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation<class_AudioStreamPlayer2D_property_attenuation>` | 1.0 |
|
||||
+---------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer2D_property_autoplay>` | false |
|
||||
+---------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer2D_property_bus>` | "Master" |
|
||||
+---------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer2D_property_max_distance>` | 2000.0 |
|
||||
+---------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer2D_property_pitch_scale>` | 1.0 |
|
||||
+---------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer2D_property_playing>` | false |
|
||||
+---------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer2D_property_stream>` | |
|
||||
+---------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer2D_property_stream_paused>` | false |
|
||||
+---------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer2D_property_volume_db>` | 0.0 |
|
||||
+---------------------------------------+------------------------------------------------------------------------+----------+
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer2D_property_area_mask>` | ``1`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation<class_AudioStreamPlayer2D_property_attenuation>` | ``1.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer2D_property_autoplay>` | ``false`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer2D_property_bus>` | ``"Master"`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer2D_property_max_distance>` | ``2000.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer2D_property_pitch_scale>` | ``1.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer2D_property_playing>` | ``false`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer2D_property_stream>` | |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer2D_property_stream_paused>` | ``false`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer2D_property_volume_db>` | ``0.0`` |
|
||||
+---------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -80,7 +80,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **area_mask**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_area_mask(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -96,7 +96,7 @@ Areas in which this sound plays.
|
||||
- :ref:`float<class_float>` **attenuation**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_attenuation(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -112,7 +112,7 @@ Dampens audio over distance with this as an exponent.
|
||||
- :ref:`bool<class_bool>` **autoplay**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_autoplay(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -128,7 +128,7 @@ If ``true``, audio plays when added to scene tree.
|
||||
- :ref:`String<class_String>` **bus**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | "Master" |
|
||||
| *Default* | ``"Master"`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_bus(value) |
|
||||
+-----------+----------------+
|
||||
@@ -144,7 +144,7 @@ Bus on which this audio is playing.
|
||||
- :ref:`float<class_float>` **max_distance**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 2000.0 |
|
||||
| *Default* | ``2000.0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_max_distance(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -160,7 +160,7 @@ Maximum distance from which audio is still hearable.
|
||||
- :ref:`float<class_float>` **pitch_scale**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_pitch_scale(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -176,7 +176,7 @@ Changes the pitch and the tempo of the audio.
|
||||
- :ref:`bool<class_bool>` **playing**
|
||||
|
||||
+-----------+--------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------+
|
||||
| *Getter* | is_playing() |
|
||||
+-----------+--------------+
|
||||
@@ -204,7 +204,7 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
|
||||
- :ref:`bool<class_bool>` **stream_paused**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_stream_paused(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -220,7 +220,7 @@ If ``true``, the playback is paused. You can resume it by setting ``stream_pause
|
||||
- :ref:`float<class_float>` **volume_db**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_volume_db(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -26,45 +26,45 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer3D_property_area_mask>` | 1 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz>` | 5000.0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_db<class_AudioStreamPlayer3D_property_attenuation_filter_db>` | -24.0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` | :ref:`attenuation_model<class_AudioStreamPlayer3D_property_attenuation_model>` | 0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer3D_property_autoplay>` | false |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer3D_property_bus>` | "Master" |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` | :ref:`doppler_tracking<class_AudioStreamPlayer3D_property_doppler_tracking>` | 0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_degrees<class_AudioStreamPlayer3D_property_emission_angle_degrees>` | 45.0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emission_angle_enabled<class_AudioStreamPlayer3D_property_emission_angle_enabled>` | false |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db>` | -12.0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`max_db<class_AudioStreamPlayer3D_property_max_db>` | 3.0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` | 0.0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` | :ref:`out_of_range_mode<class_AudioStreamPlayer3D_property_out_of_range_mode>` | 0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer3D_property_pitch_scale>` | 1.0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer3D_property_playing>` | false |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer3D_property_stream>` | |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer3D_property_stream_paused>` | false |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_db<class_AudioStreamPlayer3D_property_unit_db>` | 0.0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_size<class_AudioStreamPlayer3D_property_unit_size>` | 1.0 |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer3D_property_area_mask>` | ``1`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz>` | ``5000.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`attenuation_filter_db<class_AudioStreamPlayer3D_property_attenuation_filter_db>` | ``-24.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` | :ref:`attenuation_model<class_AudioStreamPlayer3D_property_attenuation_model>` | ``0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer3D_property_autoplay>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer3D_property_bus>` | ``"Master"`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` | :ref:`doppler_tracking<class_AudioStreamPlayer3D_property_doppler_tracking>` | ``0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_degrees<class_AudioStreamPlayer3D_property_emission_angle_degrees>` | ``45.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emission_angle_enabled<class_AudioStreamPlayer3D_property_emission_angle_enabled>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db>` | ``-12.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_db<class_AudioStreamPlayer3D_property_max_db>` | ``3.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` | ``0.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` | :ref:`out_of_range_mode<class_AudioStreamPlayer3D_property_out_of_range_mode>` | ``0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer3D_property_pitch_scale>` | ``1.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer3D_property_playing>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer3D_property_stream>` | |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer3D_property_stream_paused>` | ``false`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_db<class_AudioStreamPlayer3D_property_unit_db>` | ``0.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
| :ref:`float<class_float>` | :ref:`unit_size<class_AudioStreamPlayer3D_property_unit_size>` | ``1.0`` |
|
||||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -153,7 +153,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **area_mask**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_area_mask(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -169,7 +169,7 @@ Areas in which this sound plays.
|
||||
- :ref:`float<class_float>` **attenuation_filter_cutoff_hz**
|
||||
|
||||
+-----------+-----------------------------------------+
|
||||
| *Default* | 5000.0 |
|
||||
| *Default* | ``5000.0`` |
|
||||
+-----------+-----------------------------------------+
|
||||
| *Setter* | set_attenuation_filter_cutoff_hz(value) |
|
||||
+-----------+-----------------------------------------+
|
||||
@@ -185,7 +185,7 @@ Dampens audio above this frequency, in Hz.
|
||||
- :ref:`float<class_float>` **attenuation_filter_db**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | -24.0 |
|
||||
| *Default* | ``-24.0`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_attenuation_filter_db(value) |
|
||||
+-----------+----------------------------------+
|
||||
@@ -201,7 +201,7 @@ Amount how much the filter affects the loudness, in dB.
|
||||
- :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` **attenuation_model**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_attenuation_model(value) |
|
||||
+-----------+------------------------------+
|
||||
@@ -217,7 +217,7 @@ Decides if audio should get quieter with distance linearly, quadratically, logar
|
||||
- :ref:`bool<class_bool>` **autoplay**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_autoplay(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -233,7 +233,7 @@ If ``true``, audio plays when added to scene tree.
|
||||
- :ref:`String<class_String>` **bus**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | "Master" |
|
||||
| *Default* | ``"Master"`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_bus(value) |
|
||||
+-----------+----------------+
|
||||
@@ -249,7 +249,7 @@ Bus on which this audio is playing.
|
||||
- :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` **doppler_tracking**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_doppler_tracking(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -265,7 +265,7 @@ Decides in which step the Doppler effect should be calculated.
|
||||
- :ref:`float<class_float>` **emission_angle_degrees**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 45.0 |
|
||||
| *Default* | ``45.0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_emission_angle(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -281,7 +281,7 @@ The angle in which the audio reaches cameras undampened.
|
||||
- :ref:`bool<class_bool>` **emission_angle_enabled**
|
||||
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------------------------+
|
||||
| *Setter* | set_emission_angle_enabled(value) |
|
||||
+-----------+-----------------------------------+
|
||||
@@ -297,7 +297,7 @@ If ``true``, the audio should be dampened according to the direction of the soun
|
||||
- :ref:`float<class_float>` **emission_angle_filter_attenuation_db**
|
||||
|
||||
+-----------+-------------------------------------------------+
|
||||
| *Default* | -12.0 |
|
||||
| *Default* | ``-12.0`` |
|
||||
+-----------+-------------------------------------------------+
|
||||
| *Setter* | set_emission_angle_filter_attenuation_db(value) |
|
||||
+-----------+-------------------------------------------------+
|
||||
@@ -313,7 +313,7 @@ Dampens audio if camera is outside of :ref:`emission_angle_degrees<class_AudioSt
|
||||
- :ref:`float<class_float>` **max_db**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 3.0 |
|
||||
| *Default* | ``3.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_max_db(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -329,7 +329,7 @@ Sets the absolute maximum of the soundlevel, in dB.
|
||||
- :ref:`float<class_float>` **max_distance**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_max_distance(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -345,7 +345,7 @@ Sets the distance from which the :ref:`out_of_range_mode<class_AudioStreamPlayer
|
||||
- :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` **out_of_range_mode**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_out_of_range_mode(value) |
|
||||
+-----------+------------------------------+
|
||||
@@ -361,7 +361,7 @@ Decides if audio should pause when source is outside of :ref:`max_distance<class
|
||||
- :ref:`float<class_float>` **pitch_scale**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_pitch_scale(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -377,7 +377,7 @@ Changes the pitch and the tempo of the audio.
|
||||
- :ref:`bool<class_bool>` **playing**
|
||||
|
||||
+-----------+--------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------+
|
||||
| *Getter* | is_playing() |
|
||||
+-----------+--------------+
|
||||
@@ -405,7 +405,7 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
|
||||
- :ref:`bool<class_bool>` **stream_paused**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_stream_paused(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -421,7 +421,7 @@ If ``true``, the playback is paused. You can resume it by setting ``stream_pause
|
||||
- :ref:`float<class_float>` **unit_db**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_unit_db(value) |
|
||||
+-----------+--------------------+
|
||||
@@ -437,7 +437,7 @@ Base sound level unaffected by dampening, in dB.
|
||||
- :ref:`float<class_float>` **unit_size**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_unit_size(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -21,11 +21,11 @@ Randomly varies pitch on each start.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------+-------------------------------------------------------------------------+-----+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_property_audio_stream>` | |
|
||||
+---------------------------------------+-------------------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_property_random_pitch>` | 1.1 |
|
||||
+---------------------------------------+-------------------------------------------------------------------------+-----+
|
||||
+---------------------------------------+-------------------------------------------------------------------------+---------+
|
||||
| :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_property_audio_stream>` | |
|
||||
+---------------------------------------+-------------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_property_random_pitch>` | ``1.1`` |
|
||||
+---------------------------------------+-------------------------------------------------------------------------+---------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -49,7 +49,7 @@ The current :ref:`AudioStream<class_AudioStream>`.
|
||||
- :ref:`float<class_float>` **random_pitch**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 1.1 |
|
||||
| *Default* | ``1.1`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_random_pitch(value) |
|
||||
+-----------+-------------------------+
|
||||
|
||||
@@ -23,21 +23,21 @@ This class can also be used to store dynamically-generated PCM audio data.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamSample_property_data>` | PoolByteArray( ) |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------+
|
||||
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioStreamSample_property_format>` | 0 |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_begin<class_AudioStreamSample_property_loop_begin>` | 0 |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_end<class_AudioStreamSample_property_loop_end>` | 0 |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------+
|
||||
| :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` | :ref:`loop_mode<class_AudioStreamSample_property_loop_mode>` | 0 |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------+
|
||||
| :ref:`int<class_int>` | :ref:`mix_rate<class_AudioStreamSample_property_mix_rate>` | 44100 |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stereo<class_AudioStreamSample_property_stereo>` | false |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-------------------+
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamSample_property_data>` | ``PoolByteArray( )`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioStreamSample_property_format>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_begin<class_AudioStreamSample_property_loop_begin>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`loop_end<class_AudioStreamSample_property_loop_end>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` | :ref:`loop_mode<class_AudioStreamSample_property_loop_mode>` | ``0`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`mix_rate<class_AudioStreamSample_property_mix_rate>` | ``44100`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`stereo<class_AudioStreamSample_property_stereo>` | ``false`` |
|
||||
+--------------------------------------------------+----------------------------------------------------------------+-----------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -94,13 +94,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`PoolByteArray<class_PoolByteArray>` **data**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | PoolByteArray( ) |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_data(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_data() |
|
||||
+-----------+-------------------+
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``PoolByteArray( )`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_data(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_data() |
|
||||
+-----------+-----------------------+
|
||||
|
||||
Contains the audio data in bytes.
|
||||
|
||||
@@ -113,7 +113,7 @@ Contains the audio data in bytes.
|
||||
- :ref:`Format<enum_AudioStreamSample_Format>` **format**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_format(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -129,7 +129,7 @@ Audio format. See :ref:`Format<enum_AudioStreamSample_Format>` constants for val
|
||||
- :ref:`int<class_int>` **loop_begin**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_loop_begin(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -145,7 +145,7 @@ Loop start in bytes.
|
||||
- :ref:`int<class_int>` **loop_end**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_loop_end(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -161,7 +161,7 @@ Loop end in bytes.
|
||||
- :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` **loop_mode**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_loop_mode(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -177,7 +177,7 @@ Loop mode. See :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` constants for va
|
||||
- :ref:`int<class_int>` **mix_rate**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 44100 |
|
||||
| *Default* | ``44100`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_mix_rate(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -193,7 +193,7 @@ The sample rate for mixing this audio.
|
||||
- :ref:`bool<class_bool>` **stereo**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_stereo(value) |
|
||||
+-----------+-------------------+
|
||||
|
||||
@@ -21,11 +21,11 @@ Node for back-buffering the currently-displayed screen. The region defined in th
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+-----------------------------------------------------------+-------------------------------+
|
||||
| :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` | :ref:`copy_mode<class_BackBufferCopy_property_copy_mode>` | 1 |
|
||||
+-----------------------------------------------+-----------------------------------------------------------+-------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`rect<class_BackBufferCopy_property_rect>` | Rect2( -100, -100, 200, 200 ) |
|
||||
+-----------------------------------------------+-----------------------------------------------------------+-------------------------------+
|
||||
+-----------------------------------------------+-----------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` | :ref:`copy_mode<class_BackBufferCopy_property_copy_mode>` | ``1`` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Rect2<class_Rect2>` | :ref:`rect<class_BackBufferCopy_property_rect>` | ``Rect2( -100, -100, 200, 200 )`` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------+-----------------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -54,7 +54,7 @@ Property Descriptions
|
||||
- :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` **copy_mode**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_copy_mode(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -69,13 +69,13 @@ Buffer mode. See :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` constants.
|
||||
|
||||
- :ref:`Rect2<class_Rect2>` **rect**
|
||||
|
||||
+-----------+-------------------------------+
|
||||
| *Default* | Rect2( -100, -100, 200, 200 ) |
|
||||
+-----------+-------------------------------+
|
||||
| *Setter* | set_rect(value) |
|
||||
+-----------+-------------------------------+
|
||||
| *Getter* | get_rect() |
|
||||
+-----------+-------------------------------+
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | ``Rect2( -100, -100, 200, 200 )`` |
|
||||
+-----------+-----------------------------------+
|
||||
| *Setter* | set_rect(value) |
|
||||
+-----------+-----------------------------------+
|
||||
| *Getter* | get_rect() |
|
||||
+-----------+-----------------------------------+
|
||||
|
||||
The area covered by the BackBufferCopy. Only used if :ref:`copy_mode<class_BackBufferCopy_property_copy_mode>` is :ref:`COPY_MODE_RECT<class_BackBufferCopy_constant_COPY_MODE_RECT>`.
|
||||
|
||||
|
||||
@@ -26,29 +26,29 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_cell_size<class_BakedLightmap_property_bake_cell_size>` | 0.25 |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_default_texels_per_unit<class_BakedLightmap_property_bake_default_texels_per_unit>` | 20.0 |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_energy<class_BakedLightmap_property_bake_energy>` | 1.0 |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`bake_extents<class_BakedLightmap_property_bake_extents>` | Vector3( 10, 10, 10 ) |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bake_hdr<class_BakedLightmap_property_bake_hdr>` | false |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`BakeMode<enum_BakedLightmap_BakeMode>` | :ref:`bake_mode<class_BakedLightmap_property_bake_mode>` | 0 |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_propagation<class_BakedLightmap_property_bake_propagation>` | 1.0 |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` | :ref:`bake_quality<class_BakedLightmap_property_bake_quality>` | 1 |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`capture_cell_size<class_BakedLightmap_property_capture_cell_size>` | 0.5 |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`String<class_String>` | :ref:`image_path<class_BakedLightmap_property_image_path>` | "." |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`BakedLightmapData<class_BakedLightmapData>` | :ref:`light_data<class_BakedLightmap_property_light_data>` | |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------+
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_cell_size<class_BakedLightmap_property_bake_cell_size>` | ``0.25`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_default_texels_per_unit<class_BakedLightmap_property_bake_default_texels_per_unit>` | ``20.0`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_energy<class_BakedLightmap_property_bake_energy>` | ``1.0`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`bake_extents<class_BakedLightmap_property_bake_extents>` | ``Vector3( 10, 10, 10 )`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bake_hdr<class_BakedLightmap_property_bake_hdr>` | ``false`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`BakeMode<enum_BakedLightmap_BakeMode>` | :ref:`bake_mode<class_BakedLightmap_property_bake_mode>` | ``0`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`bake_propagation<class_BakedLightmap_property_bake_propagation>` | ``1.0`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` | :ref:`bake_quality<class_BakedLightmap_property_bake_quality>` | ``1`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`capture_cell_size<class_BakedLightmap_property_capture_cell_size>` | ``0.5`` |
|
||||
+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+
|
||||
| :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
|
||||
-------
|
||||
@@ -126,7 +126,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **bake_cell_size**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 0.25 |
|
||||
| *Default* | ``0.25`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_bake_cell_size(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -142,7 +142,7 @@ Grid subdivision size for lightmapper calculation. The default value will work f
|
||||
- :ref:`float<class_float>` **bake_default_texels_per_unit**
|
||||
|
||||
+-----------+-----------------------------------------+
|
||||
| *Default* | 20.0 |
|
||||
| *Default* | ``20.0`` |
|
||||
+-----------+-----------------------------------------+
|
||||
| *Setter* | set_bake_default_texels_per_unit(value) |
|
||||
+-----------+-----------------------------------------+
|
||||
@@ -158,7 +158,7 @@ If a :ref:`Mesh.lightmap_size_hint<class_Mesh_property_lightmap_size_hint>` isn'
|
||||
- :ref:`float<class_float>` **bake_energy**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_energy(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -173,13 +173,13 @@ Multiplies the light sources' intensity by this value. For instance, if the valu
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **bake_extents**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | Vector3( 10, 10, 10 ) |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_extents(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_extents() |
|
||||
+-----------+-----------------------+
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``Vector3( 10, 10, 10 )`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_extents(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | get_extents() |
|
||||
+-----------+---------------------------+
|
||||
|
||||
The size of the affected area.
|
||||
|
||||
@@ -190,7 +190,7 @@ The size of the affected area.
|
||||
- :ref:`bool<class_bool>` **bake_hdr**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_hdr(value) |
|
||||
+-----------+----------------+
|
||||
@@ -206,7 +206,7 @@ If ``true``, the lightmap can capture light values greater than ``1.0``. Turning
|
||||
- :ref:`BakeMode<enum_BakedLightmap_BakeMode>` **bake_mode**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_bake_mode(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -222,7 +222,7 @@ Lightmapping mode. See :ref:`BakeMode<enum_BakedLightmap_BakeMode>`.
|
||||
- :ref:`float<class_float>` **bake_propagation**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_propagation(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -238,7 +238,7 @@ Defines how far the light will travel before it is no longer effective. The high
|
||||
- :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` **bake_quality**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_bake_quality(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -254,7 +254,7 @@ Three quality modes are available. Higher quality requires more rendering time.
|
||||
- :ref:`float<class_float>` **capture_cell_size**
|
||||
|
||||
+-----------+------------------------------+
|
||||
| *Default* | 0.5 |
|
||||
| *Default* | ``0.5`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_capture_cell_size(value) |
|
||||
+-----------+------------------------------+
|
||||
@@ -270,7 +270,7 @@ Grid size used for real-time capture information on dynamic objects. Cannot be l
|
||||
- :ref:`String<class_String>` **image_path**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | "." |
|
||||
| *Default* | ``"."`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_image_path(value) |
|
||||
+-----------+-----------------------+
|
||||
|
||||
@@ -16,17 +16,17 @@ BakedLightmapData
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`bounds<class_BakedLightmapData_property_bounds>` | AABB( 0, 0, 0, 0, 0, 0 ) |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`cell_space_transform<class_BakedLightmapData_property_cell_space_transform>` | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`cell_subdiv<class_BakedLightmapData_property_cell_subdiv>` | 1 |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`energy<class_BakedLightmapData_property_energy>` | 1.0 |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`octree<class_BakedLightmapData_property_octree>` | PoolByteArray( ) |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`bounds<class_BakedLightmapData_property_bounds>` | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`Transform<class_Transform>` | :ref:`cell_space_transform<class_BakedLightmapData_property_cell_space_transform>` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`cell_subdiv<class_BakedLightmapData_property_cell_subdiv>` | ``1`` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`energy<class_BakedLightmapData_property_energy>` | ``1.0`` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`octree<class_BakedLightmapData_property_octree>` | ``PoolByteArray( )`` |
|
||||
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -50,13 +50,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`AABB<class_AABB>` **bounds**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | AABB( 0, 0, 0, 0, 0, 0 ) |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_bounds(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_bounds() |
|
||||
+-----------+--------------------------+
|
||||
+-----------+------------------------------+
|
||||
| *Default* | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
|
||||
+-----------+------------------------------+
|
||||
| *Setter* | set_bounds(value) |
|
||||
+-----------+------------------------------+
|
||||
| *Getter* | get_bounds() |
|
||||
+-----------+------------------------------+
|
||||
|
||||
----
|
||||
|
||||
@@ -64,13 +64,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`Transform<class_Transform>` **cell_space_transform**
|
||||
|
||||
+-----------+-------------------------------------------------+
|
||||
| *Default* | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) |
|
||||
+-----------+-------------------------------------------------+
|
||||
| *Setter* | set_cell_space_transform(value) |
|
||||
+-----------+-------------------------------------------------+
|
||||
| *Getter* | get_cell_space_transform() |
|
||||
+-----------+-------------------------------------------------+
|
||||
+-----------+-----------------------------------------------------+
|
||||
| *Default* | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
|
||||
+-----------+-----------------------------------------------------+
|
||||
| *Setter* | set_cell_space_transform(value) |
|
||||
+-----------+-----------------------------------------------------+
|
||||
| *Getter* | get_cell_space_transform() |
|
||||
+-----------+-----------------------------------------------------+
|
||||
|
||||
----
|
||||
|
||||
@@ -79,7 +79,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **cell_subdiv**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_cell_subdiv(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -93,7 +93,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **energy**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_energy(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -106,13 +106,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`PoolByteArray<class_PoolByteArray>` **octree**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | PoolByteArray( ) |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_octree(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_octree() |
|
||||
+-----------+-------------------+
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``PoolByteArray( )`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_octree(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_octree() |
|
||||
+-----------+-----------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
@@ -23,29 +23,29 @@ BaseButton is the abstract base class for buttons, so it shouldn't be used direc
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
| :ref:`ActionMode<enum_BaseButton_ActionMode>` | :ref:`action_mode<class_BaseButton_property_action_mode>` | 1 |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
| :ref:`int<class_int>` | :ref:`button_mask<class_BaseButton_property_button_mask>` | 1 |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_BaseButton_property_disabled>` | false |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`enabled_focus_mode<class_BaseButton_property_enabled_focus_mode>` | 2 |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
| :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | **O:** 2 |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
| :ref:`ButtonGroup<class_ButtonGroup>` | :ref:`group<class_BaseButton_property_group>` | |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`keep_pressed_outside<class_BaseButton_property_keep_pressed_outside>` | false |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`pressed<class_BaseButton_property_pressed>` | false |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
| :ref:`ShortCut<class_ShortCut>` | :ref:`shortcut<class_BaseButton_property_shortcut>` | |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shortcut_in_tooltip<class_BaseButton_property_shortcut_in_tooltip>` | true |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` | false |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+----------+
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
| :ref:`ActionMode<enum_BaseButton_ActionMode>` | :ref:`action_mode<class_BaseButton_property_action_mode>` | ``1`` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | :ref:`button_mask<class_BaseButton_property_button_mask>` | ``1`` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_BaseButton_property_disabled>` | ``false`` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`enabled_focus_mode<class_BaseButton_property_enabled_focus_mode>` | ``2`` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
| :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | **O:** ``2`` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
| :ref:`ButtonGroup<class_ButtonGroup>` | :ref:`group<class_BaseButton_property_group>` | |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`keep_pressed_outside<class_BaseButton_property_keep_pressed_outside>` | ``false`` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`pressed<class_BaseButton_property_pressed>` | ``false`` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
| :ref:`ShortCut<class_ShortCut>` | :ref:`shortcut<class_BaseButton_property_shortcut>` | |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shortcut_in_tooltip<class_BaseButton_property_shortcut_in_tooltip>` | ``true`` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` | ``false`` |
|
||||
+-----------------------------------------------+-----------------------------------------------------------------------------+--------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -142,7 +142,7 @@ Property Descriptions
|
||||
- :ref:`ActionMode<enum_BaseButton_ActionMode>` **action_mode**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_action_mode(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -158,7 +158,7 @@ Determines when the button is considered clicked, one of the :ref:`ActionMode<en
|
||||
- :ref:`int<class_int>` **button_mask**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_button_mask(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -176,7 +176,7 @@ To allow both left-click and right-click, use ``BUTTON_MASK_LEFT | BUTTON_MASK_R
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_disabled(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -192,7 +192,7 @@ If ``true``, the button is in disabled state and can't be clicked or toggled.
|
||||
- :ref:`FocusMode<enum_Control_FocusMode>` **enabled_focus_mode**
|
||||
|
||||
+-----------+-------------------------------+
|
||||
| *Default* | 2 |
|
||||
| *Default* | ``2`` |
|
||||
+-----------+-------------------------------+
|
||||
| *Setter* | set_enabled_focus_mode(value) |
|
||||
+-----------+-------------------------------+
|
||||
@@ -222,7 +222,7 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont
|
||||
- :ref:`bool<class_bool>` **keep_pressed_outside**
|
||||
|
||||
+-----------+---------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------------------+
|
||||
| *Setter* | set_keep_pressed_outside(value) |
|
||||
+-----------+---------------------------------+
|
||||
@@ -238,7 +238,7 @@ If ``true``, the button stays pressed when moving the cursor outside the button
|
||||
- :ref:`bool<class_bool>` **pressed**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_pressed(value) |
|
||||
+-----------+--------------------+
|
||||
@@ -268,7 +268,7 @@ If ``true``, the button's state is pressed. Means the button is pressed down or
|
||||
- :ref:`bool<class_bool>` **shortcut_in_tooltip**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_shortcut_in_tooltip(value) |
|
||||
+-----------+----------------------------------+
|
||||
@@ -284,7 +284,7 @@ If ``true``, the button will add information about its shortcut in the tooltip.
|
||||
- :ref:`bool<class_bool>` **toggle_mode**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_toggle_mode(value) |
|
||||
+-----------+------------------------+
|
||||
|
||||
@@ -26,13 +26,13 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+----------------------------------+--------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`x<class_Basis_property_x>` | Vector3( 1, 0, 0 ) |
|
||||
+-------------------------------+----------------------------------+--------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`y<class_Basis_property_y>` | Vector3( 0, 1, 0 ) |
|
||||
+-------------------------------+----------------------------------+--------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`z<class_Basis_property_z>` | Vector3( 0, 0, 1 ) |
|
||||
+-------------------------------+----------------------------------+--------------------+
|
||||
+-------------------------------+----------------------------------+------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`x<class_Basis_property_x>` | ``Vector3( 1, 0, 0 )`` |
|
||||
+-------------------------------+----------------------------------+------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`y<class_Basis_property_y>` | ``Vector3( 0, 1, 0 )`` |
|
||||
+-------------------------------+----------------------------------+------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`z<class_Basis_property_z>` | ``Vector3( 0, 0, 1 )`` |
|
||||
+-------------------------------+----------------------------------+------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -107,9 +107,9 @@ Property Descriptions
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **x**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | Vector3( 1, 0, 0 ) |
|
||||
+-----------+--------------------+
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``Vector3( 1, 0, 0 )`` |
|
||||
+-----------+------------------------+
|
||||
|
||||
The basis matrix's X vector.
|
||||
|
||||
@@ -119,9 +119,9 @@ The basis matrix's X vector.
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **y**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | Vector3( 0, 1, 0 ) |
|
||||
+-----------+--------------------+
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``Vector3( 0, 1, 0 )`` |
|
||||
+-----------+------------------------+
|
||||
|
||||
The basis matrix's Y vector.
|
||||
|
||||
@@ -131,9 +131,9 @@ The basis matrix's Y vector.
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **z**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | Vector3( 0, 0, 1 ) |
|
||||
+-----------+--------------------+
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``Vector3( 0, 0, 1 )`` |
|
||||
+-----------+------------------------+
|
||||
|
||||
The basis matrix's Z vector.
|
||||
|
||||
|
||||
@@ -23,15 +23,15 @@ Renders text using ``*.fnt`` fonts containing texture atlases. Supports distance
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------+-----------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`ascent<class_BitmapFont_property_ascent>` | 0.0 |
|
||||
+-------------------------------------+-----------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`distance_field<class_BitmapFont_property_distance_field>` | false |
|
||||
+-------------------------------------+-----------------------------------------------------------------+-------+
|
||||
| :ref:`BitmapFont<class_BitmapFont>` | :ref:`fallback<class_BitmapFont_property_fallback>` | |
|
||||
+-------------------------------------+-----------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_BitmapFont_property_height>` | 1.0 |
|
||||
+-------------------------------------+-----------------------------------------------------------------+-------+
|
||||
+-------------------------------------+-----------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`ascent<class_BitmapFont_property_ascent>` | ``0.0`` |
|
||||
+-------------------------------------+-----------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`distance_field<class_BitmapFont_property_distance_field>` | ``false`` |
|
||||
+-------------------------------------+-----------------------------------------------------------------+-----------+
|
||||
| :ref:`BitmapFont<class_BitmapFont>` | :ref:`fallback<class_BitmapFont_property_fallback>` | |
|
||||
+-------------------------------------+-----------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_BitmapFont_property_height>` | ``1.0`` |
|
||||
+-------------------------------------+-----------------------------------------------------------------+-----------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -64,7 +64,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **ascent**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_ascent(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -80,7 +80,7 @@ Ascent (number of pixels above the baseline).
|
||||
- :ref:`bool<class_bool>` **distance_field**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_distance_field_hint(value) |
|
||||
+-----------+--------------------------------+
|
||||
@@ -110,7 +110,7 @@ The fallback font.
|
||||
- :ref:`float<class_float>` **height**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_height(value) |
|
||||
+-----------+-------------------+
|
||||
|
||||
@@ -27,11 +27,11 @@ If in the editor, you can set the rest pose of an entire skeleton using a menu o
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------+-------------------------------------------------------------+---------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`default_length<class_Bone2D_property_default_length>` | 16.0 |
|
||||
+---------------------------------------+-------------------------------------------------------------+---------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`rest<class_Bone2D_property_rest>` | Transform2D( 0, 0, 0, 0, 0, 0 ) |
|
||||
+---------------------------------------+-------------------------------------------------------------+---------------------------------+
|
||||
+---------------------------------------+-------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`default_length<class_Bone2D_property_default_length>` | ``16.0`` |
|
||||
+---------------------------------------+-------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`rest<class_Bone2D_property_rest>` | ``Transform2D( 0, 0, 0, 0, 0, 0 )`` |
|
||||
+---------------------------------------+-------------------------------------------------------------+-------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -52,7 +52,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **default_length**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 16.0 |
|
||||
| *Default* | ``16.0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_default_length(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -67,13 +67,13 @@ Length of the bone's representation drawn in the editor's viewport in pixels.
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **rest**
|
||||
|
||||
+-----------+---------------------------------+
|
||||
| *Default* | Transform2D( 0, 0, 0, 0, 0, 0 ) |
|
||||
+-----------+---------------------------------+
|
||||
| *Setter* | set_rest(value) |
|
||||
+-----------+---------------------------------+
|
||||
| *Getter* | get_rest() |
|
||||
+-----------+---------------------------------+
|
||||
+-----------+-------------------------------------+
|
||||
| *Default* | ``Transform2D( 0, 0, 0, 0, 0, 0 )`` |
|
||||
+-----------+-------------------------------------+
|
||||
| *Setter* | set_rest(value) |
|
||||
+-----------+-------------------------------------+
|
||||
| *Getter* | get_rest() |
|
||||
+-----------+-------------------------------------+
|
||||
|
||||
Rest transform of the bone. You can reset the node's transforms to this value using :ref:`apply_rest<class_Bone2D_method_apply_rest>`.
|
||||
|
||||
|
||||
@@ -21,9 +21,9 @@ This node must be the child of a :ref:`Skeleton<class_Skeleton>` node. You can t
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------+-----------------------------------------------------------+----+
|
||||
| :ref:`String<class_String>` | :ref:`bone_name<class_BoneAttachment_property_bone_name>` | "" |
|
||||
+-----------------------------+-----------------------------------------------------------+----+
|
||||
+-----------------------------+-----------------------------------------------------------+--------+
|
||||
| :ref:`String<class_String>` | :ref:`bone_name<class_BoneAttachment_property_bone_name>` | ``""`` |
|
||||
+-----------------------------+-----------------------------------------------------------+--------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -33,7 +33,7 @@ Property Descriptions
|
||||
- :ref:`String<class_String>` **bone_name**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | "" |
|
||||
| *Default* | ``""`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_bone_name(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -23,11 +23,11 @@ Arranges child controls vertically or horizontally, and rearranges the controls
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+---------------------------------------------------------+----------+
|
||||
| :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_property_alignment>` | 0 |
|
||||
+-----------------------------------------------+---------------------------------------------------------+----------+
|
||||
| :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | **O:** 1 |
|
||||
+-----------------------------------------------+---------------------------------------------------------+----------+
|
||||
+-----------------------------------------------+---------------------------------------------------------+--------------+
|
||||
| :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_property_alignment>` | ``0`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------+--------------+
|
||||
| :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | **O:** ``1`` |
|
||||
+-----------------------------------------------+---------------------------------------------------------+--------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -63,7 +63,7 @@ Property Descriptions
|
||||
- :ref:`AlignMode<enum_BoxContainer_AlignMode>` **alignment**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_alignment(value) |
|
||||
+-----------+----------------------+
|
||||
|
||||
@@ -21,9 +21,9 @@ Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+-------------------------------------------------+--------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`extents<class_BoxShape_property_extents>` | Vector3( 1, 1, 1 ) |
|
||||
+-------------------------------+-------------------------------------------------+--------------------+
|
||||
+-------------------------------+-------------------------------------------------+------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`extents<class_BoxShape_property_extents>` | ``Vector3( 1, 1, 1 )`` |
|
||||
+-------------------------------+-------------------------------------------------+------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -32,13 +32,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **extents**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | Vector3( 1, 1, 1 ) |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_extents(value) |
|
||||
+-----------+--------------------+
|
||||
| *Getter* | get_extents() |
|
||||
+-----------+--------------------+
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``Vector3( 1, 1, 1 )`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_extents(value) |
|
||||
+-----------+------------------------+
|
||||
| *Getter* | get_extents() |
|
||||
+-----------+------------------------+
|
||||
|
||||
The box's half extents. The width, height and depth of this shape is twice the half extents.
|
||||
|
||||
|
||||
@@ -23,19 +23,19 @@ Button is the standard themed button. It can contain text and an icon, and will
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------+-------------------------------------------------------+-------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | :ref:`align<class_Button_property_align>` | 1 |
|
||||
+-----------------------------------------+-------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_text<class_Button_property_clip_text>` | false |
|
||||
+-----------------------------------------+-------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`expand_icon<class_Button_property_expand_icon>` | false |
|
||||
+-----------------------------------------+-------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flat<class_Button_property_flat>` | false |
|
||||
+-----------------------------------------+-------------------------------------------------------+-------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` | |
|
||||
+-----------------------------------------+-------------------------------------------------------+-------+
|
||||
| :ref:`String<class_String>` | :ref:`text<class_Button_property_text>` | "" |
|
||||
+-----------------------------------------+-------------------------------------------------------+-------+
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | :ref:`align<class_Button_property_align>` | ``1`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_text<class_Button_property_clip_text>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`expand_icon<class_Button_property_expand_icon>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flat<class_Button_property_flat>` | ``false`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` | |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`text<class_Button_property_text>` | ``""`` |
|
||||
+-----------------------------------------+-------------------------------------------------------+-----------+
|
||||
|
||||
Theme Properties
|
||||
----------------
|
||||
@@ -91,7 +91,7 @@ Property Descriptions
|
||||
- :ref:`TextAlign<enum_Button_TextAlign>` **align**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_text_align(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -107,7 +107,7 @@ Text alignment policy for the button's text, use one of the :ref:`TextAlign<enum
|
||||
- :ref:`bool<class_bool>` **clip_text**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_clip_text(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -123,7 +123,7 @@ When this property is enabled, text that is too large to fit the button is clipp
|
||||
- :ref:`bool<class_bool>` **expand_icon**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_expand_icon(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -139,7 +139,7 @@ When enabled, the button's icon will expand/shrink to fit the button's size whil
|
||||
- :ref:`bool<class_bool>` **flat**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_flat(value) |
|
||||
+-----------+-----------------+
|
||||
@@ -169,7 +169,7 @@ Button's icon, if text is present the icon will be placed before the text.
|
||||
- :ref:`String<class_String>` **text**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | "" |
|
||||
| *Default* | ``""`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_text(value) |
|
||||
+-----------+-----------------+
|
||||
|
||||
@@ -23,9 +23,9 @@ Group of :ref:`Button<class_Button>`. All direct and indirect children buttons b
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+-------------------------+-------------+
|
||||
| :ref:`bool<class_bool>` | resource_local_to_scene | **O:** true |
|
||||
+-------------------------+-------------------------+-------------+
|
||||
+-------------------------+-------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | resource_local_to_scene | **O:** ``true`` |
|
||||
+-------------------------+-------------------------+-----------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
@@ -23,33 +23,33 @@ Camera is a special node that displays what is visible from its current location
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`int<class_int>` | :ref:`cull_mask<class_Camera_property_cull_mask>` | 1048575 |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`current<class_Camera_property_current>` | false |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`DopplerTracking<enum_Camera_DopplerTracking>` | :ref:`doppler_tracking<class_Camera_property_doppler_tracking>` | 0 |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`Environment<class_Environment>` | :ref:`environment<class_Camera_property_environment>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`far<class_Camera_property_far>` | 100.0 |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`fov<class_Camera_property_fov>` | 70.0 |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`frustum_offset<class_Camera_property_frustum_offset>` | Vector2( 0, 0 ) |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`h_offset<class_Camera_property_h_offset>` | 0.0 |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`KeepAspect<enum_Camera_KeepAspect>` | :ref:`keep_aspect<class_Camera_property_keep_aspect>` | 1 |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`near<class_Camera_property_near>` | 0.05 |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`Projection<enum_Camera_Projection>` | :ref:`projection<class_Camera_property_projection>` | 0 |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`size<class_Camera_property_size>` | 1.0 |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`v_offset<class_Camera_property_v_offset>` | 0.0 |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`cull_mask<class_Camera_property_cull_mask>` | ``1048575`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`current<class_Camera_property_current>` | ``false`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`DopplerTracking<enum_Camera_DopplerTracking>` | :ref:`doppler_tracking<class_Camera_property_doppler_tracking>` | ``0`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`Environment<class_Environment>` | :ref:`environment<class_Camera_property_environment>` | |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`far<class_Camera_property_far>` | ``100.0`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fov<class_Camera_property_fov>` | ``70.0`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`frustum_offset<class_Camera_property_frustum_offset>` | ``Vector2( 0, 0 )`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`h_offset<class_Camera_property_h_offset>` | ``0.0`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`KeepAspect<enum_Camera_KeepAspect>` | :ref:`keep_aspect<class_Camera_property_keep_aspect>` | ``1`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`near<class_Camera_property_near>` | ``0.05`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`Projection<enum_Camera_Projection>` | :ref:`projection<class_Camera_property_projection>` | ``0`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`size<class_Camera_property_size>` | ``1.0`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`v_offset<class_Camera_property_v_offset>` | ``0.0`` |
|
||||
+-----------------------------------------------------+-----------------------------------------------------------------+---------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -147,7 +147,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **cull_mask**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 1048575 |
|
||||
| *Default* | ``1048575`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_cull_mask(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -163,7 +163,7 @@ The culling mask that describes which 3D render layers are rendered by this came
|
||||
- :ref:`bool<class_bool>` **current**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_current(value) |
|
||||
+-----------+--------------------+
|
||||
@@ -179,7 +179,7 @@ If ``true``, the ancestor :ref:`Viewport<class_Viewport>` is currently using thi
|
||||
- :ref:`DopplerTracking<enum_Camera_DopplerTracking>` **doppler_tracking**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_doppler_tracking(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -209,7 +209,7 @@ The :ref:`Environment<class_Environment>` to use for this camera.
|
||||
- :ref:`float<class_float>` **far**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | 100.0 |
|
||||
| *Default* | ``100.0`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_zfar(value) |
|
||||
+-----------+-----------------+
|
||||
@@ -225,7 +225,7 @@ The distance to the far culling boundary for this camera relative to its local Z
|
||||
- :ref:`float<class_float>` **fov**
|
||||
|
||||
+-----------+----------------+
|
||||
| *Default* | 70.0 |
|
||||
| *Default* | ``70.0`` |
|
||||
+-----------+----------------+
|
||||
| *Setter* | set_fov(value) |
|
||||
+-----------+----------------+
|
||||
@@ -241,7 +241,7 @@ The camera's field of view angle (in degrees). Only applicable in perspective mo
|
||||
- :ref:`Vector2<class_Vector2>` **frustum_offset**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | Vector2( 0, 0 ) |
|
||||
| *Default* | ``Vector2( 0, 0 )`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_frustum_offset(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -257,7 +257,7 @@ The camera's frustum offset. This can be changed from the default to create "til
|
||||
- :ref:`float<class_float>` **h_offset**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_h_offset(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -273,7 +273,7 @@ The horizontal (X) offset of the camera viewport.
|
||||
- :ref:`KeepAspect<enum_Camera_KeepAspect>` **keep_aspect**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_keep_aspect_mode(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -289,7 +289,7 @@ The axis to lock during :ref:`fov<class_Camera_property_fov>`/:ref:`size<class_C
|
||||
- :ref:`float<class_float>` **near**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.05 |
|
||||
| *Default* | ``0.05`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_znear(value) |
|
||||
+-----------+------------------+
|
||||
@@ -305,7 +305,7 @@ The distance to the near culling boundary for this camera relative to its local
|
||||
- :ref:`Projection<enum_Camera_Projection>` **projection**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_projection(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -321,7 +321,7 @@ The camera's projection mode. In :ref:`PROJECTION_PERSPECTIVE<class_Camera_const
|
||||
- :ref:`float<class_float>` **size**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_size(value) |
|
||||
+-----------+-----------------+
|
||||
@@ -337,7 +337,7 @@ The camera's size measured as 1/2 the width or height. Only applicable in orthog
|
||||
- :ref:`float<class_float>` **v_offset**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_v_offset(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -23,57 +23,57 @@ This node is intended to be a simple helper to get things going quickly and it m
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`AnchorMode<enum_Camera2D_AnchorMode>` | :ref:`anchor_mode<class_Camera2D_property_anchor_mode>` | 1 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`current<class_Camera2D_property_current>` | false |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :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>` | 0.2 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_margin_h_enabled<class_Camera2D_property_drag_margin_h_enabled>` | false |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_left<class_Camera2D_property_drag_margin_left>` | 0.2 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_right<class_Camera2D_property_drag_margin_right>` | 0.2 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_top<class_Camera2D_property_drag_margin_top>` | 0.2 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_margin_v_enabled<class_Camera2D_property_drag_margin_v_enabled>` | false |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_drag_margin<class_Camera2D_property_editor_draw_drag_margin>` | false |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_limits<class_Camera2D_property_editor_draw_limits>` | false |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_screen<class_Camera2D_property_editor_draw_screen>` | true |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_bottom<class_Camera2D_property_limit_bottom>` | 10000000 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_left<class_Camera2D_property_limit_left>` | -10000000 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_right<class_Camera2D_property_limit_right>` | 10000000 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`limit_smoothed<class_Camera2D_property_limit_smoothed>` | false |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_top<class_Camera2D_property_limit_top>` | -10000000 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_Camera2D_property_offset>` | Vector2( 0, 0 ) |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`offset_h<class_Camera2D_property_offset_h>` | 0.0 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`offset_v<class_Camera2D_property_offset_v>` | 0.0 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` | :ref:`process_mode<class_Camera2D_property_process_mode>` | 1 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`rotating<class_Camera2D_property_rotating>` | false |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`smoothing_enabled<class_Camera2D_property_smoothing_enabled>` | false |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`smoothing_speed<class_Camera2D_property_smoothing_speed>` | 5.0 |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`zoom<class_Camera2D_property_zoom>` | Vector2( 1, 1 ) |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`AnchorMode<enum_Camera2D_AnchorMode>` | :ref:`anchor_mode<class_Camera2D_property_anchor_mode>` | ``1`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`current<class_Camera2D_property_current>` | ``false`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :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>` | ``0.2`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_margin_h_enabled<class_Camera2D_property_drag_margin_h_enabled>` | ``false`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_left<class_Camera2D_property_drag_margin_left>` | ``0.2`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_right<class_Camera2D_property_drag_margin_right>` | ``0.2`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_margin_top<class_Camera2D_property_drag_margin_top>` | ``0.2`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_margin_v_enabled<class_Camera2D_property_drag_margin_v_enabled>` | ``false`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_drag_margin<class_Camera2D_property_editor_draw_drag_margin>` | ``false`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_limits<class_Camera2D_property_editor_draw_limits>` | ``false`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_screen<class_Camera2D_property_editor_draw_screen>` | ``true`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_bottom<class_Camera2D_property_limit_bottom>` | ``10000000`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_left<class_Camera2D_property_limit_left>` | ``-10000000`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_right<class_Camera2D_property_limit_right>` | ``10000000`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`limit_smoothed<class_Camera2D_property_limit_smoothed>` | ``false`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_top<class_Camera2D_property_limit_top>` | ``-10000000`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_Camera2D_property_offset>` | ``Vector2( 0, 0 )`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`offset_h<class_Camera2D_property_offset_h>` | ``0.0`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`offset_v<class_Camera2D_property_offset_v>` | ``0.0`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` | :ref:`process_mode<class_Camera2D_property_process_mode>` | ``1`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`rotating<class_Camera2D_property_rotating>` | ``false`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`smoothing_enabled<class_Camera2D_property_smoothing_enabled>` | ``false`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`smoothing_speed<class_Camera2D_property_smoothing_speed>` | ``5.0`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`zoom<class_Camera2D_property_zoom>` | ``Vector2( 1, 1 )`` |
|
||||
+---------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -139,7 +139,7 @@ Property Descriptions
|
||||
- :ref:`AnchorMode<enum_Camera2D_AnchorMode>` **anchor_mode**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_anchor_mode(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -155,7 +155,7 @@ The Camera2D's anchor point. See :ref:`AnchorMode<enum_Camera2D_AnchorMode>` con
|
||||
- :ref:`bool<class_bool>` **current**
|
||||
|
||||
+-----------+--------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------+
|
||||
| *Getter* | is_current() |
|
||||
+-----------+--------------+
|
||||
@@ -183,7 +183,7 @@ The custom :ref:`Viewport<class_Viewport>` node attached to the ``Camera2D``. If
|
||||
- :ref:`float<class_float>` **drag_margin_bottom**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 0.2 |
|
||||
| *Default* | ``0.2`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_drag_margin(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -199,7 +199,7 @@ Bottom margin needed to drag the camera. A value of ``1`` makes the camera move
|
||||
- :ref:`bool<class_bool>` **drag_margin_h_enabled**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_h_drag_enabled(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -215,7 +215,7 @@ If ``true``, the camera only moves when reaching the horizontal drag margins. If
|
||||
- :ref:`float<class_float>` **drag_margin_left**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 0.2 |
|
||||
| *Default* | ``0.2`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_drag_margin(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -231,7 +231,7 @@ Left margin needed to drag the camera. A value of ``1`` makes the camera move on
|
||||
- :ref:`float<class_float>` **drag_margin_right**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 0.2 |
|
||||
| *Default* | ``0.2`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_drag_margin(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -247,7 +247,7 @@ Right margin needed to drag the camera. A value of ``1`` makes the camera move o
|
||||
- :ref:`float<class_float>` **drag_margin_top**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 0.2 |
|
||||
| *Default* | ``0.2`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_drag_margin(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -263,7 +263,7 @@ Top margin needed to drag the camera. A value of ``1`` makes the camera move onl
|
||||
- :ref:`bool<class_bool>` **drag_margin_v_enabled**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_v_drag_enabled(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -279,7 +279,7 @@ If ``true``, the camera only moves when reaching the vertical drag margins. If `
|
||||
- :ref:`bool<class_bool>` **editor_draw_drag_margin**
|
||||
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-----------------------------------+
|
||||
| *Setter* | set_margin_drawing_enabled(value) |
|
||||
+-----------+-----------------------------------+
|
||||
@@ -295,7 +295,7 @@ If ``true``, draws the camera's drag margin rectangle in the editor.
|
||||
- :ref:`bool<class_bool>` **editor_draw_limits**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_limit_drawing_enabled(value) |
|
||||
+-----------+----------------------------------+
|
||||
@@ -311,7 +311,7 @@ If ``true``, draws the camera's limits rectangle in the editor.
|
||||
- :ref:`bool<class_bool>` **editor_draw_screen**
|
||||
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+-----------------------------------+
|
||||
| *Setter* | set_screen_drawing_enabled(value) |
|
||||
+-----------+-----------------------------------+
|
||||
@@ -327,7 +327,7 @@ If ``true``, draws the camera's screen rectangle in the editor.
|
||||
- :ref:`int<class_int>` **limit_bottom**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 10000000 |
|
||||
| *Default* | ``10000000`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_limit(value) |
|
||||
+-----------+------------------+
|
||||
@@ -343,7 +343,7 @@ Bottom scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
- :ref:`int<class_int>` **limit_left**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | -10000000 |
|
||||
| *Default* | ``-10000000`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_limit(value) |
|
||||
+-----------+------------------+
|
||||
@@ -359,7 +359,7 @@ Left scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
- :ref:`int<class_int>` **limit_right**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 10000000 |
|
||||
| *Default* | ``10000000`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_limit(value) |
|
||||
+-----------+------------------+
|
||||
@@ -375,7 +375,7 @@ Right scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
- :ref:`bool<class_bool>` **limit_smoothed**
|
||||
|
||||
+-----------+------------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+------------------------------------+
|
||||
| *Setter* | set_limit_smoothing_enabled(value) |
|
||||
+-----------+------------------------------------+
|
||||
@@ -391,7 +391,7 @@ If ``true``, the camera smoothly stops when reaches its limits.
|
||||
- :ref:`int<class_int>` **limit_top**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | -10000000 |
|
||||
| *Default* | ``-10000000`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_limit(value) |
|
||||
+-----------+------------------+
|
||||
@@ -406,13 +406,13 @@ Top scroll limit in pixels. The camera stops moving when reaching this value.
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **offset**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | Vector2( 0, 0 ) |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_offset(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_offset() |
|
||||
+-----------+-------------------+
|
||||
+-----------+---------------------+
|
||||
| *Default* | ``Vector2( 0, 0 )`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_offset(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_offset() |
|
||||
+-----------+---------------------+
|
||||
|
||||
The camera's offset, useful for looking around or camera shake animations.
|
||||
|
||||
@@ -423,7 +423,7 @@ The camera's offset, useful for looking around or camera shake animations.
|
||||
- :ref:`float<class_float>` **offset_h**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_h_offset(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -441,7 +441,7 @@ The horizontal offset of the camera, relative to the drag margins.
|
||||
- :ref:`float<class_float>` **offset_v**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_v_offset(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -459,7 +459,7 @@ The vertical offset of the camera, relative to the drag margins.
|
||||
- :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` **process_mode**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_process_mode(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -475,7 +475,7 @@ The camera's process callback. See :ref:`Camera2DProcessMode<enum_Camera2D_Camer
|
||||
- :ref:`bool<class_bool>` **rotating**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_rotating(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -491,7 +491,7 @@ If ``true``, the camera rotates with the target.
|
||||
- :ref:`bool<class_bool>` **smoothing_enabled**
|
||||
|
||||
+-----------+------------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+------------------------------------+
|
||||
| *Setter* | set_enable_follow_smoothing(value) |
|
||||
+-----------+------------------------------------+
|
||||
@@ -507,7 +507,7 @@ If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_spe
|
||||
- :ref:`float<class_float>` **smoothing_speed**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 5.0 |
|
||||
| *Default* | ``5.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_follow_smoothing(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -522,13 +522,13 @@ Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **zoom**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | Vector2( 1, 1 ) |
|
||||
+-----------+-----------------+
|
||||
| *Setter* | set_zoom(value) |
|
||||
+-----------+-----------------+
|
||||
| *Getter* | get_zoom() |
|
||||
+-----------+-----------------+
|
||||
+-----------+---------------------+
|
||||
| *Default* | ``Vector2( 1, 1 )`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_zoom(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_zoom() |
|
||||
+-----------+---------------------+
|
||||
|
||||
The camera's zoom relative to the viewport. Values larger than ``Vector2(1, 1)`` zoom out and smaller values zoom in. For an example, use ``Vector2(0.5, 0.5)`` for a 2× zoom-in, and ``Vector2(4, 4)`` for a 4× zoom-out.
|
||||
|
||||
|
||||
@@ -23,11 +23,11 @@ A camera feed gives you access to a single physical camera attached to your devi
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------+-----------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`feed_is_active<class_CameraFeed_property_feed_is_active>` | false |
|
||||
+---------------------------------------+-----------------------------------------------------------------+----------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`feed_transform<class_CameraFeed_property_feed_transform>` | Transform2D( 1, 0, 0, -1, 0, 1 ) |
|
||||
+---------------------------------------+-----------------------------------------------------------------+----------------------------------+
|
||||
+---------------------------------------+-----------------------------------------------------------------+--------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`feed_is_active<class_CameraFeed_property_feed_is_active>` | ``false`` |
|
||||
+---------------------------------------+-----------------------------------------------------------------+--------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`feed_transform<class_CameraFeed_property_feed_transform>` | ``Transform2D( 1, 0, 0, -1, 0, 1 )`` |
|
||||
+---------------------------------------+-----------------------------------------------------------------+--------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -89,7 +89,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **feed_is_active**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_active(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -104,13 +104,13 @@ If ``true``, the feed is active.
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **feed_transform**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | Transform2D( 1, 0, 0, -1, 0, 1 ) |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_transform(value) |
|
||||
+-----------+----------------------------------+
|
||||
| *Getter* | get_transform() |
|
||||
+-----------+----------------------------------+
|
||||
+-----------+--------------------------------------+
|
||||
| *Default* | ``Transform2D( 1, 0, 0, -1, 0, 1 )`` |
|
||||
+-----------+--------------------------------------+
|
||||
| *Setter* | set_transform(value) |
|
||||
+-----------+--------------------------------------+
|
||||
| *Getter* | get_transform() |
|
||||
+-----------+--------------------------------------+
|
||||
|
||||
The transform applied to the camera's image.
|
||||
|
||||
|
||||
@@ -18,15 +18,15 @@ This texture gives access to the camera texture provided by a :ref:`CameraFeed<c
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`int<class_int>` | :ref:`camera_feed_id<class_CameraTexture_property_camera_feed_id>` | 0 |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`camera_is_active<class_CameraTexture_property_camera_is_active>` | false |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`int<class_int>` | flags | **O:** 0 |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` | 0 |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+----------+
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | :ref:`camera_feed_id<class_CameraTexture_property_camera_feed_id>` | ``0`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`camera_is_active<class_CameraTexture_property_camera_is_active>` | ``false`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`int<class_int>` | flags | **O:** ``0`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
| :ref:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` | ``0`` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+--------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -36,7 +36,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **camera_feed_id**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_camera_feed_id(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -52,7 +52,7 @@ The ID of the :ref:`CameraFeed<class_CameraFeed>` for which we want to display t
|
||||
- :ref:`bool<class_bool>` **camera_is_active**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_camera_active(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -68,7 +68,7 @@ Convenience property that gives access to the active property of the :ref:`Camer
|
||||
- :ref:`FeedImage<enum_CameraServer_FeedImage>` **which_feed**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_which_feed(value) |
|
||||
+-----------+-----------------------+
|
||||
|
||||
@@ -38,23 +38,23 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`light_mask<class_CanvasItem_property_light_mask>` | 1 |
|
||||
+---------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Material<class_Material>` | :ref:`material<class_CanvasItem_property_material>` | |
|
||||
+---------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`modulate<class_CanvasItem_property_modulate>` | Color( 1, 1, 1, 1 ) |
|
||||
+---------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`self_modulate<class_CanvasItem_property_self_modulate>` | Color( 1, 1, 1, 1 ) |
|
||||
+---------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`show_behind_parent<class_CanvasItem_property_show_behind_parent>` | false |
|
||||
+---------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :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>` | false |
|
||||
+---------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`visible<class_CanvasItem_property_visible>` | true |
|
||||
+---------------------------------+---------------------------------------------------------------------------+---------------------+
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`light_mask<class_CanvasItem_property_light_mask>` | ``1`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Material<class_Material>` | :ref:`material<class_CanvasItem_property_material>` | |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`modulate<class_CanvasItem_property_modulate>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`self_modulate<class_CanvasItem_property_self_modulate>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`show_behind_parent<class_CanvasItem_property_show_behind_parent>` | ``false`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :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>` | ``false`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`visible<class_CanvasItem_property_visible>` | ``true`` |
|
||||
+---------------------------------+---------------------------------------------------------------------------+-------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -248,7 +248,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **light_mask**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_light_mask(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -277,13 +277,13 @@ The material applied to textures on this ``CanvasItem``.
|
||||
|
||||
- :ref:`Color<class_Color>` **modulate**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | Color( 1, 1, 1, 1 ) |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_modulate(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_modulate() |
|
||||
+-----------+---------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_modulate(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_modulate() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
The color applied to textures on this ``CanvasItem``.
|
||||
|
||||
@@ -294,7 +294,7 @@ The color applied to textures on this ``CanvasItem``.
|
||||
- :ref:`Color<class_Color>` **self_modulate**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | Color( 1, 1, 1, 1 ) |
|
||||
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_self_modulate(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -310,7 +310,7 @@ The color applied to textures on this ``CanvasItem``. This is not inherited by c
|
||||
- :ref:`bool<class_bool>` **show_behind_parent**
|
||||
|
||||
+-----------+---------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------------------+
|
||||
| *Setter* | set_draw_behind_parent(value) |
|
||||
+-----------+---------------------------------+
|
||||
@@ -334,7 +334,7 @@ If ``true``, the object draws on top of its parent.
|
||||
- :ref:`bool<class_bool>` **use_parent_material**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_use_parent_material(value) |
|
||||
+-----------+--------------------------------+
|
||||
@@ -350,7 +350,7 @@ If ``true``, the parent ``CanvasItem``'s :ref:`material<class_CanvasItem_propert
|
||||
- :ref:`bool<class_bool>` **visible**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_visible(value) |
|
||||
+-----------+--------------------+
|
||||
|
||||
@@ -21,19 +21,19 @@ Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` | :ref:`blend_mode<class_CanvasItemMaterial_property_blend_mode>` | 0 |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` | :ref:`light_mode<class_CanvasItemMaterial_property_light_mode>` | 0 |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+
|
||||
| :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>` | false |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` | :ref:`blend_mode<class_CanvasItemMaterial_property_blend_mode>` | ``0`` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` | :ref:`light_mode<class_CanvasItemMaterial_property_light_mode>` | ``0`` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
||||
| :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>` | ``false`` |
|
||||
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -88,7 +88,7 @@ Property Descriptions
|
||||
- :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` **blend_mode**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_blend_mode(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -104,7 +104,7 @@ The manner in which a material's rendering is applied to underlying textures.
|
||||
- :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` **light_mode**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_light_mode(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -156,7 +156,7 @@ The manner in which material reacts to lighting.
|
||||
- :ref:`bool<class_bool>` **particles_animation**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_particles_animation(value) |
|
||||
+-----------+--------------------------------+
|
||||
|
||||
@@ -30,25 +30,25 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+
|
||||
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_CanvasLayer_property_custom_viewport>` | |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`follow_viewport_enable<class_CanvasLayer_property_follow_viewport_enable>` | false |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`follow_viewport_scale<class_CanvasLayer_property_follow_viewport_scale>` | 1.0 |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`layer<class_CanvasLayer_property_layer>` | 1 |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_CanvasLayer_property_offset>` | Vector2( 0, 0 ) |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rotation<class_CanvasLayer_property_rotation>` | 0.0 |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rotation_degrees<class_CanvasLayer_property_rotation_degrees>` | 0.0 |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`scale<class_CanvasLayer_property_scale>` | Vector2( 1, 1 ) |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`transform<class_CanvasLayer_property_transform>` | Transform2D( 1, 0, 0, 1, 0, 0 ) |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_CanvasLayer_property_custom_viewport>` | |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`follow_viewport_enable<class_CanvasLayer_property_follow_viewport_enable>` | ``false`` |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`follow_viewport_scale<class_CanvasLayer_property_follow_viewport_scale>` | ``1.0`` |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`layer<class_CanvasLayer_property_layer>` | ``1`` |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_CanvasLayer_property_offset>` | ``Vector2( 0, 0 )`` |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rotation<class_CanvasLayer_property_rotation>` | ``0.0`` |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rotation_degrees<class_CanvasLayer_property_rotation_degrees>` | ``0.0`` |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`scale<class_CanvasLayer_property_scale>` | ``Vector2( 1, 1 )`` |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Transform2D<class_Transform2D>` | :ref:`transform<class_CanvasLayer_property_transform>` | ``Transform2D( 1, 0, 0, 1, 0, 0 )`` |
|
||||
+---------------------------------------+----------------------------------------------------------------------------------+-------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -79,7 +79,7 @@ The custom :ref:`Viewport<class_Viewport>` node assigned to the ``CanvasLayer``.
|
||||
- :ref:`bool<class_bool>` **follow_viewport_enable**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_follow_viewport(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -93,7 +93,7 @@ The custom :ref:`Viewport<class_Viewport>` node assigned to the ``CanvasLayer``.
|
||||
- :ref:`float<class_float>` **follow_viewport_scale**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_follow_viewport_scale(value) |
|
||||
+-----------+----------------------------------+
|
||||
@@ -107,7 +107,7 @@ The custom :ref:`Viewport<class_Viewport>` node assigned to the ``CanvasLayer``.
|
||||
- :ref:`int<class_int>` **layer**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_layer(value) |
|
||||
+-----------+------------------+
|
||||
@@ -122,13 +122,13 @@ Layer index for draw order. Lower values are drawn first.
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **offset**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | Vector2( 0, 0 ) |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_offset(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_offset() |
|
||||
+-----------+-------------------+
|
||||
+-----------+---------------------+
|
||||
| *Default* | ``Vector2( 0, 0 )`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_offset(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_offset() |
|
||||
+-----------+---------------------+
|
||||
|
||||
The layer's base offset.
|
||||
|
||||
@@ -139,7 +139,7 @@ The layer's base offset.
|
||||
- :ref:`float<class_float>` **rotation**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_rotation(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -155,7 +155,7 @@ The layer's rotation in radians.
|
||||
- :ref:`float<class_float>` **rotation_degrees**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_rotation_degrees(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -170,13 +170,13 @@ The layer's rotation in degrees.
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **scale**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | Vector2( 1, 1 ) |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_scale(value) |
|
||||
+-----------+------------------+
|
||||
| *Getter* | get_scale() |
|
||||
+-----------+------------------+
|
||||
+-----------+---------------------+
|
||||
| *Default* | ``Vector2( 1, 1 )`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_scale(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_scale() |
|
||||
+-----------+---------------------+
|
||||
|
||||
The layer's scale.
|
||||
|
||||
@@ -186,13 +186,13 @@ The layer's scale.
|
||||
|
||||
- :ref:`Transform2D<class_Transform2D>` **transform**
|
||||
|
||||
+-----------+---------------------------------+
|
||||
| *Default* | Transform2D( 1, 0, 0, 1, 0, 0 ) |
|
||||
+-----------+---------------------------------+
|
||||
| *Setter* | set_transform(value) |
|
||||
+-----------+---------------------------------+
|
||||
| *Getter* | get_transform() |
|
||||
+-----------+---------------------------------+
|
||||
+-----------+-------------------------------------+
|
||||
| *Default* | ``Transform2D( 1, 0, 0, 1, 0, 0 )`` |
|
||||
+-----------+-------------------------------------+
|
||||
| *Setter* | set_transform(value) |
|
||||
+-----------+-------------------------------------+
|
||||
| *Getter* | get_transform() |
|
||||
+-----------+-------------------------------------+
|
||||
|
||||
The layer's transform.
|
||||
|
||||
|
||||
@@ -21,9 +21,9 @@ Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_CanvasModulate_property_color>` | Color( 1, 1, 1, 1 ) |
|
||||
+---------------------------+---------------------------------------------------+---------------------+
|
||||
+---------------------------+---------------------------------------------------+-------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_CanvasModulate_property_color>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------+---------------------------------------------------+-------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -32,13 +32,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`Color<class_Color>` **color**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | Color( 1, 1, 1, 1 ) |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_color(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_color() |
|
||||
+-----------+---------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_color(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_color() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
The tint color to apply.
|
||||
|
||||
|
||||
@@ -21,15 +21,15 @@ Class representing a capsule-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+--------------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleMesh_property_mid_height>` | 1.0 |
|
||||
+---------------------------+--------------------------------------------------------------------+-----+
|
||||
| :ref:`int<class_int>` | :ref:`radial_segments<class_CapsuleMesh_property_radial_segments>` | 64 |
|
||||
+---------------------------+--------------------------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleMesh_property_radius>` | 1.0 |
|
||||
+---------------------------+--------------------------------------------------------------------+-----+
|
||||
| :ref:`int<class_int>` | :ref:`rings<class_CapsuleMesh_property_rings>` | 8 |
|
||||
+---------------------------+--------------------------------------------------------------------+-----+
|
||||
+---------------------------+--------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleMesh_property_mid_height>` | ``1.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------+---------+
|
||||
| :ref:`int<class_int>` | :ref:`radial_segments<class_CapsuleMesh_property_radial_segments>` | ``64`` |
|
||||
+---------------------------+--------------------------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleMesh_property_radius>` | ``1.0`` |
|
||||
+---------------------------+--------------------------------------------------------------------+---------+
|
||||
| :ref:`int<class_int>` | :ref:`rings<class_CapsuleMesh_property_rings>` | ``8`` |
|
||||
+---------------------------+--------------------------------------------------------------------+---------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -39,7 +39,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **mid_height**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_mid_height(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -55,7 +55,7 @@ Height of the capsule mesh from the center point.
|
||||
- :ref:`int<class_int>` **radial_segments**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | 64 |
|
||||
| *Default* | ``64`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_radial_segments(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -71,7 +71,7 @@ Number of radial segments on the capsule mesh.
|
||||
- :ref:`float<class_float>` **radius**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_radius(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -87,7 +87,7 @@ Radius of the capsule mesh.
|
||||
- :ref:`int<class_int>` **rings**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 8 |
|
||||
| *Default* | ``8`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_rings(value) |
|
||||
+-----------+------------------+
|
||||
|
||||
@@ -21,11 +21,11 @@ Capsule shape for collisions.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape_property_height>` | 1.0 |
|
||||
+---------------------------+---------------------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape_property_radius>` | 1.0 |
|
||||
+---------------------------+---------------------------------------------------+-----+
|
||||
+---------------------------+---------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape_property_height>` | ``1.0`` |
|
||||
+---------------------------+---------------------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape_property_radius>` | ``1.0`` |
|
||||
+---------------------------+---------------------------------------------------+---------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -35,7 +35,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **height**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_height(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -51,7 +51,7 @@ The capsule's height.
|
||||
- :ref:`float<class_float>` **radius**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_radius(value) |
|
||||
+-----------+-------------------+
|
||||
|
||||
@@ -21,11 +21,11 @@ Capsule shape for 2D collisions.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-----------------------------------------------------+------+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>` | 20.0 |
|
||||
+---------------------------+-----------------------------------------------------+------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>` | 10.0 |
|
||||
+---------------------------+-----------------------------------------------------+------+
|
||||
+---------------------------+-----------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>` | ``20.0`` |
|
||||
+---------------------------+-----------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>` | ``10.0`` |
|
||||
+---------------------------+-----------------------------------------------------+----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -35,7 +35,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **height**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 20.0 |
|
||||
| *Default* | ``20.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_height(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -51,7 +51,7 @@ The capsule's height.
|
||||
- :ref:`float<class_float>` **radius**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 10.0 |
|
||||
| *Default* | ``10.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_radius(value) |
|
||||
+-----------+-------------------+
|
||||
|
||||
@@ -21,9 +21,9 @@ CenterContainer keeps children controls centered. This container keeps all child
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`use_top_left<class_CenterContainer_property_use_top_left>` | false |
|
||||
+-------------------------+------------------------------------------------------------------+-------+
|
||||
+-------------------------+------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`use_top_left<class_CenterContainer_property_use_top_left>` | ``false`` |
|
||||
+-------------------------+------------------------------------------------------------------+-----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -33,7 +33,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **use_top_left**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_use_top_left(value) |
|
||||
+-----------+-------------------------+
|
||||
|
||||
@@ -28,23 +28,23 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------+----------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`absolute_index<class_CharFXTransform_property_absolute_index>` | 0 |
|
||||
+-------------------------------------+----------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`character<class_CharFXTransform_property_character>` | 0 |
|
||||
+-------------------------------------+----------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_CharFXTransform_property_color>` | Color( 0, 0, 0, 1 ) |
|
||||
+-------------------------------------+----------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`elapsed_time<class_CharFXTransform_property_elapsed_time>` | 0.0 |
|
||||
+-------------------------------------+----------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`env<class_CharFXTransform_property_env>` | {} |
|
||||
+-------------------------------------+----------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_CharFXTransform_property_offset>` | Vector2( 0, 0 ) |
|
||||
+-------------------------------------+----------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`relative_index<class_CharFXTransform_property_relative_index>` | 0 |
|
||||
+-------------------------------------+----------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`visible<class_CharFXTransform_property_visible>` | true |
|
||||
+-------------------------------------+----------------------------------------------------------------------+---------------------+
|
||||
+-------------------------------------+----------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`absolute_index<class_CharFXTransform_property_absolute_index>` | ``0`` |
|
||||
+-------------------------------------+----------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`character<class_CharFXTransform_property_character>` | ``0`` |
|
||||
+-------------------------------------+----------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_CharFXTransform_property_color>` | ``Color( 0, 0, 0, 1 )`` |
|
||||
+-------------------------------------+----------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`elapsed_time<class_CharFXTransform_property_elapsed_time>` | ``0.0`` |
|
||||
+-------------------------------------+----------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Dictionary<class_Dictionary>` | :ref:`env<class_CharFXTransform_property_env>` | ``{}`` |
|
||||
+-------------------------------------+----------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_CharFXTransform_property_offset>` | ``Vector2( 0, 0 )`` |
|
||||
+-------------------------------------+----------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`relative_index<class_CharFXTransform_property_relative_index>` | ``0`` |
|
||||
+-------------------------------------+----------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`visible<class_CharFXTransform_property_visible>` | ``true`` |
|
||||
+-------------------------------------+----------------------------------------------------------------------+-------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -54,7 +54,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **absolute_index**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_absolute_index(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -70,7 +70,7 @@ The index of the current character (starting from 0). Setting this property won'
|
||||
- :ref:`int<class_int>` **character**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_character(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -91,13 +91,13 @@ The Unicode codepoint the character will use. This only affects non-whitespace c
|
||||
|
||||
- :ref:`Color<class_Color>` **color**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | Color( 0, 0, 0, 1 ) |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_color(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_color() |
|
||||
+-----------+---------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Color( 0, 0, 0, 1 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_color(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_color() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
The color the character will be drawn with.
|
||||
|
||||
@@ -108,7 +108,7 @@ The color the character will be drawn with.
|
||||
- :ref:`float<class_float>` **elapsed_time**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_elapsed_time(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -126,7 +126,7 @@ The time elapsed since the :ref:`RichTextLabel<class_RichTextLabel>` was added t
|
||||
- :ref:`Dictionary<class_Dictionary>` **env**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | {} |
|
||||
| *Default* | ``{}`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_environment(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -147,13 +147,13 @@ For example, the opening BBCode tag ``[example foo=hello bar=true baz=42 color=#
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **offset**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | Vector2( 0, 0 ) |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_offset(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_offset() |
|
||||
+-----------+-------------------+
|
||||
+-----------+---------------------+
|
||||
| *Default* | ``Vector2( 0, 0 )`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_offset(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_offset() |
|
||||
+-----------+---------------------+
|
||||
|
||||
The position offset the character will be drawn with (in pixels).
|
||||
|
||||
@@ -164,7 +164,7 @@ The position offset the character will be drawn with (in pixels).
|
||||
- :ref:`int<class_int>` **relative_index**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_relative_index(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -180,7 +180,7 @@ The index of the current character (starting from 0). Setting this property won'
|
||||
- :ref:`bool<class_bool>` **visible**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_visibility(value) |
|
||||
+-----------+-----------------------+
|
||||
|
||||
@@ -21,11 +21,11 @@ A checkbox allows the user to make a binary choice (choosing only one of two pos
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------+-------------+-------------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | align | **O:** 0 |
|
||||
+-----------------------------------------+-------------+-------------+
|
||||
| :ref:`bool<class_bool>` | toggle_mode | **O:** true |
|
||||
+-----------------------------------------+-------------+-------------+
|
||||
+-----------------------------------------+-------------+-----------------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | align | **O:** ``0`` |
|
||||
+-----------------------------------------+-------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | toggle_mode | **O:** ``true`` |
|
||||
+-----------------------------------------+-------------+-----------------+
|
||||
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
@@ -21,11 +21,11 @@ CheckButton is a toggle button displayed as a check field.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------+-------------+-------------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | align | **O:** 0 |
|
||||
+-----------------------------------------+-------------+-------------+
|
||||
| :ref:`bool<class_bool>` | toggle_mode | **O:** true |
|
||||
+-----------------------------------------+-------------+-------------+
|
||||
+-----------------------------------------+-------------+-----------------+
|
||||
| :ref:`TextAlign<enum_Button_TextAlign>` | align | **O:** ``0`` |
|
||||
+-----------------------------------------+-------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | toggle_mode | **O:** ``true`` |
|
||||
+-----------------------------------------+-------------+-----------------+
|
||||
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
@@ -21,9 +21,9 @@ Circular shape for 2D collisions. This shape is useful for modeling balls or sma
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+----------------------------------------------------+------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CircleShape2D_property_radius>` | 10.0 |
|
||||
+---------------------------+----------------------------------------------------+------+
|
||||
+---------------------------+----------------------------------------------------+----------+
|
||||
| :ref:`float<class_float>` | :ref:`radius<class_CircleShape2D_property_radius>` | ``10.0`` |
|
||||
+---------------------------+----------------------------------------------------+----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -33,7 +33,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **radius**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 10.0 |
|
||||
| *Default* | ``10.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_radius(value) |
|
||||
+-----------+-------------------+
|
||||
|
||||
@@ -21,17 +21,17 @@ This node extends :ref:`Camera<class_Camera>` to add collisions with :ref:`Area<
|
||||
Properties
|
||||
----------
|
||||
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_to_areas<class_ClippedCamera_property_clip_to_areas>` | false |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_to_bodies<class_ClippedCamera_property_clip_to_bodies>` | true |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_ClippedCamera_property_collision_mask>` | 1 |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`margin<class_ClippedCamera_property_margin>` | 0.0 |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-------+
|
||||
| :ref:`ProcessMode<enum_ClippedCamera_ProcessMode>` | :ref:`process_mode<class_ClippedCamera_property_process_mode>` | 0 |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-------+
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_to_areas<class_ClippedCamera_property_clip_to_areas>` | ``false`` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`clip_to_bodies<class_ClippedCamera_property_clip_to_bodies>` | ``true`` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`int<class_int>` | :ref:`collision_mask<class_ClippedCamera_property_collision_mask>` | ``1`` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`margin<class_ClippedCamera_property_margin>` | ``0.0`` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
| :ref:`ProcessMode<enum_ClippedCamera_ProcessMode>` | :ref:`process_mode<class_ClippedCamera_property_process_mode>` | ``0`` |
|
||||
+----------------------------------------------------+--------------------------------------------------------------------+-----------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -77,7 +77,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **clip_to_areas**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_clip_to_areas(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -93,7 +93,7 @@ If ``true``, the camera stops on contact with :ref:`Area<class_Area>`\ s.
|
||||
- :ref:`bool<class_bool>` **clip_to_bodies**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_clip_to_bodies(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -109,7 +109,7 @@ If ``true``, the camera stops on contact with :ref:`PhysicsBody<class_PhysicsBod
|
||||
- :ref:`int<class_int>` **collision_mask**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_collision_mask(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -125,7 +125,7 @@ The camera's collision mask. Only objects in at least one collision layer matchi
|
||||
- :ref:`float<class_float>` **margin**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_margin(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -141,7 +141,7 @@ The camera's collision margin. The camera can't get closer than this distance to
|
||||
- :ref:`ProcessMode<enum_ClippedCamera_ProcessMode>` **process_mode**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_process_mode(value) |
|
||||
+-----------+-------------------------+
|
||||
|
||||
@@ -23,11 +23,11 @@ CollisionObject is the base class for physics objects. It can hold any number of
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_capture_on_drag<class_CollisionObject_property_input_capture_on_drag>` | false |
|
||||
+-------------------------+------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_ray_pickable<class_CollisionObject_property_input_ray_pickable>` | true |
|
||||
+-------------------------+------------------------------------------------------------------------------------+-------+
|
||||
+-------------------------+------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_capture_on_drag<class_CollisionObject_property_input_capture_on_drag>` | ``false`` |
|
||||
+-------------------------+------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_ray_pickable<class_CollisionObject_property_input_ray_pickable>` | ``true`` |
|
||||
+-------------------------+------------------------------------------------------------------------------------+-----------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -101,7 +101,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **input_capture_on_drag**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_capture_input_on_drag(value) |
|
||||
+-----------+----------------------------------+
|
||||
@@ -117,7 +117,7 @@ If ``true``, the ``CollisionObject`` will continue to receive input events as th
|
||||
- :ref:`bool<class_bool>` **input_ray_pickable**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_ray_pickable(value) |
|
||||
+-----------+-------------------------+
|
||||
|
||||
@@ -23,9 +23,9 @@ CollisionObject2D is the base class for 2D physics objects. It can hold any numb
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------+------------------------------------------------------------------------+------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_pickable<class_CollisionObject2D_property_input_pickable>` | true |
|
||||
+-------------------------+------------------------------------------------------------------------+------+
|
||||
+-------------------------+------------------------------------------------------------------------+----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`input_pickable<class_CollisionObject2D_property_input_pickable>` | ``true`` |
|
||||
+-------------------------+------------------------------------------------------------------------+----------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -107,7 +107,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **input_pickable**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_pickable(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -21,13 +21,13 @@ Allows editing a collision polygon's vertices on a selected plane. Can also set
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+-----------------------------------------------------------+----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_CollisionPolygon_property_depth>` | 1.0 |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon_property_disabled>` | false |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+----------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon_property_polygon>` | PoolVector2Array( ) |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+----------------------+
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`depth<class_CollisionPolygon_property_depth>` | ``1.0`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon_property_disabled>` | ``false`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon_property_polygon>` | ``PoolVector2Array( )`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -37,7 +37,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **depth**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_depth(value) |
|
||||
+-----------+------------------+
|
||||
@@ -53,7 +53,7 @@ Length that the resulting collision extends in either direction perpendicular to
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_disabled(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -68,13 +68,13 @@ If ``true``, no collision will be produced.
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | PoolVector2Array( ) |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_polygon(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_polygon() |
|
||||
+-----------+----------------------+
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``PoolVector2Array( )`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_polygon(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_polygon() |
|
||||
+-----------+--------------------------+
|
||||
|
||||
Array of vertices which define the polygon.
|
||||
|
||||
|
||||
@@ -21,17 +21,17 @@ Provides a 2D collision polygon to a :ref:`CollisionObject2D<class_CollisionObje
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+
|
||||
| :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` | :ref:`build_mode<class_CollisionPolygon2D_property_build_mode>` | 0 |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon2D_property_disabled>` | false |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionPolygon2D_property_one_way_collision>` | false |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`one_way_collision_margin<class_CollisionPolygon2D_property_one_way_collision_margin>` | 1.0 |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon2D_property_polygon>` | PoolVector2Array( ) |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` | :ref:`build_mode<class_CollisionPolygon2D_property_build_mode>` | ``0`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon2D_property_disabled>` | ``false`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionPolygon2D_property_one_way_collision>` | ``false`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`one_way_collision_margin<class_CollisionPolygon2D_property_one_way_collision_margin>` | ``1.0`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon2D_property_polygon>` | ``PoolVector2Array( )`` |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
@@ -56,7 +56,7 @@ Property Descriptions
|
||||
- :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` **build_mode**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_build_mode(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -72,7 +72,7 @@ Collision build mode. Use one of the :ref:`BuildMode<enum_CollisionPolygon2D_Bui
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_disabled(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -88,7 +88,7 @@ If ``true``, no collisions will be detected.
|
||||
- :ref:`bool<class_bool>` **one_way_collision**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_one_way_collision(value) |
|
||||
+-----------+--------------------------------+
|
||||
@@ -104,7 +104,7 @@ If ``true``, only edges that face up, relative to ``CollisionPolygon2D``'s rotat
|
||||
- :ref:`float<class_float>` **one_way_collision_margin**
|
||||
|
||||
+-----------+-------------------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------------------------+
|
||||
| *Setter* | set_one_way_collision_margin(value) |
|
||||
+-----------+-------------------------------------+
|
||||
@@ -117,13 +117,13 @@ If ``true``, only edges that face up, relative to ``CollisionPolygon2D``'s rotat
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | PoolVector2Array( ) |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_polygon(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_polygon() |
|
||||
+-----------+----------------------+
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``PoolVector2Array( )`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_polygon(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_polygon() |
|
||||
+-----------+--------------------------+
|
||||
|
||||
The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the :ref:`PoolVector2Array<class_PoolVector2Array>`, not a reference.
|
||||
|
||||
|
||||
@@ -26,11 +26,11 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+---------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape_property_disabled>` | false |
|
||||
+---------------------------+---------------------------------------------------------+-------+
|
||||
| :ref:`Shape<class_Shape>` | :ref:`shape<class_CollisionShape_property_shape>` | |
|
||||
+---------------------------+---------------------------------------------------------+-------+
|
||||
+---------------------------+---------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape_property_disabled>` | ``false`` |
|
||||
+---------------------------+---------------------------------------------------------+-----------+
|
||||
| :ref:`Shape<class_Shape>` | :ref:`shape<class_CollisionShape_property_shape>` | |
|
||||
+---------------------------+---------------------------------------------------------+-----------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -49,7 +49,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_disabled(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -26,15 +26,15 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+-------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape2D_property_disabled>` | false |
|
||||
+-------------------------------+-------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionShape2D_property_one_way_collision>` | false |
|
||||
+-------------------------------+-------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`one_way_collision_margin<class_CollisionShape2D_property_one_way_collision_margin>` | 1.0 |
|
||||
+-------------------------------+-------------------------------------------------------------------------------------------+-------+
|
||||
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_CollisionShape2D_property_shape>` | |
|
||||
+-------------------------------+-------------------------------------------------------------------------------------------+-------+
|
||||
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape2D_property_disabled>` | ``false`` |
|
||||
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionShape2D_property_one_way_collision>` | ``false`` |
|
||||
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`one_way_collision_margin<class_CollisionShape2D_property_one_way_collision_margin>` | ``1.0`` |
|
||||
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
||||
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_CollisionShape2D_property_shape>` | |
|
||||
+-------------------------------+-------------------------------------------------------------------------------------------+-----------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -44,7 +44,7 @@ Property Descriptions
|
||||
- :ref:`bool<class_bool>` **disabled**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_disabled(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -60,7 +60,7 @@ A disabled collision shape has no effect in the world.
|
||||
- :ref:`bool<class_bool>` **one_way_collision**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_one_way_collision(value) |
|
||||
+-----------+--------------------------------+
|
||||
@@ -76,7 +76,7 @@ Sets whether this collision shape should only detect collision on one side (top
|
||||
- :ref:`float<class_float>` **one_way_collision_margin**
|
||||
|
||||
+-----------+-------------------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------------------------+
|
||||
| *Setter* | set_one_way_collision_margin(value) |
|
||||
+-----------+-------------------------------------+
|
||||
|
||||
@@ -21,29 +21,29 @@ You can also create a color from standardized color names by using :ref:`@GDScri
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`a<class_Color_property_a>` | 1.0 |
|
||||
+---------------------------+------------------------------------+-----+
|
||||
| :ref:`int<class_int>` | :ref:`a8<class_Color_property_a8>` | 255 |
|
||||
+---------------------------+------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`b<class_Color_property_b>` | 0.0 |
|
||||
+---------------------------+------------------------------------+-----+
|
||||
| :ref:`int<class_int>` | :ref:`b8<class_Color_property_b8>` | 0 |
|
||||
+---------------------------+------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`g<class_Color_property_g>` | 0.0 |
|
||||
+---------------------------+------------------------------------+-----+
|
||||
| :ref:`int<class_int>` | :ref:`g8<class_Color_property_g8>` | 0 |
|
||||
+---------------------------+------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`h<class_Color_property_h>` | 0.0 |
|
||||
+---------------------------+------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`r<class_Color_property_r>` | 0.0 |
|
||||
+---------------------------+------------------------------------+-----+
|
||||
| :ref:`int<class_int>` | :ref:`r8<class_Color_property_r8>` | 0 |
|
||||
+---------------------------+------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`s<class_Color_property_s>` | 0.0 |
|
||||
+---------------------------+------------------------------------+-----+
|
||||
| :ref:`float<class_float>` | :ref:`v<class_Color_property_v>` | 0.0 |
|
||||
+---------------------------+------------------------------------+-----+
|
||||
+---------------------------+------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`a<class_Color_property_a>` | ``1.0`` |
|
||||
+---------------------------+------------------------------------+---------+
|
||||
| :ref:`int<class_int>` | :ref:`a8<class_Color_property_a8>` | ``255`` |
|
||||
+---------------------------+------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`b<class_Color_property_b>` | ``0.0`` |
|
||||
+---------------------------+------------------------------------+---------+
|
||||
| :ref:`int<class_int>` | :ref:`b8<class_Color_property_b8>` | ``0`` |
|
||||
+---------------------------+------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`g<class_Color_property_g>` | ``0.0`` |
|
||||
+---------------------------+------------------------------------+---------+
|
||||
| :ref:`int<class_int>` | :ref:`g8<class_Color_property_g8>` | ``0`` |
|
||||
+---------------------------+------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`h<class_Color_property_h>` | ``0.0`` |
|
||||
+---------------------------+------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`r<class_Color_property_r>` | ``0.0`` |
|
||||
+---------------------------+------------------------------------+---------+
|
||||
| :ref:`int<class_int>` | :ref:`r8<class_Color_property_r8>` | ``0`` |
|
||||
+---------------------------+------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`s<class_Color_property_s>` | ``0.0`` |
|
||||
+---------------------------+------------------------------------+---------+
|
||||
| :ref:`float<class_float>` | :ref:`v<class_Color_property_v>` | ``0.0`` |
|
||||
+---------------------------+------------------------------------+---------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -684,9 +684,9 @@ Property Descriptions
|
||||
|
||||
- :ref:`float<class_float>` **a**
|
||||
|
||||
+-----------+-----+
|
||||
| *Default* | 1.0 |
|
||||
+-----------+-----+
|
||||
+-----------+---------+
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+---------+
|
||||
|
||||
Alpha value (range 0 to 1).
|
||||
|
||||
@@ -696,9 +696,9 @@ Alpha value (range 0 to 1).
|
||||
|
||||
- :ref:`int<class_int>` **a8**
|
||||
|
||||
+-----------+-----+
|
||||
| *Default* | 255 |
|
||||
+-----------+-----+
|
||||
+-----------+---------+
|
||||
| *Default* | ``255`` |
|
||||
+-----------+---------+
|
||||
|
||||
Alpha value (range 0 to 255).
|
||||
|
||||
@@ -708,9 +708,9 @@ Alpha value (range 0 to 255).
|
||||
|
||||
- :ref:`float<class_float>` **b**
|
||||
|
||||
+-----------+-----+
|
||||
| *Default* | 0.0 |
|
||||
+-----------+-----+
|
||||
+-----------+---------+
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------+
|
||||
|
||||
Blue value (range 0 to 1).
|
||||
|
||||
@@ -720,9 +720,9 @@ Blue value (range 0 to 1).
|
||||
|
||||
- :ref:`int<class_int>` **b8**
|
||||
|
||||
+-----------+---+
|
||||
| *Default* | 0 |
|
||||
+-----------+---+
|
||||
+-----------+-------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------+
|
||||
|
||||
Blue value (range 0 to 255).
|
||||
|
||||
@@ -732,9 +732,9 @@ Blue value (range 0 to 255).
|
||||
|
||||
- :ref:`float<class_float>` **g**
|
||||
|
||||
+-----------+-----+
|
||||
| *Default* | 0.0 |
|
||||
+-----------+-----+
|
||||
+-----------+---------+
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------+
|
||||
|
||||
Green value (range 0 to 1).
|
||||
|
||||
@@ -744,9 +744,9 @@ Green value (range 0 to 1).
|
||||
|
||||
- :ref:`int<class_int>` **g8**
|
||||
|
||||
+-----------+---+
|
||||
| *Default* | 0 |
|
||||
+-----------+---+
|
||||
+-----------+-------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------+
|
||||
|
||||
Green value (range 0 to 255).
|
||||
|
||||
@@ -756,9 +756,9 @@ Green value (range 0 to 255).
|
||||
|
||||
- :ref:`float<class_float>` **h**
|
||||
|
||||
+-----------+-----+
|
||||
| *Default* | 0.0 |
|
||||
+-----------+-----+
|
||||
+-----------+---------+
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------+
|
||||
|
||||
HSV hue value (range 0 to 1).
|
||||
|
||||
@@ -768,9 +768,9 @@ HSV hue value (range 0 to 1).
|
||||
|
||||
- :ref:`float<class_float>` **r**
|
||||
|
||||
+-----------+-----+
|
||||
| *Default* | 0.0 |
|
||||
+-----------+-----+
|
||||
+-----------+---------+
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------+
|
||||
|
||||
Red value (range 0 to 1).
|
||||
|
||||
@@ -780,9 +780,9 @@ Red value (range 0 to 1).
|
||||
|
||||
- :ref:`int<class_int>` **r8**
|
||||
|
||||
+-----------+---+
|
||||
| *Default* | 0 |
|
||||
+-----------+---+
|
||||
+-----------+-------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------+
|
||||
|
||||
Red value (range 0 to 255).
|
||||
|
||||
@@ -792,9 +792,9 @@ Red value (range 0 to 255).
|
||||
|
||||
- :ref:`float<class_float>` **s**
|
||||
|
||||
+-----------+-----+
|
||||
| *Default* | 0.0 |
|
||||
+-----------+-----+
|
||||
+-----------+---------+
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------+
|
||||
|
||||
HSV saturation value (range 0 to 1).
|
||||
|
||||
@@ -804,9 +804,9 @@ HSV saturation value (range 0 to 1).
|
||||
|
||||
- :ref:`float<class_float>` **v**
|
||||
|
||||
+-----------+-----+
|
||||
| *Default* | 0.0 |
|
||||
+-----------+-----+
|
||||
+-----------+---------+
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------+
|
||||
|
||||
HSV value (range 0 to 1).
|
||||
|
||||
|
||||
@@ -21,21 +21,21 @@ Description
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+--------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_ColorPicker_property_color>` | Color( 1, 1, 1, 1 ) |
|
||||
+---------------------------+--------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`deferred_mode<class_ColorPicker_property_deferred_mode>` | false |
|
||||
+---------------------------+--------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPicker_property_edit_alpha>` | true |
|
||||
+---------------------------+--------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`hsv_mode<class_ColorPicker_property_hsv_mode>` | false |
|
||||
+---------------------------+--------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`presets_enabled<class_ColorPicker_property_presets_enabled>` | true |
|
||||
+---------------------------+--------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`presets_visible<class_ColorPicker_property_presets_visible>` | true |
|
||||
+---------------------------+--------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`raw_mode<class_ColorPicker_property_raw_mode>` | false |
|
||||
+---------------------------+--------------------------------------------------------------------+---------------------+
|
||||
+---------------------------+--------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_ColorPicker_property_color>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------+--------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`deferred_mode<class_ColorPicker_property_deferred_mode>` | ``false`` |
|
||||
+---------------------------+--------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPicker_property_edit_alpha>` | ``true`` |
|
||||
+---------------------------+--------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`hsv_mode<class_ColorPicker_property_hsv_mode>` | ``false`` |
|
||||
+---------------------------+--------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`presets_enabled<class_ColorPicker_property_presets_enabled>` | ``true`` |
|
||||
+---------------------------+--------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`presets_visible<class_ColorPicker_property_presets_visible>` | ``true`` |
|
||||
+---------------------------+--------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`raw_mode<class_ColorPicker_property_raw_mode>` | ``false`` |
|
||||
+---------------------------+--------------------------------------------------------------------+-------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -107,13 +107,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`Color<class_Color>` **color**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | Color( 1, 1, 1, 1 ) |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_pick_color(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_pick_color() |
|
||||
+-----------+-----------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_pick_color(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_pick_color() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
The currently selected color.
|
||||
|
||||
@@ -124,7 +124,7 @@ The currently selected color.
|
||||
- :ref:`bool<class_bool>` **deferred_mode**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_deferred_mode(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -140,7 +140,7 @@ If ``true``, the color will apply only after the user releases the mouse button,
|
||||
- :ref:`bool<class_bool>` **edit_alpha**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_edit_alpha(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -156,7 +156,7 @@ If ``true``, shows an alpha channel slider (transparency).
|
||||
- :ref:`bool<class_bool>` **hsv_mode**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_hsv_mode(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -174,7 +174,7 @@ If ``true``, allows editing the color with Hue/Saturation/Value sliders.
|
||||
- :ref:`bool<class_bool>` **presets_enabled**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_presets_enabled(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -190,7 +190,7 @@ If ``true``, the "add preset" button is enabled.
|
||||
- :ref:`bool<class_bool>` **presets_visible**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_presets_visible(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -206,7 +206,7 @@ If ``true``, saved color presets are visible.
|
||||
- :ref:`bool<class_bool>` **raw_mode**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_raw_mode(value) |
|
||||
+-----------+---------------------+
|
||||
|
||||
@@ -21,13 +21,13 @@ Encapsulates a :ref:`ColorPicker<class_ColorPicker>` making it accessible by pre
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+----------------------------------------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_ColorPickerButton_property_color>` | Color( 0, 0, 0, 1 ) |
|
||||
+---------------------------+----------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPickerButton_property_edit_alpha>` | true |
|
||||
+---------------------------+----------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | toggle_mode | **O:** true |
|
||||
+---------------------------+----------------------------------------------------------------+---------------------+
|
||||
+---------------------------+----------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_ColorPickerButton_property_color>` | ``Color( 0, 0, 0, 1 )`` |
|
||||
+---------------------------+----------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPickerButton_property_edit_alpha>` | ``true`` |
|
||||
+---------------------------+----------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | toggle_mode | **O:** ``true`` |
|
||||
+---------------------------+----------------------------------------------------------------+-------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -99,13 +99,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`Color<class_Color>` **color**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | Color( 0, 0, 0, 1 ) |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_pick_color(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_pick_color() |
|
||||
+-----------+-----------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Color( 0, 0, 0, 1 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_pick_color(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_pick_color() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
The currently selected color.
|
||||
|
||||
@@ -116,7 +116,7 @@ The currently selected color.
|
||||
- :ref:`bool<class_bool>` **edit_alpha**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_edit_alpha(value) |
|
||||
+-----------+-----------------------+
|
||||
|
||||
@@ -21,9 +21,9 @@ Displays a colored rectangle.
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+----------------------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_ColorRect_property_color>` | Color( 1, 1, 1, 1 ) |
|
||||
+---------------------------+----------------------------------------------+---------------------+
|
||||
+---------------------------+----------------------------------------------+-------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_ColorRect_property_color>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------+----------------------------------------------+-------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -32,13 +32,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`Color<class_Color>` **color**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | Color( 1, 1, 1, 1 ) |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_frame_color(value) |
|
||||
+-----------+------------------------+
|
||||
| *Getter* | get_frame_color() |
|
||||
+-----------+------------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_frame_color(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_frame_color() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
The fill color.
|
||||
|
||||
|
||||
@@ -23,9 +23,9 @@ The main difference between a :ref:`ConvexPolygonShape2D<class_ConvexPolygonShap
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+----------------------------------------------------------------+----------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`segments<class_ConcavePolygonShape2D_property_segments>` | PoolVector2Array( ) |
|
||||
+-------------------------------------------------+----------------------------------------------------------------+----------------------+
|
||||
+-------------------------------------------------+----------------------------------------------------------------+--------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`segments<class_ConcavePolygonShape2D_property_segments>` | ``PoolVector2Array( )`` |
|
||||
+-------------------------------------------------+----------------------------------------------------------------+--------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -34,13 +34,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **segments**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | PoolVector2Array( ) |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_segments(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_segments() |
|
||||
+-----------+----------------------+
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``PoolVector2Array( )`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_segments(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_segments() |
|
||||
+-----------+--------------------------+
|
||||
|
||||
The array of points that make up the ``ConcavePolygonShape2D``'s line segments.
|
||||
|
||||
|
||||
@@ -25,17 +25,17 @@ Once the Bodies swing, the twist axis is calculated as the middle of the x-axes
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------+-------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`bias<class_ConeTwistJoint_property_bias>` | 0.3 |
|
||||
+---------------------------+-------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`relaxation<class_ConeTwistJoint_property_relaxation>` | 1.0 |
|
||||
+---------------------------+-------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`softness<class_ConeTwistJoint_property_softness>` | 0.8 |
|
||||
+---------------------------+-------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`swing_span<class_ConeTwistJoint_property_swing_span>` | 45.0 |
|
||||
+---------------------------+-------------------------------------------------------------+-------+
|
||||
| :ref:`float<class_float>` | :ref:`twist_span<class_ConeTwistJoint_property_twist_span>` | 180.0 |
|
||||
+---------------------------+-------------------------------------------------------------+-------+
|
||||
+---------------------------+-------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`bias<class_ConeTwistJoint_property_bias>` | ``0.3`` |
|
||||
+---------------------------+-------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`relaxation<class_ConeTwistJoint_property_relaxation>` | ``1.0`` |
|
||||
+---------------------------+-------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`softness<class_ConeTwistJoint_property_softness>` | ``0.8`` |
|
||||
+---------------------------+-------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`swing_span<class_ConeTwistJoint_property_swing_span>` | ``45.0`` |
|
||||
+---------------------------+-------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`twist_span<class_ConeTwistJoint_property_twist_span>` | ``180.0`` |
|
||||
+---------------------------+-------------------------------------------------------------+-----------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -95,7 +95,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **bias**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.3 |
|
||||
| *Default* | ``0.3`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -113,7 +113,7 @@ The higher, the faster.
|
||||
- :ref:`float<class_float>` **relaxation**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -129,7 +129,7 @@ Defines, how fast the swing- and twist-speed-difference on both sides gets synce
|
||||
- :ref:`float<class_float>` **softness**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.8 |
|
||||
| *Default* | ``0.8`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -144,9 +144,9 @@ The ease with which the joint starts to twist. If it's too low, it takes more fo
|
||||
|
||||
- :ref:`float<class_float>` **swing_span**
|
||||
|
||||
+-----------+------+
|
||||
| *Default* | 45.0 |
|
||||
+-----------+------+
|
||||
+-----------+----------+
|
||||
| *Default* | ``45.0`` |
|
||||
+-----------+----------+
|
||||
|
||||
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
|
||||
|
||||
@@ -162,9 +162,9 @@ If below 0.05, this behavior is locked.
|
||||
|
||||
- :ref:`float<class_float>` **twist_span**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | 180.0 |
|
||||
+-----------+-------+
|
||||
+-----------+-----------+
|
||||
| *Default* | ``180.0`` |
|
||||
+-----------+-----------+
|
||||
|
||||
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
|
||||
|
||||
|
||||
@@ -29,11 +29,11 @@ To get cancel action, you can use:
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------+---------------+----------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | rect_min_size | **O:** Vector2( 200, 70 ) |
|
||||
+-------------------------------+---------------+----------------------------+
|
||||
| :ref:`String<class_String>` | window_title | **O:** "Please Confirm..." |
|
||||
+-------------------------------+---------------+----------------------------+
|
||||
+-------------------------------+---------------+--------------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | rect_min_size | **O:** ``Vector2( 200, 70 )`` |
|
||||
+-------------------------------+---------------+--------------------------------+
|
||||
| :ref:`String<class_String>` | window_title | **O:** ``"Please Confirm..."`` |
|
||||
+-------------------------------+---------------+--------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
@@ -42,71 +42,71 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`anchor_bottom<class_Control_property_anchor_bottom>` | 0.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`anchor_left<class_Control_property_anchor_left>` | 0.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`anchor_right<class_Control_property_anchor_right>` | 0.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`anchor_top<class_Control_property_anchor_top>` | 0.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`focus_mode<class_Control_property_focus_mode>` | 0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_bottom<class_Control_property_focus_neighbour_bottom>` | NodePath("") |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_left<class_Control_property_focus_neighbour_left>` | NodePath("") |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_right<class_Control_property_focus_neighbour_right>` | NodePath("") |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_top<class_Control_property_focus_neighbour_top>` | NodePath("") |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_next<class_Control_property_focus_next>` | NodePath("") |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_previous<class_Control_property_focus_previous>` | NodePath("") |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`GrowDirection<enum_Control_GrowDirection>` | :ref:`grow_horizontal<class_Control_property_grow_horizontal>` | 1 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`GrowDirection<enum_Control_GrowDirection>` | :ref:`grow_vertical<class_Control_property_grow_vertical>` | 1 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`String<class_String>` | :ref:`hint_tooltip<class_Control_property_hint_tooltip>` | "" |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`margin_bottom<class_Control_property_margin_bottom>` | 0.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`margin_left<class_Control_property_margin_left>` | 0.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`margin_right<class_Control_property_margin_right>` | 0.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`margin_top<class_Control_property_margin_top>` | 0.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`CursorShape<enum_Control_CursorShape>` | :ref:`mouse_default_cursor_shape<class_Control_property_mouse_default_cursor_shape>` | 0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`MouseFilter<enum_Control_MouseFilter>` | :ref:`mouse_filter<class_Control_property_mouse_filter>` | 0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`rect_clip_content<class_Control_property_rect_clip_content>` | false |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_global_position<class_Control_property_rect_global_position>` | |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_min_size<class_Control_property_rect_min_size>` | Vector2( 0, 0 ) |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>` | Vector2( 0, 0 ) |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_position<class_Control_property_rect_position>` | Vector2( 0, 0 ) |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`rect_rotation<class_Control_property_rect_rotation>` | 0.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_scale<class_Control_property_rect_scale>` | Vector2( 1, 1 ) |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_size<class_Control_property_rect_size>` | Vector2( 0, 0 ) |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`int<class_int>` | :ref:`size_flags_horizontal<class_Control_property_size_flags_horizontal>` | 1 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`float<class_float>` | :ref:`size_flags_stretch_ratio<class_Control_property_size_flags_stretch_ratio>` | 1.0 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`int<class_int>` | :ref:`size_flags_vertical<class_Control_property_size_flags_vertical>` | 1 |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
| :ref:`Theme<class_Theme>` | :ref:`theme<class_Control_property_theme>` | |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anchor_bottom<class_Control_property_anchor_bottom>` | ``0.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anchor_left<class_Control_property_anchor_left>` | ``0.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anchor_right<class_Control_property_anchor_right>` | ``0.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anchor_top<class_Control_property_anchor_top>` | ``0.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`focus_mode<class_Control_property_focus_mode>` | ``0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_bottom<class_Control_property_focus_neighbour_bottom>` | ``NodePath("")`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_left<class_Control_property_focus_neighbour_left>` | ``NodePath("")`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_right<class_Control_property_focus_neighbour_right>` | ``NodePath("")`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_top<class_Control_property_focus_neighbour_top>` | ``NodePath("")`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_next<class_Control_property_focus_next>` | ``NodePath("")`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`NodePath<class_NodePath>` | :ref:`focus_previous<class_Control_property_focus_previous>` | ``NodePath("")`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`GrowDirection<enum_Control_GrowDirection>` | :ref:`grow_horizontal<class_Control_property_grow_horizontal>` | ``1`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`GrowDirection<enum_Control_GrowDirection>` | :ref:`grow_vertical<class_Control_property_grow_vertical>` | ``1`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`String<class_String>` | :ref:`hint_tooltip<class_Control_property_hint_tooltip>` | ``""`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`margin_bottom<class_Control_property_margin_bottom>` | ``0.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`margin_left<class_Control_property_margin_left>` | ``0.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`margin_right<class_Control_property_margin_right>` | ``0.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`margin_top<class_Control_property_margin_top>` | ``0.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`CursorShape<enum_Control_CursorShape>` | :ref:`mouse_default_cursor_shape<class_Control_property_mouse_default_cursor_shape>` | ``0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`MouseFilter<enum_Control_MouseFilter>` | :ref:`mouse_filter<class_Control_property_mouse_filter>` | ``0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`rect_clip_content<class_Control_property_rect_clip_content>` | ``false`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_global_position<class_Control_property_rect_global_position>` | |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_min_size<class_Control_property_rect_min_size>` | ``Vector2( 0, 0 )`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>` | ``Vector2( 0, 0 )`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_position<class_Control_property_rect_position>` | ``Vector2( 0, 0 )`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rect_rotation<class_Control_property_rect_rotation>` | ``0.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_scale<class_Control_property_rect_scale>` | ``Vector2( 1, 1 )`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`rect_size<class_Control_property_rect_size>` | ``Vector2( 0, 0 )`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size_flags_horizontal<class_Control_property_size_flags_horizontal>` | ``1`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`size_flags_stretch_ratio<class_Control_property_size_flags_stretch_ratio>` | ``1.0`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size_flags_vertical<class_Control_property_size_flags_vertical>` | ``1`` |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Theme<class_Theme>` | :ref:`theme<class_Control_property_theme>` | |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -632,7 +632,7 @@ Property Descriptions
|
||||
- :ref:`float<class_float>` **anchor_bottom**
|
||||
|
||||
+-----------+--------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+--------------+
|
||||
| *Getter* | get_anchor() |
|
||||
+-----------+--------------+
|
||||
@@ -646,7 +646,7 @@ Anchors the bottom edge of the node to the origin, the center, or the end of its
|
||||
- :ref:`float<class_float>` **anchor_left**
|
||||
|
||||
+-----------+--------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+--------------+
|
||||
| *Getter* | get_anchor() |
|
||||
+-----------+--------------+
|
||||
@@ -660,7 +660,7 @@ Anchors the left edge of the node to the origin, the center or the end of its pa
|
||||
- :ref:`float<class_float>` **anchor_right**
|
||||
|
||||
+-----------+--------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+--------------+
|
||||
| *Getter* | get_anchor() |
|
||||
+-----------+--------------+
|
||||
@@ -674,7 +674,7 @@ Anchors the right edge of the node to the origin, the center or the end of its p
|
||||
- :ref:`float<class_float>` **anchor_top**
|
||||
|
||||
+-----------+--------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+--------------+
|
||||
| *Getter* | get_anchor() |
|
||||
+-----------+--------------+
|
||||
@@ -688,7 +688,7 @@ Anchors the top edge of the node to the origin, the center or the end of its par
|
||||
- :ref:`FocusMode<enum_Control_FocusMode>` **focus_mode**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_focus_mode(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -704,7 +704,7 @@ The focus access mode for the control (None, Click or All). Only one Control can
|
||||
- :ref:`NodePath<class_NodePath>` **focus_neighbour_bottom**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | NodePath("") |
|
||||
| *Default* | ``NodePath("")`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_focus_neighbour(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -720,7 +720,7 @@ Tells Godot which node it should give keyboard focus to if the user presses the
|
||||
- :ref:`NodePath<class_NodePath>` **focus_neighbour_left**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | NodePath("") |
|
||||
| *Default* | ``NodePath("")`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_focus_neighbour(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -736,7 +736,7 @@ Tells Godot which node it should give keyboard focus to if the user presses the
|
||||
- :ref:`NodePath<class_NodePath>` **focus_neighbour_right**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | NodePath("") |
|
||||
| *Default* | ``NodePath("")`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_focus_neighbour(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -752,7 +752,7 @@ Tells Godot which node it should give keyboard focus to if the user presses the
|
||||
- :ref:`NodePath<class_NodePath>` **focus_neighbour_top**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | NodePath("") |
|
||||
| *Default* | ``NodePath("")`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_focus_neighbour(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -768,7 +768,7 @@ Tells Godot which node it should give keyboard focus to if the user presses the
|
||||
- :ref:`NodePath<class_NodePath>` **focus_next**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | NodePath("") |
|
||||
| *Default* | ``NodePath("")`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_focus_next(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -786,7 +786,7 @@ If this property is not set, Godot will select a "best guess" based on surroundi
|
||||
- :ref:`NodePath<class_NodePath>` **focus_previous**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | NodePath("") |
|
||||
| *Default* | ``NodePath("")`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_focus_previous(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -804,7 +804,7 @@ If this property is not set, Godot will select a "best guess" based on surroundi
|
||||
- :ref:`GrowDirection<enum_Control_GrowDirection>` **grow_horizontal**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_h_grow_direction(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -820,7 +820,7 @@ Controls the direction on the horizontal axis in which the control should grow i
|
||||
- :ref:`GrowDirection<enum_Control_GrowDirection>` **grow_vertical**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_v_grow_direction(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -836,7 +836,7 @@ Controls the direction on the vertical axis in which the control should grow if
|
||||
- :ref:`String<class_String>` **hint_tooltip**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | "" |
|
||||
| *Default* | ``""`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_tooltip(value) |
|
||||
+-----------+--------------------+
|
||||
@@ -850,7 +850,7 @@ Changes the tooltip text. The tooltip appears when the user's mouse cursor stays
|
||||
- :ref:`float<class_float>` **margin_bottom**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_margin(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -868,7 +868,7 @@ Margins are often controlled by one or multiple parent :ref:`Container<class_Con
|
||||
- :ref:`float<class_float>` **margin_left**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_margin(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -886,7 +886,7 @@ Margins are often controlled by one or multiple parent :ref:`Container<class_Con
|
||||
- :ref:`float<class_float>` **margin_right**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_margin(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -904,7 +904,7 @@ Margins are often controlled by one or multiple parent :ref:`Container<class_Con
|
||||
- :ref:`float<class_float>` **margin_top**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_margin(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -922,7 +922,7 @@ Margins are often controlled by one or multiple parent :ref:`Container<class_Con
|
||||
- :ref:`CursorShape<enum_Control_CursorShape>` **mouse_default_cursor_shape**
|
||||
|
||||
+-----------+---------------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------------------------+
|
||||
| *Setter* | set_default_cursor_shape(value) |
|
||||
+-----------+---------------------------------+
|
||||
@@ -940,7 +940,7 @@ The default cursor shape for this control. Useful for Godot plugins and applicat
|
||||
- :ref:`MouseFilter<enum_Control_MouseFilter>` **mouse_filter**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_mouse_filter(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -956,7 +956,7 @@ Controls whether the control will be able to receive mouse button input events t
|
||||
- :ref:`bool<class_bool>` **rect_clip_content**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_clip_contents(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -984,7 +984,7 @@ The node's global position, relative to the world (usually to the top-left corne
|
||||
- :ref:`Vector2<class_Vector2>` **rect_min_size**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | Vector2( 0, 0 ) |
|
||||
| *Default* | ``Vector2( 0, 0 )`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_custom_minimum_size(value) |
|
||||
+-----------+--------------------------------+
|
||||
@@ -1000,7 +1000,7 @@ The minimum size of the node's bounding rectangle. If you set it to a value grea
|
||||
- :ref:`Vector2<class_Vector2>` **rect_pivot_offset**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | Vector2( 0, 0 ) |
|
||||
| *Default* | ``Vector2( 0, 0 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_pivot_offset(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -1015,11 +1015,11 @@ By default, the node's pivot is its top-left corner. When you change its :ref:`r
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **rect_position**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | Vector2( 0, 0 ) |
|
||||
+-----------+-----------------+
|
||||
| *Getter* | get_position() |
|
||||
+-----------+-----------------+
|
||||
+-----------+---------------------+
|
||||
| *Default* | ``Vector2( 0, 0 )`` |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_position() |
|
||||
+-----------+---------------------+
|
||||
|
||||
The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>`.
|
||||
|
||||
@@ -1030,7 +1030,7 @@ The node's position, relative to its parent. It corresponds to the rectangle's t
|
||||
- :ref:`float<class_float>` **rect_rotation**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_rotation_degrees(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -1045,13 +1045,13 @@ The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset<cl
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **rect_scale**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | Vector2( 1, 1 ) |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_scale(value) |
|
||||
+-----------+------------------+
|
||||
| *Getter* | get_scale() |
|
||||
+-----------+------------------+
|
||||
+-----------+---------------------+
|
||||
| *Default* | ``Vector2( 1, 1 )`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_scale(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_scale() |
|
||||
+-----------+---------------------+
|
||||
|
||||
The node's scale, relative to its :ref:`rect_size<class_Control_property_rect_size>`. Change this property to scale the node around its :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>`.
|
||||
|
||||
@@ -1061,11 +1061,11 @@ The node's scale, relative to its :ref:`rect_size<class_Control_property_rect_si
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **rect_size**
|
||||
|
||||
+-----------+-----------------+
|
||||
| *Default* | Vector2( 0, 0 ) |
|
||||
+-----------+-----------------+
|
||||
| *Getter* | get_size() |
|
||||
+-----------+-----------------+
|
||||
+-----------+---------------------+
|
||||
| *Default* | ``Vector2( 0, 0 )`` |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_size() |
|
||||
+-----------+---------------------+
|
||||
|
||||
The size of the node's bounding rectangle, in pixels. :ref:`Container<class_Container>` nodes update this property automatically.
|
||||
|
||||
@@ -1076,7 +1076,7 @@ The size of the node's bounding rectangle, in pixels. :ref:`Container<class_Cont
|
||||
- :ref:`int<class_int>` **size_flags_horizontal**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_h_size_flags(value) |
|
||||
+-----------+-------------------------+
|
||||
@@ -1092,7 +1092,7 @@ Tells the parent :ref:`Container<class_Container>` nodes how they should resize
|
||||
- :ref:`float<class_float>` **size_flags_stretch_ratio**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_stretch_ratio(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -1108,7 +1108,7 @@ If the node and at least one of its neighbours uses the :ref:`SIZE_EXPAND<class_
|
||||
- :ref:`int<class_int>` **size_flags_vertical**
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | 1 |
|
||||
| *Default* | ``1`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_v_size_flags(value) |
|
||||
+-----------+-------------------------+
|
||||
|
||||
@@ -21,9 +21,9 @@ Convex polygon shape resource, which can be added to a :ref:`PhysicsBody<class_P
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+---------------------------------------------------------+----------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`points<class_ConvexPolygonShape_property_points>` | PoolVector3Array( ) |
|
||||
+-------------------------------------------------+---------------------------------------------------------+----------------------+
|
||||
+-------------------------------------------------+---------------------------------------------------------+--------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`points<class_ConvexPolygonShape_property_points>` | ``PoolVector3Array( )`` |
|
||||
+-------------------------------------------------+---------------------------------------------------------+--------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
@@ -32,13 +32,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **points**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | PoolVector3Array( ) |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_points(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_points() |
|
||||
+-----------+----------------------+
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``PoolVector3Array( )`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_points(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_points() |
|
||||
+-----------+--------------------------+
|
||||
|
||||
The list of 3D points forming the convex polygon shape.
|
||||
|
||||
|
||||
@@ -23,9 +23,9 @@ The main difference between a ``ConvexPolygonShape2D`` and a :ref:`ConcavePolygo
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------+-----------------------------------------------------------+----------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`points<class_ConvexPolygonShape2D_property_points>` | PoolVector2Array( ) |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+----------------------+
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`points<class_ConvexPolygonShape2D_property_points>` | ``PoolVector2Array( )`` |
|
||||
+-------------------------------------------------+-----------------------------------------------------------+--------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -41,13 +41,13 @@ Property Descriptions
|
||||
|
||||
- :ref:`PoolVector2Array<class_PoolVector2Array>` **points**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | PoolVector2Array( ) |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_points(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_points() |
|
||||
+-----------+----------------------+
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``PoolVector2Array( )`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_points(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_points() |
|
||||
+-----------+--------------------------+
|
||||
|
||||
The polygon's list of vertices. Can be in either clockwise or counterclockwise order.
|
||||
|
||||
|
||||
@@ -23,135 +23,135 @@ See also :ref:`Particles<class_Particles>`, which provides the same functionalit
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`amount<class_CPUParticles_property_amount>` | 8 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angle<class_CPUParticles_property_angle>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles_property_angle_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angle_random<class_CPUParticles_property_angle_random>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_velocity<class_CPUParticles_property_angular_velocity>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles_property_angular_velocity_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_velocity_random<class_CPUParticles_property_angular_velocity_random>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_offset<class_CPUParticles_property_anim_offset>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles_property_anim_offset_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_offset_random<class_CPUParticles_property_anim_offset_random>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_speed<class_CPUParticles_property_anim_speed>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles_property_anim_speed_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_speed_random<class_CPUParticles_property_anim_speed_random>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_CPUParticles_property_color>` | Color( 1, 1, 1, 1 ) |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles_property_color_ramp>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping<class_CPUParticles_property_damping>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles_property_damping_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping_random<class_CPUParticles_property_damping_random>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`direction<class_CPUParticles_property_direction>` | Vector3( 1, 0, 0 ) |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` | :ref:`draw_order<class_CPUParticles_property_draw_order>` | 0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_CPUParticles_property_emission_box_extents>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`emission_colors<class_CPUParticles_property_emission_colors>` | PoolColorArray( ) |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`emission_normals<class_CPUParticles_property_emission_normals>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`emission_points<class_CPUParticles_property_emission_points>` | PoolVector3Array( ) |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` | :ref:`emission_shape<class_CPUParticles_property_emission_shape>` | 0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_CPUParticles_property_emission_sphere_radius>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emitting<class_CPUParticles_property_emitting>` | true |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`explosiveness<class_CPUParticles_property_explosiveness>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`fixed_fps<class_CPUParticles_property_fixed_fps>` | 0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_align_y<class_CPUParticles_property_flag_align_y>` | false |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_disable_z<class_CPUParticles_property_flag_disable_z>` | false |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_rotate_y<class_CPUParticles_property_flag_rotate_y>` | false |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`flatness<class_CPUParticles_property_flatness>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`fract_delta<class_CPUParticles_property_fract_delta>` | true |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_CPUParticles_property_gravity>` | Vector3( 0, -9.8, 0 ) |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hue_variation<class_CPUParticles_property_hue_variation>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles_property_hue_variation_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles_property_hue_variation_random>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity<class_CPUParticles_property_initial_velocity>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity_random<class_CPUParticles_property_initial_velocity_random>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`lifetime<class_CPUParticles_property_lifetime>` | 1.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`lifetime_randomness<class_CPUParticles_property_lifetime_randomness>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_accel<class_CPUParticles_property_linear_accel>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles_property_linear_accel_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_accel_random<class_CPUParticles_property_linear_accel_random>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles_property_local_coords>` | true |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CPUParticles_property_mesh>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles_property_one_shot>` | false |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity<class_CPUParticles_property_orbit_velocity>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`orbit_velocity_curve<class_CPUParticles_property_orbit_velocity_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity_random<class_CPUParticles_property_orbit_velocity_random>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles_property_preprocess>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles_property_radial_accel>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles_property_radial_accel_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles_property_radial_accel_random>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles_property_randomness>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles_property_scale_amount>` | 1.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles_property_scale_amount_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles_property_scale_amount_random>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles_property_speed_scale>` | 1.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`spread<class_CPUParticles_property_spread>` | 45.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tangential_accel<class_CPUParticles_property_tangential_accel>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles_property_tangential_accel_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles_property_tangential_accel_random>` | 0.0 |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`amount<class_CPUParticles_property_amount>` | ``8`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angle<class_CPUParticles_property_angle>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles_property_angle_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angle_random<class_CPUParticles_property_angle_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_velocity<class_CPUParticles_property_angular_velocity>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles_property_angular_velocity_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_velocity_random<class_CPUParticles_property_angular_velocity_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_offset<class_CPUParticles_property_anim_offset>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles_property_anim_offset_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_offset_random<class_CPUParticles_property_anim_offset_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_speed<class_CPUParticles_property_anim_speed>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles_property_anim_speed_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_speed_random<class_CPUParticles_property_anim_speed_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_CPUParticles_property_color>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles_property_color_ramp>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping<class_CPUParticles_property_damping>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles_property_damping_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping_random<class_CPUParticles_property_damping_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`direction<class_CPUParticles_property_direction>` | ``Vector3( 1, 0, 0 )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` | :ref:`draw_order<class_CPUParticles_property_draw_order>` | ``0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_CPUParticles_property_emission_box_extents>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`emission_colors<class_CPUParticles_property_emission_colors>` | ``PoolColorArray( )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`emission_normals<class_CPUParticles_property_emission_normals>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`emission_points<class_CPUParticles_property_emission_points>` | ``PoolVector3Array( )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` | :ref:`emission_shape<class_CPUParticles_property_emission_shape>` | ``0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_CPUParticles_property_emission_sphere_radius>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emitting<class_CPUParticles_property_emitting>` | ``true`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`explosiveness<class_CPUParticles_property_explosiveness>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`fixed_fps<class_CPUParticles_property_fixed_fps>` | ``0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_align_y<class_CPUParticles_property_flag_align_y>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_disable_z<class_CPUParticles_property_flag_disable_z>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_rotate_y<class_CPUParticles_property_flag_rotate_y>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`flatness<class_CPUParticles_property_flatness>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`fract_delta<class_CPUParticles_property_fract_delta>` | ``true`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_CPUParticles_property_gravity>` | ``Vector3( 0, -9.8, 0 )`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hue_variation<class_CPUParticles_property_hue_variation>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles_property_hue_variation_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles_property_hue_variation_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity<class_CPUParticles_property_initial_velocity>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity_random<class_CPUParticles_property_initial_velocity_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`lifetime<class_CPUParticles_property_lifetime>` | ``1.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`lifetime_randomness<class_CPUParticles_property_lifetime_randomness>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_accel<class_CPUParticles_property_linear_accel>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles_property_linear_accel_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_accel_random<class_CPUParticles_property_linear_accel_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles_property_local_coords>` | ``true`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CPUParticles_property_mesh>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles_property_one_shot>` | ``false`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity<class_CPUParticles_property_orbit_velocity>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`orbit_velocity_curve<class_CPUParticles_property_orbit_velocity_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity_random<class_CPUParticles_property_orbit_velocity_random>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles_property_preprocess>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles_property_radial_accel>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles_property_radial_accel_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles_property_radial_accel_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles_property_randomness>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles_property_scale_amount>` | ``1.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles_property_scale_amount_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles_property_scale_amount_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles_property_speed_scale>` | ``1.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`spread<class_CPUParticles_property_spread>` | ``45.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tangential_accel<class_CPUParticles_property_tangential_accel>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles_property_tangential_accel_curve>` | |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles_property_tangential_accel_random>` | ``0.0`` |
|
||||
+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -315,7 +315,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **amount**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 8 |
|
||||
| *Default* | ``8`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_amount(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -331,7 +331,7 @@ Number of particles emitted in one emission cycle.
|
||||
- :ref:`float<class_float>` **angle**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -361,7 +361,7 @@ Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **angle_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -377,7 +377,7 @@ Rotation randomness ratio.
|
||||
- :ref:`float<class_float>` **angular_velocity**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -407,7 +407,7 @@ Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **angular_velocity_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -423,7 +423,7 @@ Angular velocity randomness ratio.
|
||||
- :ref:`float<class_float>` **anim_offset**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -453,7 +453,7 @@ Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **anim_offset_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -469,7 +469,7 @@ Animation offset randomness ratio.
|
||||
- :ref:`float<class_float>` **anim_speed**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -499,7 +499,7 @@ Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **anim_speed_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -514,13 +514,13 @@ Animation speed randomness ratio.
|
||||
|
||||
- :ref:`Color<class_Color>` **color**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | Color( 1, 1, 1, 1 ) |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_color(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_color() |
|
||||
+-----------+---------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_color(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_color() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
Unused for 3D particles.
|
||||
|
||||
@@ -545,7 +545,7 @@ Unused for 3D particles.
|
||||
- :ref:`float<class_float>` **damping**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -575,7 +575,7 @@ Damping will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **damping_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -590,13 +590,13 @@ Damping randomness ratio.
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **direction**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | Vector3( 1, 0, 0 ) |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_direction(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_direction() |
|
||||
+-----------+----------------------+
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``Vector3( 1, 0, 0 )`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_direction(value) |
|
||||
+-----------+------------------------+
|
||||
| *Getter* | get_direction() |
|
||||
+-----------+------------------------+
|
||||
|
||||
Unit vector specifying the particles' emission direction.
|
||||
|
||||
@@ -607,7 +607,7 @@ Unit vector specifying the particles' emission direction.
|
||||
- :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` **draw_order**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_draw_order(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -637,7 +637,7 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emis
|
||||
- :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | PoolColorArray( ) |
|
||||
| *Default* | ``PoolColorArray( )`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_emission_colors(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -663,7 +663,7 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emis
|
||||
- :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_points**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | PoolVector3Array( ) |
|
||||
| *Default* | ``PoolVector3Array( )`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_emission_points(value) |
|
||||
+-----------+----------------------------+
|
||||
@@ -677,7 +677,7 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emis
|
||||
- :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` **emission_shape**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_emission_shape(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -707,7 +707,7 @@ The sphere's radius if :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` is
|
||||
- :ref:`bool<class_bool>` **emitting**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_emitting(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -723,7 +723,7 @@ If ``true``, particles are being emitted.
|
||||
- :ref:`float<class_float>` **explosiveness**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_explosiveness_ratio(value) |
|
||||
+-----------+--------------------------------+
|
||||
@@ -739,7 +739,7 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t
|
||||
- :ref:`int<class_int>` **fixed_fps**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_fixed_fps(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -755,7 +755,7 @@ The particle system's frame rate is fixed to a value. For instance, changing the
|
||||
- :ref:`bool<class_bool>` **flag_align_y**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_particle_flag(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -771,7 +771,7 @@ Align Y axis of particle with the direction of its velocity.
|
||||
- :ref:`bool<class_bool>` **flag_disable_z**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_particle_flag(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -787,7 +787,7 @@ If ``true``, particles will not move on the z axis.
|
||||
- :ref:`bool<class_bool>` **flag_rotate_y**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_particle_flag(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -803,7 +803,7 @@ If ``true``, particles rotate around Y axis by :ref:`angle<class_CPUParticles_pr
|
||||
- :ref:`float<class_float>` **flatness**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_flatness(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -819,7 +819,7 @@ Amount of :ref:`spread<class_CPUParticles_property_spread>` in Y/Z plane. A valu
|
||||
- :ref:`bool<class_bool>` **fract_delta**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_fractional_delta(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -834,13 +834,13 @@ If ``true``, results in fractional delta calculation which has a smoother partic
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **gravity**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | Vector3( 0, -9.8, 0 ) |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_gravity(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_gravity() |
|
||||
+-----------+-----------------------+
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``Vector3( 0, -9.8, 0 )`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_gravity(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | get_gravity() |
|
||||
+-----------+---------------------------+
|
||||
|
||||
Gravity applied to every particle.
|
||||
|
||||
@@ -851,7 +851,7 @@ Gravity applied to every particle.
|
||||
- :ref:`float<class_float>` **hue_variation**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -881,7 +881,7 @@ Each particle's hue will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **hue_variation_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -897,7 +897,7 @@ Hue variation randomness ratio.
|
||||
- :ref:`float<class_float>` **initial_velocity**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -913,7 +913,7 @@ Initial velocity magnitude for each particle. Direction comes from :ref:`spread<
|
||||
- :ref:`float<class_float>` **initial_velocity_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -929,7 +929,7 @@ Initial velocity randomness ratio.
|
||||
- :ref:`float<class_float>` **lifetime**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_lifetime(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -945,7 +945,7 @@ Amount of time each particle will exist.
|
||||
- :ref:`float<class_float>` **lifetime_randomness**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_lifetime_randomness(value) |
|
||||
+-----------+--------------------------------+
|
||||
@@ -961,7 +961,7 @@ Particle lifetime randomness ratio.
|
||||
- :ref:`float<class_float>` **linear_accel**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -991,7 +991,7 @@ Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve
|
||||
- :ref:`float<class_float>` **linear_accel_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -1007,7 +1007,7 @@ Linear acceleration randomness ratio.
|
||||
- :ref:`bool<class_bool>` **local_coords**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_use_local_coordinates(value) |
|
||||
+-----------+----------------------------------+
|
||||
@@ -1037,7 +1037,7 @@ The :ref:`Mesh<class_Mesh>` used for each particle. If ``null``, particles will
|
||||
- :ref:`bool<class_bool>` **one_shot**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_one_shot(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -1097,7 +1097,7 @@ Orbital velocity randomness ratio.
|
||||
- :ref:`float<class_float>` **preprocess**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_pre_process_time(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -1113,7 +1113,7 @@ Particle system starts as if it had already run for this many seconds.
|
||||
- :ref:`float<class_float>` **radial_accel**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -1143,7 +1143,7 @@ Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve
|
||||
- :ref:`float<class_float>` **radial_accel_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -1159,7 +1159,7 @@ Radial acceleration randomness ratio.
|
||||
- :ref:`float<class_float>` **randomness**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_randomness_ratio(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -1175,7 +1175,7 @@ Emission lifetime randomness ratio.
|
||||
- :ref:`float<class_float>` **scale_amount**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -1205,7 +1205,7 @@ Each particle's scale will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **scale_amount_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -1221,7 +1221,7 @@ Scale randomness ratio.
|
||||
- :ref:`float<class_float>` **speed_scale**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_speed_scale(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -1237,7 +1237,7 @@ Particle system's running speed scaling ratio. A value of ``0`` can be used to p
|
||||
- :ref:`float<class_float>` **spread**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 45.0 |
|
||||
| *Default* | ``45.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_spread(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -1253,7 +1253,7 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees.
|
||||
- :ref:`float<class_float>` **tangential_accel**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -1283,7 +1283,7 @@ Each particle's tangential acceleration will vary along this :ref:`Curve<class_C
|
||||
- :ref:`float<class_float>` **tangential_accel_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
|
||||
@@ -28,133 +28,133 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`amount<class_CPUParticles2D_property_amount>` | 8 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angle<class_CPUParticles2D_property_angle>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles2D_property_angle_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angle_random<class_CPUParticles2D_property_angle_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_velocity<class_CPUParticles2D_property_angular_velocity>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles2D_property_angular_velocity_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_velocity_random<class_CPUParticles2D_property_angular_velocity_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_offset<class_CPUParticles2D_property_anim_offset>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles2D_property_anim_offset_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_offset_random<class_CPUParticles2D_property_anim_offset_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_speed<class_CPUParticles2D_property_anim_speed>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles2D_property_anim_speed_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_speed_random<class_CPUParticles2D_property_anim_speed_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_CPUParticles2D_property_color>` | Color( 1, 1, 1, 1 ) |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles2D_property_color_ramp>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping<class_CPUParticles2D_property_damping>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles2D_property_damping_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping_random<class_CPUParticles2D_property_damping_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`direction<class_CPUParticles2D_property_direction>` | Vector2( 1, 0 ) |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` | :ref:`draw_order<class_CPUParticles2D_property_draw_order>` | 0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`emission_colors<class_CPUParticles2D_property_emission_colors>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`emission_normals<class_CPUParticles2D_property_emission_normals>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`emission_points<class_CPUParticles2D_property_emission_points>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`emission_rect_extents<class_CPUParticles2D_property_emission_rect_extents>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`EmissionShape<enum_CPUParticles2D_EmissionShape>` | :ref:`emission_shape<class_CPUParticles2D_property_emission_shape>` | 0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_CPUParticles2D_property_emission_sphere_radius>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emitting<class_CPUParticles2D_property_emitting>` | true |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`explosiveness<class_CPUParticles2D_property_explosiveness>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`int<class_int>` | :ref:`fixed_fps<class_CPUParticles2D_property_fixed_fps>` | 0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_align_y<class_CPUParticles2D_property_flag_align_y>` | false |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`flatness<class_CPUParticles2D_property_flatness>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`fract_delta<class_CPUParticles2D_property_fract_delta>` | true |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`gravity<class_CPUParticles2D_property_gravity>` | Vector2( 0, 98 ) |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hue_variation<class_CPUParticles2D_property_hue_variation>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles2D_property_hue_variation_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles2D_property_hue_variation_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity<class_CPUParticles2D_property_initial_velocity>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity_random<class_CPUParticles2D_property_initial_velocity_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`lifetime<class_CPUParticles2D_property_lifetime>` | 1.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`lifetime_randomness<class_CPUParticles2D_property_lifetime_randomness>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_accel<class_CPUParticles2D_property_linear_accel>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles2D_property_linear_accel_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_accel_random<class_CPUParticles2D_property_linear_accel_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles2D_property_local_coords>` | true |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`normalmap<class_CPUParticles2D_property_normalmap>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles2D_property_one_shot>` | false |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity<class_CPUParticles2D_property_orbit_velocity>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`orbit_velocity_curve<class_CPUParticles2D_property_orbit_velocity_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity_random<class_CPUParticles2D_property_orbit_velocity_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles2D_property_preprocess>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles2D_property_radial_accel>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles2D_property_radial_accel_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles2D_property_radial_accel_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles2D_property_randomness>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles2D_property_scale_amount>` | 1.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles2D_property_scale_amount_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles2D_property_scale_amount_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles2D_property_speed_scale>` | 1.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`spread<class_CPUParticles2D_property_spread>` | 45.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tangential_accel<class_CPUParticles2D_property_tangential_accel>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles2D_property_tangential_accel_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles2D_property_tangential_accel_random>` | 0.0 |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`texture<class_CPUParticles2D_property_texture>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`amount<class_CPUParticles2D_property_amount>` | ``8`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angle<class_CPUParticles2D_property_angle>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles2D_property_angle_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angle_random<class_CPUParticles2D_property_angle_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_velocity<class_CPUParticles2D_property_angular_velocity>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles2D_property_angular_velocity_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`angular_velocity_random<class_CPUParticles2D_property_angular_velocity_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_offset<class_CPUParticles2D_property_anim_offset>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles2D_property_anim_offset_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_offset_random<class_CPUParticles2D_property_anim_offset_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_speed<class_CPUParticles2D_property_anim_speed>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles2D_property_anim_speed_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`anim_speed_random<class_CPUParticles2D_property_anim_speed_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_CPUParticles2D_property_color>` | ``Color( 1, 1, 1, 1 )`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles2D_property_color_ramp>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping<class_CPUParticles2D_property_damping>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles2D_property_damping_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damping_random<class_CPUParticles2D_property_damping_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`direction<class_CPUParticles2D_property_direction>` | ``Vector2( 1, 0 )`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` | :ref:`draw_order<class_CPUParticles2D_property_draw_order>` | ``0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`emission_colors<class_CPUParticles2D_property_emission_colors>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`emission_normals<class_CPUParticles2D_property_emission_normals>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`emission_points<class_CPUParticles2D_property_emission_points>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`emission_rect_extents<class_CPUParticles2D_property_emission_rect_extents>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`EmissionShape<enum_CPUParticles2D_EmissionShape>` | :ref:`emission_shape<class_CPUParticles2D_property_emission_shape>` | ``0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_CPUParticles2D_property_emission_sphere_radius>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`emitting<class_CPUParticles2D_property_emitting>` | ``true`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`explosiveness<class_CPUParticles2D_property_explosiveness>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`fixed_fps<class_CPUParticles2D_property_fixed_fps>` | ``0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`flag_align_y<class_CPUParticles2D_property_flag_align_y>` | ``false`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`flatness<class_CPUParticles2D_property_flatness>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`fract_delta<class_CPUParticles2D_property_fract_delta>` | ``true`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`gravity<class_CPUParticles2D_property_gravity>` | ``Vector2( 0, 98 )`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hue_variation<class_CPUParticles2D_property_hue_variation>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles2D_property_hue_variation_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles2D_property_hue_variation_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity<class_CPUParticles2D_property_initial_velocity>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`initial_velocity_random<class_CPUParticles2D_property_initial_velocity_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`lifetime<class_CPUParticles2D_property_lifetime>` | ``1.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`lifetime_randomness<class_CPUParticles2D_property_lifetime_randomness>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_accel<class_CPUParticles2D_property_linear_accel>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles2D_property_linear_accel_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`linear_accel_random<class_CPUParticles2D_property_linear_accel_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles2D_property_local_coords>` | ``true`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`normalmap<class_CPUParticles2D_property_normalmap>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles2D_property_one_shot>` | ``false`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity<class_CPUParticles2D_property_orbit_velocity>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`orbit_velocity_curve<class_CPUParticles2D_property_orbit_velocity_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`orbit_velocity_random<class_CPUParticles2D_property_orbit_velocity_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles2D_property_preprocess>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles2D_property_radial_accel>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles2D_property_radial_accel_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles2D_property_radial_accel_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles2D_property_randomness>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles2D_property_scale_amount>` | ``1.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles2D_property_scale_amount_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles2D_property_scale_amount_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles2D_property_speed_scale>` | ``1.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`spread<class_CPUParticles2D_property_spread>` | ``45.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tangential_accel<class_CPUParticles2D_property_tangential_accel>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles2D_property_tangential_accel_curve>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles2D_property_tangential_accel_random>` | ``0.0`` |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
| :ref:`Texture<class_Texture>` | :ref:`texture<class_CPUParticles2D_property_texture>` | |
|
||||
+---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -314,7 +314,7 @@ Property Descriptions
|
||||
- :ref:`int<class_int>` **amount**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 8 |
|
||||
| *Default* | ``8`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_amount(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -330,7 +330,7 @@ Number of particles emitted in one emission cycle.
|
||||
- :ref:`float<class_float>` **angle**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -360,7 +360,7 @@ Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **angle_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -376,7 +376,7 @@ Rotation randomness ratio.
|
||||
- :ref:`float<class_float>` **angular_velocity**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -406,7 +406,7 @@ Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **angular_velocity_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -422,7 +422,7 @@ Angular velocity randomness ratio.
|
||||
- :ref:`float<class_float>` **anim_offset**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -452,7 +452,7 @@ Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **anim_offset_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -468,7 +468,7 @@ Animation offset randomness ratio.
|
||||
- :ref:`float<class_float>` **anim_speed**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -498,7 +498,7 @@ Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **anim_speed_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -513,13 +513,13 @@ Animation speed randomness ratio.
|
||||
|
||||
- :ref:`Color<class_Color>` **color**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | Color( 1, 1, 1, 1 ) |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_color(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_color() |
|
||||
+-----------+---------------------+
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_color(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_color() |
|
||||
+-----------+-------------------------+
|
||||
|
||||
Each particle's initial color. If :ref:`texture<class_CPUParticles2D_property_texture>` is defined, it will be multiplied by this color.
|
||||
|
||||
@@ -544,7 +544,7 @@ Each particle's color will vary along this :ref:`Gradient<class_Gradient>`.
|
||||
- :ref:`float<class_float>` **damping**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -574,7 +574,7 @@ Damping will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **damping_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -590,7 +590,7 @@ Damping randomness ratio.
|
||||
- :ref:`Vector2<class_Vector2>` **direction**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | Vector2( 1, 0 ) |
|
||||
| *Default* | ``Vector2( 1, 0 )`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_direction(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -606,7 +606,7 @@ Unit vector specifying the particles' emission direction.
|
||||
- :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` **draw_order**
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_draw_order(value) |
|
||||
+-----------+-----------------------+
|
||||
@@ -672,7 +672,7 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles2D_property_em
|
||||
- :ref:`EmissionShape<enum_CPUParticles2D_EmissionShape>` **emission_shape**
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_emission_shape(value) |
|
||||
+-----------+---------------------------+
|
||||
@@ -702,7 +702,7 @@ The sphere's radius if :ref:`emission_shape<class_CPUParticles2D_property_emissi
|
||||
- :ref:`bool<class_bool>` **emitting**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_emitting(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -718,7 +718,7 @@ If ``true``, particles are being emitted.
|
||||
- :ref:`float<class_float>` **explosiveness**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_explosiveness_ratio(value) |
|
||||
+-----------+--------------------------------+
|
||||
@@ -734,7 +734,7 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t
|
||||
- :ref:`int<class_int>` **fixed_fps**
|
||||
|
||||
+-----------+----------------------+
|
||||
| *Default* | 0 |
|
||||
| *Default* | ``0`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_fixed_fps(value) |
|
||||
+-----------+----------------------+
|
||||
@@ -750,7 +750,7 @@ The particle system's frame rate is fixed to a value. For instance, changing the
|
||||
- :ref:`bool<class_bool>` **flag_align_y**
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_particle_flag(value) |
|
||||
+-----------+--------------------------+
|
||||
@@ -766,7 +766,7 @@ Align Y axis of particle with the direction of its velocity.
|
||||
- :ref:`float<class_float>` **flatness**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_flatness(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -780,7 +780,7 @@ Align Y axis of particle with the direction of its velocity.
|
||||
- :ref:`bool<class_bool>` **fract_delta**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_fractional_delta(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -795,13 +795,13 @@ If ``true``, results in fractional delta calculation which has a smoother partic
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **gravity**
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | Vector2( 0, 98 ) |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_gravity(value) |
|
||||
+-----------+--------------------+
|
||||
| *Getter* | get_gravity() |
|
||||
+-----------+--------------------+
|
||||
+-----------+----------------------+
|
||||
| *Default* | ``Vector2( 0, 98 )`` |
|
||||
+-----------+----------------------+
|
||||
| *Setter* | set_gravity(value) |
|
||||
+-----------+----------------------+
|
||||
| *Getter* | get_gravity() |
|
||||
+-----------+----------------------+
|
||||
|
||||
Gravity applied to every particle.
|
||||
|
||||
@@ -812,7 +812,7 @@ Gravity applied to every particle.
|
||||
- :ref:`float<class_float>` **hue_variation**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -842,7 +842,7 @@ Each particle's hue will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **hue_variation_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -858,7 +858,7 @@ Hue variation randomness ratio.
|
||||
- :ref:`float<class_float>` **initial_velocity**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -874,7 +874,7 @@ Initial velocity magnitude for each particle. Direction comes from :ref:`spread<
|
||||
- :ref:`float<class_float>` **initial_velocity_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -890,7 +890,7 @@ Initial velocity randomness ratio.
|
||||
- :ref:`float<class_float>` **lifetime**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_lifetime(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -906,7 +906,7 @@ Amount of time each particle will exist.
|
||||
- :ref:`float<class_float>` **lifetime_randomness**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+--------------------------------+
|
||||
| *Setter* | set_lifetime_randomness(value) |
|
||||
+-----------+--------------------------------+
|
||||
@@ -922,7 +922,7 @@ Particle lifetime randomness ratio.
|
||||
- :ref:`float<class_float>` **linear_accel**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -952,7 +952,7 @@ Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve
|
||||
- :ref:`float<class_float>` **linear_accel_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -968,7 +968,7 @@ Linear acceleration randomness ratio.
|
||||
- :ref:`bool<class_bool>` **local_coords**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | true |
|
||||
| *Default* | ``true`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_use_local_coordinates(value) |
|
||||
+-----------+----------------------------------+
|
||||
@@ -998,7 +998,7 @@ Normal map to be used for the :ref:`texture<class_CPUParticles2D_property_textur
|
||||
- :ref:`bool<class_bool>` **one_shot**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | false |
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_one_shot(value) |
|
||||
+-----------+---------------------+
|
||||
@@ -1014,7 +1014,7 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi
|
||||
- :ref:`float<class_float>` **orbit_velocity**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -1044,7 +1044,7 @@ Each particle's orbital velocity will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **orbit_velocity_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -1060,7 +1060,7 @@ Orbital velocity randomness ratio.
|
||||
- :ref:`float<class_float>` **preprocess**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_pre_process_time(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -1076,7 +1076,7 @@ Particle system starts as if it had already run for this many seconds.
|
||||
- :ref:`float<class_float>` **radial_accel**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -1106,7 +1106,7 @@ Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve
|
||||
- :ref:`float<class_float>` **radial_accel_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -1122,7 +1122,7 @@ Radial acceleration randomness ratio.
|
||||
- :ref:`float<class_float>` **randomness**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_randomness_ratio(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -1138,7 +1138,7 @@ Emission lifetime randomness ratio.
|
||||
- :ref:`float<class_float>` **scale_amount**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -1168,7 +1168,7 @@ Each particle's scale will vary along this :ref:`Curve<class_Curve>`.
|
||||
- :ref:`float<class_float>` **scale_amount_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
@@ -1184,7 +1184,7 @@ Scale randomness ratio.
|
||||
- :ref:`float<class_float>` **speed_scale**
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | 1.0 |
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_speed_scale(value) |
|
||||
+-----------+------------------------+
|
||||
@@ -1200,7 +1200,7 @@ Particle system's running speed scaling ratio. A value of ``0`` can be used to p
|
||||
- :ref:`float<class_float>` **spread**
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | 45.0 |
|
||||
| *Default* | ``45.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_spread(value) |
|
||||
+-----------+-------------------+
|
||||
@@ -1216,7 +1216,7 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees.
|
||||
- :ref:`float<class_float>` **tangential_accel**
|
||||
|
||||
+-----------+------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+------------------+
|
||||
| *Setter* | set_param(value) |
|
||||
+-----------+------------------+
|
||||
@@ -1246,7 +1246,7 @@ Each particle's tangential acceleration will vary along this :ref:`Curve<class_C
|
||||
- :ref:`float<class_float>` **tangential_accel_random**
|
||||
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | 0.0 |
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+-----------------------------+
|
||||
| *Setter* | set_param_randomness(value) |
|
||||
+-----------+-----------------------------+
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user