godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-07-02 14:03:23 +02:00
parent 5402f28f59
commit a203daa272
397 changed files with 21934 additions and 16529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

242
classes/class_@globalscope.rst
View File

@@ -982,7 +982,7 @@ enum **KeyList**:
- **KEY_UNDERSCORE** = **95** --- \_ key.
- **KEY_QUOTELEFT** = **96** --- Left Quote key.
- **KEY_QUOTELEFT** = **96** --- ` key.
- **KEY_BRACELEFT** = **123** --- { key.
@@ -1000,9 +1000,9 @@ enum **KeyList**:
- **KEY_STERLING** = **163** --- £ key.
- **KEY_CURRENCY** = **164**
- **KEY_CURRENCY** = **164** --- ¤ key.
- **KEY_YEN** = **165** --- Yen key.
- **KEY_YEN** = **165** --- ¥ key.
- **KEY_BROKENBAR** = **166** --- ¦ key.
@@ -1012,17 +1012,17 @@ enum **KeyList**:
- **KEY_COPYRIGHT** = **169** --- © key.
- **KEY_ORDFEMININE** = **170**
- **KEY_ORDFEMININE** = **170** --- ª key.
- **KEY_GUILLEMOTLEFT** = **171** --- « key.
- **KEY_NOTSIGN** = **172** --- » key.
- **KEY_NOTSIGN** = **172** --- ¬ key.
- **KEY_HYPHEN** = **173** --- ‐ key.
- **KEY_HYPHEN** = **173** --- Soft hyphen key.
- **KEY_REGISTERED** = **174** --- ® key.
- **KEY_MACRON** = **175** --- Macron key.
- **KEY_MACRON** = **175** --- ¯ key.
- **KEY_DEGREE** = **176** --- ° key.
@@ -1036,15 +1036,15 @@ enum **KeyList**:
- **KEY_MU** = **181** --- µ key.
- **KEY_PARAGRAPH** = **182** --- § key.
- **KEY_PARAGRAPH** = **182** --- key.
- **KEY_PERIODCENTERED** = **183** --- · key.
- **KEY_CEDILLA** = **184** --- ¬ key.
- **KEY_CEDILLA** = **184** --- ¸ key.
- **KEY_ONESUPERIOR** = **185** --- ¹ key.
- **KEY_MASCULINE** = **186** --- ♂ key.
- **KEY_MASCULINE** = **186** --- º key.
- **KEY_GUILLEMOTRIGHT** = **187** --- » key.
@@ -1056,67 +1056,67 @@ enum **KeyList**:
- **KEY_QUESTIONDOWN** = **191** --- ¿ key.
- **KEY_AGRAVE** = **192** --- à key.
- **KEY_AGRAVE** = **192** --- À key.
- **KEY_AACUTE** = **193** --- á key.
- **KEY_AACUTE** = **193** --- Á key.
- **KEY_ACIRCUMFLEX** = **194** --- â key.
- **KEY_ACIRCUMFLEX** = **194** --- Â key.
- **KEY_ATILDE** = **195** --- ã key.
- **KEY_ATILDE** = **195** --- Ã key.
- **KEY_ADIAERESIS** = **196** --- ä key.
- **KEY_ADIAERESIS** = **196** --- Ä key.
- **KEY_ARING** = **197** --- å key.
- **KEY_ARING** = **197** --- Å key.
- **KEY_AE** = **198** --- æ key.
- **KEY_AE** = **198** --- Æ key.
- **KEY_CCEDILLA** = **199** --- ç key.
- **KEY_CCEDILLA** = **199** --- Ç key.
- **KEY_EGRAVE** = **200** --- è key.
- **KEY_EGRAVE** = **200** --- È key.
- **KEY_EACUTE** = **201** --- é key.
- **KEY_EACUTE** = **201** --- É key.
- **KEY_ECIRCUMFLEX** = **202** --- ê key.
- **KEY_ECIRCUMFLEX** = **202** --- Ê key.
- **KEY_EDIAERESIS** = **203** --- ë key.
- **KEY_EDIAERESIS** = **203** --- Ë key.
- **KEY_IGRAVE** = **204** --- ì key.
- **KEY_IGRAVE** = **204** --- Ì key.
- **KEY_IACUTE** = **205** --- í key.
- **KEY_IACUTE** = **205** --- Í key.
- **KEY_ICIRCUMFLEX** = **206** --- î key.
- **KEY_ICIRCUMFLEX** = **206** --- Î key.
- **KEY_IDIAERESIS** = **207** --- ë key.
- **KEY_IDIAERESIS** = **207** --- Ï key.
- **KEY_ETH** = **208** --- ð key.
- **KEY_ETH** = **208** --- Ð key.
- **KEY_NTILDE** = **209** --- ñ key.
- **KEY_NTILDE** = **209** --- Ñ key.
- **KEY_OGRAVE** = **210** --- ò key.
- **KEY_OGRAVE** = **210** --- Ò key.
- **KEY_OACUTE** = **211** --- ó key.
- **KEY_OACUTE** = **211** --- Ó key.
- **KEY_OCIRCUMFLEX** = **212** --- ô key.
- **KEY_OCIRCUMFLEX** = **212** --- Ô key.
- **KEY_OTILDE** = **213** --- õ key.
- **KEY_OTILDE** = **213** --- Õ key.
- **KEY_ODIAERESIS** = **214** --- ö key.
- **KEY_ODIAERESIS** = **214** --- Ö key.
- **KEY_MULTIPLY** = **215** --- × key.
- **KEY_OOBLIQUE** = **216** --- ø key.
- **KEY_OOBLIQUE** = **216** --- Ø key.
- **KEY_UGRAVE** = **217** --- ù key.
- **KEY_UGRAVE** = **217** --- Ù key.
- **KEY_UACUTE** = **218** --- ú key.
- **KEY_UACUTE** = **218** --- Ú key.
- **KEY_UCIRCUMFLEX** = **219** --- û key.
- **KEY_UCIRCUMFLEX** = **219** --- Û key.
- **KEY_UDIAERESIS** = **220** --- ü key.
- **KEY_UDIAERESIS** = **220** --- Ü key.
- **KEY_YACUTE** = **221** --- ý key.
- **KEY_YACUTE** = **221** --- Ý key.
- **KEY_THORN** = **222** --- þ key.
- **KEY_THORN** = **222** --- Þ key.
- **KEY_SSHARP** = **223** --- ß key.
@@ -1416,13 +1416,13 @@ enum **JoystickList**:
- **JOY_XBOX_Y** = **3** --- Xbox controller Y button.
- **JOY_DS_A** = **1** --- DualShock controller A button.
- **JOY_DS_A** = **1** --- Nintendo controller A button.
- **JOY_DS_B** = **0** --- DualShock controller B button.
- **JOY_DS_B** = **0** --- Nintendo controller B button.
- **JOY_DS_X** = **3** --- DualShock controller X button.
- **JOY_DS_X** = **3** --- Nintendo controller X button.
- **JOY_DS_Y** = **2** --- DualShock controller Y button.
- **JOY_DS_Y** = **2** --- Nintendo controller Y button.
- **JOY_VR_GRIP** = **2** --- Grip (side) buttons on a VR controller.
@@ -1470,17 +1470,17 @@ enum **JoystickList**:
- **JOY_AXIS_3** = **3** --- Gamepad right stick vertical axis.
- **JOY_AXIS_4** = **4**
- **JOY_AXIS_4** = **4** --- Generic gamepad axis 4.
- **JOY_AXIS_5** = **5**
- **JOY_AXIS_5** = **5** --- Generic gamepad axis 5.
- **JOY_AXIS_6** = **6** --- Gamepad left trigger analog axis.
- **JOY_AXIS_7** = **7** --- Gamepad right trigger analog axis.
- **JOY_AXIS_8** = **8**
- **JOY_AXIS_8** = **8** --- Generic gamepad axis 8.
- **JOY_AXIS_9** = **9**
- **JOY_AXIS_9** = **9** --- Generic gamepad axis 9.
- **JOY_AXIS_MAX** = **10** --- Represents the maximum number of joystick axes supported.
@@ -1522,19 +1522,19 @@ enum **JoystickList**:
enum **MidiMessageList**:
- **MIDI_MESSAGE_NOTE_OFF** = **8**
- **MIDI_MESSAGE_NOTE_OFF** = **8** --- MIDI note OFF message.
- **MIDI_MESSAGE_NOTE_ON** = **9**
- **MIDI_MESSAGE_NOTE_ON** = **9** --- MIDI note ON message.
- **MIDI_MESSAGE_AFTERTOUCH** = **10**
- **MIDI_MESSAGE_AFTERTOUCH** = **10** --- MIDI aftertouch message.
- **MIDI_MESSAGE_CONTROL_CHANGE** = **11**
- **MIDI_MESSAGE_CONTROL_CHANGE** = **11** --- MIDI control change message.
- **MIDI_MESSAGE_PROGRAM_CHANGE** = **12**
- **MIDI_MESSAGE_PROGRAM_CHANGE** = **12** --- MIDI program change message.
- **MIDI_MESSAGE_CHANNEL_PRESSURE** = **13**
- **MIDI_MESSAGE_CHANNEL_PRESSURE** = **13** --- MIDI channel pressure message.
- **MIDI_MESSAGE_PITCH_BEND** = **14**
- **MIDI_MESSAGE_PITCH_BEND** = **14** --- MIDI pitch bend message.
.. _enum_@GlobalScope_Error:
@@ -1797,47 +1797,47 @@ enum **PropertyHint**:
- **PROPERTY_HINT_NONE** = **0** --- No hint for the edited property.
- **PROPERTY_HINT_RANGE** = **1** --- Hints that the string is a range, defined as ``"min,max"`` or ``"min,max,step"``. This is valid for integers and floats.
- **PROPERTY_HINT_RANGE** = **1** --- Hints that an integer or float property should be within a range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"allow_greater"`` and/or ``"allow_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"-360,360,1,allow_greater,allow_lesser"``.
- **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that the string is an exponential range, defined as ``"min,max"`` or ``"min,max,step"``. This is valid for integers and floats.
- **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that an integer or float property should be within an exponential range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"allow_greater"`` and/or ``"allow_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"0.01,100,0.01,allow_greater"``.
- **PROPERTY_HINT_ENUM** = **3** --- Property hint for an enumerated value, like ``"Hello,Something,Else"``. This is valid for integer, float and string properties.
- **PROPERTY_HINT_ENUM** = **3** --- Hints that an integer, float or string property is an enumerated value to pick in a list specified via a hint string such as ``"Hello,Something,Else"``.
- **PROPERTY_HINT_EXP_EASING** = **4**
- **PROPERTY_HINT_EXP_EASING** = **4** --- Hints that a float property should be edited via an exponential easing function. The hint string can include ``"attenuation"`` to flip the curve horizontally and/or ``"inout"`` to also include in/out easing.
- **PROPERTY_HINT_LENGTH** = **5**
- **PROPERTY_HINT_LENGTH** = **5** --- Deprecated hint, unused.
- **PROPERTY_HINT_KEY_ACCEL** = **7**
- **PROPERTY_HINT_KEY_ACCEL** = **7** --- Deprecated hint, unused.
- **PROPERTY_HINT_FLAGS** = **8** --- Property hint for a bitmask description. For example, for bits 0, 1, 2, 3 and 5, the hint could be something like ``"Bit0,Bit1,Bit2,Bit3,,Bit5"``. This is only valid for integer properties.
- **PROPERTY_HINT_FLAGS** = **8** --- Hints that an integer property is a bitmask with named bit flags. For example, to allow toggling bits 0, 1, 2 and 4, the hint could be something like ``"Bit0,Bit1,Bit2,,Bit4"``.
- **PROPERTY_HINT_LAYERS_2D_RENDER** = **9**
- **PROPERTY_HINT_LAYERS_2D_RENDER** = **9** --- Hints that an integer property is a bitmask using the optionally named 2D render layers.
- **PROPERTY_HINT_LAYERS_2D_PHYSICS** = **10**
- **PROPERTY_HINT_LAYERS_2D_PHYSICS** = **10** --- Hints that an integer property is a bitmask using the optionally named 2D physics layers.
- **PROPERTY_HINT_LAYERS_3D_RENDER** = **11**
- **PROPERTY_HINT_LAYERS_3D_RENDER** = **11** --- Hints that an integer property is a bitmask using the optionally named 3D render layers.
- **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **12**
- **PROPERTY_HINT_LAYERS_3D_PHYSICS** = **12** --- Hints that an integer property is a bitmask using the optionally named 3D physics layers.
- **PROPERTY_HINT_FILE** = **13** --- String property is a file, will pop up a file dialog when edited. Hint string can be a set of wildcards like ``"*.doc"``.
- **PROPERTY_HINT_FILE** = **13** --- Hints that a string property is a path to a file. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like ``"*.png,*.jpg"``.
- **PROPERTY_HINT_DIR** = **14** --- String property is a directory, will pop up a file dialog when edited.
- **PROPERTY_HINT_DIR** = **14** --- Hints that a string property is a path to a directory. Editing it will show a file dialog for picking the path.
- **PROPERTY_HINT_GLOBAL_FILE** = **15**
- **PROPERTY_HINT_GLOBAL_FILE** = **15** --- Hints that a string property is an absolute path to a file outside the project folder. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like ``"*.png,*.jpg"``.
- **PROPERTY_HINT_GLOBAL_DIR** = **16**
- **PROPERTY_HINT_GLOBAL_DIR** = **16** --- Hints that a string property is an absolute path to a directory outside the project folder. Editing it will show a file dialog for picking the path.
- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- String property is a resource, will open the resource popup menu when edited.
- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- Hints that a property is an instance of a :ref:`Resource<class_Resource>`-derived type, optionally specified via the hint string (e.g. ``"Texture"``). Editing it will show a popup menu of valid resource types to instantiate.
- **PROPERTY_HINT_MULTILINE_TEXT** = **18**
- **PROPERTY_HINT_MULTILINE_TEXT** = **18** --- Hints that a string property is text with line breaks. Editing it will show a text input field where line breaks can be typed.
- **PROPERTY_HINT_PLACEHOLDER_TEXT** = **19**
- **PROPERTY_HINT_PLACEHOLDER_TEXT** = **19** --- Hints that a string property should have a placeholder text visible on its input field, whenever the property is empty. The hint string is the placeholder text to use.
- **PROPERTY_HINT_COLOR_NO_ALPHA** = **20**
- **PROPERTY_HINT_COLOR_NO_ALPHA** = **20** --- Hints that a color property should be edited without changing its alpha component, i.e. only R, G and B channels are edited.
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **21** --- Hints that the image is compressed using lossy compression.
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **21** --- Hints that an image is compressed using lossy compression.
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that the image is compressed using lossless compression.
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that an image is compressed using lossless compression.
.. _enum_@GlobalScope_PropertyUsageFlags:
@@ -1873,35 +1873,35 @@ enum **PropertyHint**:
enum **PropertyUsageFlags**:
- **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default).
- **PROPERTY_USAGE_STORAGE** = **1** --- The property is serialized and saved in the scene file (default).
- **PROPERTY_USAGE_EDITOR** = **2** --- Property will be visible in editor (default).
- **PROPERTY_USAGE_EDITOR** = **2** --- The property is shown in the editor inspector (default).
- **PROPERTY_USAGE_NETWORK** = **4**
- **PROPERTY_USAGE_NETWORK** = **4** --- Deprecated usage flag, unused.
- **PROPERTY_USAGE_EDITOR_HELPER** = **8**
- **PROPERTY_USAGE_EDITOR_HELPER** = **8** --- Deprecated usage flag, unused.
- **PROPERTY_USAGE_CHECKABLE** = **16**
- **PROPERTY_USAGE_CHECKABLE** = **16** --- The property can be checked in the editor inspector.
- **PROPERTY_USAGE_CHECKED** = **32**
- **PROPERTY_USAGE_CHECKED** = **32** --- The property is checked in the editor inspector.
- **PROPERTY_USAGE_INTERNATIONALIZED** = **64**
- **PROPERTY_USAGE_INTERNATIONALIZED** = **64** --- The property is a translatable string.
- **PROPERTY_USAGE_GROUP** = **128**
- **PROPERTY_USAGE_GROUP** = **128** --- Used to group properties together in the editor.
- **PROPERTY_USAGE_CATEGORY** = **256**
- **PROPERTY_USAGE_CATEGORY** = **256** --- Used to categorize properties together in the editor.
- **PROPERTY_USAGE_NO_INSTANCE_STATE** = **2048**
- **PROPERTY_USAGE_NO_INSTANCE_STATE** = **2048** --- The property does not save its state in :ref:`PackedScene<class_PackedScene>`.
- **PROPERTY_USAGE_RESTART_IF_CHANGED** = **4096**
- **PROPERTY_USAGE_RESTART_IF_CHANGED** = **4096** --- Editing the property prompts the user for restarting the editor.
- **PROPERTY_USAGE_SCRIPT_VARIABLE** = **8192**
- **PROPERTY_USAGE_SCRIPT_VARIABLE** = **8192** --- The property is a script variable which should be serialized and saved in the scene file.
- **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage and editor).
- **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage, editor and network).
- **PROPERTY_USAGE_DEFAULT_INTL** = **71**
- **PROPERTY_USAGE_DEFAULT_INTL** = **71** --- Default usage for translatable strings (storage, editor, network and internationalized).
- **PROPERTY_USAGE_NOEDITOR** = **5**
- **PROPERTY_USAGE_NOEDITOR** = **5** --- Default usage but without showing the property in the editor (storage, network).
.. _enum_@GlobalScope_MethodFlags:
@@ -1927,15 +1927,15 @@ enum **MethodFlags**:
- **METHOD_FLAG_EDITOR** = **2** --- Flag for an editor method.
- **METHOD_FLAG_NOSCRIPT** = **4**
- **METHOD_FLAG_NOSCRIPT** = **4** --- Deprecated method flag, unused.
- **METHOD_FLAG_CONST** = **8** --- Flag for a constant method.
- **METHOD_FLAG_REVERSE** = **16**
- **METHOD_FLAG_REVERSE** = **16** --- Deprecated method flag, unused.
- **METHOD_FLAG_VIRTUAL** = **32** --- Flag for a virtual method.
- **METHOD_FLAG_FROM_SCRIPT** = **64** --- Flag for a method from a script.
- **METHOD_FLAG_FROM_SCRIPT** = **64** --- Deprecated method flag, unused.
- **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags.
@@ -1999,13 +1999,13 @@ enum **MethodFlags**:
enum **Variant.Type**:
- **TYPE_NIL** = **0** --- Variable is of type nil (only applied for ``null``).
- **TYPE_NIL** = **0** --- Variable is of type :ref:`Nil<class_Nil>` (only applied for ``null``).
- **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool<class_bool>`.
- **TYPE_INT** = **2** --- Variable is of type :ref:`int<class_int>`.
- **TYPE_REAL** = **3** --- Variable is of type :ref:`float<class_float>`/real.
- **TYPE_REAL** = **3** --- Variable is of type :ref:`float<class_float>` (real).
- **TYPE_STRING** = **4** --- Variable is of type :ref:`String<class_String>`.
@@ -2111,55 +2111,55 @@ enum **Variant.Type**:
enum **Variant.Operator**:
- **OP_EQUAL** = **0**
- **OP_EQUAL** = **0** --- Equality operator (``==``).
- **OP_NOT_EQUAL** = **1**
- **OP_NOT_EQUAL** = **1** --- Inequality operator (``!=``).
- **OP_LESS** = **2**
- **OP_LESS** = **2** --- Less than operator (``<``).
- **OP_LESS_EQUAL** = **3**
- **OP_LESS_EQUAL** = **3** --- Less than or equal operator (``<=``).
- **OP_GREATER** = **4**
- **OP_GREATER** = **4** --- Greater than operator (``>``).
- **OP_GREATER_EQUAL** = **5**
- **OP_GREATER_EQUAL** = **5** --- Greater than or equal operator (``>=``).
- **OP_ADD** = **6**
- **OP_ADD** = **6** --- Addition operator (``+``).
- **OP_SUBTRACT** = **7**
- **OP_SUBTRACT** = **7** --- Subtraction operator (``-``).
- **OP_MULTIPLY** = **8**
- **OP_MULTIPLY** = **8** --- Multiplication operator (``*``).
- **OP_DIVIDE** = **9**
- **OP_DIVIDE** = **9** --- Division operator (``/``).
- **OP_NEGATE** = **10**
- **OP_NEGATE** = **10** --- Unary negation operator (``-``).
- **OP_POSITIVE** = **11**
- **OP_POSITIVE** = **11** --- Unary plus operator (``+``).
- **OP_MODULE** = **12**
- **OP_MODULE** = **12** --- Remainder/modulo operator (``%``).
- **OP_STRING_CONCAT** = **13**
- **OP_STRING_CONCAT** = **13** --- String concatenation operator (``+``).
- **OP_SHIFT_LEFT** = **14**
- **OP_SHIFT_LEFT** = **14** --- Left shift operator (``<<``).
- **OP_SHIFT_RIGHT** = **15**
- **OP_SHIFT_RIGHT** = **15** --- Right shift operator (``>>``).
- **OP_BIT_AND** = **16**
- **OP_BIT_AND** = **16** --- Bitwise AND operator (``&``).
- **OP_BIT_OR** = **17**
- **OP_BIT_OR** = **17** --- Bitwise OR operator (``|``).
- **OP_BIT_XOR** = **18**
- **OP_BIT_XOR** = **18** --- Bitwise XOR operator (``^``).
- **OP_BIT_NEGATE** = **19**
- **OP_BIT_NEGATE** = **19** --- Bitwise NOT operator (``~``).
- **OP_AND** = **20**
- **OP_AND** = **20** --- Logical AND operator (``and`` or ``&&``).
- **OP_OR** = **21**
- **OP_OR** = **21** --- Logical OR operator (``or`` or ``||``).
- **OP_XOR** = **22**
- **OP_XOR** = **22** --- Logical XOR operator (not implemented in GDScript).
- **OP_NOT** = **23**
- **OP_NOT** = **23** --- Logical NOT operator (``not`` or ``!``).
- **OP_IN** = **24**
- **OP_IN** = **24** --- Logical IN operator (``in``).
- **OP_MAX** = **25** --- Represents the size of the :ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` enum.

26
classes/class_aabb.rst
View File

@@ -17,13 +17,13 @@ Axis-Aligned Bounding Box.
Properties
----------
+-------------------------------+-----------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`end<class_AABB_property_end>` |
+-------------------------------+-----------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`position<class_AABB_property_position>` |
+-------------------------------+-----------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`size<class_AABB_property_size>` |
+-------------------------------+-----------------------------------------------+
+-------------------------------+-----------------------------------------------+--------------------+
| :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
-------
@@ -89,18 +89,30 @@ Property Descriptions
- :ref:`Vector3<class_Vector3>` **end**
+-----------+--------------------+
| *Default* | Vector3( 0, 0, 0 ) |
+-----------+--------------------+
Ending corner.
.. _class_AABB_property_position:
- :ref:`Vector3<class_Vector3>` **position**
+-----------+--------------------+
| *Default* | Vector3( 0, 0, 0 ) |
+-----------+--------------------+
Beginning corner.
.. _class_AABB_property_size:
- :ref:`Vector3<class_Vector3>` **size**
+-----------+--------------------+
| *Default* | Vector3( 0, 0, 0 ) |
+-----------+--------------------+
Size from position to end.
Method Descriptions

54
classes/class_acceptdialog.rst
View File

@@ -21,13 +21,13 @@ Base dialog for user notification.
Properties
----------
+-----------------------------+-------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`dialog_autowrap<class_AcceptDialog_property_dialog_autowrap>` |
+-----------------------------+-------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`dialog_hide_on_ok<class_AcceptDialog_property_dialog_hide_on_ok>` |
+-----------------------------+-------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`dialog_text<class_AcceptDialog_property_dialog_text>` |
+-----------------------------+-------------------------------------------------------------------------+
+-----------------------------+-------------------------------------------------------------------------+-------+
| :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>` | "" |
+-----------------------------+-------------------------------------------------------------------------+-------+
Methods
-------
@@ -71,11 +71,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **dialog_autowrap**
+----------+---------------------+
| *Setter* | set_autowrap(value) |
+----------+---------------------+
| *Getter* | has_autowrap() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_autowrap(value) |
+-----------+---------------------+
| *Getter* | has_autowrap() |
+-----------+---------------------+
Sets autowrapping for the text in the dialog.
@@ -83,13 +85,15 @@ Sets autowrapping for the text in the dialog.
- :ref:`bool<class_bool>` **dialog_hide_on_ok**
+----------+-----------------------+
| *Setter* | set_hide_on_ok(value) |
+----------+-----------------------+
| *Getter* | get_hide_on_ok() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | true |
+-----------+-----------------------+
| *Setter* | set_hide_on_ok(value) |
+-----------+-----------------------+
| *Getter* | get_hide_on_ok() |
+-----------+-----------------------+
If ``true``, the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed<class_AcceptDialog_signal_confirmed>` signal, and handle hiding the dialog in your own logic. Default value: ``true``.
If ``true``, the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed<class_AcceptDialog_signal_confirmed>` signal, and handle hiding the dialog in your own logic.
**Note:** Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example :ref:`FileDialog<class_FileDialog>` defaults to ``false``, and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such, this property can't be used in :ref:`FileDialog<class_FileDialog>` to disable hiding the dialog when pressing OK.
@@ -97,11 +101,13 @@ If ``true``, the dialog is hidden when the OK button is pressed. You can set it
- :ref:`String<class_String>` **dialog_text**
+----------+-----------------+
| *Setter* | set_text(value) |
+----------+-----------------+
| *Getter* | get_text() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | "" |
+-----------+-----------------+
| *Setter* | set_text(value) |
+-----------+-----------------+
| *Getter* | get_text() |
+-----------+-----------------+
The text displayed by the dialog.
@@ -114,7 +120,7 @@ Method Descriptions
Adds a button with label ``text`` and a custom ``action`` to the dialog and returns the created button. ``action`` will be passed to the :ref:`custom_action<class_AcceptDialog_signal_custom_action>` signal when pressed.
If ``true``, ``right`` will place the button to the right of any sibling buttons. Default value: ``false``.
If ``true``, ``right`` will place the button to the right of any sibling buttons.
.. _class_AcceptDialog_method_add_cancel:

144
classes/class_animatedsprite.rst
View File

@@ -19,25 +19,25 @@ Sprite node that can use multiple textures for animation.
Properties
----------
+-----------------------------------------+---------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite_property_animation>` |
+-----------------------------------------+---------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`centered<class_AnimatedSprite_property_centered>` |
+-----------------------------------------+---------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`flip_h<class_AnimatedSprite_property_flip_h>` |
+-----------------------------------------+---------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`flip_v<class_AnimatedSprite_property_flip_v>` |
+-----------------------------------------+---------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite_property_frame>` |
+-----------------------------------------+---------------------------------------------------------------+
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite_property_frames>` |
+-----------------------------------------+---------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_AnimatedSprite_property_offset>` |
+-----------------------------------------+---------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite_property_playing>` |
+-----------------------------------------+---------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimatedSprite_property_speed_scale>` |
+-----------------------------------------+---------------------------------------------------------------+
+-----------------------------------------+---------------------------------------------------------------+-----------------+
| :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>` | null |
+-----------------------------------------+---------------------------------------------------------------+-----------------+
| :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,11 +77,13 @@ Property Descriptions
- :ref:`String<class_String>` **animation**
+----------+----------------------+
| *Setter* | set_animation(value) |
+----------+----------------------+
| *Getter* | get_animation() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | "default" |
+-----------+----------------------+
| *Setter* | set_animation(value) |
+-----------+----------------------+
| *Getter* | get_animation() |
+-----------+----------------------+
The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset.
@@ -89,47 +91,55 @@ The current animation from the ``frames`` resource. If this value changes, the `
- :ref:`bool<class_bool>` **centered**
+----------+---------------------+
| *Setter* | set_centered(value) |
+----------+---------------------+
| *Getter* | is_centered() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | true |
+-----------+---------------------+
| *Setter* | set_centered(value) |
+-----------+---------------------+
| *Getter* | is_centered() |
+-----------+---------------------+
If ``true``, texture will be centered. Default value: ``true``.
If ``true``, texture will be centered.
.. _class_AnimatedSprite_property_flip_h:
- :ref:`bool<class_bool>` **flip_h**
+----------+-------------------+
| *Setter* | set_flip_h(value) |
+----------+-------------------+
| *Getter* | is_flipped_h() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | false |
+-----------+-------------------+
| *Setter* | set_flip_h(value) |
+-----------+-------------------+
| *Getter* | is_flipped_h() |
+-----------+-------------------+
If ``true``, texture is flipped horizontally. Default value: ``false``.
If ``true``, texture is flipped horizontally.
.. _class_AnimatedSprite_property_flip_v:
- :ref:`bool<class_bool>` **flip_v**
+----------+-------------------+
| *Setter* | set_flip_v(value) |
+----------+-------------------+
| *Getter* | is_flipped_v() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | false |
+-----------+-------------------+
| *Setter* | set_flip_v(value) |
+-----------+-------------------+
| *Getter* | is_flipped_v() |
+-----------+-------------------+
If ``true``, texture is flipped vertically. Default value: ``false``.
If ``true``, texture is flipped vertically.
.. _class_AnimatedSprite_property_frame:
- :ref:`int<class_int>` **frame**
+----------+------------------+
| *Setter* | set_frame(value) |
+----------+------------------+
| *Getter* | get_frame() |
+----------+------------------+
+-----------+------------------+
| *Default* | 0 |
+-----------+------------------+
| *Setter* | set_frame(value) |
+-----------+------------------+
| *Getter* | get_frame() |
+-----------+------------------+
The displayed animation frame's index.
@@ -137,11 +147,13 @@ The displayed animation frame's index.
- :ref:`SpriteFrames<class_SpriteFrames>` **frames**
+----------+--------------------------+
| *Setter* | set_sprite_frames(value) |
+----------+--------------------------+
| *Getter* | get_sprite_frames() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_sprite_frames(value) |
+-----------+--------------------------+
| *Getter* | get_sprite_frames() |
+-----------+--------------------------+
The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s).
@@ -149,11 +161,13 @@ The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s)
- :ref:`Vector2<class_Vector2>` **offset**
+----------+-------------------+
| *Setter* | set_offset(value) |
+----------+-------------------+
| *Getter* | get_offset() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+-------------------+
| *Setter* | set_offset(value) |
+-----------+-------------------+
| *Getter* | get_offset() |
+-----------+-------------------+
The texture's drawing offset.
@@ -161,17 +175,23 @@ The texture's drawing offset.
- :ref:`bool<class_bool>` **playing**
+-----------+-------+
| *Default* | false |
+-----------+-------+
If ``true``, the :ref:`animation<class_AnimatedSprite_property_animation>` is currently playing.
.. _class_AnimatedSprite_property_speed_scale:
- :ref:`float<class_float>` **speed_scale**
+----------+------------------------+
| *Setter* | set_speed_scale(value) |
+----------+------------------------+
| *Getter* | get_speed_scale() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1.0 |
+-----------+------------------------+
| *Setter* | set_speed_scale(value) |
+-----------+------------------------+
| *Getter* | get_speed_scale() |
+-----------+------------------------+
The animation speed is multiplied by this value.

58
classes/class_animatedsprite3d.rst
View File

@@ -19,15 +19,15 @@ Brief Description
Properties
----------
+-----------------------------------------+-------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`animation<class_AnimatedSprite3D_property_animation>` |
+-----------------------------------------+-------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`frame<class_AnimatedSprite3D_property_frame>` |
+-----------------------------------------+-------------------------------------------------------------+
| :ref:`SpriteFrames<class_SpriteFrames>` | :ref:`frames<class_AnimatedSprite3D_property_frames>` |
+-----------------------------------------+-------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite3D_property_playing>` |
+-----------------------------------------+-------------------------------------------------------------+
+-----------------------------------------+-------------------------------------------------------------+-----------+
| :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>` | null |
+-----------------------------------------+-------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AnimatedSprite3D_property_playing>` | false |
+-----------------------------------------+-------------------------------------------------------------+-----------+
Methods
-------
@@ -61,11 +61,13 @@ Property Descriptions
- :ref:`String<class_String>` **animation**
+----------+----------------------+
| *Setter* | set_animation(value) |
+----------+----------------------+
| *Getter* | get_animation() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | "default" |
+-----------+----------------------+
| *Setter* | set_animation(value) |
+-----------+----------------------+
| *Getter* | get_animation() |
+-----------+----------------------+
The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset.
@@ -73,11 +75,13 @@ The current animation from the ``frames`` resource. If this value changes, the `
- :ref:`int<class_int>` **frame**
+----------+------------------+
| *Setter* | set_frame(value) |
+----------+------------------+
| *Getter* | get_frame() |
+----------+------------------+
+-----------+------------------+
| *Default* | 0 |
+-----------+------------------+
| *Setter* | set_frame(value) |
+-----------+------------------+
| *Getter* | get_frame() |
+-----------+------------------+
The displayed animation frame's index.
@@ -85,11 +89,13 @@ The displayed animation frame's index.
- :ref:`SpriteFrames<class_SpriteFrames>` **frames**
+----------+--------------------------+
| *Setter* | set_sprite_frames(value) |
+----------+--------------------------+
| *Getter* | get_sprite_frames() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | null |
+-----------+--------------------------+
| *Setter* | set_sprite_frames(value) |
+-----------+--------------------------+
| *Getter* | get_sprite_frames() |
+-----------+--------------------------+
The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s).
@@ -97,6 +103,10 @@ The :ref:`SpriteFrames<class_SpriteFrames>` resource containing the animation(s)
- :ref:`bool<class_bool>` **playing**
+-----------+-------+
| *Default* | false |
+-----------+-------+
If ``true``, the :ref:`animation<class_AnimatedSprite3D_property_animation>` is currently playing.
Method Descriptions

38
classes/class_animatedtexture.rst
View File

@@ -19,11 +19,11 @@ Proxy texture for simple frame-based animations.
Properties
----------
+---------------------------+------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`fps<class_AnimatedTexture_property_fps>` |
+---------------------------+------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`frames<class_AnimatedTexture_property_frames>` |
+---------------------------+------------------------------------------------------+
+---------------------------+------------------------------------------------------+-----+
| :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,13 +61,15 @@ Property Descriptions
- :ref:`float<class_float>` **fps**
+----------+----------------+
| *Setter* | set_fps(value) |
+----------+----------------+
| *Getter* | get_fps() |
+----------+----------------+
+-----------+----------------+
| *Default* | 4.0 |
+-----------+----------------+
| *Setter* | set_fps(value) |
+-----------+----------------+
| *Getter* | get_fps() |
+-----------+----------------+
Animation speed in frames per second. This value defines the default time interval between two frames of the animation, and thus the overall duration of the animation loop based on the :ref:`frames<class_AnimatedTexture_property_frames>` property. A value of 0 means no predefined number of frames per second, the animation will play according to each frame's frame delay (see :ref:`set_frame_delay<class_AnimatedTexture_method_set_frame_delay>`). Default value: 4.
Animation speed in frames per second. This value defines the default time interval between two frames of the animation, and thus the overall duration of the animation loop based on the :ref:`frames<class_AnimatedTexture_property_frames>` property. A value of 0 means no predefined number of frames per second, the animation will play according to each frame's frame delay (see :ref:`set_frame_delay<class_AnimatedTexture_method_set_frame_delay>`).
For example, an animation with 8 frames, no frame delay and a ``fps`` value of 2 will run for 4 seconds, with each frame lasting 0.5 seconds.
@@ -75,13 +77,15 @@ For example, an animation with 8 frames, no frame delay and a ``fps`` value of 2
- :ref:`int<class_int>` **frames**
+----------+-------------------+
| *Setter* | set_frames(value) |
+----------+-------------------+
| *Getter* | get_frames() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1 |
+-----------+-------------------+
| *Setter* | set_frames(value) |
+-----------+-------------------+
| *Getter* | get_frames() |
+-----------+-------------------+
Number of frames to use in the animation. While you can create the frames independently with :ref:`set_frame_texture<class_AnimatedTexture_method_set_frame_texture>`, you need to set this value for the animation to take new frames into account. The maximum number of frames is :ref:`MAX_FRAMES<class_AnimatedTexture_constant_MAX_FRAMES>`. Default value: 1.
Number of frames to use in the animation. While you can create the frames independently with :ref:`set_frame_texture<class_AnimatedTexture_method_set_frame_texture>`, you need to set this value for the animation to take new frames into account. The maximum number of frames is :ref:`MAX_FRAMES<class_AnimatedTexture_constant_MAX_FRAMES>`.
Method Descriptions
-------------------

52
classes/class_animation.rst
View File

@@ -19,13 +19,13 @@ Contains data used to animate everything in the engine.
Properties
----------
+---------------------------+------------------------------------------------+
| :ref:`float<class_float>` | :ref:`length<class_Animation_property_length>` |
+---------------------------+------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`loop<class_Animation_property_loop>` |
+---------------------------+------------------------------------------------+
| :ref:`float<class_float>` | :ref:`step<class_Animation_property_step>` |
+---------------------------+------------------------------------------------+
+---------------------------+------------------------------------------------+-------+
| :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
-------
@@ -251,11 +251,13 @@ Property Descriptions
- :ref:`float<class_float>` **length**
+----------+-------------------+
| *Setter* | set_length(value) |
+----------+-------------------+
| *Getter* | get_length() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1.0 |
+-----------+-------------------+
| *Setter* | set_length(value) |
+-----------+-------------------+
| *Getter* | get_length() |
+-----------+-------------------+
The total length of the animation (in seconds).
@@ -265,11 +267,13 @@ The total length of the animation (in seconds).
- :ref:`bool<class_bool>` **loop**
+----------+-----------------+
| *Setter* | set_loop(value) |
+----------+-----------------+
| *Getter* | has_loop() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | false |
+-----------+-----------------+
| *Setter* | set_loop(value) |
+-----------+-----------------+
| *Getter* | has_loop() |
+-----------+-----------------+
A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
@@ -277,11 +281,13 @@ A flag indicating that the animation must loop. This is uses for correct interpo
- :ref:`float<class_float>` **step**
+----------+-----------------+
| *Setter* | set_step(value) |
+----------+-----------------+
| *Getter* | get_step() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | 0.1 |
+-----------+-----------------+
| *Setter* | set_step(value) |
+-----------+-----------------+
| *Getter* | get_step() |
+-----------+-----------------+
The animation step value.
@@ -424,7 +430,7 @@ Finds the key index by time in a given track. Optionally, only find it if the ex
- :ref:`bool<class_bool>` **track_get_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx **)** const
Returns ``true`` if the track at ``idx`` wraps the interpolation loop. Default value: ``true``.
Returns ``true`` if the track at ``idx`` wraps the interpolation loop. New tracks wrap the interpolation loop by default.
.. _class_Animation_method_track_get_interpolation_type:

18
classes/class_animationnodeadd2.rst
View File

@@ -19,9 +19,9 @@ Blends two animations additively inside of an :ref:`AnimationNodeBlendTree<class
Properties
----------
+-------------------------+----------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd2_property_sync>` |
+-------------------------+----------------------------------------------------+
+-------------------------+----------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd2_property_sync>` | false |
+-------------------------+----------------------------------------------------+-------+
Description
-----------
@@ -35,11 +35,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **sync**
+----------+---------------------+
| *Setter* | set_use_sync(value) |
+----------+---------------------+
| *Getter* | is_using_sync() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_use_sync(value) |
+-----------+---------------------+
| *Getter* | is_using_sync() |
+-----------+---------------------+
If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input<class_AnimationNode_method_blend_input>`, forcing the blended animations to update every frame.

18
classes/class_animationnodeadd3.rst
View File

@@ -19,9 +19,9 @@ Blends two of three animations additively inside of an :ref:`AnimationNodeBlendT
Properties
----------
+-------------------------+----------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd3_property_sync>` |
+-------------------------+----------------------------------------------------+
+-------------------------+----------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd3_property_sync>` | false |
+-------------------------+----------------------------------------------------+-------+
Description
-----------
@@ -43,11 +43,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **sync**
+----------+---------------------+
| *Setter* | set_use_sync(value) |
+----------+---------------------+
| *Getter* | is_using_sync() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_use_sync(value) |
+-----------+---------------------+
| *Getter* | is_using_sync() |
+-----------+---------------------+
If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input<class_AnimationNode_method_blend_input>`, forcing the blended animations to update every frame.

18
classes/class_animationnodeanimation.rst
View File

@@ -19,9 +19,9 @@ Input animation to use in an :ref:`AnimationNodeBlendTree<class_AnimationNodeBle
Properties
----------
+-----------------------------+-------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` |
+-----------------------------+-------------------------------------------------------------------+
+-----------------------------+-------------------------------------------------------------------+----+
| :ref:`String<class_String>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` | "" |
+-----------------------------+-------------------------------------------------------------------+----+
Description
-----------
@@ -35,11 +35,13 @@ Property Descriptions
- :ref:`String<class_String>` **animation**
+----------+----------------------+
| *Setter* | set_animation(value) |
+----------+----------------------+
| *Getter* | get_animation() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | "" |
+-----------+----------------------+
| *Setter* | set_animation(value) |
+-----------+----------------------+
| *Getter* | get_animation() |
+-----------+----------------------+
Animation to use as an output. It is one of the animations provided by :ref:`AnimationTree.anim_player<class_AnimationTree_property_anim_player>`.

18
classes/class_animationnodeblend2.rst
View File

@@ -19,9 +19,9 @@ Blends two animations linearly inside of an :ref:`AnimationNodeBlendTree<class_A
Properties
----------
+-------------------------+------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend2_property_sync>` |
+-------------------------+------------------------------------------------------+
+-------------------------+------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend2_property_sync>` | false |
+-------------------------+------------------------------------------------------+-------+
Description
-----------
@@ -35,11 +35,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **sync**
+----------+---------------------+
| *Setter* | set_use_sync(value) |
+----------+---------------------+
| *Getter* | is_using_sync() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_use_sync(value) |
+-----------+---------------------+
| *Getter* | is_using_sync() |
+-----------+---------------------+
If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input<class_AnimationNode_method_blend_input>`, forcing the blended animations to update every frame.

18
classes/class_animationnodeblend3.rst
View File

@@ -19,9 +19,9 @@ Blends two of three animations linearly inside of an :ref:`AnimationNodeBlendTre
Properties
----------
+-------------------------+------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend3_property_sync>` |
+-------------------------+------------------------------------------------------+
+-------------------------+------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend3_property_sync>` | false |
+-------------------------+------------------------------------------------------+-------+
Description
-----------
@@ -43,11 +43,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **sync**
+----------+---------------------+
| *Setter* | set_use_sync(value) |
+----------+---------------------+
| *Getter* | is_using_sync() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_use_sync(value) |
+-----------+---------------------+
| *Getter* | is_using_sync() |
+-----------+---------------------+
If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input<class_AnimationNode_method_blend_input>`, forcing the blended animations to update every frame.

66
classes/class_animationnodeblendspace1d.rst
View File

@@ -19,15 +19,15 @@ Blends linearly between two of any number of :ref:`AnimationNode<class_Animation
Properties
----------
+-----------------------------+--------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`max_space<class_AnimationNodeBlendSpace1D_property_max_space>` |
+-----------------------------+--------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`min_space<class_AnimationNodeBlendSpace1D_property_min_space>` |
+-----------------------------+--------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`snap<class_AnimationNodeBlendSpace1D_property_snap>` |
+-----------------------------+--------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`value_label<class_AnimationNodeBlendSpace1D_property_value_label>` |
+-----------------------------+--------------------------------------------------------------------------+
+-----------------------------+--------------------------------------------------------------------------+---------+
| :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
-------
@@ -66,11 +66,13 @@ Property Descriptions
- :ref:`float<class_float>` **max_space**
+----------+----------------------+
| *Setter* | set_max_space(value) |
+----------+----------------------+
| *Getter* | get_max_space() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 1.0 |
+-----------+----------------------+
| *Setter* | set_max_space(value) |
+-----------+----------------------+
| *Getter* | get_max_space() |
+-----------+----------------------+
The blend space's axis's upper limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
@@ -78,11 +80,13 @@ The blend space's axis's upper limit for the points' position. See :ref:`add_ble
- :ref:`float<class_float>` **min_space**
+----------+----------------------+
| *Setter* | set_min_space(value) |
+----------+----------------------+
| *Getter* | get_min_space() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | -1.0 |
+-----------+----------------------+
| *Setter* | set_min_space(value) |
+-----------+----------------------+
| *Getter* | get_min_space() |
+-----------+----------------------+
The blend space's axis's lower limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
@@ -90,11 +94,13 @@ The blend space's axis's lower limit for the points' position. See :ref:`add_ble
- :ref:`float<class_float>` **snap**
+----------+-----------------+
| *Setter* | set_snap(value) |
+----------+-----------------+
| *Getter* | get_snap() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | 0.1 |
+-----------+-----------------+
| *Setter* | set_snap(value) |
+-----------+-----------------+
| *Getter* | get_snap() |
+-----------+-----------------+
Position increment to snap to when moving a point on the axis.
@@ -102,11 +108,13 @@ Position increment to snap to when moving a point on the axis.
- :ref:`String<class_String>` **value_label**
+----------+------------------------+
| *Setter* | set_value_label(value) |
+----------+------------------------+
| *Getter* | get_value_label() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | "value" |
+-----------+------------------------+
| *Setter* | set_value_label(value) |
+-----------+------------------------+
| *Getter* | get_value_label() |
+-----------+------------------------+
Label of the virtual axis of the blend space.

114
classes/class_animationnodeblendspace2d.rst
View File

@@ -19,21 +19,21 @@ Blends linearly between three :ref:`AnimationNode<class_AnimationNode>` of any t
Properties
----------
+------------------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`auto_triangles<class_AnimationNodeBlendSpace2D_property_auto_triangles>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` | :ref:`blend_mode<class_AnimationNodeBlendSpace2D_property_blend_mode>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`max_space<class_AnimationNodeBlendSpace2D_property_max_space>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`min_space<class_AnimationNodeBlendSpace2D_property_min_space>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`snap<class_AnimationNodeBlendSpace2D_property_snap>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`x_label<class_AnimationNodeBlendSpace2D_property_x_label>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`y_label<class_AnimationNodeBlendSpace2D_property_y_label>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------+
+------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+
| :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
-------
@@ -106,11 +106,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **auto_triangles**
+----------+---------------------------+
| *Setter* | set_auto_triangles(value) |
+----------+---------------------------+
| *Getter* | get_auto_triangles() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | true |
+-----------+---------------------------+
| *Setter* | set_auto_triangles(value) |
+-----------+---------------------------+
| *Getter* | get_auto_triangles() |
+-----------+---------------------------+
If true, the blend space is triangulated automatically. The mesh updates every time you add or remove points with :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>` and :ref:`remove_blend_point<class_AnimationNodeBlendSpace2D_method_remove_blend_point>`.
@@ -118,11 +120,13 @@ If true, the blend space is triangulated automatically. The mesh updates every t
- :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` **blend_mode**
+----------+-----------------------+
| *Setter* | set_blend_mode(value) |
+----------+-----------------------+
| *Getter* | get_blend_mode() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 0 |
+-----------+-----------------------+
| *Setter* | set_blend_mode(value) |
+-----------+-----------------------+
| *Getter* | get_blend_mode() |
+-----------+-----------------------+
Controls the interpolation between animations. See :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` constants.
@@ -130,11 +134,13 @@ Controls the interpolation between animations. See :ref:`BlendMode<enum_Animatio
- :ref:`Vector2<class_Vector2>` **max_space**
+----------+----------------------+
| *Setter* | set_max_space(value) |
+----------+----------------------+
| *Getter* | get_max_space() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | Vector2( 1, 1 ) |
+-----------+----------------------+
| *Setter* | set_max_space(value) |
+-----------+----------------------+
| *Getter* | get_max_space() |
+-----------+----------------------+
The blend space's X and Y axes' upper limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>`.
@@ -142,11 +148,13 @@ The blend space's X and Y axes' upper limit for the points' position. See :ref:`
- :ref:`Vector2<class_Vector2>` **min_space**
+----------+----------------------+
| *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>`.
@@ -154,11 +162,13 @@ The blend space's X and Y axes' lower limit for the points' position. See :ref:`
- :ref:`Vector2<class_Vector2>` **snap**
+----------+-----------------+
| *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.
@@ -166,11 +176,13 @@ Position increment to snap to when moving a point.
- :ref:`String<class_String>` **x_label**
+----------+--------------------+
| *Setter* | set_x_label(value) |
+----------+--------------------+
| *Getter* | get_x_label() |
+----------+--------------------+
+-----------+--------------------+
| *Default* | "x" |
+-----------+--------------------+
| *Setter* | set_x_label(value) |
+-----------+--------------------+
| *Getter* | get_x_label() |
+-----------+--------------------+
Name of the blend space's X axis.
@@ -178,11 +190,13 @@ Name of the blend space's X axis.
- :ref:`String<class_String>` **y_label**
+----------+--------------------+
| *Setter* | set_y_label(value) |
+----------+--------------------+
| *Getter* | get_y_label() |
+----------+--------------------+
+-----------+--------------------+
| *Default* | "y" |
+-----------+--------------------+
| *Setter* | set_y_label(value) |
+-----------+--------------------+
| *Getter* | get_y_label() |
+-----------+--------------------+
Name of the blend space's Y axis.

18
classes/class_animationnodeblendtree.rst
View File

@@ -19,9 +19,9 @@ Brief Description
Properties
----------
+-------------------------------+-------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`graph_offset<class_AnimationNodeBlendTree_property_graph_offset>` |
+-------------------------------+-------------------------------------------------------------------------+
+-------------------------------+-------------------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`graph_offset<class_AnimationNodeBlendTree_property_graph_offset>` | Vector2( 0, 0 ) |
+-------------------------------+-------------------------------------------------------------------------+-----------------+
Methods
-------
@@ -80,11 +80,13 @@ Property Descriptions
- :ref:`Vector2<class_Vector2>` **graph_offset**
+----------+-------------------------+
| *Setter* | set_graph_offset(value) |
+----------+-------------------------+
| *Getter* | get_graph_offset() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+-------------------------+
| *Setter* | set_graph_offset(value) |
+-----------+-------------------------+
| *Getter* | get_graph_offset() |
+-----------+-------------------------+
Method Descriptions
-------------------

98
classes/class_animationnodeoneshot.rst
View File

@@ -19,19 +19,19 @@ Brief Description
Properties
----------
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`autorestart<class_AnimationNodeOneShot_property_autorestart>` |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`autorestart_delay<class_AnimationNodeOneShot_property_autorestart_delay>` |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`autorestart_random_delay<class_AnimationNodeOneShot_property_autorestart_random_delay>` |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`fadein_time<class_AnimationNodeOneShot_property_fadein_time>` |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`fadeout_time<class_AnimationNodeOneShot_property_fadeout_time>` |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeOneShot_property_sync>` |
+---------------------------+-----------------------------------------------------------------------------------------------+
+---------------------------+-----------------------------------------------------------------------------------------------+-------+
| :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
-------
@@ -64,61 +64,73 @@ Property Descriptions
- :ref:`bool<class_bool>` **autorestart**
+----------+------------------------+
| *Setter* | set_autorestart(value) |
+----------+------------------------+
| *Getter* | has_autorestart() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | false |
+-----------+------------------------+
| *Setter* | set_autorestart(value) |
+-----------+------------------------+
| *Getter* | has_autorestart() |
+-----------+------------------------+
.. _class_AnimationNodeOneShot_property_autorestart_delay:
- :ref:`float<class_float>` **autorestart_delay**
+----------+------------------------------+
| *Setter* | set_autorestart_delay(value) |
+----------+------------------------------+
| *Getter* | get_autorestart_delay() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | 1.0 |
+-----------+------------------------------+
| *Setter* | set_autorestart_delay(value) |
+-----------+------------------------------+
| *Getter* | get_autorestart_delay() |
+-----------+------------------------------+
.. _class_AnimationNodeOneShot_property_autorestart_random_delay:
- :ref:`float<class_float>` **autorestart_random_delay**
+----------+-------------------------------------+
| *Setter* | set_autorestart_random_delay(value) |
+----------+-------------------------------------+
| *Getter* | get_autorestart_random_delay() |
+----------+-------------------------------------+
+-----------+-------------------------------------+
| *Default* | 0.0 |
+-----------+-------------------------------------+
| *Setter* | set_autorestart_random_delay(value) |
+-----------+-------------------------------------+
| *Getter* | get_autorestart_random_delay() |
+-----------+-------------------------------------+
.. _class_AnimationNodeOneShot_property_fadein_time:
- :ref:`float<class_float>` **fadein_time**
+----------+------------------------+
| *Setter* | set_fadein_time(value) |
+----------+------------------------+
| *Getter* | get_fadein_time() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 0.1 |
+-----------+------------------------+
| *Setter* | set_fadein_time(value) |
+-----------+------------------------+
| *Getter* | get_fadein_time() |
+-----------+------------------------+
.. _class_AnimationNodeOneShot_property_fadeout_time:
- :ref:`float<class_float>` **fadeout_time**
+----------+-------------------------+
| *Setter* | set_fadeout_time(value) |
+----------+-------------------------+
| *Getter* | get_fadeout_time() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0.1 |
+-----------+-------------------------+
| *Setter* | set_fadeout_time(value) |
+-----------+-------------------------+
| *Getter* | get_fadeout_time() |
+-----------+-------------------------+
.. _class_AnimationNodeOneShot_property_sync:
- :ref:`bool<class_bool>` **sync**
+----------+---------------------+
| *Setter* | set_use_sync(value) |
+----------+---------------------+
| *Getter* | is_using_sync() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_use_sync(value) |
+-----------+---------------------+
| *Getter* | is_using_sync() |
+-----------+---------------------+
Method Descriptions
-------------------

98
classes/class_animationnodestatemachinetransition.rst
View File

@@ -19,19 +19,19 @@ Brief Description
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>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`disabled<class_AnimationNodeStateMachineTransition_property_disabled>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`priority<class_AnimationNodeStateMachineTransition_property_priority>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`SwitchMode<enum_AnimationNodeStateMachineTransition_SwitchMode>` | :ref:`switch_mode<class_AnimationNodeStateMachineTransition_property_switch_mode>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeStateMachineTransition_property_xfade_time>` |
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+
| :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
-------
@@ -66,11 +66,13 @@ Property Descriptions
- :ref:`String<class_String>` **advance_condition**
+----------+------------------------------+
| *Setter* | set_advance_condition(value) |
+----------+------------------------------+
| *Getter* | get_advance_condition() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | "" |
+-----------+------------------------------+
| *Setter* | set_advance_condition(value) |
+-----------+------------------------------+
| *Getter* | get_advance_condition() |
+-----------+------------------------------+
Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the :ref:`AnimationTree<class_AnimationTree>` that can be controlled from code (see `https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html#controlling-from-code <https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html#controlling-from-code>`_). For example, if :ref:`AnimationTree.tree_root<class_AnimationTree_property_tree_root>` is an :ref:`AnimationNodeStateMachine<class_AnimationNodeStateMachine>` and :ref:`advance_condition<class_AnimationNodeStateMachineTransition_property_advance_condition>` is set to "idle":
@@ -82,11 +84,13 @@ Turn on auto advance when this condition is set. The provided name will become a
- :ref:`bool<class_bool>` **auto_advance**
+----------+-------------------------+
| *Setter* | set_auto_advance(value) |
+----------+-------------------------+
| *Getter* | has_auto_advance() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | false |
+-----------+-------------------------+
| *Setter* | set_auto_advance(value) |
+-----------+-------------------------+
| *Getter* | has_auto_advance() |
+-----------+-------------------------+
Turn on the transition automatically when this state is reached. This works best with :ref:`SWITCH_MODE_AT_END<class_AnimationNodeStateMachineTransition_constant_SWITCH_MODE_AT_END>`.
@@ -94,11 +98,13 @@ Turn on the transition automatically when this state is reached. This works best
- :ref:`bool<class_bool>` **disabled**
+----------+---------------------+
| *Setter* | set_disabled(value) |
+----------+---------------------+
| *Getter* | is_disabled() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_disabled(value) |
+-----------+---------------------+
| *Getter* | is_disabled() |
+-----------+---------------------+
Don't use this transition during :ref:`AnimationNodeStateMachinePlayback.travel<class_AnimationNodeStateMachinePlayback_method_travel>` or :ref:`auto_advance<class_AnimationNodeStateMachineTransition_property_auto_advance>`.
@@ -106,11 +112,13 @@ Don't use this transition during :ref:`AnimationNodeStateMachinePlayback.travel<
- :ref:`int<class_int>` **priority**
+----------+---------------------+
| *Setter* | set_priority(value) |
+----------+---------------------+
| *Getter* | get_priority() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 1 |
+-----------+---------------------+
| *Setter* | set_priority(value) |
+-----------+---------------------+
| *Getter* | get_priority() |
+-----------+---------------------+
Lower priority transitions are preferred when travelling through the tree via :ref:`AnimationNodeStateMachinePlayback.travel<class_AnimationNodeStateMachinePlayback_method_travel>` or :ref:`auto_advance<class_AnimationNodeStateMachineTransition_property_auto_advance>`.
@@ -118,11 +126,13 @@ Lower priority transitions are preferred when travelling through the tree via :r
- :ref:`SwitchMode<enum_AnimationNodeStateMachineTransition_SwitchMode>` **switch_mode**
+----------+------------------------+
| *Setter* | set_switch_mode(value) |
+----------+------------------------+
| *Getter* | get_switch_mode() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 0 |
+-----------+------------------------+
| *Setter* | set_switch_mode(value) |
+-----------+------------------------+
| *Getter* | get_switch_mode() |
+-----------+------------------------+
The transition type.
@@ -130,11 +140,13 @@ The transition type.
- :ref:`float<class_float>` **xfade_time**
+----------+-----------------------+
| *Setter* | set_xfade_time(value) |
+----------+-----------------------+
| *Getter* | get_xfade_time() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 0.0 |
+-----------+-----------------------+
| *Setter* | set_xfade_time(value) |
+-----------+-----------------------+
| *Getter* | get_xfade_time() |
+-----------+-----------------------+
The time to cross-fade between this state and the next.

290
classes/class_animationnodetransition.rst
View File

@@ -19,139 +19,139 @@ Brief Description
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>` |
+-----------------------------+--------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeTransition_property_xfade_time>` |
+-----------------------------+--------------------------------------------------------------------------------------------+
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_0/auto_advance<class_AnimationNodeTransition_property_input_0/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_0/name<class_AnimationNodeTransition_property_input_0/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_1/auto_advance<class_AnimationNodeTransition_property_input_1/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_1/name<class_AnimationNodeTransition_property_input_1/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_10/auto_advance<class_AnimationNodeTransition_property_input_10/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_10/name<class_AnimationNodeTransition_property_input_10/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_11/auto_advance<class_AnimationNodeTransition_property_input_11/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_11/name<class_AnimationNodeTransition_property_input_11/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_12/auto_advance<class_AnimationNodeTransition_property_input_12/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_12/name<class_AnimationNodeTransition_property_input_12/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_13/auto_advance<class_AnimationNodeTransition_property_input_13/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_13/name<class_AnimationNodeTransition_property_input_13/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_14/auto_advance<class_AnimationNodeTransition_property_input_14/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_14/name<class_AnimationNodeTransition_property_input_14/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_15/auto_advance<class_AnimationNodeTransition_property_input_15/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_15/name<class_AnimationNodeTransition_property_input_15/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_16/auto_advance<class_AnimationNodeTransition_property_input_16/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_16/name<class_AnimationNodeTransition_property_input_16/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_17/auto_advance<class_AnimationNodeTransition_property_input_17/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_17/name<class_AnimationNodeTransition_property_input_17/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_18/auto_advance<class_AnimationNodeTransition_property_input_18/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_18/name<class_AnimationNodeTransition_property_input_18/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_19/auto_advance<class_AnimationNodeTransition_property_input_19/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_19/name<class_AnimationNodeTransition_property_input_19/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_2/auto_advance<class_AnimationNodeTransition_property_input_2/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_2/name<class_AnimationNodeTransition_property_input_2/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_20/auto_advance<class_AnimationNodeTransition_property_input_20/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_20/name<class_AnimationNodeTransition_property_input_20/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_21/auto_advance<class_AnimationNodeTransition_property_input_21/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_21/name<class_AnimationNodeTransition_property_input_21/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_22/auto_advance<class_AnimationNodeTransition_property_input_22/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_22/name<class_AnimationNodeTransition_property_input_22/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_23/auto_advance<class_AnimationNodeTransition_property_input_23/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_23/name<class_AnimationNodeTransition_property_input_23/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_24/auto_advance<class_AnimationNodeTransition_property_input_24/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_24/name<class_AnimationNodeTransition_property_input_24/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_25/auto_advance<class_AnimationNodeTransition_property_input_25/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_25/name<class_AnimationNodeTransition_property_input_25/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_26/auto_advance<class_AnimationNodeTransition_property_input_26/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_26/name<class_AnimationNodeTransition_property_input_26/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_27/auto_advance<class_AnimationNodeTransition_property_input_27/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_27/name<class_AnimationNodeTransition_property_input_27/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_28/auto_advance<class_AnimationNodeTransition_property_input_28/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_28/name<class_AnimationNodeTransition_property_input_28/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_29/auto_advance<class_AnimationNodeTransition_property_input_29/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_29/name<class_AnimationNodeTransition_property_input_29/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_3/auto_advance<class_AnimationNodeTransition_property_input_3/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_3/name<class_AnimationNodeTransition_property_input_3/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_30/auto_advance<class_AnimationNodeTransition_property_input_30/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_30/name<class_AnimationNodeTransition_property_input_30/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_31/auto_advance<class_AnimationNodeTransition_property_input_31/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_31/name<class_AnimationNodeTransition_property_input_31/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_4/auto_advance<class_AnimationNodeTransition_property_input_4/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_4/name<class_AnimationNodeTransition_property_input_4/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_5/auto_advance<class_AnimationNodeTransition_property_input_5/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_5/name<class_AnimationNodeTransition_property_input_5/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_6/auto_advance<class_AnimationNodeTransition_property_input_6/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_6/name<class_AnimationNodeTransition_property_input_6/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_7/auto_advance<class_AnimationNodeTransition_property_input_7/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_7/name<class_AnimationNodeTransition_property_input_7/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_8/auto_advance<class_AnimationNodeTransition_property_input_8/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_8/name<class_AnimationNodeTransition_property_input_8/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`bool<class_bool>` | :ref:`input_9/auto_advance<class_AnimationNodeTransition_property_input_9/auto_advance>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`String<class_String>` | :ref:`input_9/name<class_AnimationNodeTransition_property_input_9/name>` | |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`int<class_int>` | :ref:`input_count<class_AnimationNodeTransition_property_input_count>` | 0 |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`xfade_time<class_AnimationNodeTransition_property_xfade_time>` | 0.0 |
+-----------------------------+--------------------------------------------------------------------------------------------+-----+
Property Descriptions
---------------------
@@ -800,19 +800,23 @@ Property Descriptions
- :ref:`int<class_int>` **input_count**
+----------+---------------------------+
| *Setter* | set_enabled_inputs(value) |
+----------+---------------------------+
| *Getter* | get_enabled_inputs() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 0 |
+-----------+---------------------------+
| *Setter* | set_enabled_inputs(value) |
+-----------+---------------------------+
| *Getter* | get_enabled_inputs() |
+-----------+---------------------------+
.. _class_AnimationNodeTransition_property_xfade_time:
- :ref:`float<class_float>` **xfade_time**
+----------+----------------------------+
| *Setter* | set_cross_fade_time(value) |
+----------+----------------------------+
| *Getter* | get_cross_fade_time() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | 0.0 |
+-----------+----------------------------+
| *Setter* | set_cross_fade_time(value) |
+-----------+----------------------------+
| *Getter* | get_cross_fade_time() |
+-----------+----------------------------+

146
classes/class_animationplayer.rst
View File

@@ -19,29 +19,29 @@ Container and player of :ref:`Animation<class_Animation>` resources.
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>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`playback_active<class_AnimationPlayer_property_playback_active>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`playback_default_blend_time<class_AnimationPlayer_property_playback_default_blend_time>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationPlayer_property_playback_process_mode>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`playback_speed<class_AnimationPlayer_property_playback_speed>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`root_node<class_AnimationPlayer_property_root_node>` |
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+
| :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
-------
@@ -179,25 +179,29 @@ If playing, the current animation; otherwise, the animation last played. When se
- :ref:`String<class_String>` **autoplay**
+----------+---------------------+
| *Setter* | set_autoplay(value) |
+----------+---------------------+
| *Getter* | get_autoplay() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | "" |
+-----------+---------------------+
| *Setter* | set_autoplay(value) |
+-----------+---------------------+
| *Getter* | get_autoplay() |
+-----------+---------------------+
The name of the animation to play when the scene loads. Default value: ``""``.
The name of the animation to play when the scene loads.
.. _class_AnimationPlayer_property_current_animation:
- :ref:`String<class_String>` **current_animation**
+----------+------------------------------+
| *Setter* | set_current_animation(value) |
+----------+------------------------------+
| *Getter* | get_current_animation() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | "" |
+-----------+------------------------------+
| *Setter* | set_current_animation(value) |
+-----------+------------------------------+
| *Getter* | get_current_animation() |
+-----------+------------------------------+
The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play<class_AnimationPlayer_method_play>`. Default value: ``""``.
The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play<class_AnimationPlayer_method_play>`.
.. _class_AnimationPlayer_property_current_animation_length:
@@ -223,13 +227,15 @@ The position (in seconds) of the currently playing animation.
- :ref:`AnimationMethodCallMode<enum_AnimationPlayer_AnimationMethodCallMode>` **method_call_mode**
+----------+-----------------------------+
| *Setter* | set_method_call_mode(value) |
+----------+-----------------------------+
| *Getter* | get_method_call_mode() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | 0 |
+-----------+-----------------------------+
| *Setter* | set_method_call_mode(value) |
+-----------+-----------------------------+
| *Getter* | get_method_call_mode() |
+-----------+-----------------------------+
The call mode to use for Call Method tracks. Default value: :ref:`ANIMATION_METHOD_CALL_DEFERRED<class_AnimationPlayer_constant_ANIMATION_METHOD_CALL_DEFERRED>`.
The call mode to use for Call Method tracks.
.. _class_AnimationPlayer_property_playback_active:
@@ -241,55 +247,63 @@ The call mode to use for Call Method tracks. Default value: :ref:`ANIMATION_METH
| *Getter* | is_active() |
+----------+-------------------+
If ``true``, updates animations in response to process-related notifications. Default value: ``true``.
If ``true``, updates animations in response to process-related notifications.
.. _class_AnimationPlayer_property_playback_default_blend_time:
- :ref:`float<class_float>` **playback_default_blend_time**
+----------+-------------------------------+
| *Setter* | set_default_blend_time(value) |
+----------+-------------------------------+
| *Getter* | get_default_blend_time() |
+----------+-------------------------------+
+-----------+-------------------------------+
| *Default* | 0.0 |
+-----------+-------------------------------+
| *Setter* | set_default_blend_time(value) |
+-----------+-------------------------------+
| *Getter* | get_default_blend_time() |
+-----------+-------------------------------+
The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: ``0``.
The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision.
.. _class_AnimationPlayer_property_playback_process_mode:
- :ref:`AnimationProcessMode<enum_AnimationPlayer_AnimationProcessMode>` **playback_process_mode**
+----------+-----------------------------------+
| *Setter* | set_animation_process_mode(value) |
+----------+-----------------------------------+
| *Getter* | get_animation_process_mode() |
+----------+-----------------------------------+
+-----------+-----------------------------------+
| *Default* | 1 |
+-----------+-----------------------------------+
| *Setter* | set_animation_process_mode(value) |
+-----------+-----------------------------------+
| *Getter* | get_animation_process_mode() |
+-----------+-----------------------------------+
The process notification in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE<class_AnimationPlayer_constant_ANIMATION_PROCESS_IDLE>`.
The process notification in which to update animations.
.. _class_AnimationPlayer_property_playback_speed:
- :ref:`float<class_float>` **playback_speed**
+----------+------------------------+
| *Setter* | set_speed_scale(value) |
+----------+------------------------+
| *Getter* | get_speed_scale() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1.0 |
+-----------+------------------------+
| *Setter* | set_speed_scale(value) |
+-----------+------------------------+
| *Getter* | get_speed_scale() |
+-----------+------------------------+
The speed scaling ratio. For instance, if this value is 1, then the animation plays at normal speed. If it's 0.5, then it plays at half speed. If it's 2, then it plays at double speed. Default value: ``1``.
The speed scaling ratio. For instance, if this value is 1, then the animation plays at normal speed. If it's 0.5, then it plays at half speed. If it's 2, then it plays at double speed.
.. _class_AnimationPlayer_property_root_node:
- :ref:`NodePath<class_NodePath>` **root_node**
+----------+-----------------+
| *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. Default value: ``".."``.
The node from which node path references will travel.
Method Descriptions
-------------------

82
classes/class_animationtree.rst
View File

@@ -19,17 +19,17 @@ Brief Description
Properties
----------
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`active<class_AnimationTree_property_active>` |
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`anim_player<class_AnimationTree_property_anim_player>` |
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`AnimationProcessMode<enum_AnimationTree_AnimationProcessMode>` | :ref:`process_mode<class_AnimationTree_property_process_mode>` |
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`root_motion_track<class_AnimationTree_property_root_motion_track>` |
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`AnimationNode<class_AnimationNode>` | :ref:`tree_root<class_AnimationTree_property_tree_root>` |
+----------------------------------------------------------------------+--------------------------------------------------------------------------+
+----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+
| :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>` | null |
+----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+
Methods
-------
@@ -75,51 +75,61 @@ Property Descriptions
- :ref:`bool<class_bool>` **active**
+----------+-------------------+
| *Setter* | set_active(value) |
+----------+-------------------+
| *Getter* | is_active() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | false |
+-----------+-------------------+
| *Setter* | set_active(value) |
+-----------+-------------------+
| *Getter* | is_active() |
+-----------+-------------------+
.. _class_AnimationTree_property_anim_player:
- :ref:`NodePath<class_NodePath>` **anim_player**
+----------+-----------------------------+
| *Setter* | set_animation_player(value) |
+----------+-----------------------------+
| *Getter* | get_animation_player() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | NodePath("") |
+-----------+-----------------------------+
| *Setter* | set_animation_player(value) |
+-----------+-----------------------------+
| *Getter* | get_animation_player() |
+-----------+-----------------------------+
.. _class_AnimationTree_property_process_mode:
- :ref:`AnimationProcessMode<enum_AnimationTree_AnimationProcessMode>` **process_mode**
+----------+-------------------------+
| *Setter* | set_process_mode(value) |
+----------+-------------------------+
| *Getter* | get_process_mode() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 1 |
+-----------+-------------------------+
| *Setter* | set_process_mode(value) |
+-----------+-------------------------+
| *Getter* | get_process_mode() |
+-----------+-------------------------+
.. _class_AnimationTree_property_root_motion_track:
- :ref:`NodePath<class_NodePath>` **root_motion_track**
+----------+------------------------------+
| *Setter* | set_root_motion_track(value) |
+----------+------------------------------+
| *Getter* | get_root_motion_track() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | NodePath("") |
+-----------+------------------------------+
| *Setter* | set_root_motion_track(value) |
+-----------+------------------------------+
| *Getter* | get_root_motion_track() |
+-----------+------------------------------+
.. _class_AnimationTree_property_tree_root:
- :ref:`AnimationNode<class_AnimationNode>` **tree_root**
+----------+----------------------+
| *Setter* | set_tree_root(value) |
+----------+----------------------+
| *Getter* | get_tree_root() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | null |
+-----------+----------------------+
| *Setter* | set_tree_root(value) |
+-----------+----------------------+
| *Getter* | get_tree_root() |
+-----------+----------------------+
Method Descriptions
-------------------

72
classes/class_animationtreeplayer.rst
View File

@@ -19,15 +19,15 @@ Animation Player that uses a node graph for blending Animations.
Properties
----------
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`active<class_AnimationTreePlayer_property_active>` |
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`base_path<class_AnimationTreePlayer_property_base_path>` |
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`master_player<class_AnimationTreePlayer_property_master_player>` |
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` | :ref:`playback_process_mode<class_AnimationTreePlayer_property_playback_process_mode>` |
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------+
| :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,25 +221,29 @@ Property Descriptions
- :ref:`bool<class_bool>` **active**
+----------+-------------------+
| *Setter* | set_active(value) |
+----------+-------------------+
| *Getter* | is_active() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | false |
+-----------+-------------------+
| *Setter* | set_active(value) |
+-----------+-------------------+
| *Getter* | is_active() |
+-----------+-------------------+
If ``true``, the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``.
If ``true``, the ``AnimationTreePlayer`` is able to play animations.
.. _class_AnimationTreePlayer_property_base_path:
- :ref:`NodePath<class_NodePath>` **base_path**
+----------+----------------------+
| *Setter* | set_base_path(value) |
+----------+----------------------+
| *Getter* | get_base_path() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | NodePath("..") |
+-----------+----------------------+
| *Setter* | set_base_path(value) |
+-----------+----------------------+
| *Getter* | get_base_path() |
+-----------+----------------------+
The node from which to relatively access other nodes. Default value: ``".."``.
The node from which to relatively access other nodes.
It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at.
@@ -247,11 +251,13 @@ It accesses the Bones, so it should point to the same Node the AnimationPlayer w
- :ref:`NodePath<class_NodePath>` **master_player**
+----------+--------------------------+
| *Setter* | set_master_player(value) |
+----------+--------------------------+
| *Getter* | get_master_player() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | NodePath("") |
+-----------+--------------------------+
| *Setter* | set_master_player(value) |
+-----------+--------------------------+
| *Getter* | get_master_player() |
+-----------+--------------------------+
The path to the :ref:`AnimationPlayer<class_AnimationPlayer>` from which this ``AnimationTreePlayer`` binds animations to animation nodes.
@@ -261,13 +267,15 @@ Once set, Animation nodes can be added to the AnimationTreePlayer.
- :ref:`AnimationProcessMode<enum_AnimationTreePlayer_AnimationProcessMode>` **playback_process_mode**
+----------+-----------------------------------+
| *Setter* | set_animation_process_mode(value) |
+----------+-----------------------------------+
| *Getter* | get_animation_process_mode() |
+----------+-----------------------------------+
+-----------+-----------------------------------+
| *Default* | 1 |
+-----------+-----------------------------------+
| *Setter* | set_animation_process_mode(value) |
+-----------+-----------------------------------+
| *Getter* | get_animation_process_mode() |
+-----------+-----------------------------------+
The thread in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE<class_AnimationTreePlayer_constant_ANIMATION_PROCESS_IDLE>`.
The thread in which to update animations.
Method Descriptions
-------------------

300
classes/class_area.rst
View File

@@ -19,43 +19,43 @@ General-purpose area node for detection and 3D physics influence.
Properties
----------
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area_property_angular_damp>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area_property_audio_bus_name>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area_property_audio_bus_override>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`collision_layer<class_Area_property_collision_layer>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`collision_mask<class_Area_property_collision_mask>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`gravity<class_Area_property_gravity>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area_property_gravity_distance_scale>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area_property_gravity_point>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`gravity_vec<class_Area_property_gravity_vec>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`linear_damp<class_Area_property_linear_damp>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area_property_monitorable>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area_property_monitoring>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`priority<class_Area_property_priority>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`reverb_bus_amount<class_Area_property_reverb_bus_amount>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`reverb_bus_enable<class_Area_property_reverb_bus_enable>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`reverb_bus_name<class_Area_property_reverb_bus_name>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`reverb_bus_uniformity<class_Area_property_reverb_bus_uniformity>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
| :ref:`SpaceOverride<enum_Area_SpaceOverride>` | :ref:`space_override<class_Area_property_space_override>` |
+-----------------------------------------------+---------------------------------------------------------------------------+
+-----------------------------------------------+---------------------------------------------------------------------------+---------------------+
| :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
-------
@@ -176,11 +176,13 @@ Property Descriptions
- :ref:`float<class_float>` **angular_damp**
+----------+-------------------------+
| *Setter* | set_angular_damp(value) |
+----------+-------------------------+
| *Getter* | get_angular_damp() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0.1 |
+-----------+-------------------------+
| *Setter* | set_angular_damp(value) |
+-----------+-------------------------+
| *Getter* | get_angular_damp() |
+-----------+-------------------------+
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
@@ -188,11 +190,13 @@ The rate at which objects stop spinning in this area. Represents the angular vel
- :ref:`String<class_String>` **audio_bus_name**
+----------+----------------------+
| *Setter* | set_audio_bus(value) |
+----------+----------------------+
| *Getter* | get_audio_bus() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | "Master" |
+-----------+----------------------+
| *Setter* | set_audio_bus(value) |
+-----------+----------------------+
| *Getter* | get_audio_bus() |
+-----------+----------------------+
The name of the area's audio bus.
@@ -200,23 +204,27 @@ The name of the area's audio bus.
- :ref:`bool<class_bool>` **audio_bus_override**
+----------+-------------------------------+
| *Setter* | set_audio_bus_override(value) |
+----------+-------------------------------+
| *Getter* | is_overriding_audio_bus() |
+----------+-------------------------------+
+-----------+-------------------------------+
| *Default* | false |
+-----------+-------------------------------+
| *Setter* | set_audio_bus_override(value) |
+-----------+-------------------------------+
| *Getter* | is_overriding_audio_bus() |
+-----------+-------------------------------+
If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``.
If ``true``, the area's audio bus overrides the default audio bus.
.. _class_Area_property_collision_layer:
- :ref:`int<class_int>` **collision_layer**
+----------+----------------------------+
| *Setter* | set_collision_layer(value) |
+----------+----------------------------+
| *Getter* | get_collision_layer() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | 1 |
+-----------+----------------------------+
| *Setter* | set_collision_layer(value) |
+-----------+----------------------------+
| *Getter* | get_collision_layer() |
+-----------+----------------------------+
The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask<class_Area_property_collision_mask>`.
@@ -224,11 +232,13 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different
- :ref:`int<class_int>` **collision_mask**
+----------+---------------------------+
| *Setter* | set_collision_mask(value) |
+----------+---------------------------+
| *Getter* | get_collision_mask() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 1 |
+-----------+---------------------------+
| *Setter* | set_collision_mask(value) |
+-----------+---------------------------+
| *Getter* | get_collision_mask() |
+-----------+---------------------------+
The physics layers this area scans to determine collision detection.
@@ -236,11 +246,13 @@ The physics layers this area scans to determine collision detection.
- :ref:`float<class_float>` **gravity**
+----------+--------------------+
| *Setter* | set_gravity(value) |
+----------+--------------------+
| *Getter* | get_gravity() |
+----------+--------------------+
+-----------+--------------------+
| *Default* | 9.8 |
+-----------+--------------------+
| *Setter* | set_gravity(value) |
+-----------+--------------------+
| *Getter* | get_gravity() |
+-----------+--------------------+
The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
@@ -248,11 +260,13 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies
- :ref:`float<class_float>` **gravity_distance_scale**
+----------+-----------------------------------+
| *Setter* | set_gravity_distance_scale(value) |
+----------+-----------------------------------+
| *Getter* | get_gravity_distance_scale() |
+----------+-----------------------------------+
+-----------+-----------------------------------+
| *Default* | 0.0 |
+-----------+-----------------------------------+
| *Setter* | set_gravity_distance_scale(value) |
+-----------+-----------------------------------+
| *Getter* | get_gravity_distance_scale() |
+-----------+-----------------------------------+
The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
@@ -260,23 +274,27 @@ The falloff factor for point gravity. The greater the value, the faster gravity
- :ref:`bool<class_bool>` **gravity_point**
+----------+-----------------------------+
| *Setter* | set_gravity_is_point(value) |
+----------+-----------------------------+
| *Getter* | is_gravity_a_point() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | false |
+-----------+-----------------------------+
| *Setter* | set_gravity_is_point(value) |
+-----------+-----------------------------+
| *Getter* | is_gravity_a_point() |
+-----------+-----------------------------+
If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area_property_gravity_vec>`). See also :ref:`space_override<class_Area_property_space_override>`. Default value: ``false``.
If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area_property_gravity_vec>`). See also :ref:`space_override<class_Area_property_space_override>`.
.. _class_Area_property_gravity_vec:
- :ref:`Vector3<class_Vector3>` **gravity_vec**
+----------+---------------------------+
| *Setter* | set_gravity_vector(value) |
+----------+---------------------------+
| *Getter* | get_gravity_vector() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | Vector3( 0, -1, 0 ) |
+-----------+---------------------------+
| *Setter* | set_gravity_vector(value) |
+-----------+---------------------------+
| *Getter* | get_gravity_vector() |
+-----------+---------------------------+
The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area_property_gravity_point>`), this will be the point of attraction.
@@ -284,11 +302,13 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra
- :ref:`float<class_float>` **linear_damp**
+----------+------------------------+
| *Setter* | set_linear_damp(value) |
+----------+------------------------+
| *Getter* | get_linear_damp() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 0.1 |
+-----------+------------------------+
| *Setter* | set_linear_damp(value) |
+-----------+------------------------+
| *Getter* | get_linear_damp() |
+-----------+------------------------+
The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
@@ -296,47 +316,55 @@ The rate at which objects stop moving in this area. Represents the linear veloci
- :ref:`bool<class_bool>` **monitorable**
+----------+------------------------+
| *Setter* | set_monitorable(value) |
+----------+------------------------+
| *Getter* | is_monitorable() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | true |
+-----------+------------------------+
| *Setter* | set_monitorable(value) |
+-----------+------------------------+
| *Getter* | is_monitorable() |
+-----------+------------------------+
If ``true``, other monitoring areas can detect this area. Default value: ``true``.
If ``true``, other monitoring areas can detect this area.
.. _class_Area_property_monitoring:
- :ref:`bool<class_bool>` **monitoring**
+----------+-----------------------+
| *Setter* | set_monitoring(value) |
+----------+-----------------------+
| *Getter* | is_monitoring() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | true |
+-----------+-----------------------+
| *Setter* | set_monitoring(value) |
+-----------+-----------------------+
| *Getter* | is_monitoring() |
+-----------+-----------------------+
If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``.
If ``true``, the area detects bodies or areas entering and exiting it.
.. _class_Area_property_priority:
- :ref:`float<class_float>` **priority**
+----------+---------------------+
| *Setter* | set_priority(value) |
+----------+---------------------+
| *Getter* | get_priority() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0.0 |
+-----------+---------------------+
| *Setter* | set_priority(value) |
+-----------+---------------------+
| *Getter* | get_priority() |
+-----------+---------------------+
The area's priority. Higher priority areas are processed first. Default value: 0.
The area's priority. Higher priority areas are processed first.
.. _class_Area_property_reverb_bus_amount:
- :ref:`float<class_float>` **reverb_bus_amount**
+----------+--------------------------+
| *Setter* | set_reverb_amount(value) |
+----------+--------------------------+
| *Getter* | get_reverb_amount() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 0.0 |
+-----------+--------------------------+
| *Setter* | set_reverb_amount(value) |
+-----------+--------------------------+
| *Getter* | get_reverb_amount() |
+-----------+--------------------------+
The degree to which this area applies reverb to its associated audio. Ranges from ``0`` to ``1`` with ``0.1`` precision.
@@ -344,11 +372,13 @@ The degree to which this area applies reverb to its associated audio. Ranges fro
- :ref:`bool<class_bool>` **reverb_bus_enable**
+----------+---------------------------+
| *Setter* | set_use_reverb_bus(value) |
+----------+---------------------------+
| *Getter* | is_using_reverb_bus() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | false |
+-----------+---------------------------+
| *Setter* | set_use_reverb_bus(value) |
+-----------+---------------------------+
| *Getter* | is_using_reverb_bus() |
+-----------+---------------------------+
If ``true``, the area applies reverb to its associated audio.
@@ -356,11 +386,13 @@ If ``true``, the area applies reverb to its associated audio.
- :ref:`String<class_String>` **reverb_bus_name**
+----------+-----------------------+
| *Setter* | set_reverb_bus(value) |
+----------+-----------------------+
| *Getter* | get_reverb_bus() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | "Master" |
+-----------+-----------------------+
| *Setter* | set_reverb_bus(value) |
+-----------+-----------------------+
| *Getter* | get_reverb_bus() |
+-----------+-----------------------+
The reverb bus name to use for this area's associated audio.
@@ -368,11 +400,13 @@ The reverb bus name to use for this area's associated audio.
- :ref:`float<class_float>` **reverb_bus_uniformity**
+----------+------------------------------+
| *Setter* | set_reverb_uniformity(value) |
+----------+------------------------------+
| *Getter* | get_reverb_uniformity() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | 0.0 |
+-----------+------------------------------+
| *Setter* | set_reverb_uniformity(value) |
+-----------+------------------------------+
| *Getter* | get_reverb_uniformity() |
+-----------+------------------------------+
The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to ``1`` with ``0.1`` precision.
@@ -380,11 +414,13 @@ The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to
- :ref:`SpaceOverride<enum_Area_SpaceOverride>` **space_override**
+----------+--------------------------------+
| *Setter* | set_space_override_mode(value) |
+----------+--------------------------------+
| *Getter* | get_space_override_mode() |
+----------+--------------------------------+
+-----------+--------------------------------+
| *Default* | 0 |
+-----------+--------------------------------+
| *Setter* | set_space_override_mode(value) |
+-----------+--------------------------------+
| *Getter* | get_space_override_mode() |
+-----------+--------------------------------+
Override mode for gravity and damping calculations within this area. See :ref:`SpaceOverride<enum_Area_SpaceOverride>` for possible values.

236
classes/class_area2d.rst
View File

@@ -19,35 +19,35 @@ Brief Description
Properties
----------
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area2D_property_angular_damp>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`audio_bus_name<class_Area2D_property_audio_bus_name>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area2D_property_audio_bus_override>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`collision_layer<class_Area2D_property_collision_layer>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`collision_mask<class_Area2D_property_collision_mask>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`gravity<class_Area2D_property_gravity>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area2D_property_gravity_distance_scale>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area2D_property_gravity_point>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`gravity_vec<class_Area2D_property_gravity_vec>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`linear_damp<class_Area2D_property_linear_damp>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area2D_property_monitorable>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area2D_property_monitoring>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`priority<class_Area2D_property_priority>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` | :ref:`space_override<class_Area2D_property_space_override>` |
+-------------------------------------------------+-----------------------------------------------------------------------------+
+-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+
| :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
-------
@@ -168,11 +168,13 @@ Property Descriptions
- :ref:`float<class_float>` **angular_damp**
+----------+-------------------------+
| *Setter* | set_angular_damp(value) |
+----------+-------------------------+
| *Getter* | get_angular_damp() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 1.0 |
+-----------+-------------------------+
| *Setter* | set_angular_damp(value) |
+-----------+-------------------------+
| *Getter* | get_angular_damp() |
+-----------+-------------------------+
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
@@ -180,11 +182,13 @@ The rate at which objects stop spinning in this area. Represents the angular vel
- :ref:`String<class_String>` **audio_bus_name**
+----------+---------------------------+
| *Setter* | set_audio_bus_name(value) |
+----------+---------------------------+
| *Getter* | get_audio_bus_name() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | "Master" |
+-----------+---------------------------+
| *Setter* | set_audio_bus_name(value) |
+-----------+---------------------------+
| *Getter* | get_audio_bus_name() |
+-----------+---------------------------+
The name of the area's audio bus.
@@ -192,23 +196,27 @@ The name of the area's audio bus.
- :ref:`bool<class_bool>` **audio_bus_override**
+----------+-------------------------------+
| *Setter* | set_audio_bus_override(value) |
+----------+-------------------------------+
| *Getter* | is_overriding_audio_bus() |
+----------+-------------------------------+
+-----------+-------------------------------+
| *Default* | false |
+-----------+-------------------------------+
| *Setter* | set_audio_bus_override(value) |
+-----------+-------------------------------+
| *Getter* | is_overriding_audio_bus() |
+-----------+-------------------------------+
If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``.
If ``true``, the area's audio bus overrides the default audio bus.
.. _class_Area2D_property_collision_layer:
- :ref:`int<class_int>` **collision_layer**
+----------+----------------------------+
| *Setter* | set_collision_layer(value) |
+----------+----------------------------+
| *Getter* | get_collision_layer() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | 1 |
+-----------+----------------------------+
| *Setter* | set_collision_layer(value) |
+-----------+----------------------------+
| *Getter* | get_collision_layer() |
+-----------+----------------------------+
The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask<class_Area2D_property_collision_mask>`.
@@ -216,11 +224,13 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different
- :ref:`int<class_int>` **collision_mask**
+----------+---------------------------+
| *Setter* | set_collision_mask(value) |
+----------+---------------------------+
| *Getter* | get_collision_mask() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 1 |
+-----------+---------------------------+
| *Setter* | set_collision_mask(value) |
+-----------+---------------------------+
| *Getter* | get_collision_mask() |
+-----------+---------------------------+
The physics layers this area scans to determine collision detection.
@@ -228,11 +238,13 @@ The physics layers this area scans to determine collision detection.
- :ref:`float<class_float>` **gravity**
+----------+--------------------+
| *Setter* | set_gravity(value) |
+----------+--------------------+
| *Getter* | get_gravity() |
+----------+--------------------+
+-----------+--------------------+
| *Default* | 98.0 |
+-----------+--------------------+
| *Setter* | set_gravity(value) |
+-----------+--------------------+
| *Getter* | get_gravity() |
+-----------+--------------------+
The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
@@ -240,11 +252,13 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies
- :ref:`float<class_float>` **gravity_distance_scale**
+----------+-----------------------------------+
| *Setter* | set_gravity_distance_scale(value) |
+----------+-----------------------------------+
| *Getter* | get_gravity_distance_scale() |
+----------+-----------------------------------+
+-----------+-----------------------------------+
| *Default* | 0.0 |
+-----------+-----------------------------------+
| *Setter* | set_gravity_distance_scale(value) |
+-----------+-----------------------------------+
| *Getter* | get_gravity_distance_scale() |
+-----------+-----------------------------------+
The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
@@ -252,23 +266,27 @@ The falloff factor for point gravity. The greater the value, the faster gravity
- :ref:`bool<class_bool>` **gravity_point**
+----------+-----------------------------+
| *Setter* | set_gravity_is_point(value) |
+----------+-----------------------------+
| *Getter* | is_gravity_a_point() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | false |
+-----------+-----------------------------+
| *Setter* | set_gravity_is_point(value) |
+-----------+-----------------------------+
| *Getter* | is_gravity_a_point() |
+-----------+-----------------------------+
If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area2D_property_gravity_vec>`). See also :ref:`space_override<class_Area2D_property_space_override>`. Default value: ``false``.
If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area2D_property_gravity_vec>`). See also :ref:`space_override<class_Area2D_property_space_override>`.
.. _class_Area2D_property_gravity_vec:
- :ref:`Vector2<class_Vector2>` **gravity_vec**
+----------+---------------------------+
| *Setter* | set_gravity_vector(value) |
+----------+---------------------------+
| *Getter* | get_gravity_vector() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | Vector2( 0, 1 ) |
+-----------+---------------------------+
| *Setter* | set_gravity_vector(value) |
+-----------+---------------------------+
| *Getter* | get_gravity_vector() |
+-----------+---------------------------+
The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area2D_property_gravity_point>`), this will be the point of attraction.
@@ -276,11 +294,13 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra
- :ref:`float<class_float>` **linear_damp**
+----------+------------------------+
| *Setter* | set_linear_damp(value) |
+----------+------------------------+
| *Getter* | get_linear_damp() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 0.1 |
+-----------+------------------------+
| *Setter* | set_linear_damp(value) |
+-----------+------------------------+
| *Getter* | get_linear_damp() |
+-----------+------------------------+
The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
@@ -288,47 +308,55 @@ The rate at which objects stop moving in this area. Represents the linear veloci
- :ref:`bool<class_bool>` **monitorable**
+----------+------------------------+
| *Setter* | set_monitorable(value) |
+----------+------------------------+
| *Getter* | is_monitorable() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | true |
+-----------+------------------------+
| *Setter* | set_monitorable(value) |
+-----------+------------------------+
| *Getter* | is_monitorable() |
+-----------+------------------------+
If ``true``, other monitoring areas can detect this area. Default value: ``true``.
If ``true``, other monitoring areas can detect this area.
.. _class_Area2D_property_monitoring:
- :ref:`bool<class_bool>` **monitoring**
+----------+-----------------------+
| *Setter* | set_monitoring(value) |
+----------+-----------------------+
| *Getter* | is_monitoring() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | true |
+-----------+-----------------------+
| *Setter* | set_monitoring(value) |
+-----------+-----------------------+
| *Getter* | is_monitoring() |
+-----------+-----------------------+
If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``.
If ``true``, the area detects bodies or areas entering and exiting it.
.. _class_Area2D_property_priority:
- :ref:`float<class_float>` **priority**
+----------+---------------------+
| *Setter* | set_priority(value) |
+----------+---------------------+
| *Getter* | get_priority() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0.0 |
+-----------+---------------------+
| *Setter* | set_priority(value) |
+-----------+---------------------+
| *Getter* | get_priority() |
+-----------+---------------------+
The area's priority. Higher priority areas are processed first. Default value: 0.
The area's priority. Higher priority areas are processed first.
.. _class_Area2D_property_space_override:
- :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` **space_override**
+----------+--------------------------------+
| *Setter* | set_space_override_mode(value) |
+----------+--------------------------------+
| *Getter* | get_space_override_mode() |
+----------+--------------------------------+
+-----------+--------------------------------+
| *Default* | 0 |
+-----------+--------------------------------+
| *Setter* | set_space_override_mode(value) |
+-----------+--------------------------------+
| *Getter* | get_space_override_mode() |
+-----------+--------------------------------+
Override mode for gravity and damping calculations within this area. See :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` for possible values.

36
classes/class_arraymesh.rst
View File

@@ -19,11 +19,11 @@ Brief Description
Properties
----------
+-------------------------------------------------+--------------------------------------------------------------------+
| :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` | :ref:`blend_shape_mode<class_ArrayMesh_property_blend_shape_mode>` |
+-------------------------------------------------+--------------------------------------------------------------------+
| :ref:`AABB<class_AABB>` | :ref:`custom_aabb<class_ArrayMesh_property_custom_aabb>` |
+-------------------------------------------------+--------------------------------------------------------------------+
+-------------------------------------------------+--------------------------------------------------------------------+--------------------------+
| :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
-------
@@ -192,23 +192,27 @@ Property Descriptions
- :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` **blend_shape_mode**
+----------+-----------------------------+
| *Setter* | set_blend_shape_mode(value) |
+----------+-----------------------------+
| *Getter* | get_blend_shape_mode() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | 1 |
+-----------+-----------------------------+
| *Setter* | set_blend_shape_mode(value) |
+-----------+-----------------------------+
| *Getter* | get_blend_shape_mode() |
+-----------+-----------------------------+
.. _class_ArrayMesh_property_custom_aabb:
- :ref:`AABB<class_AABB>` **custom_aabb**
+----------+------------------------+
| *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 unnexpected culling when using a shader to offset vertices.
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.
Method Descriptions
-------------------

18
classes/class_arvranchor.rst
View File

@@ -19,9 +19,9 @@ An anchor point in AR space.
Properties
----------
+-----------------------+-------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`anchor_id<class_ARVRAnchor_property_anchor_id>` |
+-----------------------+-------------------------------------------------------+
+-----------------------+-------------------------------------------------------+---+
| :ref:`int<class_int>` | :ref:`anchor_id<class_ARVRAnchor_property_anchor_id>` | 1 |
+-----------------------+-------------------------------------------------------+---+
Methods
-------
@@ -63,11 +63,13 @@ Property Descriptions
- :ref:`int<class_int>` **anchor_id**
+----------+----------------------+
| *Setter* | set_anchor_id(value) |
+----------+----------------------+
| *Getter* | get_anchor_id() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 1 |
+-----------+----------------------+
| *Setter* | set_anchor_id(value) |
+-----------+----------------------+
| *Getter* | get_anchor_id() |
+-----------+----------------------+
The anchor's ID. You can set this before the anchor itself exists. The first anchor gets an ID of ``1``, the second an ID of ``2``, etc. When anchors get removed, the engine can then assign the corresponding ID to new anchors. The most common situation where anchors "disappear" is when the AR server identifies that two anchors represent different parts of the same plane and merges them.

34
classes/class_arvrcontroller.rst
View File

@@ -19,11 +19,11 @@ A spatial node representing a spatially-tracked controller.
Properties
----------
+---------------------------+-------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`controller_id<class_ARVRController_property_controller_id>` |
+---------------------------+-------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRController_property_rumble>` |
+---------------------------+-------------------------------------------------------------------+
+---------------------------+-------------------------------------------------------------------+-----+
| :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
-------
@@ -81,11 +81,13 @@ Property Descriptions
- :ref:`int<class_int>` **controller_id**
+----------+--------------------------+
| *Setter* | set_controller_id(value) |
+----------+--------------------------+
| *Getter* | get_controller_id() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 1 |
+-----------+--------------------------+
| *Setter* | set_controller_id(value) |
+-----------+--------------------------+
| *Getter* | get_controller_id() |
+-----------+--------------------------+
The controller's ID.
@@ -99,11 +101,13 @@ When a controller is turned off, its slot is freed. This ensures controllers wil
- :ref:`float<class_float>` **rumble**
+----------+-------------------+
| *Setter* | set_rumble(value) |
+----------+-------------------+
| *Getter* | get_rumble() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 0.0 |
+-----------+-------------------+
| *Setter* | set_rumble(value) |
+-----------+-------------------+
| *Getter* | get_rumble() |
+-----------+-------------------+
The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. If changed, updates :ref:`ARVRPositionalTracker.rumble<class_ARVRPositionalTracker_property_rumble>` accordingly.

50
classes/class_arvrinterface.rst
View File

@@ -21,13 +21,13 @@ Base class for an AR/VR interface implementation.
Properties
----------
+-------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`ar_is_anchor_detection_enabled<class_ARVRInterface_property_ar_is_anchor_detection_enabled>` |
+-------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`interface_is_initialized<class_ARVRInterface_property_interface_is_initialized>` |
+-------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`interface_is_primary<class_ARVRInterface_property_interface_is_primary>` |
+-------------------------+----------------------------------------------------------------------------------------------------+
+-------------------------+----------------------------------------------------------------------------------------------------+-------+
| :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
-------
@@ -131,11 +131,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **ar_is_anchor_detection_enabled**
+----------+----------------------------------------+
| *Setter* | set_anchor_detection_is_enabled(value) |
+----------+----------------------------------------+
| *Getter* | get_anchor_detection_is_enabled() |
+----------+----------------------------------------+
+-----------+----------------------------------------+
| *Default* | false |
+-----------+----------------------------------------+
| *Setter* | set_anchor_detection_is_enabled(value) |
+-----------+----------------------------------------+
| *Getter* | get_anchor_detection_is_enabled() |
+-----------+----------------------------------------+
On an AR interface, is our anchor detection enabled?
@@ -143,11 +145,13 @@ On an AR interface, is our anchor detection enabled?
- :ref:`bool<class_bool>` **interface_is_initialized**
+----------+---------------------------+
| *Setter* | set_is_initialized(value) |
+----------+---------------------------+
| *Getter* | is_initialized() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | false |
+-----------+---------------------------+
| *Setter* | set_is_initialized(value) |
+-----------+---------------------------+
| *Getter* | is_initialized() |
+-----------+---------------------------+
Has this interface been initialized?
@@ -155,11 +159,13 @@ Has this interface been initialized?
- :ref:`bool<class_bool>` **interface_is_primary**
+----------+-----------------------+
| *Setter* | set_is_primary(value) |
+----------+-----------------------+
| *Getter* | is_primary() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | false |
+-----------+-----------------------+
| *Setter* | set_is_primary(value) |
+-----------+-----------------------+
| *Getter* | is_primary() |
+-----------+-----------------------+
Is this our primary interface?

18
classes/class_arvrorigin.rst
View File

@@ -19,9 +19,9 @@ The origin point in AR/VR.
Properties
----------
+---------------------------+-----------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVROrigin_property_world_scale>` |
+---------------------------+-----------------------------------------------------------+
+---------------------------+-----------------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVROrigin_property_world_scale>` | 1.0 |
+---------------------------+-----------------------------------------------------------+-----+
Description
-----------
@@ -41,11 +41,13 @@ Property Descriptions
- :ref:`float<class_float>` **world_scale**
+----------+------------------------+
| *Setter* | set_world_scale(value) |
+----------+------------------------+
| *Getter* | get_world_scale() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1.0 |
+-----------+------------------------+
| *Setter* | set_world_scale(value) |
+-----------+------------------------+
| *Getter* | get_world_scale() |
+-----------+------------------------+
Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter.

18
classes/class_arvrpositionaltracker.rst
View File

@@ -19,9 +19,9 @@ A tracked object.
Properties
----------
+---------------------------+------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRPositionalTracker_property_rumble>` |
+---------------------------+------------------------------------------------------------+
+---------------------------+------------------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`rumble<class_ARVRPositionalTracker_property_rumble>` | 0.0 |
+---------------------------+------------------------------------------------------------+-----+
Methods
-------
@@ -83,11 +83,13 @@ Property Descriptions
- :ref:`float<class_float>` **rumble**
+----------+-------------------+
| *Setter* | set_rumble(value) |
+----------+-------------------+
| *Getter* | get_rumble() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 0.0 |
+-----------+-------------------+
| *Setter* | set_rumble(value) |
+-----------+-------------------+
| *Getter* | get_rumble() |
+-----------+-------------------+
The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``.

34
classes/class_arvrserver.rst
View File

@@ -19,11 +19,11 @@ The AR/VR server.
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>` |
+-------------------------------------------+-----------------------------------------------------------------------+
+-------------------------------------------+-----------------------------------------------------------------------+------+
| :ref:`ARVRInterface<class_ARVRInterface>` | :ref:`primary_interface<class_ARVRServer_property_primary_interface>` | null |
+-------------------------------------------+-----------------------------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`world_scale<class_ARVRServer_property_world_scale>` | 1.0 |
+-------------------------------------------+-----------------------------------------------------------------------+------+
Methods
-------
@@ -140,21 +140,25 @@ Property Descriptions
- :ref:`ARVRInterface<class_ARVRInterface>` **primary_interface**
+----------+------------------------------+
| *Setter* | set_primary_interface(value) |
+----------+------------------------------+
| *Getter* | get_primary_interface() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | null |
+-----------+------------------------------+
| *Setter* | set_primary_interface(value) |
+-----------+------------------------------+
| *Getter* | get_primary_interface() |
+-----------+------------------------------+
.. _class_ARVRServer_property_world_scale:
- :ref:`float<class_float>` **world_scale**
+----------+------------------------+
| *Setter* | set_world_scale(value) |
+----------+------------------------+
| *Getter* | get_world_scale() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1.0 |
+-----------+------------------------+
| *Setter* | set_world_scale(value) |
+-----------+------------------------+
| *Getter* | get_world_scale() |
+-----------+------------------------+
Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter.

66
classes/class_atlastexture.rst
View File

@@ -19,15 +19,15 @@ Packs multiple small textures in a single, bigger one. Helps to optimize video m
Properties
----------
+-------------------------------+-------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`atlas<class_AtlasTexture_property_atlas>` |
+-------------------------------+-------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_property_filter_clip>` |
+-------------------------------+-------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`margin<class_AtlasTexture_property_margin>` |
+-------------------------------+-------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`region<class_AtlasTexture_property_region>` |
+-------------------------------+-------------------------------------------------------------+
+-------------------------------+-------------------------------------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | :ref:`atlas<class_AtlasTexture_property_atlas>` | null |
+-------------------------------+-------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_property_filter_clip>` | false |
+-------------------------------+-------------------------------------------------------------+---------------------+
| :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 ) |
+-------------------------------+-------------------------------------------------------------+---------------------+
Description
-----------
@@ -43,11 +43,13 @@ Property Descriptions
- :ref:`Texture<class_Texture>` **atlas**
+----------+------------------+
| *Setter* | set_atlas(value) |
+----------+------------------+
| *Getter* | get_atlas() |
+----------+------------------+
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_atlas(value) |
+-----------+------------------+
| *Getter* | get_atlas() |
+-----------+------------------+
The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` subtype.
@@ -55,11 +57,13 @@ The texture that contains the atlas. Can be any :ref:`Texture<class_Texture>` su
- :ref:`bool<class_bool>` **filter_clip**
+----------+------------------------+
| *Setter* | set_filter_clip(value) |
+----------+------------------------+
| *Getter* | has_filter_clip() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | false |
+-----------+------------------------+
| *Setter* | set_filter_clip(value) |
+-----------+------------------------+
| *Getter* | has_filter_clip() |
+-----------+------------------------+
If ``true``, clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
@@ -67,11 +71,13 @@ If ``true``, clips the area outside of the region to avoid bleeding of the surro
- :ref:`Rect2<class_Rect2>` **margin**
+----------+-------------------+
| *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.
@@ -79,11 +85,13 @@ The margin around the region. The :ref:`Rect2<class_Rect2>`'s :ref:`Rect2.size<c
- :ref:`Rect2<class_Rect2>` **region**
+----------+-------------------+
| *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.

20
classes/class_audioeffectamplify.rst
View File

@@ -21,9 +21,9 @@ Increases or decreases the volume of the selected audio bus.
Properties
----------
+---------------------------+---------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioEffectAmplify_property_volume_db>` |
+---------------------------+---------------------------------------------------------------+
+---------------------------+---------------------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioEffectAmplify_property_volume_db>` | 0.0 |
+---------------------------+---------------------------------------------------------------+-----+
Description
-----------
@@ -37,11 +37,13 @@ Property Descriptions
- :ref:`float<class_float>` **volume_db**
+----------+----------------------+
| *Setter* | set_volume_db(value) |
+----------+----------------------+
| *Getter* | get_volume_db() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0.0 |
+-----------+----------------------+
| *Setter* | set_volume_db(value) |
+-----------+----------------------+
| *Getter* | get_volume_db() |
+-----------+----------------------+
Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: ``0``.
Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24.

290
classes/class_audioeffectchorus.rst
View File

@@ -19,61 +19,61 @@ Adds a chorus audio effect.
Properties
----------
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectChorus_property_dry>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/cutoff_hz<class_AudioEffectChorus_property_voice/1/cutoff_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/delay_ms<class_AudioEffectChorus_property_voice/1/delay_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/depth_ms<class_AudioEffectChorus_property_voice/1/depth_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/level_db<class_AudioEffectChorus_property_voice/1/level_db>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/pan<class_AudioEffectChorus_property_voice/1/pan>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/rate_hz<class_AudioEffectChorus_property_voice/1/rate_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/cutoff_hz<class_AudioEffectChorus_property_voice/2/cutoff_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/delay_ms<class_AudioEffectChorus_property_voice/2/delay_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/depth_ms<class_AudioEffectChorus_property_voice/2/depth_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/level_db<class_AudioEffectChorus_property_voice/2/level_db>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/pan<class_AudioEffectChorus_property_voice/2/pan>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/rate_hz<class_AudioEffectChorus_property_voice/2/rate_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/cutoff_hz<class_AudioEffectChorus_property_voice/3/cutoff_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/delay_ms<class_AudioEffectChorus_property_voice/3/delay_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/depth_ms<class_AudioEffectChorus_property_voice/3/depth_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/level_db<class_AudioEffectChorus_property_voice/3/level_db>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/pan<class_AudioEffectChorus_property_voice/3/pan>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/rate_hz<class_AudioEffectChorus_property_voice/3/rate_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/cutoff_hz<class_AudioEffectChorus_property_voice/4/cutoff_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/delay_ms<class_AudioEffectChorus_property_voice/4/delay_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/depth_ms<class_AudioEffectChorus_property_voice/4/depth_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/level_db<class_AudioEffectChorus_property_voice/4/level_db>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/pan<class_AudioEffectChorus_property_voice/4/pan>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/rate_hz<class_AudioEffectChorus_property_voice/4/rate_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`voice_count<class_AudioEffectChorus_property_voice_count>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectChorus_property_wet>` |
+---------------------------+------------------------------------------------------------------------------+
+---------------------------+------------------------------------------------------------------------------+--------+
| :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 |
+---------------------------+------------------------------------------------------------------------------+--------+
Description
-----------
@@ -87,11 +87,13 @@ Property Descriptions
- :ref:`float<class_float>` **dry**
+----------+----------------+
| *Setter* | set_dry(value) |
+----------+----------------+
| *Getter* | get_dry() |
+----------+----------------+
+-----------+----------------+
| *Default* | 1.0 |
+-----------+----------------+
| *Setter* | set_dry(value) |
+-----------+----------------+
| *Getter* | get_dry() |
+-----------+----------------+
The effect's raw signal.
@@ -99,11 +101,13 @@ The effect's raw signal.
- :ref:`float<class_float>` **voice/1/cutoff_hz**
+----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+----------+----------------------------+
| *Getter* | get_voice_cutoff_hz() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | 8000.0 |
+-----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+-----------+----------------------------+
| *Getter* | get_voice_cutoff_hz() |
+-----------+----------------------------+
The voice's cutoff frequency.
@@ -111,11 +115,13 @@ The voice's cutoff frequency.
- :ref:`float<class_float>` **voice/1/delay_ms**
+----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_delay_ms() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 15.0 |
+-----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+-----------+---------------------------+
| *Getter* | get_voice_delay_ms() |
+-----------+---------------------------+
The voice's signal delay.
@@ -123,11 +129,13 @@ The voice's signal delay.
- :ref:`float<class_float>` **voice/1/depth_ms**
+----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_depth_ms() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 2.0 |
+-----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+-----------+---------------------------+
| *Getter* | get_voice_depth_ms() |
+-----------+---------------------------+
The voice filter's depth.
@@ -135,11 +143,13 @@ The voice filter's depth.
- :ref:`float<class_float>` **voice/1/level_db**
+----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+----------+---------------------------+
| *Getter* | get_voice_level_db() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 0.0 |
+-----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+-----------+---------------------------+
| *Getter* | get_voice_level_db() |
+-----------+---------------------------+
The voice's volume.
@@ -147,11 +157,13 @@ The voice's volume.
- :ref:`float<class_float>` **voice/1/pan**
+----------+----------------------+
| *Setter* | set_voice_pan(value) |
+----------+----------------------+
| *Getter* | get_voice_pan() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | -0.5 |
+-----------+----------------------+
| *Setter* | set_voice_pan(value) |
+-----------+----------------------+
| *Getter* | get_voice_pan() |
+-----------+----------------------+
The voice's pan level.
@@ -159,11 +171,13 @@ The voice's pan level.
- :ref:`float<class_float>` **voice/1/rate_hz**
+----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+----------+--------------------------+
| *Getter* | get_voice_rate_hz() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 0.8 |
+-----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+-----------+--------------------------+
| *Getter* | get_voice_rate_hz() |
+-----------+--------------------------+
The voice's filter rate.
@@ -171,11 +185,13 @@ The voice's filter rate.
- :ref:`float<class_float>` **voice/2/cutoff_hz**
+----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+----------+----------------------------+
| *Getter* | get_voice_cutoff_hz() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | 8000.0 |
+-----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+-----------+----------------------------+
| *Getter* | get_voice_cutoff_hz() |
+-----------+----------------------------+
The voice's cutoff frequency.
@@ -183,11 +199,13 @@ The voice's cutoff frequency.
- :ref:`float<class_float>` **voice/2/delay_ms**
+----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_delay_ms() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 20.0 |
+-----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+-----------+---------------------------+
| *Getter* | get_voice_delay_ms() |
+-----------+---------------------------+
The voice's signal delay.
@@ -195,11 +213,13 @@ The voice's signal delay.
- :ref:`float<class_float>` **voice/2/depth_ms**
+----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_depth_ms() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 3.0 |
+-----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+-----------+---------------------------+
| *Getter* | get_voice_depth_ms() |
+-----------+---------------------------+
The voice filter's depth.
@@ -207,11 +227,13 @@ The voice filter's depth.
- :ref:`float<class_float>` **voice/2/level_db**
+----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+----------+---------------------------+
| *Getter* | get_voice_level_db() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 0.0 |
+-----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+-----------+---------------------------+
| *Getter* | get_voice_level_db() |
+-----------+---------------------------+
The voice's volume.
@@ -219,11 +241,13 @@ The voice's volume.
- :ref:`float<class_float>` **voice/2/pan**
+----------+----------------------+
| *Setter* | set_voice_pan(value) |
+----------+----------------------+
| *Getter* | get_voice_pan() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0.5 |
+-----------+----------------------+
| *Setter* | set_voice_pan(value) |
+-----------+----------------------+
| *Getter* | get_voice_pan() |
+-----------+----------------------+
The voice's pan level.
@@ -231,11 +255,13 @@ The voice's pan level.
- :ref:`float<class_float>` **voice/2/rate_hz**
+----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+----------+--------------------------+
| *Getter* | get_voice_rate_hz() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 1.2 |
+-----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+-----------+--------------------------+
| *Getter* | get_voice_rate_hz() |
+-----------+--------------------------+
The voice's filter rate.
@@ -387,11 +413,13 @@ The voice's filter rate.
- :ref:`int<class_int>` **voice_count**
+----------+------------------------+
| *Setter* | set_voice_count(value) |
+----------+------------------------+
| *Getter* | get_voice_count() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 2 |
+-----------+------------------------+
| *Setter* | set_voice_count(value) |
+-----------+------------------------+
| *Getter* | get_voice_count() |
+-----------+------------------------+
The amount of voices in the effect.
@@ -399,11 +427,13 @@ The amount of voices in the effect.
- :ref:`float<class_float>` **wet**
+----------+----------------+
| *Setter* | set_wet(value) |
+----------+----------------+
| *Getter* | get_wet() |
+----------+----------------+
+-----------+----------------+
| *Default* | 0.5 |
+-----------+----------------+
| *Setter* | set_wet(value) |
+-----------+----------------+
| *Getter* | get_wet() |
+-----------+----------------+
The effect's processed signal.

124
classes/class_audioeffectcompressor.rst
View File

@@ -21,21 +21,21 @@ Reduces sounds that exceed a certain threshold level, smooths out the dynamics a
Properties
----------
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`attack_us<class_AudioEffectCompressor_property_attack_us>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectCompressor_property_gain>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`mix<class_AudioEffectCompressor_property_mix>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`ratio<class_AudioEffectCompressor_property_ratio>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`release_ms<class_AudioEffectCompressor_property_release_ms>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`sidechain<class_AudioEffectCompressor_property_sidechain>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`threshold<class_AudioEffectCompressor_property_threshold>` |
+-----------------------------+--------------------------------------------------------------------+
+-----------------------------+--------------------------------------------------------------------+-------+
| :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 |
+-----------------------------+--------------------------------------------------------------------+-------+
Description
-----------
@@ -59,23 +59,27 @@ Property Descriptions
- :ref:`float<class_float>` **attack_us**
+----------+----------------------+
| *Setter* | set_attack_us(value) |
+----------+----------------------+
| *Getter* | get_attack_us() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 20.0 |
+-----------+----------------------+
| *Setter* | set_attack_us(value) |
+-----------+----------------------+
| *Getter* | get_attack_us() |
+-----------+----------------------+
Compressor's reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000. Default value: ``20us``.
Compressor's reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000.
.. _class_AudioEffectCompressor_property_gain:
- :ref:`float<class_float>` **gain**
+----------+-----------------+
| *Setter* | set_gain(value) |
+----------+-----------------+
| *Getter* | get_gain() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | 0.0 |
+-----------+-----------------+
| *Setter* | set_gain(value) |
+-----------+-----------------+
| *Getter* | get_gain() |
+-----------+-----------------+
Gain applied to the output signal.
@@ -83,47 +87,55 @@ Gain applied to the output signal.
- :ref:`float<class_float>` **mix**
+----------+----------------+
| *Setter* | set_mix(value) |
+----------+----------------+
| *Getter* | get_mix() |
+----------+----------------+
+-----------+----------------+
| *Default* | 1.0 |
+-----------+----------------+
| *Setter* | set_mix(value) |
+-----------+----------------+
| *Getter* | get_mix() |
+-----------+----------------+
Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: ``1``.
Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet).
.. _class_AudioEffectCompressor_property_ratio:
- :ref:`float<class_float>` **ratio**
+----------+------------------+
| *Setter* | set_ratio(value) |
+----------+------------------+
| *Getter* | get_ratio() |
+----------+------------------+
+-----------+------------------+
| *Default* | 4.0 |
+-----------+------------------+
| *Setter* | set_ratio(value) |
+-----------+------------------+
| *Getter* | get_ratio() |
+-----------+------------------+
Amount of compression applied to the audio once it passes the threshold level. The higher the ratio, the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: ``4``.
Amount of compression applied to the audio once it passes the threshold level. The higher the ratio, the more the loud parts of the audio will be compressed. Value can range from 1 to 48.
.. _class_AudioEffectCompressor_property_release_ms:
- :ref:`float<class_float>` **release_ms**
+----------+-----------------------+
| *Setter* | set_release_ms(value) |
+----------+-----------------------+
| *Getter* | get_release_ms() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 250.0 |
+-----------+-----------------------+
| *Setter* | set_release_ms(value) |
+-----------+-----------------------+
| *Getter* | get_release_ms() |
+-----------+-----------------------+
Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000. Default value: ``250ms``.
Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000.
.. _class_AudioEffectCompressor_property_sidechain:
- :ref:`String<class_String>` **sidechain**
+----------+----------------------+
| *Setter* | set_sidechain(value) |
+----------+----------------------+
| *Getter* | get_sidechain() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | "" |
+-----------+----------------------+
| *Setter* | set_sidechain(value) |
+-----------+----------------------+
| *Getter* | get_sidechain() |
+-----------+----------------------+
Reduce the sound level using another audio bus for threshold detection.
@@ -131,11 +143,13 @@ Reduce the sound level using another audio bus for threshold detection.
- :ref:`float<class_float>` **threshold**
+----------+----------------------+
| *Setter* | set_threshold(value) |
+----------+----------------------+
| *Getter* | get_threshold() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0.0 |
+-----------+----------------------+
| *Setter* | set_threshold(value) |
+-----------+----------------------+
| *Getter* | get_threshold() |
+-----------+----------------------+
The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: ``0``.
The level above which compression is applied to the audio. Value can range from -60 to 0.

236
classes/class_audioeffectdelay.rst
View File

@@ -21,33 +21,33 @@ Two tap delay and feedback options.
Properties
----------
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectDelay_property_dry>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`feedback/active<class_AudioEffectDelay_property_feedback/active>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`feedback/delay_ms<class_AudioEffectDelay_property_feedback/delay_ms>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`feedback/level_db<class_AudioEffectDelay_property_feedback/level_db>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`feedback/lowpass<class_AudioEffectDelay_property_feedback/lowpass>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`tap1/active<class_AudioEffectDelay_property_tap1/active>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tap1/delay_ms<class_AudioEffectDelay_property_tap1/delay_ms>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tap1/level_db<class_AudioEffectDelay_property_tap1/level_db>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tap1/pan<class_AudioEffectDelay_property_tap1/pan>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`tap2/active<class_AudioEffectDelay_property_tap2/active>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tap2/delay_ms<class_AudioEffectDelay_property_tap2/delay_ms>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tap2/level_db<class_AudioEffectDelay_property_tap2/level_db>` |
+---------------------------+-----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tap2/pan<class_AudioEffectDelay_property_tap2/pan>` |
+---------------------------+-----------------------------------------------------------------------------+
+---------------------------+-----------------------------------------------------------------------------+---------+
| :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 |
+---------------------------+-----------------------------------------------------------------------------+---------+
Description
-----------
@@ -61,155 +61,181 @@ Property Descriptions
- :ref:`float<class_float>` **dry**
+----------+----------------+
| *Setter* | set_dry(value) |
+----------+----------------+
| *Getter* | get_dry() |
+----------+----------------+
+-----------+----------------+
| *Default* | 1.0 |
+-----------+----------------+
| *Setter* | set_dry(value) |
+-----------+----------------+
| *Getter* | get_dry() |
+-----------+----------------+
Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: ``1``.
Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1.
.. _class_AudioEffectDelay_property_feedback/active:
- :ref:`bool<class_bool>` **feedback/active**
+----------+----------------------------+
| *Setter* | set_feedback_active(value) |
+----------+----------------------------+
| *Getter* | is_feedback_active() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | false |
+-----------+----------------------------+
| *Setter* | set_feedback_active(value) |
+-----------+----------------------------+
| *Getter* | is_feedback_active() |
+-----------+----------------------------+
If ``true``, feedback is enabled. Default value: ``false``.
If ``true``, feedback is enabled.
.. _class_AudioEffectDelay_property_feedback/delay_ms:
- :ref:`float<class_float>` **feedback/delay_ms**
+----------+------------------------------+
| *Setter* | set_feedback_delay_ms(value) |
+----------+------------------------------+
| *Getter* | get_feedback_delay_ms() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | 340.0 |
+-----------+------------------------------+
| *Setter* | set_feedback_delay_ms(value) |
+-----------+------------------------------+
| *Getter* | get_feedback_delay_ms() |
+-----------+------------------------------+
Feedback delay time in milliseconds. Default value: ``340``.
Feedback delay time in milliseconds.
.. _class_AudioEffectDelay_property_feedback/level_db:
- :ref:`float<class_float>` **feedback/level_db**
+----------+------------------------------+
| *Setter* | set_feedback_level_db(value) |
+----------+------------------------------+
| *Getter* | get_feedback_level_db() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | -6.0 |
+-----------+------------------------------+
| *Setter* | set_feedback_level_db(value) |
+-----------+------------------------------+
| *Getter* | get_feedback_level_db() |
+-----------+------------------------------+
Sound level for ``tap1``. Default value: ``-6 dB``.
Sound level for ``tap1``.
.. _class_AudioEffectDelay_property_feedback/lowpass:
- :ref:`float<class_float>` **feedback/lowpass**
+----------+-----------------------------+
| *Setter* | set_feedback_lowpass(value) |
+----------+-----------------------------+
| *Getter* | get_feedback_lowpass() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | 16000.0 |
+-----------+-----------------------------+
| *Setter* | set_feedback_lowpass(value) |
+-----------+-----------------------------+
| *Getter* | get_feedback_lowpass() |
+-----------+-----------------------------+
Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal. Default value: ``16000``.
Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal.
.. _class_AudioEffectDelay_property_tap1/active:
- :ref:`bool<class_bool>` **tap1/active**
+----------+------------------------+
| *Setter* | set_tap1_active(value) |
+----------+------------------------+
| *Getter* | is_tap1_active() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | true |
+-----------+------------------------+
| *Setter* | set_tap1_active(value) |
+-----------+------------------------+
| *Getter* | is_tap1_active() |
+-----------+------------------------+
If ``true``, ``tap1`` will be enabled. Default value: ``true``.
If ``true``, ``tap1`` will be enabled.
.. _class_AudioEffectDelay_property_tap1/delay_ms:
- :ref:`float<class_float>` **tap1/delay_ms**
+----------+--------------------------+
| *Setter* | set_tap1_delay_ms(value) |
+----------+--------------------------+
| *Getter* | get_tap1_delay_ms() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 250.0 |
+-----------+--------------------------+
| *Setter* | set_tap1_delay_ms(value) |
+-----------+--------------------------+
| *Getter* | get_tap1_delay_ms() |
+-----------+--------------------------+
``tap1`` delay time in milliseconds. Default value: ``250ms``.
``tap1`` delay time in milliseconds.
.. _class_AudioEffectDelay_property_tap1/level_db:
- :ref:`float<class_float>` **tap1/level_db**
+----------+--------------------------+
| *Setter* | set_tap1_level_db(value) |
+----------+--------------------------+
| *Getter* | get_tap1_level_db() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | -6.0 |
+-----------+--------------------------+
| *Setter* | set_tap1_level_db(value) |
+-----------+--------------------------+
| *Getter* | get_tap1_level_db() |
+-----------+--------------------------+
Sound level for ``tap1``. Default value: ``-6 dB``.
Sound level for ``tap1``.
.. _class_AudioEffectDelay_property_tap1/pan:
- :ref:`float<class_float>` **tap1/pan**
+----------+---------------------+
| *Setter* | set_tap1_pan(value) |
+----------+---------------------+
| *Getter* | get_tap1_pan() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0.2 |
+-----------+---------------------+
| *Setter* | set_tap1_pan(value) |
+-----------+---------------------+
| *Getter* | get_tap1_pan() |
+-----------+---------------------+
Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``0.2``.
Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right).
.. _class_AudioEffectDelay_property_tap2/active:
- :ref:`bool<class_bool>` **tap2/active**
+----------+------------------------+
| *Setter* | set_tap2_active(value) |
+----------+------------------------+
| *Getter* | is_tap2_active() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | true |
+-----------+------------------------+
| *Setter* | set_tap2_active(value) |
+-----------+------------------------+
| *Getter* | is_tap2_active() |
+-----------+------------------------+
If ``true``, ``tap2`` will be enabled. Default value: ``true``.
If ``true``, ``tap2`` will be enabled.
.. _class_AudioEffectDelay_property_tap2/delay_ms:
- :ref:`float<class_float>` **tap2/delay_ms**
+----------+--------------------------+
| *Setter* | set_tap2_delay_ms(value) |
+----------+--------------------------+
| *Getter* | get_tap2_delay_ms() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 500.0 |
+-----------+--------------------------+
| *Setter* | set_tap2_delay_ms(value) |
+-----------+--------------------------+
| *Getter* | get_tap2_delay_ms() |
+-----------+--------------------------+
**Tap2** delay time in milliseconds. Default value: ``500ms``.
**Tap2** delay time in milliseconds.
.. _class_AudioEffectDelay_property_tap2/level_db:
- :ref:`float<class_float>` **tap2/level_db**
+----------+--------------------------+
| *Setter* | set_tap2_level_db(value) |
+----------+--------------------------+
| *Getter* | get_tap2_level_db() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | -12.0 |
+-----------+--------------------------+
| *Setter* | set_tap2_level_db(value) |
+-----------+--------------------------+
| *Getter* | get_tap2_level_db() |
+-----------+--------------------------+
Sound level for ``tap2``. Default value: ``-12 dB``.
Sound level for ``tap2``.
.. _class_AudioEffectDelay_property_tap2/pan:
- :ref:`float<class_float>` **tap2/pan**
+----------+---------------------+
| *Setter* | set_tap2_pan(value) |
+----------+---------------------+
| *Getter* | get_tap2_pan() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | -0.4 |
+-----------+---------------------+
| *Setter* | set_tap2_pan(value) |
+-----------+---------------------+
| *Getter* | get_tap2_pan() |
+-----------+---------------------+
Pan position for ``tap2``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``-0.4``.
Pan position for ``tap2``. Value can range from -1 (fully left) to 1 (fully right).

92
classes/class_audioeffectdistortion.rst
View File

@@ -21,17 +21,17 @@ Modify the sound to make it dirty.
Properties
----------
+----------------------------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drive<class_AudioEffectDistortion_property_drive>` |
+----------------------------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`keep_hf_hz<class_AudioEffectDistortion_property_keep_hf_hz>` |
+----------------------------------------------+--------------------------------------------------------------------+
| :ref:`Mode<enum_AudioEffectDistortion_Mode>` | :ref:`mode<class_AudioEffectDistortion_property_mode>` |
+----------------------------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`post_gain<class_AudioEffectDistortion_property_post_gain>` |
+----------------------------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pre_gain<class_AudioEffectDistortion_property_pre_gain>` |
+----------------------------------------------+--------------------------------------------------------------------+
+----------------------------------------------+--------------------------------------------------------------------+---------+
| :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
------------
@@ -74,59 +74,69 @@ Property Descriptions
- :ref:`float<class_float>` **drive**
+----------+------------------+
| *Setter* | set_drive(value) |
+----------+------------------+
| *Getter* | get_drive() |
+----------+------------------+
+-----------+------------------+
| *Default* | 0.0 |
+-----------+------------------+
| *Setter* | set_drive(value) |
+-----------+------------------+
| *Getter* | get_drive() |
+-----------+------------------+
Distortion power. Value can range from 0 to 1. Default value: ``0``.
Distortion power. Value can range from 0 to 1.
.. _class_AudioEffectDistortion_property_keep_hf_hz:
- :ref:`float<class_float>` **keep_hf_hz**
+----------+-----------------------+
| *Setter* | set_keep_hf_hz(value) |
+----------+-----------------------+
| *Getter* | get_keep_hf_hz() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 16000.0 |
+-----------+-----------------------+
| *Setter* | set_keep_hf_hz(value) |
+-----------+-----------------------+
| *Getter* | get_keep_hf_hz() |
+-----------+-----------------------+
High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: ``16000``.
High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000.
.. _class_AudioEffectDistortion_property_mode:
- :ref:`Mode<enum_AudioEffectDistortion_Mode>` **mode**
+----------+-----------------+
| *Setter* | set_mode(value) |
+----------+-----------------+
| *Getter* | get_mode() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | 0 |
+-----------+-----------------+
| *Setter* | set_mode(value) |
+-----------+-----------------+
| *Getter* | get_mode() |
+-----------+-----------------+
Distortion type. Default value: :ref:`MODE_CLIP<class_AudioEffectDistortion_constant_MODE_CLIP>`.
Distortion type.
.. _class_AudioEffectDistortion_property_post_gain:
- :ref:`float<class_float>` **post_gain**
+----------+----------------------+
| *Setter* | set_post_gain(value) |
+----------+----------------------+
| *Getter* | get_post_gain() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0.0 |
+-----------+----------------------+
| *Setter* | set_post_gain(value) |
+-----------+----------------------+
| *Getter* | get_post_gain() |
+-----------+----------------------+
Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: ``0``.
Increases or decreases the volume after the effect. Value can range from -80 to 24.
.. _class_AudioEffectDistortion_property_pre_gain:
- :ref:`float<class_float>` **pre_gain**
+----------+---------------------+
| *Setter* | set_pre_gain(value) |
+----------+---------------------+
| *Getter* | get_pre_gain() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0.0 |
+-----------+---------------------+
| *Setter* | set_pre_gain(value) |
+-----------+---------------------+
| *Getter* | get_pre_gain() |
+-----------+---------------------+
Increases or decreases the volume before the effect. Value can range from -60 to 60. Default value: ``0``.
Increases or decreases the volume before the effect. Value can range from -60 to 60.

66
classes/class_audioeffectfilter.rst
View File

@@ -21,15 +21,15 @@ Adds a filter to the audio bus.
Properties
----------
+--------------------------------------------------+--------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`cutoff_hz<class_AudioEffectFilter_property_cutoff_hz>` |
+--------------------------------------------------+--------------------------------------------------------------+
| :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` | :ref:`db<class_AudioEffectFilter_property_db>` |
+--------------------------------------------------+--------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`gain<class_AudioEffectFilter_property_gain>` |
+--------------------------------------------------+--------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`resonance<class_AudioEffectFilter_property_resonance>` |
+--------------------------------------------------+--------------------------------------------------------------+
+--------------------------------------------------+--------------------------------------------------------------+--------+
| :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
------------
@@ -66,11 +66,13 @@ Property Descriptions
- :ref:`float<class_float>` **cutoff_hz**
+----------+-------------------+
| *Setter* | set_cutoff(value) |
+----------+-------------------+
| *Getter* | get_cutoff() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 2000.0 |
+-----------+-------------------+
| *Setter* | set_cutoff(value) |
+-----------+-------------------+
| *Getter* | get_cutoff() |
+-----------+-------------------+
Threshold frequency for the filter, in Hz.
@@ -78,21 +80,25 @@ Threshold frequency for the filter, in Hz.
- :ref:`FilterDB<enum_AudioEffectFilter_FilterDB>` **db**
+----------+---------------+
| *Setter* | set_db(value) |
+----------+---------------+
| *Getter* | get_db() |
+----------+---------------+
+-----------+---------------+
| *Default* | 0 |
+-----------+---------------+
| *Setter* | set_db(value) |
+-----------+---------------+
| *Getter* | get_db() |
+-----------+---------------+
.. _class_AudioEffectFilter_property_gain:
- :ref:`float<class_float>` **gain**
+----------+-----------------+
| *Setter* | set_gain(value) |
+----------+-----------------+
| *Getter* | get_gain() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | 1.0 |
+-----------+-----------------+
| *Setter* | set_gain(value) |
+-----------+-----------------+
| *Getter* | get_gain() |
+-----------+-----------------+
Gain amount of the frequencies after the filter.
@@ -100,11 +106,13 @@ Gain amount of the frequencies after the filter.
- :ref:`float<class_float>` **resonance**
+----------+----------------------+
| *Setter* | set_resonance(value) |
+----------+----------------------+
| *Getter* | get_resonance() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0.5 |
+-----------+----------------------+
| *Setter* | set_resonance(value) |
+-----------+----------------------+
| *Getter* | get_resonance() |
+-----------+----------------------+
Amount of boost in the overtones near the cutoff frequency.

72
classes/class_audioeffectlimiter.rst
View File

@@ -19,15 +19,15 @@ Adds a soft-clip limiter audio effect to an Audio bus.
Properties
----------
+---------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`ceiling_db<class_AudioEffectLimiter_property_ceiling_db>` |
+---------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`soft_clip_db<class_AudioEffectLimiter_property_soft_clip_db>` |
+---------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`soft_clip_ratio<class_AudioEffectLimiter_property_soft_clip_ratio>` |
+---------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`threshold_db<class_AudioEffectLimiter_property_threshold_db>` |
+---------------------------+---------------------------------------------------------------------------+
+---------------------------+---------------------------------------------------------------------------+------+
| :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 |
+---------------------------+---------------------------------------------------------------------------+------+
Description
-----------
@@ -43,45 +43,53 @@ Property Descriptions
- :ref:`float<class_float>` **ceiling_db**
+----------+-----------------------+
| *Setter* | set_ceiling_db(value) |
+----------+-----------------------+
| *Getter* | get_ceiling_db() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | -0.1 |
+-----------+-----------------------+
| *Setter* | set_ceiling_db(value) |
+-----------+-----------------------+
| *Getter* | get_ceiling_db() |
+-----------+-----------------------+
The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1. Default value: ``-0.1dB``.
The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1.
.. _class_AudioEffectLimiter_property_soft_clip_db:
- :ref:`float<class_float>` **soft_clip_db**
+----------+-------------------------+
| *Setter* | set_soft_clip_db(value) |
+----------+-------------------------+
| *Getter* | get_soft_clip_db() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 2.0 |
+-----------+-------------------------+
| *Setter* | set_soft_clip_db(value) |
+-----------+-------------------------+
| *Getter* | get_soft_clip_db() |
+-----------+-------------------------+
Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. Default value: ``2dB``.
Applies a gain to the limited waves, in decibels. Value can range from 0 to 6.
.. _class_AudioEffectLimiter_property_soft_clip_ratio:
- :ref:`float<class_float>` **soft_clip_ratio**
+----------+----------------------------+
| *Setter* | set_soft_clip_ratio(value) |
+----------+----------------------------+
| *Getter* | get_soft_clip_ratio() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | 10.0 |
+-----------+----------------------------+
| *Setter* | set_soft_clip_ratio(value) |
+-----------+----------------------------+
| *Getter* | get_soft_clip_ratio() |
+-----------+----------------------------+
.. _class_AudioEffectLimiter_property_threshold_db:
- :ref:`float<class_float>` **threshold_db**
+----------+-------------------------+
| *Setter* | set_threshold_db(value) |
+----------+-------------------------+
| *Getter* | get_threshold_db() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0.0 |
+-----------+-------------------------+
| *Setter* | set_threshold_db(value) |
+-----------+-------------------------+
| *Getter* | get_threshold_db() |
+-----------+-------------------------+
Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0. Default value: ``0dB``.
Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0.

18
classes/class_audioeffectpanner.rst
View File

@@ -19,9 +19,9 @@ Adds a panner audio effect to an Audio bus. Pans sound left or right.
Properties
----------
+---------------------------+--------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pan<class_AudioEffectPanner_property_pan>` |
+---------------------------+--------------------------------------------------+
+---------------------------+--------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`pan<class_AudioEffectPanner_property_pan>` | 0.0 |
+---------------------------+--------------------------------------------------+-----+
Description
-----------
@@ -35,11 +35,13 @@ Property Descriptions
- :ref:`float<class_float>` **pan**
+----------+----------------+
| *Setter* | set_pan(value) |
+----------+----------------+
| *Getter* | get_pan() |
+----------+----------------+
+-----------+----------------+
| *Default* | 0.0 |
+-----------+----------------+
| *Setter* | set_pan(value) |
+-----------+----------------+
| *Getter* | get_pan() |
+-----------+----------------+
Pan position. Value can range from -1 (fully left) to 1 (fully right).

90
classes/class_audioeffectphaser.rst
View File

@@ -21,17 +21,17 @@ Combines the original signal with a copy that is slightly out of phase with the
Properties
----------
+---------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`depth<class_AudioEffectPhaser_property_depth>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`feedback<class_AudioEffectPhaser_property_feedback>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`range_max_hz<class_AudioEffectPhaser_property_range_max_hz>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`range_min_hz<class_AudioEffectPhaser_property_range_min_hz>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`rate_hz<class_AudioEffectPhaser_property_rate_hz>` |
+---------------------------+--------------------------------------------------------------------+
+---------------------------+--------------------------------------------------------------------+--------+
| :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 |
+---------------------------+--------------------------------------------------------------------+--------+
Description
-----------
@@ -45,59 +45,69 @@ Property Descriptions
- :ref:`float<class_float>` **depth**
+----------+------------------+
| *Setter* | set_depth(value) |
+----------+------------------+
| *Getter* | get_depth() |
+----------+------------------+
+-----------+------------------+
| *Default* | 1.0 |
+-----------+------------------+
| *Setter* | set_depth(value) |
+-----------+------------------+
| *Getter* | get_depth() |
+-----------+------------------+
Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: ``1``.
Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4.
.. _class_AudioEffectPhaser_property_feedback:
- :ref:`float<class_float>` **feedback**
+----------+---------------------+
| *Setter* | set_feedback(value) |
+----------+---------------------+
| *Getter* | get_feedback() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0.7 |
+-----------+---------------------+
| *Setter* | set_feedback(value) |
+-----------+---------------------+
| *Getter* | get_feedback() |
+-----------+---------------------+
Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: ``0.7``.
Output percent of modified sound. Value can range from 0.1 to 0.9.
.. _class_AudioEffectPhaser_property_range_max_hz:
- :ref:`float<class_float>` **range_max_hz**
+----------+-------------------------+
| *Setter* | set_range_max_hz(value) |
+----------+-------------------------+
| *Getter* | get_range_max_hz() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 1600.0 |
+-----------+-------------------------+
| *Setter* | set_range_max_hz(value) |
+-----------+-------------------------+
| *Getter* | get_range_max_hz() |
+-----------+-------------------------+
Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000. Default value: ``1600hz``.
Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
.. _class_AudioEffectPhaser_property_range_min_hz:
- :ref:`float<class_float>` **range_min_hz**
+----------+-------------------------+
| *Setter* | set_range_min_hz(value) |
+----------+-------------------------+
| *Getter* | get_range_min_hz() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 440.0 |
+-----------+-------------------------+
| *Setter* | set_range_min_hz(value) |
+-----------+-------------------------+
| *Getter* | get_range_min_hz() |
+-----------+-------------------------+
Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000. Default value: ``440hz``.
Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
.. _class_AudioEffectPhaser_property_rate_hz:
- :ref:`float<class_float>` **rate_hz**
+----------+--------------------+
| *Setter* | set_rate_hz(value) |
+----------+--------------------+
| *Getter* | get_rate_hz() |
+----------+--------------------+
+-----------+--------------------+
| *Default* | 0.5 |
+-----------+--------------------+
| *Setter* | set_rate_hz(value) |
+-----------+--------------------+
| *Getter* | get_rate_hz() |
+-----------+--------------------+
Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range.

50
classes/class_audioeffectpitchshift.rst
View File

@@ -21,13 +21,13 @@ Raises or lowers the pitch of original sound.
Properties
----------
+------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` | :ref:`fft_size<class_AudioEffectPitchShift_property_fft_size>` |
+------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`oversampling<class_AudioEffectPitchShift_property_oversampling>` |
+------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` |
+------------------------------------------------------+------------------------------------------------------------------------+
+------------------------------------------------------+------------------------------------------------------------------------+-----+
| :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
------------
@@ -72,31 +72,37 @@ Property Descriptions
- :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` **fft_size**
+----------+---------------------+
| *Setter* | set_fft_size(value) |
+----------+---------------------+
| *Getter* | get_fft_size() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 3 |
+-----------+---------------------+
| *Setter* | set_fft_size(value) |
+-----------+---------------------+
| *Getter* | get_fft_size() |
+-----------+---------------------+
.. _class_AudioEffectPitchShift_property_oversampling:
- :ref:`int<class_int>` **oversampling**
+----------+-------------------------+
| *Setter* | set_oversampling(value) |
+----------+-------------------------+
| *Getter* | get_oversampling() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 4 |
+-----------+-------------------------+
| *Setter* | set_oversampling(value) |
+-----------+-------------------------+
| *Getter* | get_oversampling() |
+-----------+-------------------------+
.. _class_AudioEffectPitchShift_property_pitch_scale:
- :ref:`float<class_float>` **pitch_scale**
+----------+------------------------+
| *Setter* | set_pitch_scale(value) |
+----------+------------------------+
| *Getter* | get_pitch_scale() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1.0 |
+-----------+------------------------+
| *Setter* | set_pitch_scale(value) |
+-----------+------------------------+
| *Getter* | get_pitch_scale() |
+-----------+------------------------+
Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves).

18
classes/class_audioeffectrecord.rst
View File

@@ -19,9 +19,9 @@ Brief Description
Properties
----------
+----------------------------------------------+--------------------------------------------------------+
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioEffectRecord_property_format>` |
+----------------------------------------------+--------------------------------------------------------+
+----------------------------------------------+--------------------------------------------------------+---+
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioEffectRecord_property_format>` | 1 |
+----------------------------------------------+--------------------------------------------------------+---+
Methods
-------
@@ -41,11 +41,13 @@ Property Descriptions
- :ref:`Format<enum_AudioStreamSample_Format>` **format**
+----------+-------------------+
| *Setter* | set_format(value) |
+----------+-------------------+
| *Getter* | get_format() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1 |
+-----------+-------------------+
| *Setter* | set_format(value) |
+-----------+-------------------+
| *Getter* | get_format() |
+-----------+-------------------+
Method Descriptions
-------------------

146
classes/class_audioeffectreverb.rst
View File

@@ -21,23 +21,23 @@ Simulates the sound of acoustic environments such as rooms, concert halls, caver
Properties
----------
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`damping<class_AudioEffectReverb_property_damping>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectReverb_property_dry>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`hipass<class_AudioEffectReverb_property_hipass>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`predelay_feedback<class_AudioEffectReverb_property_predelay_feedback>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`predelay_msec<class_AudioEffectReverb_property_predelay_msec>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`room_size<class_AudioEffectReverb_property_room_size>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`spread<class_AudioEffectReverb_property_spread>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectReverb_property_wet>` |
+---------------------------+------------------------------------------------------------------------------+
+---------------------------+------------------------------------------------------------------------------+-------+
| :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 |
+---------------------------+------------------------------------------------------------------------------+-------+
Description
-----------
@@ -51,95 +51,111 @@ Property Descriptions
- :ref:`float<class_float>` **damping**
+----------+--------------------+
| *Setter* | set_damping(value) |
+----------+--------------------+
| *Getter* | get_damping() |
+----------+--------------------+
+-----------+--------------------+
| *Default* | 0.5 |
+-----------+--------------------+
| *Setter* | set_damping(value) |
+-----------+--------------------+
| *Getter* | get_damping() |
+-----------+--------------------+
Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: ``1``.
Defines how reflective the imaginary room's walls are. Value can range from 0 to 1.
.. _class_AudioEffectReverb_property_dry:
- :ref:`float<class_float>` **dry**
+----------+----------------+
| *Setter* | set_dry(value) |
+----------+----------------+
| *Getter* | get_dry() |
+----------+----------------+
+-----------+----------------+
| *Default* | 1.0 |
+-----------+----------------+
| *Setter* | set_dry(value) |
+-----------+----------------+
| *Getter* | get_dry() |
+-----------+----------------+
Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: ``1``.
Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1.
.. _class_AudioEffectReverb_property_hipass:
- :ref:`float<class_float>` **hipass**
+----------+----------------+
| *Setter* | set_hpf(value) |
+----------+----------------+
| *Getter* | get_hpf() |
+----------+----------------+
+-----------+----------------+
| *Default* | 0.0 |
+-----------+----------------+
| *Setter* | set_hpf(value) |
+-----------+----------------+
| *Getter* | get_hpf() |
+-----------+----------------+
High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: ``0``.
High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1.
.. _class_AudioEffectReverb_property_predelay_feedback:
- :ref:`float<class_float>` **predelay_feedback**
+----------+------------------------------+
| *Setter* | set_predelay_feedback(value) |
+----------+------------------------------+
| *Getter* | get_predelay_feedback() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | 0.4 |
+-----------+------------------------------+
| *Setter* | set_predelay_feedback(value) |
+-----------+------------------------------+
| *Getter* | get_predelay_feedback() |
+-----------+------------------------------+
Output percent of predelay. Value can range from 0 to 1. Default value: ``1``.
Output percent of predelay. Value can range from 0 to 1.
.. _class_AudioEffectReverb_property_predelay_msec:
- :ref:`float<class_float>` **predelay_msec**
+----------+--------------------------+
| *Setter* | set_predelay_msec(value) |
+----------+--------------------------+
| *Getter* | get_predelay_msec() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 150.0 |
+-----------+--------------------------+
| *Setter* | set_predelay_msec(value) |
+-----------+--------------------------+
| *Getter* | get_predelay_msec() |
+-----------+--------------------------+
Time between the original signal and the early reflections of the reverb signal, in milliseconds. Default value: ``150ms``.
Time between the original signal and the early reflections of the reverb signal, in milliseconds.
.. _class_AudioEffectReverb_property_room_size:
- :ref:`float<class_float>` **room_size**
+----------+----------------------+
| *Setter* | set_room_size(value) |
+----------+----------------------+
| *Getter* | get_room_size() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0.8 |
+-----------+----------------------+
| *Setter* | set_room_size(value) |
+-----------+----------------------+
| *Getter* | get_room_size() |
+-----------+----------------------+
Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: ``0.8``.
Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1.
.. _class_AudioEffectReverb_property_spread:
- :ref:`float<class_float>` **spread**
+----------+-------------------+
| *Setter* | set_spread(value) |
+----------+-------------------+
| *Getter* | get_spread() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1.0 |
+-----------+-------------------+
| *Setter* | set_spread(value) |
+-----------+-------------------+
| *Getter* | get_spread() |
+-----------+-------------------+
Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: ``1``.
Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1.
.. _class_AudioEffectReverb_property_wet:
- :ref:`float<class_float>` **wet**
+----------+----------------+
| *Setter* | set_wet(value) |
+----------+----------------+
| *Getter* | get_wet() |
+----------+----------------+
+-----------+----------------+
| *Default* | 0.5 |
+-----------+----------------+
| *Setter* | set_wet(value) |
+-----------+----------------+
| *Getter* | get_wet() |
+-----------+----------------+
Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. Default value: ``0.5``.
Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1.

50
classes/class_audioeffectspectrumanalyzer.rst
View File

@@ -19,13 +19,13 @@ Brief Description
Properties
----------
+------------------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`buffer_length<class_AudioEffectSpectrumAnalyzer_property_buffer_length>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` | :ref:`fft_size<class_AudioEffectSpectrumAnalyzer_property_fft_size>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tap_back_pos<class_AudioEffectSpectrumAnalyzer_property_tap_back_pos>` |
+------------------------------------------------------------+--------------------------------------------------------------------------------+
+------------------------------------------------------------+--------------------------------------------------------------------------------+------+
| :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
------------
@@ -65,29 +65,35 @@ Property Descriptions
- :ref:`float<class_float>` **buffer_length**
+----------+--------------------------+
| *Setter* | set_buffer_length(value) |
+----------+--------------------------+
| *Getter* | get_buffer_length() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 2.0 |
+-----------+--------------------------+
| *Setter* | set_buffer_length(value) |
+-----------+--------------------------+
| *Getter* | get_buffer_length() |
+-----------+--------------------------+
.. _class_AudioEffectSpectrumAnalyzer_property_fft_size:
- :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` **fft_size**
+----------+---------------------+
| *Setter* | set_fft_size(value) |
+----------+---------------------+
| *Getter* | get_fft_size() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 2 |
+-----------+---------------------+
| *Setter* | set_fft_size(value) |
+-----------+---------------------+
| *Getter* | get_fft_size() |
+-----------+---------------------+
.. _class_AudioEffectSpectrumAnalyzer_property_tap_back_pos:
- :ref:`float<class_float>` **tap_back_pos**
+----------+-------------------------+
| *Setter* | set_tap_back_pos(value) |
+----------+-------------------------+
| *Getter* | get_tap_back_pos() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0.01 |
+-----------+-------------------------+
| *Setter* | set_tap_back_pos(value) |
+-----------+-------------------------+
| *Getter* | get_tap_back_pos() |
+-----------+-------------------------+

50
classes/class_audioeffectstereoenhance.rst
View File

@@ -19,13 +19,13 @@ Brief Description
Properties
----------
+---------------------------+---------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pan_pullout<class_AudioEffectStereoEnhance_property_pan_pullout>` |
+---------------------------+---------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`surround<class_AudioEffectStereoEnhance_property_surround>` |
+---------------------------+---------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`time_pullout_ms<class_AudioEffectStereoEnhance_property_time_pullout_ms>` |
+---------------------------+---------------------------------------------------------------------------------+
+---------------------------+---------------------------------------------------------------------------------+-----+
| :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
---------------------
@@ -34,29 +34,35 @@ Property Descriptions
- :ref:`float<class_float>` **pan_pullout**
+----------+------------------------+
| *Setter* | set_pan_pullout(value) |
+----------+------------------------+
| *Getter* | get_pan_pullout() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1.0 |
+-----------+------------------------+
| *Setter* | set_pan_pullout(value) |
+-----------+------------------------+
| *Getter* | get_pan_pullout() |
+-----------+------------------------+
.. _class_AudioEffectStereoEnhance_property_surround:
- :ref:`float<class_float>` **surround**
+----------+---------------------+
| *Setter* | set_surround(value) |
+----------+---------------------+
| *Getter* | get_surround() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0.0 |
+-----------+---------------------+
| *Setter* | set_surround(value) |
+-----------+---------------------+
| *Getter* | get_surround() |
+-----------+---------------------+
.. _class_AudioEffectStereoEnhance_property_time_pullout_ms:
- :ref:`float<class_float>` **time_pullout_ms**
+----------+-------------------------+
| *Setter* | set_time_pullout(value) |
+----------+-------------------------+
| *Getter* | get_time_pullout() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0.0 |
+-----------+-------------------------+
| *Setter* | set_time_pullout(value) |
+-----------+-------------------------+
| *Getter* | get_time_pullout() |
+-----------+-------------------------+

100
classes/class_audioserver.rst
View File

@@ -16,6 +16,17 @@ Brief Description
Server interface for low-level audio access.
Properties
----------
+-----------------------------+------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`bus_count<class_AudioServer_property_bus_count>` | 1 |
+-----------------------------+------------------------------------------------------------------------+-----------+
| :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
-------
@@ -34,8 +45,6 @@ Methods
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_channels<class_AudioServer_method_get_bus_channels>` **(** :ref:`int<class_int>` bus_idx **)** const |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_count<class_AudioServer_method_get_bus_count>` **(** **)** const |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioEffect<class_AudioEffect>` | :ref:`get_bus_effect<class_AudioServer_method_get_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_effect_count<class_AudioServer_method_get_bus_effect_count>` **(** :ref:`int<class_int>` bus_idx **)** |
@@ -54,8 +63,6 @@ Methods
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_method_get_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx **)** const |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_device<class_AudioServer_method_get_device>` **(** **)** |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_device_list<class_AudioServer_method_get_device_list>` **(** **)** |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_method_get_mix_rate>` **(** **)** const |
@@ -86,8 +93,6 @@ Methods
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_bypass_effects<class_AudioServer_method_set_bus_bypass_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_count<class_AudioServer_method_set_bus_count>` **(** :ref:`int<class_int>` amount **)** |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_effect_enabled<class_AudioServer_method_set_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)** |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_layout<class_AudioServer_method_set_bus_layout>` **(** :ref:`AudioBusLayout<class_AudioBusLayout>` bus_layout **)** |
@@ -102,8 +107,6 @@ Methods
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bus_volume_db<class_AudioServer_method_set_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)** |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_device<class_AudioServer_method_set_device>` **(** :ref:`String<class_String>` device **)** |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`swap_bus_effects<class_AudioServer_method_swap_bus_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)** |
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unlock<class_AudioServer_method_unlock>` **(** **)** |
@@ -133,13 +136,13 @@ Enumerations
enum **SpeakerMode**:
- **SPEAKER_MODE_STEREO** = **0** --- Two or fewer speakers are detected.
- **SPEAKER_MODE_STEREO** = **0** --- Two or fewer speakers were detected.
- **SPEAKER_SURROUND_31** = **1**
- **SPEAKER_SURROUND_31** = **1** --- A 3.1 channel surround setup was detected.
- **SPEAKER_SURROUND_51** = **2** --- A 5.1 channel surround setup detected.
- **SPEAKER_SURROUND_51** = **2** --- A 5.1 channel surround setup was detected.
- **SPEAKER_SURROUND_71** = **3** --- A 7.1 channel surround setup detected.
- **SPEAKER_SURROUND_71** = **3** --- A 7.1 channel surround setup was detected.
Description
-----------
@@ -151,6 +154,51 @@ Tutorials
- :doc:`../tutorials/audio/audio_buses`
Property Descriptions
---------------------
.. _class_AudioServer_property_bus_count:
- :ref:`int<class_int>` **bus_count**
+-----------+----------------------+
| *Default* | 1 |
+-----------+----------------------+
| *Setter* | set_bus_count(value) |
+-----------+----------------------+
| *Getter* | get_bus_count() |
+-----------+----------------------+
Number of available audio buses.
.. _class_AudioServer_property_device:
- :ref:`String<class_String>` **device**
+-----------+-------------------+
| *Default* | "Default" |
+-----------+-------------------+
| *Setter* | set_device(value) |
+-----------+-------------------+
| *Getter* | get_device() |
+-----------+-------------------+
Name of the current device (see :ref:`get_device_list<class_AudioServer_method_get_device_list>`).
.. _class_AudioServer_property_global_rate_scale:
- :ref:`float<class_float>` **global_rate_scale**
+-----------+------------------------------+
| *Default* | 1.0 |
+-----------+------------------------------+
| *Setter* | set_global_rate_scale(value) |
+-----------+------------------------------+
| *Getter* | get_global_rate_scale() |
+-----------+------------------------------+
Scales the rate at which audio is played (i.e. setting it to ``0.5`` will make the audio be played twice as fast).
Method Descriptions
-------------------
@@ -190,12 +238,6 @@ Generates an :ref:`AudioBusLayout<class_AudioBusLayout>` using the available bus
Returns the amount of channels of the bus at index ``bus_idx``.
.. _class_AudioServer_method_get_bus_count:
- :ref:`int<class_int>` **get_bus_count** **(** **)** const
Returns the number of available buses.
.. _class_AudioServer_method_get_bus_effect:
- :ref:`AudioEffect<class_AudioEffect>` **get_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
@@ -248,24 +290,24 @@ Returns the name of the bus that the bus at index ``bus_idx`` sends to.
Returns the volume of the bus at index ``bus_idx`` in dB.
.. _class_AudioServer_method_get_device:
- :ref:`String<class_String>` **get_device** **(** **)**
.. _class_AudioServer_method_get_device_list:
- :ref:`Array<class_Array>` **get_device_list** **(** **)**
Returns the names of all audio devices detected on the system.
.. _class_AudioServer_method_get_mix_rate:
- :ref:`float<class_float>` **get_mix_rate** **(** **)** const
Returns the sample rate at the output of the audioserver.
Returns the sample rate at the output of the ``AudioServer``.
.. _class_AudioServer_method_get_output_latency:
- :ref:`float<class_float>` **get_output_latency** **(** **)** const
Returns the audio driver's output latency.
.. _class_AudioServer_method_get_speaker_mode:
- :ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` **get_speaker_mode** **(** **)** const
@@ -308,7 +350,7 @@ If ``true``, the bus at index ``bus_idx`` is in solo mode.
- void **lock** **(** **)**
Locks the audio drivers mainloop. Remember to unlock it afterwards.
Locks the audio driver's main loop. Remember to unlock it afterwards.
.. _class_AudioServer_method_move_bus:
@@ -334,12 +376,6 @@ Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``.
If ``true``, the bus at index ``bus_idx`` is bypassing effects.
.. _class_AudioServer_method_set_bus_count:
- void **set_bus_count** **(** :ref:`int<class_int>` amount **)**
Adds and removes buses to make the number of buses match ``amount``.
.. _class_AudioServer_method_set_bus_effect_enabled:
- void **set_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)**
@@ -382,10 +418,6 @@ If ``true``, the bus at index ``bus_idx`` is in solo mode.
Sets the volume of the bus at index ``bus_idx`` to ``volume_db``.
.. _class_AudioServer_method_set_device:
- void **set_device** **(** :ref:`String<class_String>` device **)**
.. _class_AudioServer_method_swap_bus_effects:
- void **swap_bus_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)**

34
classes/class_audiostreamgenerator.rst
View File

@@ -19,11 +19,11 @@ Brief Description
Properties
----------
+---------------------------+-------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`buffer_length<class_AudioStreamGenerator_property_buffer_length>` |
+---------------------------+-------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`mix_rate<class_AudioStreamGenerator_property_mix_rate>` |
+---------------------------+-------------------------------------------------------------------------+
+---------------------------+-------------------------------------------------------------------------+---------+
| :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
---------------------
@@ -32,19 +32,23 @@ Property Descriptions
- :ref:`float<class_float>` **buffer_length**
+----------+--------------------------+
| *Setter* | set_buffer_length(value) |
+----------+--------------------------+
| *Getter* | get_buffer_length() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 0.5 |
+-----------+--------------------------+
| *Setter* | set_buffer_length(value) |
+-----------+--------------------------+
| *Getter* | get_buffer_length() |
+-----------+--------------------------+
.. _class_AudioStreamGenerator_property_mix_rate:
- :ref:`float<class_float>` **mix_rate**
+----------+---------------------+
| *Setter* | set_mix_rate(value) |
+----------+---------------------+
| *Getter* | get_mix_rate() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 44100.0 |
+-----------+---------------------+
| *Setter* | set_mix_rate(value) |
+-----------+---------------------+
| *Getter* | get_mix_rate() |
+-----------+---------------------+

50
classes/class_audiostreamoggvorbis.rst
View File

@@ -19,13 +19,13 @@ OGG Vorbis audio stream driver.
Properties
----------
+-------------------------------------------+---------------------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamOGGVorbis_property_data>` |
+-------------------------------------------+---------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`loop<class_AudioStreamOGGVorbis_property_loop>` |
+-------------------------------------------+---------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`loop_offset<class_AudioStreamOGGVorbis_property_loop_offset>` |
+-------------------------------------------+---------------------------------------------------------------------+
+-------------------------------------------+---------------------------------------------------------------------+-------------------+
| :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 |
+-------------------------------------------+---------------------------------------------------------------------+-------------------+
Description
-----------
@@ -39,11 +39,13 @@ Property Descriptions
- :ref:`PoolByteArray<class_PoolByteArray>` **data**
+----------+-----------------+
| *Setter* | set_data(value) |
+----------+-----------------+
| *Getter* | get_data() |
+----------+-----------------+
+-----------+-------------------+
| *Default* | PoolByteArray( ) |
+-----------+-------------------+
| *Setter* | set_data(value) |
+-----------+-------------------+
| *Getter* | get_data() |
+-----------+-------------------+
Contains the audio data in bytes.
@@ -51,19 +53,23 @@ Contains the audio data in bytes.
- :ref:`bool<class_bool>` **loop**
+----------+-----------------+
| *Setter* | set_loop(value) |
+----------+-----------------+
| *Getter* | has_loop() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | false |
+-----------+-----------------+
| *Setter* | set_loop(value) |
+-----------+-----------------+
| *Getter* | has_loop() |
+-----------+-----------------+
.. _class_AudioStreamOGGVorbis_property_loop_offset:
- :ref:`float<class_float>` **loop_offset**
+----------+------------------------+
| *Setter* | set_loop_offset(value) |
+----------+------------------------+
| *Getter* | get_loop_offset() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 0.0 |
+-----------+------------------------+
| *Setter* | set_loop_offset(value) |
+-----------+------------------------+
| *Getter* | get_loop_offset() |
+-----------+------------------------+

128
classes/class_audiostreamplayer.rst
View File

@@ -19,23 +19,23 @@ Plays back audio non-positionally.
Properties
----------
+----------------------------------------------------+----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer_property_autoplay>` |
+----------------------------------------------------+----------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer_property_bus>` |
+----------------------------------------------------+----------------------------------------------------------------------+
| :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` | :ref:`mix_target<class_AudioStreamPlayer_property_mix_target>` |
+----------------------------------------------------+----------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer_property_pitch_scale>` |
+----------------------------------------------------+----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer_property_playing>` |
+----------------------------------------------------+----------------------------------------------------------------------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer_property_stream>` |
+----------------------------------------------------+----------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer_property_stream_paused>` |
+----------------------------------------------------+----------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer_property_volume_db>` |
+----------------------------------------------------+----------------------------------------------------------------------+
+----------------------------------------------------+----------------------------------------------------------------------+----------+
| :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>` | null |
+----------------------------------------------------+----------------------------------------------------------------------+----------+
| :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
-------
@@ -97,23 +97,27 @@ Property Descriptions
- :ref:`bool<class_bool>` **autoplay**
+----------+-----------------------+
| *Setter* | set_autoplay(value) |
+----------+-----------------------+
| *Getter* | is_autoplay_enabled() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | false |
+-----------+-----------------------+
| *Setter* | set_autoplay(value) |
+-----------+-----------------------+
| *Getter* | is_autoplay_enabled() |
+-----------+-----------------------+
If ``true``, audio plays when added to scene tree. Default value: ``false``.
If ``true``, audio plays when added to scene tree.
.. _class_AudioStreamPlayer_property_bus:
- :ref:`String<class_String>` **bus**
+----------+----------------+
| *Setter* | set_bus(value) |
+----------+----------------+
| *Getter* | get_bus() |
+----------+----------------+
+-----------+----------------+
| *Default* | "Master" |
+-----------+----------------+
| *Setter* | set_bus(value) |
+-----------+----------------+
| *Getter* | get_bus() |
+-----------+----------------+
Bus on which this audio is playing.
@@ -121,11 +125,13 @@ Bus on which this audio is playing.
- :ref:`MixTarget<enum_AudioStreamPlayer_MixTarget>` **mix_target**
+----------+-----------------------+
| *Setter* | set_mix_target(value) |
+----------+-----------------------+
| *Getter* | get_mix_target() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 0 |
+-----------+-----------------------+
| *Setter* | set_mix_target(value) |
+-----------+-----------------------+
| *Getter* | get_mix_target() |
+-----------+-----------------------+
If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants.
@@ -133,11 +139,13 @@ If the audio configuration has more than two speakers, this sets the target chan
- :ref:`float<class_float>` **pitch_scale**
+----------+------------------------+
| *Setter* | set_pitch_scale(value) |
+----------+------------------------+
| *Getter* | get_pitch_scale() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1.0 |
+-----------+------------------------+
| *Setter* | set_pitch_scale(value) |
+-----------+------------------------+
| *Getter* | get_pitch_scale() |
+-----------+------------------------+
Changes the pitch and the tempo of the audio.
@@ -145,9 +153,11 @@ Changes the pitch and the tempo of the audio.
- :ref:`bool<class_bool>` **playing**
+----------+--------------+
| *Getter* | is_playing() |
+----------+--------------+
+-----------+--------------+
| *Default* | false |
+-----------+--------------+
| *Getter* | is_playing() |
+-----------+--------------+
If ``true``, audio is playing.
@@ -155,11 +165,13 @@ If ``true``, audio is playing.
- :ref:`AudioStream<class_AudioStream>` **stream**
+----------+-------------------+
| *Setter* | set_stream(value) |
+----------+-------------------+
| *Getter* | get_stream() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | null |
+-----------+-------------------+
| *Setter* | set_stream(value) |
+-----------+-------------------+
| *Getter* | get_stream() |
+-----------+-------------------+
The :ref:`AudioStream<class_AudioStream>` object to be played.
@@ -167,21 +179,25 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
- :ref:`bool<class_bool>` **stream_paused**
+----------+--------------------------+
| *Setter* | set_stream_paused(value) |
+----------+--------------------------+
| *Getter* | get_stream_paused() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | false |
+-----------+--------------------------+
| *Setter* | set_stream_paused(value) |
+-----------+--------------------------+
| *Getter* | get_stream_paused() |
+-----------+--------------------------+
.. _class_AudioStreamPlayer_property_volume_db:
- :ref:`float<class_float>` **volume_db**
+----------+----------------------+
| *Setter* | set_volume_db(value) |
+----------+----------------------+
| *Getter* | get_volume_db() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0.0 |
+-----------+----------------------+
| *Setter* | set_volume_db(value) |
+-----------+----------------------+
| *Getter* | get_volume_db() |
+-----------+----------------------+
Volume of sound, in dB.

160
classes/class_audiostreamplayer2d.rst
View File

@@ -19,27 +19,27 @@ Plays audio in 2D.
Properties
----------
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer2D_property_area_mask>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`attenuation<class_AudioStreamPlayer2D_property_attenuation>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer2D_property_autoplay>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer2D_property_bus>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer2D_property_max_distance>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer2D_property_pitch_scale>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer2D_property_playing>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer2D_property_stream>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer2D_property_stream_paused>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer2D_property_volume_db>` |
+---------------------------------------+------------------------------------------------------------------------+
+---------------------------------------+------------------------------------------------------------------------+----------+
| :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>` | null |
+---------------------------------------+------------------------------------------------------------------------+----------+
| :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
-------
@@ -82,11 +82,13 @@ Property Descriptions
- :ref:`int<class_int>` **area_mask**
+----------+----------------------+
| *Setter* | set_area_mask(value) |
+----------+----------------------+
| *Getter* | get_area_mask() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 1 |
+-----------+----------------------+
| *Setter* | set_area_mask(value) |
+-----------+----------------------+
| *Getter* | get_area_mask() |
+-----------+----------------------+
Areas in which this sound plays.
@@ -94,11 +96,13 @@ Areas in which this sound plays.
- :ref:`float<class_float>` **attenuation**
+----------+------------------------+
| *Setter* | set_attenuation(value) |
+----------+------------------------+
| *Getter* | get_attenuation() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1.0 |
+-----------+------------------------+
| *Setter* | set_attenuation(value) |
+-----------+------------------------+
| *Getter* | get_attenuation() |
+-----------+------------------------+
Dampens audio over distance with this as an exponent.
@@ -106,23 +110,27 @@ Dampens audio over distance with this as an exponent.
- :ref:`bool<class_bool>` **autoplay**
+----------+-----------------------+
| *Setter* | set_autoplay(value) |
+----------+-----------------------+
| *Getter* | is_autoplay_enabled() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | false |
+-----------+-----------------------+
| *Setter* | set_autoplay(value) |
+-----------+-----------------------+
| *Getter* | is_autoplay_enabled() |
+-----------+-----------------------+
If ``true``, audio plays when added to scene tree. Default value: ``false``.
If ``true``, audio plays when added to scene tree.
.. _class_AudioStreamPlayer2D_property_bus:
- :ref:`String<class_String>` **bus**
+----------+----------------+
| *Setter* | set_bus(value) |
+----------+----------------+
| *Getter* | get_bus() |
+----------+----------------+
+-----------+----------------+
| *Default* | "Master" |
+-----------+----------------+
| *Setter* | set_bus(value) |
+-----------+----------------+
| *Getter* | get_bus() |
+-----------+----------------+
Bus on which this audio is playing.
@@ -130,11 +138,13 @@ Bus on which this audio is playing.
- :ref:`float<class_float>` **max_distance**
+----------+-------------------------+
| *Setter* | set_max_distance(value) |
+----------+-------------------------+
| *Getter* | get_max_distance() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 2000.0 |
+-----------+-------------------------+
| *Setter* | set_max_distance(value) |
+-----------+-------------------------+
| *Getter* | get_max_distance() |
+-----------+-------------------------+
Maximum distance from which audio is still hearable.
@@ -142,11 +152,13 @@ Maximum distance from which audio is still hearable.
- :ref:`float<class_float>` **pitch_scale**
+----------+------------------------+
| *Setter* | set_pitch_scale(value) |
+----------+------------------------+
| *Getter* | get_pitch_scale() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1.0 |
+-----------+------------------------+
| *Setter* | set_pitch_scale(value) |
+-----------+------------------------+
| *Getter* | get_pitch_scale() |
+-----------+------------------------+
Changes the pitch and the tempo of the audio.
@@ -154,9 +166,11 @@ Changes the pitch and the tempo of the audio.
- :ref:`bool<class_bool>` **playing**
+----------+--------------+
| *Getter* | is_playing() |
+----------+--------------+
+-----------+--------------+
| *Default* | false |
+-----------+--------------+
| *Getter* | is_playing() |
+-----------+--------------+
If ``true``, audio is playing.
@@ -164,11 +178,13 @@ If ``true``, audio is playing.
- :ref:`AudioStream<class_AudioStream>` **stream**
+----------+-------------------+
| *Setter* | set_stream(value) |
+----------+-------------------+
| *Getter* | get_stream() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | null |
+-----------+-------------------+
| *Setter* | set_stream(value) |
+-----------+-------------------+
| *Getter* | get_stream() |
+-----------+-------------------+
The :ref:`AudioStream<class_AudioStream>` object to be played.
@@ -176,21 +192,25 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
- :ref:`bool<class_bool>` **stream_paused**
+----------+--------------------------+
| *Setter* | set_stream_paused(value) |
+----------+--------------------------+
| *Getter* | get_stream_paused() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | false |
+-----------+--------------------------+
| *Setter* | set_stream_paused(value) |
+-----------+--------------------------+
| *Getter* | get_stream_paused() |
+-----------+--------------------------+
.. _class_AudioStreamPlayer2D_property_volume_db:
- :ref:`float<class_float>` **volume_db**
+----------+----------------------+
| *Setter* | set_volume_db(value) |
+----------+----------------------+
| *Getter* | get_volume_db() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0.0 |
+-----------+----------------------+
| *Setter* | set_volume_db(value) |
+-----------+----------------------+
| *Getter* | get_volume_db() |
+-----------+----------------------+
Base volume without dampening.

304
classes/class_audiostreamplayer3d.rst
View File

@@ -19,45 +19,45 @@ Plays 3D sound in 3D space.
Properties
----------
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer3D_property_area_mask>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`attenuation_filter_db<class_AudioStreamPlayer3D_property_attenuation_filter_db>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` | :ref:`attenuation_model<class_AudioStreamPlayer3D_property_attenuation_model>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer3D_property_autoplay>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer3D_property_bus>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` | :ref:`doppler_tracking<class_AudioStreamPlayer3D_property_doppler_tracking>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`emission_angle_degrees<class_AudioStreamPlayer3D_property_emission_angle_degrees>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`emission_angle_enabled<class_AudioStreamPlayer3D_property_emission_angle_enabled>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`max_db<class_AudioStreamPlayer3D_property_max_db>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` | :ref:`out_of_range_mode<class_AudioStreamPlayer3D_property_out_of_range_mode>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer3D_property_pitch_scale>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer3D_property_playing>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer3D_property_stream>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer3D_property_stream_paused>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`unit_db<class_AudioStreamPlayer3D_property_unit_db>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`unit_size<class_AudioStreamPlayer3D_property_unit_size>` |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
| :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>` | null |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+
| :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
-------
@@ -151,11 +151,13 @@ Property Descriptions
- :ref:`int<class_int>` **area_mask**
+----------+----------------------+
| *Setter* | set_area_mask(value) |
+----------+----------------------+
| *Getter* | get_area_mask() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 1 |
+-----------+----------------------+
| *Setter* | set_area_mask(value) |
+-----------+----------------------+
| *Getter* | get_area_mask() |
+-----------+----------------------+
Areas in which this sound plays.
@@ -163,11 +165,13 @@ Areas in which this sound plays.
- :ref:`float<class_float>` **attenuation_filter_cutoff_hz**
+----------+-----------------------------------------+
| *Setter* | set_attenuation_filter_cutoff_hz(value) |
+----------+-----------------------------------------+
| *Getter* | get_attenuation_filter_cutoff_hz() |
+----------+-----------------------------------------+
+-----------+-----------------------------------------+
| *Default* | 5000.0 |
+-----------+-----------------------------------------+
| *Setter* | set_attenuation_filter_cutoff_hz(value) |
+-----------+-----------------------------------------+
| *Getter* | get_attenuation_filter_cutoff_hz() |
+-----------+-----------------------------------------+
Dampens audio above this frequency, in Hz.
@@ -175,11 +179,13 @@ Dampens audio above this frequency, in Hz.
- :ref:`float<class_float>` **attenuation_filter_db**
+----------+----------------------------------+
| *Setter* | set_attenuation_filter_db(value) |
+----------+----------------------------------+
| *Getter* | get_attenuation_filter_db() |
+----------+----------------------------------+
+-----------+----------------------------------+
| *Default* | -24.0 |
+-----------+----------------------------------+
| *Setter* | set_attenuation_filter_db(value) |
+-----------+----------------------------------+
| *Getter* | get_attenuation_filter_db() |
+-----------+----------------------------------+
Amount how much the filter affects the loudness, in dB.
@@ -187,11 +193,13 @@ Amount how much the filter affects the loudness, in dB.
- :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` **attenuation_model**
+----------+------------------------------+
| *Setter* | set_attenuation_model(value) |
+----------+------------------------------+
| *Getter* | get_attenuation_model() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | 0 |
+-----------+------------------------------+
| *Setter* | set_attenuation_model(value) |
+-----------+------------------------------+
| *Getter* | get_attenuation_model() |
+-----------+------------------------------+
Decides if audio should get quieter with distance linearly, quadratically, logarithmically, or not be affected by distance, effectively disabling attenuation.
@@ -199,23 +207,27 @@ Decides if audio should get quieter with distance linearly, quadratically, logar
- :ref:`bool<class_bool>` **autoplay**
+----------+-----------------------+
| *Setter* | set_autoplay(value) |
+----------+-----------------------+
| *Getter* | is_autoplay_enabled() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | false |
+-----------+-----------------------+
| *Setter* | set_autoplay(value) |
+-----------+-----------------------+
| *Getter* | is_autoplay_enabled() |
+-----------+-----------------------+
If ``true``, audio plays when added to scene tree. Default value: ``false``.
If ``true``, audio plays when added to scene tree.
.. _class_AudioStreamPlayer3D_property_bus:
- :ref:`String<class_String>` **bus**
+----------+----------------+
| *Setter* | set_bus(value) |
+----------+----------------+
| *Getter* | get_bus() |
+----------+----------------+
+-----------+----------------+
| *Default* | "Master" |
+-----------+----------------+
| *Setter* | set_bus(value) |
+-----------+----------------+
| *Getter* | get_bus() |
+-----------+----------------+
Bus on which this audio is playing.
@@ -223,11 +235,13 @@ Bus on which this audio is playing.
- :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` **doppler_tracking**
+----------+-----------------------------+
| *Setter* | set_doppler_tracking(value) |
+----------+-----------------------------+
| *Getter* | get_doppler_tracking() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | 0 |
+-----------+-----------------------------+
| *Setter* | set_doppler_tracking(value) |
+-----------+-----------------------------+
| *Getter* | get_doppler_tracking() |
+-----------+-----------------------------+
Decides in which step the Doppler effect should be calculated.
@@ -235,11 +249,13 @@ Decides in which step the Doppler effect should be calculated.
- :ref:`float<class_float>` **emission_angle_degrees**
+----------+---------------------------+
| *Setter* | set_emission_angle(value) |
+----------+---------------------------+
| *Getter* | get_emission_angle() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 45.0 |
+-----------+---------------------------+
| *Setter* | set_emission_angle(value) |
+-----------+---------------------------+
| *Getter* | get_emission_angle() |
+-----------+---------------------------+
The angle in which the audio reaches cameras undampened.
@@ -247,11 +263,13 @@ The angle in which the audio reaches cameras undampened.
- :ref:`bool<class_bool>` **emission_angle_enabled**
+----------+-----------------------------------+
| *Setter* | set_emission_angle_enabled(value) |
+----------+-----------------------------------+
| *Getter* | is_emission_angle_enabled() |
+----------+-----------------------------------+
+-----------+-----------------------------------+
| *Default* | false |
+-----------+-----------------------------------+
| *Setter* | set_emission_angle_enabled(value) |
+-----------+-----------------------------------+
| *Getter* | is_emission_angle_enabled() |
+-----------+-----------------------------------+
If ``true``, the audio should be dampened according to the direction of the sound.
@@ -259,11 +277,13 @@ If ``true``, the audio should be dampened according to the direction of the soun
- :ref:`float<class_float>` **emission_angle_filter_attenuation_db**
+----------+-------------------------------------------------+
| *Setter* | set_emission_angle_filter_attenuation_db(value) |
+----------+-------------------------------------------------+
| *Getter* | get_emission_angle_filter_attenuation_db() |
+----------+-------------------------------------------------+
+-----------+-------------------------------------------------+
| *Default* | -12.0 |
+-----------+-------------------------------------------------+
| *Setter* | set_emission_angle_filter_attenuation_db(value) |
+-----------+-------------------------------------------------+
| *Getter* | get_emission_angle_filter_attenuation_db() |
+-----------+-------------------------------------------------+
Dampens audio if camera is outside of :ref:`emission_angle_degrees<class_AudioStreamPlayer3D_property_emission_angle_degrees>` and :ref:`emission_angle_enabled<class_AudioStreamPlayer3D_property_emission_angle_enabled>` is set by this factor, in dB.
@@ -271,11 +291,13 @@ Dampens audio if camera is outside of :ref:`emission_angle_degrees<class_AudioSt
- :ref:`float<class_float>` **max_db**
+----------+-------------------+
| *Setter* | set_max_db(value) |
+----------+-------------------+
| *Getter* | get_max_db() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 3.0 |
+-----------+-------------------+
| *Setter* | set_max_db(value) |
+-----------+-------------------+
| *Getter* | get_max_db() |
+-----------+-------------------+
Sets the absolute maximum of the soundlevel, in dB.
@@ -283,11 +305,13 @@ Sets the absolute maximum of the soundlevel, in dB.
- :ref:`float<class_float>` **max_distance**
+----------+-------------------------+
| *Setter* | set_max_distance(value) |
+----------+-------------------------+
| *Getter* | get_max_distance() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0.0 |
+-----------+-------------------------+
| *Setter* | set_max_distance(value) |
+-----------+-------------------------+
| *Getter* | get_max_distance() |
+-----------+-------------------------+
Sets the distance from which the :ref:`out_of_range_mode<class_AudioStreamPlayer3D_property_out_of_range_mode>` takes effect. Has no effect if set to 0.
@@ -295,11 +319,13 @@ Sets the distance from which the :ref:`out_of_range_mode<class_AudioStreamPlayer
- :ref:`OutOfRangeMode<enum_AudioStreamPlayer3D_OutOfRangeMode>` **out_of_range_mode**
+----------+------------------------------+
| *Setter* | set_out_of_range_mode(value) |
+----------+------------------------------+
| *Getter* | get_out_of_range_mode() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | 0 |
+-----------+------------------------------+
| *Setter* | set_out_of_range_mode(value) |
+-----------+------------------------------+
| *Getter* | get_out_of_range_mode() |
+-----------+------------------------------+
Decides if audio should pause when source is outside of :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` range.
@@ -307,11 +333,13 @@ Decides if audio should pause when source is outside of :ref:`max_distance<class
- :ref:`float<class_float>` **pitch_scale**
+----------+------------------------+
| *Setter* | set_pitch_scale(value) |
+----------+------------------------+
| *Getter* | get_pitch_scale() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1.0 |
+-----------+------------------------+
| *Setter* | set_pitch_scale(value) |
+-----------+------------------------+
| *Getter* | get_pitch_scale() |
+-----------+------------------------+
Changes the pitch and the tempo of the audio.
@@ -319,9 +347,11 @@ Changes the pitch and the tempo of the audio.
- :ref:`bool<class_bool>` **playing**
+----------+--------------+
| *Getter* | is_playing() |
+----------+--------------+
+-----------+--------------+
| *Default* | false |
+-----------+--------------+
| *Getter* | is_playing() |
+-----------+--------------+
If ``true``, audio is playing.
@@ -329,11 +359,13 @@ If ``true``, audio is playing.
- :ref:`AudioStream<class_AudioStream>` **stream**
+----------+-------------------+
| *Setter* | set_stream(value) |
+----------+-------------------+
| *Getter* | get_stream() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | null |
+-----------+-------------------+
| *Setter* | set_stream(value) |
+-----------+-------------------+
| *Getter* | get_stream() |
+-----------+-------------------+
The :ref:`AudioStream<class_AudioStream>` object to be played.
@@ -341,21 +373,25 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
- :ref:`bool<class_bool>` **stream_paused**
+----------+--------------------------+
| *Setter* | set_stream_paused(value) |
+----------+--------------------------+
| *Getter* | get_stream_paused() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | false |
+-----------+--------------------------+
| *Setter* | set_stream_paused(value) |
+-----------+--------------------------+
| *Getter* | get_stream_paused() |
+-----------+--------------------------+
.. _class_AudioStreamPlayer3D_property_unit_db:
- :ref:`float<class_float>` **unit_db**
+----------+--------------------+
| *Setter* | set_unit_db(value) |
+----------+--------------------+
| *Getter* | get_unit_db() |
+----------+--------------------+
+-----------+--------------------+
| *Default* | 0.0 |
+-----------+--------------------+
| *Setter* | set_unit_db(value) |
+-----------+--------------------+
| *Getter* | get_unit_db() |
+-----------+--------------------+
Base sound level unaffected by dampening, in dB.
@@ -363,11 +399,13 @@ Base sound level unaffected by dampening, in dB.
- :ref:`float<class_float>` **unit_size**
+----------+----------------------+
| *Setter* | set_unit_size(value) |
+----------+----------------------+
| *Getter* | get_unit_size() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 1.0 |
+-----------+----------------------+
| *Setter* | set_unit_size(value) |
+-----------+----------------------+
| *Getter* | get_unit_size() |
+-----------+----------------------+
Factor for the attenuation effect.

34
classes/class_audiostreamrandompitch.rst
View File

@@ -19,11 +19,11 @@ Plays audio with random pitch shifting.
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>` |
+---------------------------------------+-------------------------------------------------------------------------+
+---------------------------------------+-------------------------------------------------------------------------+------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_property_audio_stream>` | null |
+---------------------------------------+-------------------------------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_property_random_pitch>` | 1.1 |
+---------------------------------------+-------------------------------------------------------------------------+------+
Description
-----------
@@ -37,11 +37,13 @@ Property Descriptions
- :ref:`AudioStream<class_AudioStream>` **audio_stream**
+----------+-------------------------+
| *Setter* | set_audio_stream(value) |
+----------+-------------------------+
| *Getter* | get_audio_stream() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | null |
+-----------+-------------------------+
| *Setter* | set_audio_stream(value) |
+-----------+-------------------------+
| *Getter* | get_audio_stream() |
+-----------+-------------------------+
The current :ref:`AudioStream<class_AudioStream>`.
@@ -49,11 +51,13 @@ The current :ref:`AudioStream<class_AudioStream>`.
- :ref:`float<class_float>` **random_pitch**
+----------+-------------------------+
| *Setter* | set_random_pitch(value) |
+----------+-------------------------+
| *Getter* | get_random_pitch() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 1.1 |
+-----------+-------------------------+
| *Setter* | set_random_pitch(value) |
+-----------+-------------------------+
| *Getter* | get_random_pitch() |
+-----------+-------------------------+
The intensity of random pitch variation.

116
classes/class_audiostreamsample.rst
View File

@@ -19,21 +19,21 @@ Stores audio data loaded from WAV files.
Properties
----------
+--------------------------------------------------+----------------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamSample_property_data>` |
+--------------------------------------------------+----------------------------------------------------------------+
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioStreamSample_property_format>` |
+--------------------------------------------------+----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`loop_begin<class_AudioStreamSample_property_loop_begin>` |
+--------------------------------------------------+----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`loop_end<class_AudioStreamSample_property_loop_end>` |
+--------------------------------------------------+----------------------------------------------------------------+
| :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` | :ref:`loop_mode<class_AudioStreamSample_property_loop_mode>` |
+--------------------------------------------------+----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`mix_rate<class_AudioStreamSample_property_mix_rate>` |
+--------------------------------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`stereo<class_AudioStreamSample_property_stereo>` |
+--------------------------------------------------+----------------------------------------------------------------+
+--------------------------------------------------+----------------------------------------------------------------+-------------------+
| :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
-------
@@ -95,11 +95,13 @@ Property Descriptions
- :ref:`PoolByteArray<class_PoolByteArray>` **data**
+----------+-----------------+
| *Setter* | set_data(value) |
+----------+-----------------+
| *Getter* | get_data() |
+----------+-----------------+
+-----------+-------------------+
| *Default* | PoolByteArray( ) |
+-----------+-------------------+
| *Setter* | set_data(value) |
+-----------+-------------------+
| *Getter* | get_data() |
+-----------+-------------------+
Contains the audio data in bytes.
@@ -107,11 +109,13 @@ Contains the audio data in bytes.
- :ref:`Format<enum_AudioStreamSample_Format>` **format**
+----------+-------------------+
| *Setter* | set_format(value) |
+----------+-------------------+
| *Getter* | get_format() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 0 |
+-----------+-------------------+
| *Setter* | set_format(value) |
+-----------+-------------------+
| *Getter* | get_format() |
+-----------+-------------------+
Audio format. See ``FORMAT_*`` constants for values.
@@ -119,11 +123,13 @@ Audio format. See ``FORMAT_*`` constants for values.
- :ref:`int<class_int>` **loop_begin**
+----------+-----------------------+
| *Setter* | set_loop_begin(value) |
+----------+-----------------------+
| *Getter* | get_loop_begin() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 0 |
+-----------+-----------------------+
| *Setter* | set_loop_begin(value) |
+-----------+-----------------------+
| *Getter* | get_loop_begin() |
+-----------+-----------------------+
Loop start in bytes.
@@ -131,11 +137,13 @@ Loop start in bytes.
- :ref:`int<class_int>` **loop_end**
+----------+---------------------+
| *Setter* | set_loop_end(value) |
+----------+---------------------+
| *Getter* | get_loop_end() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0 |
+-----------+---------------------+
| *Setter* | set_loop_end(value) |
+-----------+---------------------+
| *Getter* | get_loop_end() |
+-----------+---------------------+
Loop end in bytes.
@@ -143,11 +151,13 @@ Loop end in bytes.
- :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` **loop_mode**
+----------+----------------------+
| *Setter* | set_loop_mode(value) |
+----------+----------------------+
| *Getter* | get_loop_mode() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0 |
+-----------+----------------------+
| *Setter* | set_loop_mode(value) |
+-----------+----------------------+
| *Getter* | get_loop_mode() |
+-----------+----------------------+
Loop mode. See ``LOOP_*`` constants for values.
@@ -155,11 +165,13 @@ Loop mode. See ``LOOP_*`` constants for values.
- :ref:`int<class_int>` **mix_rate**
+----------+---------------------+
| *Setter* | set_mix_rate(value) |
+----------+---------------------+
| *Getter* | get_mix_rate() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 44100 |
+-----------+---------------------+
| *Setter* | set_mix_rate(value) |
+-----------+---------------------+
| *Getter* | get_mix_rate() |
+-----------+---------------------+
The sample rate for mixing this audio.
@@ -167,13 +179,15 @@ The sample rate for mixing this audio.
- :ref:`bool<class_bool>` **stereo**
+----------+-------------------+
| *Setter* | set_stereo(value) |
+----------+-------------------+
| *Getter* | is_stereo() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | false |
+-----------+-------------------+
| *Setter* | set_stereo(value) |
+-----------+-------------------+
| *Getter* | is_stereo() |
+-----------+-------------------+
If ``true``, audio is stereo. Default value: ``false``.
If ``true``, audio is stereo.
Method Descriptions
-------------------

34
classes/class_backbuffercopy.rst
View File

@@ -19,11 +19,11 @@ Copies a region of the screen (or the whole screen) to a buffer so it can be acc
Properties
----------
+-----------------------------------------------+-----------------------------------------------------------+
| :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` | :ref:`copy_mode<class_BackBufferCopy_property_copy_mode>` |
+-----------------------------------------------+-----------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`rect<class_BackBufferCopy_property_rect>` |
+-----------------------------------------------+-----------------------------------------------------------+
+-----------------------------------------------+-----------------------------------------------------------+-------------------------------+
| :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
------------
@@ -56,11 +56,13 @@ Property Descriptions
- :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` **copy_mode**
+----------+----------------------+
| *Setter* | set_copy_mode(value) |
+----------+----------------------+
| *Getter* | get_copy_mode() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 1 |
+-----------+----------------------+
| *Setter* | set_copy_mode(value) |
+-----------+----------------------+
| *Getter* | get_copy_mode() |
+-----------+----------------------+
Buffer mode. See :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` constants.
@@ -68,11 +70,13 @@ Buffer mode. See :ref:`CopyMode<enum_BackBufferCopy_CopyMode>` constants.
- :ref:`Rect2<class_Rect2>` **rect**
+----------+-----------------+
| *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>`.

166
classes/class_bakedlightmap.rst
View File

@@ -19,27 +19,27 @@ Prerendered indirect light map for a scene.
Properties
----------
+----------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`bake_cell_size<class_BakedLightmap_property_bake_cell_size>` |
+----------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`bake_energy<class_BakedLightmap_property_bake_energy>` |
+----------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`bake_extents<class_BakedLightmap_property_bake_extents>` |
+----------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`bake_hdr<class_BakedLightmap_property_bake_hdr>` |
+----------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`BakeMode<enum_BakedLightmap_BakeMode>` | :ref:`bake_mode<class_BakedLightmap_property_bake_mode>` |
+----------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`bake_propagation<class_BakedLightmap_property_bake_propagation>` |
+----------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` | :ref:`bake_quality<class_BakedLightmap_property_bake_quality>` |
+----------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`capture_cell_size<class_BakedLightmap_property_capture_cell_size>` |
+----------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`image_path<class_BakedLightmap_property_image_path>` |
+----------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`BakedLightmapData<class_BakedLightmapData>` | :ref:`light_data<class_BakedLightmap_property_light_data>` |
+----------------------------------------------------+--------------------------------------------------------------------------+
+----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`bake_cell_size<class_BakedLightmap_property_bake_cell_size>` | 0.25 |
+----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+
| :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>` | null |
+----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+
Methods
-------
@@ -122,33 +122,39 @@ Property Descriptions
- :ref:`float<class_float>` **bake_cell_size**
+----------+---------------------------+
| *Setter* | set_bake_cell_size(value) |
+----------+---------------------------+
| *Getter* | get_bake_cell_size() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 0.25 |
+-----------+---------------------------+
| *Setter* | set_bake_cell_size(value) |
+-----------+---------------------------+
| *Getter* | get_bake_cell_size() |
+-----------+---------------------------+
Grid subdivision size for lightmapper calculation. Default value of ``0.25`` will work for most cases. Increase for better lighting on small details or if your scene is very large.
Grid subdivision size for lightmapper calculation. The default value will work for most cases. Increase for better lighting on small details or if your scene is very large.
.. _class_BakedLightmap_property_bake_energy:
- :ref:`float<class_float>` **bake_energy**
+----------+-------------------+
| *Setter* | set_energy(value) |
+----------+-------------------+
| *Getter* | get_energy() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1.0 |
+-----------+-------------------+
| *Setter* | set_energy(value) |
+-----------+-------------------+
| *Getter* | get_energy() |
+-----------+-------------------+
.. _class_BakedLightmap_property_bake_extents:
- :ref:`Vector3<class_Vector3>` **bake_extents**
+----------+--------------------+
| *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.
@@ -156,23 +162,27 @@ The size of the affected area.
- :ref:`bool<class_bool>` **bake_hdr**
+----------+----------------+
| *Setter* | set_hdr(value) |
+----------+----------------+
| *Getter* | is_hdr() |
+----------+----------------+
+-----------+----------------+
| *Default* | false |
+-----------+----------------+
| *Setter* | set_hdr(value) |
+-----------+----------------+
| *Getter* | is_hdr() |
+-----------+----------------+
If ``true``, the lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller file size. Default value: ``false``.
If ``true``, the lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller file size.
.. _class_BakedLightmap_property_bake_mode:
- :ref:`BakeMode<enum_BakedLightmap_BakeMode>` **bake_mode**
+----------+----------------------+
| *Setter* | set_bake_mode(value) |
+----------+----------------------+
| *Getter* | get_bake_mode() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0 |
+-----------+----------------------+
| *Setter* | set_bake_mode(value) |
+-----------+----------------------+
| *Getter* | get_bake_mode() |
+-----------+----------------------+
Lightmapping mode. See :ref:`BakeMode<enum_BakedLightmap_BakeMode>`.
@@ -180,21 +190,25 @@ Lightmapping mode. See :ref:`BakeMode<enum_BakedLightmap_BakeMode>`.
- :ref:`float<class_float>` **bake_propagation**
+----------+------------------------+
| *Setter* | set_propagation(value) |
+----------+------------------------+
| *Getter* | get_propagation() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1.0 |
+-----------+------------------------+
| *Setter* | set_propagation(value) |
+-----------+------------------------+
| *Getter* | get_propagation() |
+-----------+------------------------+
.. _class_BakedLightmap_property_bake_quality:
- :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>` **bake_quality**
+----------+-------------------------+
| *Setter* | set_bake_quality(value) |
+----------+-------------------------+
| *Getter* | get_bake_quality() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 1 |
+-----------+-------------------------+
| *Setter* | set_bake_quality(value) |
+-----------+-------------------------+
| *Getter* | get_bake_quality() |
+-----------+-------------------------+
Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality<enum_BakedLightmap_BakeQuality>`.
@@ -202,11 +216,13 @@ Three quality modes are available. Higher quality requires more rendering time.
- :ref:`float<class_float>` **capture_cell_size**
+----------+------------------------------+
| *Setter* | set_capture_cell_size(value) |
+----------+------------------------------+
| *Getter* | get_capture_cell_size() |
+----------+------------------------------+
+-----------+------------------------------+
| *Default* | 0.5 |
+-----------+------------------------------+
| *Setter* | set_capture_cell_size(value) |
+-----------+------------------------------+
| *Getter* | get_capture_cell_size() |
+-----------+------------------------------+
Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size<class_BakedLightmap_property_bake_cell_size>`.
@@ -214,11 +230,13 @@ Grid size used for real-time capture information on dynamic objects. Cannot be l
- :ref:`String<class_String>` **image_path**
+----------+-----------------------+
| *Setter* | set_image_path(value) |
+----------+-----------------------+
| *Getter* | get_image_path() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | "." |
+-----------+-----------------------+
| *Setter* | set_image_path(value) |
+-----------+-----------------------+
| *Getter* | get_image_path() |
+-----------+-----------------------+
The location where lightmaps will be saved.
@@ -226,11 +244,13 @@ The location where lightmaps will be saved.
- :ref:`BakedLightmapData<class_BakedLightmapData>` **light_data**
+----------+-----------------------+
| *Setter* | set_light_data(value) |
+----------+-----------------------+
| *Getter* | get_light_data() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | null |
+-----------+-----------------------+
| *Setter* | set_light_data(value) |
+-----------+-----------------------+
| *Getter* | get_light_data() |
+-----------+-----------------------+
The calculated light data.

82
classes/class_bakedlightmapdata.rst
View File

@@ -19,17 +19,17 @@ Brief Description
Properties
----------
+-------------------------------------------+------------------------------------------------------------------------------------+
| :ref:`AABB<class_AABB>` | :ref:`bounds<class_BakedLightmapData_property_bounds>` |
+-------------------------------------------+------------------------------------------------------------------------------------+
| :ref:`Transform<class_Transform>` | :ref:`cell_space_transform<class_BakedLightmapData_property_cell_space_transform>` |
+-------------------------------------------+------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`cell_subdiv<class_BakedLightmapData_property_cell_subdiv>` |
+-------------------------------------------+------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`energy<class_BakedLightmapData_property_energy>` |
+-------------------------------------------+------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`octree<class_BakedLightmapData_property_octree>` |
+-------------------------------------------+------------------------------------------------------------------------------------+
+-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+
| :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
-------
@@ -53,51 +53,61 @@ Property Descriptions
- :ref:`AABB<class_AABB>` **bounds**
+----------+-------------------+
| *Setter* | set_bounds(value) |
+----------+-------------------+
| *Getter* | get_bounds() |
+----------+-------------------+
+-----------+--------------------------+
| *Default* | AABB( 0, 0, 0, 0, 0, 0 ) |
+-----------+--------------------------+
| *Setter* | set_bounds(value) |
+-----------+--------------------------+
| *Getter* | get_bounds() |
+-----------+--------------------------+
.. _class_BakedLightmapData_property_cell_space_transform:
- :ref:`Transform<class_Transform>` **cell_space_transform**
+----------+---------------------------------+
| *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() |
+-----------+-------------------------------------------------+
.. _class_BakedLightmapData_property_cell_subdiv:
- :ref:`int<class_int>` **cell_subdiv**
+----------+------------------------+
| *Setter* | set_cell_subdiv(value) |
+----------+------------------------+
| *Getter* | get_cell_subdiv() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1 |
+-----------+------------------------+
| *Setter* | set_cell_subdiv(value) |
+-----------+------------------------+
| *Getter* | get_cell_subdiv() |
+-----------+------------------------+
.. _class_BakedLightmapData_property_energy:
- :ref:`float<class_float>` **energy**
+----------+-------------------+
| *Setter* | set_energy(value) |
+----------+-------------------+
| *Getter* | get_energy() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1.0 |
+-----------+-------------------+
| *Setter* | set_energy(value) |
+-----------+-------------------+
| *Getter* | get_energy() |
+-----------+-------------------+
.. _class_BakedLightmapData_property_octree:
- :ref:`PoolByteArray<class_PoolByteArray>` **octree**
+----------+-------------------+
| *Setter* | set_octree(value) |
+----------+-------------------+
| *Getter* | get_octree() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | PoolByteArray( ) |
+-----------+-------------------+
| *Setter* | set_octree(value) |
+-----------+-------------------+
| *Getter* | get_octree() |
+-----------+-------------------+
Method Descriptions
-------------------

164
classes/class_basebutton.rst
View File

@@ -21,27 +21,27 @@ Base class for different kinds of buttons.
Properties
----------
+-----------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`ActionMode<enum_BaseButton_ActionMode>` | :ref:`action_mode<class_BaseButton_property_action_mode>` |
+-----------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`button_mask<class_BaseButton_property_button_mask>` |
+-----------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`disabled<class_BaseButton_property_disabled>` |
+-----------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`enabled_focus_mode<class_BaseButton_property_enabled_focus_mode>` |
+-----------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`ButtonGroup<class_ButtonGroup>` | :ref:`group<class_BaseButton_property_group>` |
+-----------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`keep_pressed_outside<class_BaseButton_property_keep_pressed_outside>` |
+-----------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`pressed<class_BaseButton_property_pressed>` |
+-----------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`ShortCut<class_ShortCut>` | :ref:`shortcut<class_BaseButton_property_shortcut>` |
+-----------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`shortcut_in_tooltip<class_BaseButton_property_shortcut_in_tooltip>` |
+-----------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` |
+-----------------------------------------------+-----------------------------------------------------------------------------+
+-----------------------------------------------+-----------------------------------------------------------------------------+-------+
| :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:`ButtonGroup<class_ButtonGroup>` | :ref:`group<class_BaseButton_property_group>` | null |
+-----------------------------------------------+-----------------------------------------------------------------------------+-------+
| :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>` | null |
+-----------------------------------------------+-----------------------------------------------------------------------------+-------+
| :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
-------
@@ -134,11 +134,13 @@ Property Descriptions
- :ref:`ActionMode<enum_BaseButton_ActionMode>` **action_mode**
+----------+------------------------+
| *Setter* | set_action_mode(value) |
+----------+------------------------+
| *Getter* | get_action_mode() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1 |
+-----------+------------------------+
| *Setter* | set_action_mode(value) |
+-----------+------------------------+
| *Getter* | get_action_mode() |
+-----------+------------------------+
Determines when the button is considered clicked, one of the ``ACTION_MODE_*`` constants.
@@ -146,11 +148,13 @@ Determines when the button is considered clicked, one of the ``ACTION_MODE_*`` c
- :ref:`int<class_int>` **button_mask**
+----------+------------------------+
| *Setter* | set_button_mask(value) |
+----------+------------------------+
| *Getter* | get_button_mask() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1 |
+-----------+------------------------+
| *Setter* | set_button_mask(value) |
+-----------+------------------------+
| *Getter* | get_button_mask() |
+-----------+------------------------+
Binary mask to choose which mouse buttons this button will respond to.
@@ -160,11 +164,13 @@ To allow both left-click and right-click, use ``BUTTON_MASK_LEFT | BUTTON_MASK_R
- :ref:`bool<class_bool>` **disabled**
+----------+---------------------+
| *Setter* | set_disabled(value) |
+----------+---------------------+
| *Getter* | is_disabled() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_disabled(value) |
+-----------+---------------------+
| *Getter* | is_disabled() |
+-----------+---------------------+
If ``true``, the button is in disabled state and can't be clicked or toggled.
@@ -172,11 +178,13 @@ If ``true``, the button is in disabled state and can't be clicked or toggled.
- :ref:`FocusMode<enum_Control_FocusMode>` **enabled_focus_mode**
+----------+-------------------------------+
| *Setter* | set_enabled_focus_mode(value) |
+----------+-------------------------------+
| *Getter* | get_enabled_focus_mode() |
+----------+-------------------------------+
+-----------+-------------------------------+
| *Default* | 2 |
+-----------+-------------------------------+
| *Setter* | set_enabled_focus_mode(value) |
+-----------+-------------------------------+
| *Getter* | get_enabled_focus_mode() |
+-----------+-------------------------------+
Focus access mode to use when switching between enabled/disabled (see :ref:`Control.focus_mode<class_Control_property_focus_mode>` and :ref:`disabled<class_BaseButton_property_disabled>`).
@@ -184,11 +192,13 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont
- :ref:`ButtonGroup<class_ButtonGroup>` **group**
+----------+-------------------------+
| *Setter* | set_button_group(value) |
+----------+-------------------------+
| *Getter* | get_button_group() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | null |
+-----------+-------------------------+
| *Setter* | set_button_group(value) |
+-----------+-------------------------+
| *Getter* | get_button_group() |
+-----------+-------------------------+
:ref:`ButtonGroup<class_ButtonGroup>` associated to the button.
@@ -196,23 +206,27 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont
- :ref:`bool<class_bool>` **keep_pressed_outside**
+----------+---------------------------------+
| *Setter* | set_keep_pressed_outside(value) |
+----------+---------------------------------+
| *Getter* | is_keep_pressed_outside() |
+----------+---------------------------------+
+-----------+---------------------------------+
| *Default* | false |
+-----------+---------------------------------+
| *Setter* | set_keep_pressed_outside(value) |
+-----------+---------------------------------+
| *Getter* | is_keep_pressed_outside() |
+-----------+---------------------------------+
If ``true``, the button stays pressed when moving the cursor outside the button while pressing it. Default value: ``false``.
If ``true``, the button stays pressed when moving the cursor outside the button while pressing it.
.. _class_BaseButton_property_pressed:
- :ref:`bool<class_bool>` **pressed**
+----------+--------------------+
| *Setter* | set_pressed(value) |
+----------+--------------------+
| *Getter* | is_pressed() |
+----------+--------------------+
+-----------+--------------------+
| *Default* | false |
+-----------+--------------------+
| *Setter* | set_pressed(value) |
+-----------+--------------------+
| *Getter* | is_pressed() |
+-----------+--------------------+
If ``true``, the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active).
@@ -220,11 +234,13 @@ If ``true``, the button's state is pressed. Means the button is pressed down or
- :ref:`ShortCut<class_ShortCut>` **shortcut**
+----------+---------------------+
| *Setter* | set_shortcut(value) |
+----------+---------------------+
| *Getter* | get_shortcut() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_shortcut(value) |
+-----------+---------------------+
| *Getter* | get_shortcut() |
+-----------+---------------------+
:ref:`ShortCut<class_ShortCut>` associated to the button.
@@ -232,11 +248,13 @@ If ``true``, the button's state is pressed. Means the button is pressed down or
- :ref:`bool<class_bool>` **shortcut_in_tooltip**
+----------+----------------------------------+
| *Setter* | set_shortcut_in_tooltip(value) |
+----------+----------------------------------+
| *Getter* | is_shortcut_in_tooltip_enabled() |
+----------+----------------------------------+
+-----------+----------------------------------+
| *Default* | true |
+-----------+----------------------------------+
| *Setter* | set_shortcut_in_tooltip(value) |
+-----------+----------------------------------+
| *Getter* | is_shortcut_in_tooltip_enabled() |
+-----------+----------------------------------+
If ``true``, the button will add information about its shortcut in the tooltip.
@@ -244,11 +262,13 @@ If ``true``, the button will add information about its shortcut in the tooltip.
- :ref:`bool<class_bool>` **toggle_mode**
+----------+------------------------+
| *Setter* | set_toggle_mode(value) |
+----------+------------------------+
| *Getter* | is_toggle_mode() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | false |
+-----------+------------------------+
| *Setter* | set_toggle_mode(value) |
+-----------+------------------------+
| *Getter* | is_toggle_mode() |
+-----------+------------------------+
If ``true``, the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.

26
classes/class_basis.rst
View File

@@ -17,13 +17,13 @@ Brief Description
Properties
----------
+-------------------------------+----------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`x<class_Basis_property_x>` |
+-------------------------------+----------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`y<class_Basis_property_y>` |
+-------------------------------+----------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`z<class_Basis_property_z>` |
+-------------------------------+----------------------------------+
+-------------------------------+----------------------------------+--------------------+
| :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
-------
@@ -91,18 +91,30 @@ Property Descriptions
- :ref:`Vector3<class_Vector3>` **x**
+-----------+--------------------+
| *Default* | Vector3( 1, 0, 0 ) |
+-----------+--------------------+
The basis matrix's X vector.
.. _class_Basis_property_y:
- :ref:`Vector3<class_Vector3>` **y**
+-----------+--------------------+
| *Default* | Vector3( 0, 1, 0 ) |
+-----------+--------------------+
The basis matrix's Y vector.
.. _class_Basis_property_z:
- :ref:`Vector3<class_Vector3>` **z**
+-----------+--------------------+
| *Default* | Vector3( 0, 0, 1 ) |
+-----------+--------------------+
The basis matrix's Z vector.
Method Descriptions

66
classes/class_bitmapfont.rst
View File

@@ -19,15 +19,15 @@ Renders text using ``*.fnt`` fonts.
Properties
----------
+-------------------------------------+-----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`ascent<class_BitmapFont_property_ascent>` |
+-------------------------------------+-----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`distance_field<class_BitmapFont_property_distance_field>` |
+-------------------------------------+-----------------------------------------------------------------+
| :ref:`BitmapFont<class_BitmapFont>` | :ref:`fallback<class_BitmapFont_property_fallback>` |
+-------------------------------------+-----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`height<class_BitmapFont_property_height>` |
+-------------------------------------+-----------------------------------------------------------------+
+-------------------------------------+-----------------------------------------------------------------+-------+
| :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>` | null |
+-------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`height<class_BitmapFont_property_height>` | 1.0 |
+-------------------------------------+-----------------------------------------------------------------+-------+
Methods
-------
@@ -64,11 +64,13 @@ Property Descriptions
- :ref:`float<class_float>` **ascent**
+----------+-------------------+
| *Setter* | set_ascent(value) |
+----------+-------------------+
| *Getter* | get_ascent() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 0.0 |
+-----------+-------------------+
| *Setter* | set_ascent(value) |
+-----------+-------------------+
| *Getter* | get_ascent() |
+-----------+-------------------+
Ascent (number of pixels above the baseline).
@@ -76,11 +78,13 @@ Ascent (number of pixels above the baseline).
- :ref:`bool<class_bool>` **distance_field**
+----------+--------------------------------+
| *Setter* | set_distance_field_hint(value) |
+----------+--------------------------------+
| *Getter* | is_distance_field_hint() |
+----------+--------------------------------+
+-----------+--------------------------------+
| *Default* | false |
+-----------+--------------------------------+
| *Setter* | set_distance_field_hint(value) |
+-----------+--------------------------------+
| *Getter* | is_distance_field_hint() |
+-----------+--------------------------------+
If ``true``, distance field hint is enabled.
@@ -88,11 +92,13 @@ If ``true``, distance field hint is enabled.
- :ref:`BitmapFont<class_BitmapFont>` **fallback**
+----------+---------------------+
| *Setter* | set_fallback(value) |
+----------+---------------------+
| *Getter* | get_fallback() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_fallback(value) |
+-----------+---------------------+
| *Getter* | get_fallback() |
+-----------+---------------------+
The fallback font.
@@ -100,11 +106,13 @@ The fallback font.
- :ref:`float<class_float>` **height**
+----------+-------------------+
| *Setter* | set_height(value) |
+----------+-------------------+
| *Getter* | get_height() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1.0 |
+-----------+-------------------+
| *Setter* | set_height(value) |
+-----------+-------------------+
| *Getter* | get_height() |
+-----------+-------------------+
Total font height (ascent plus descent) in pixels.

34
classes/class_bone2d.rst
View File

@@ -19,11 +19,11 @@ Joint used with :ref:`Skeleton2D<class_Skeleton2D>` to control and animate other
Properties
----------
+---------------------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`default_length<class_Bone2D_property_default_length>` |
+---------------------------------------+-------------------------------------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`rest<class_Bone2D_property_rest>` |
+---------------------------------------+-------------------------------------------------------------+
+---------------------------------------+-------------------------------------------------------------+---------------------------------+
| :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
-------
@@ -54,11 +54,13 @@ Property Descriptions
- :ref:`float<class_float>` **default_length**
+----------+---------------------------+
| *Setter* | set_default_length(value) |
+----------+---------------------------+
| *Getter* | get_default_length() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 16.0 |
+-----------+---------------------------+
| *Setter* | set_default_length(value) |
+-----------+---------------------------+
| *Getter* | get_default_length() |
+-----------+---------------------------+
Length of the bone's representation drawn in the editor's viewport in pixels.
@@ -66,11 +68,13 @@ Length of the bone's representation drawn in the editor's viewport in pixels.
- :ref:`Transform2D<class_Transform2D>` **rest**
+----------+-----------------+
| *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>`.

18
classes/class_boneattachment.rst
View File

@@ -19,9 +19,9 @@ A node that will attach to a bone.
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>` | "" |
+-----------------------------+-----------------------------------------------------------+----+
Description
-----------
@@ -35,11 +35,13 @@ Property Descriptions
- :ref:`String<class_String>` **bone_name**
+----------+----------------------+
| *Setter* | set_bone_name(value) |
+----------+----------------------+
| *Getter* | get_bone_name() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | "" |
+-----------+----------------------+
| *Setter* | set_bone_name(value) |
+-----------+----------------------+
| *Getter* | get_bone_name() |
+-----------+----------------------+
The name of the attached bone.

18
classes/class_boxcontainer.rst
View File

@@ -21,9 +21,9 @@ Base class for box containers.
Properties
----------
+-----------------------------------------------+---------------------------------------------------------+
| :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_property_alignment>` |
+-----------------------------------------------+---------------------------------------------------------+
+-----------------------------------------------+---------------------------------------------------------+---+
| :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_property_alignment>` | 0 |
+-----------------------------------------------+---------------------------------------------------------+---+
Methods
-------
@@ -63,11 +63,13 @@ Property Descriptions
- :ref:`AlignMode<enum_BoxContainer_AlignMode>` **alignment**
+----------+----------------------+
| *Setter* | set_alignment(value) |
+----------+----------------------+
| *Getter* | get_alignment() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0 |
+-----------+----------------------+
| *Setter* | set_alignment(value) |
+-----------+----------------------+
| *Getter* | get_alignment() |
+-----------+----------------------+
The alignment of the container's children (must be one of :ref:`ALIGN_BEGIN<class_BoxContainer_constant_ALIGN_BEGIN>`, :ref:`ALIGN_CENTER<class_BoxContainer_constant_ALIGN_CENTER>` or :ref:`ALIGN_END<class_BoxContainer_constant_ALIGN_END>`).

18
classes/class_boxshape.rst
View File

@@ -19,9 +19,9 @@ Box shape resource.
Properties
----------
+-------------------------------+-------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`extents<class_BoxShape_property_extents>` |
+-------------------------------+-------------------------------------------------+
+-------------------------------+-------------------------------------------------+--------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`extents<class_BoxShape_property_extents>` | Vector3( 1, 1, 1 ) |
+-------------------------------+-------------------------------------------------+--------------------+
Description
-----------
@@ -35,11 +35,13 @@ Property Descriptions
- :ref:`Vector3<class_Vector3>` **extents**
+----------+--------------------+
| *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.

128
classes/class_button.rst
View File

@@ -21,44 +21,44 @@ Standard themed Button.
Properties
----------
+-----------------------------------------+---------------------------------------------------+
| :ref:`TextAlign<enum_Button_TextAlign>` | :ref:`align<class_Button_property_align>` |
+-----------------------------------------+---------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`clip_text<class_Button_property_clip_text>` |
+-----------------------------------------+---------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`flat<class_Button_property_flat>` |
+-----------------------------------------+---------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` |
+-----------------------------------------+---------------------------------------------------+
| :ref:`String<class_String>` | :ref:`text<class_Button_property_text>` |
+-----------------------------------------+---------------------------------------------------+
+-----------------------------------------+---------------------------------------------------+-------+
| :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:`flat<class_Button_property_flat>` | false |
+-----------------------------------------+---------------------------------------------------+-------+
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` | null |
+-----------------------------------------+---------------------------------------------------+-------+
| :ref:`String<class_String>` | :ref:`text<class_Button_property_text>` | "" |
+-----------------------------------------+---------------------------------------------------+-------+
Theme Properties
----------------
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | focus |
+---------------------------------+---------------------+
| :ref:`Font<class_Font>` | font |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>` | font_color |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>` | font_color_disabled |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>` | font_color_hover |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>` | font_color_pressed |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | hover |
+---------------------------------+---------------------+
| :ref:`int<class_int>` | hseparation |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | normal |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed |
+---------------------------------+---------------------+
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`int<class_int>` | hseparation | 2 |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+---------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+---------------------+------------------------------------------+
Enumerations
------------
@@ -91,11 +91,13 @@ Property Descriptions
- :ref:`TextAlign<enum_Button_TextAlign>` **align**
+----------+-----------------------+
| *Setter* | set_text_align(value) |
+----------+-----------------------+
| *Getter* | get_text_align() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 1 |
+-----------+-----------------------+
| *Setter* | set_text_align(value) |
+-----------+-----------------------+
| *Getter* | get_text_align() |
+-----------+-----------------------+
Text alignment policy for the button's text, use one of the ``ALIGN_*`` constants.
@@ -103,11 +105,13 @@ Text alignment policy for the button's text, use one of the ``ALIGN_*`` constant
- :ref:`bool<class_bool>` **clip_text**
+----------+----------------------+
| *Setter* | set_clip_text(value) |
+----------+----------------------+
| *Getter* | get_clip_text() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | false |
+-----------+----------------------+
| *Setter* | set_clip_text(value) |
+-----------+----------------------+
| *Getter* | get_clip_text() |
+-----------+----------------------+
When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default.
@@ -115,11 +119,13 @@ When this property is enabled, text that is too large to fit the button is clipp
- :ref:`bool<class_bool>` **flat**
+----------+-----------------+
| *Setter* | set_flat(value) |
+----------+-----------------+
| *Getter* | is_flat() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | false |
+-----------+-----------------+
| *Setter* | set_flat(value) |
+-----------+-----------------+
| *Getter* | is_flat() |
+-----------+-----------------+
Flat buttons don't display decoration.
@@ -127,11 +133,13 @@ Flat buttons don't display decoration.
- :ref:`Texture<class_Texture>` **icon**
+----------+------------------------+
| *Setter* | set_button_icon(value) |
+----------+------------------------+
| *Getter* | get_button_icon() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_button_icon(value) |
+-----------+------------------------+
| *Getter* | get_button_icon() |
+-----------+------------------------+
Button's icon, if text is present the icon will be placed before the text.
@@ -139,11 +147,13 @@ Button's icon, if text is present the icon will be placed before the text.
- :ref:`String<class_String>` **text**
+----------+-----------------+
| *Setter* | set_text(value) |
+----------+-----------------+
| *Getter* | get_text() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | "" |
+-----------+-----------------+
| *Setter* | set_text(value) |
+-----------+-----------------+
| *Getter* | get_text() |
+-----------+-----------------+
The button's text that will be displayed inside the button's area.

214
classes/class_camera.rst
View File

@@ -21,33 +21,33 @@ Camera node, displays from a point of view.
Properties
----------
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`cull_mask<class_Camera_property_cull_mask>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`current<class_Camera_property_current>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`DopplerTracking<enum_Camera_DopplerTracking>` | :ref:`doppler_tracking<class_Camera_property_doppler_tracking>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`Environment<class_Environment>` | :ref:`environment<class_Camera_property_environment>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`far<class_Camera_property_far>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`fov<class_Camera_property_fov>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`frustum_offset<class_Camera_property_frustum_offset>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`h_offset<class_Camera_property_h_offset>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`KeepAspect<enum_Camera_KeepAspect>` | :ref:`keep_aspect<class_Camera_property_keep_aspect>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`near<class_Camera_property_near>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`Projection<enum_Camera_Projection>` | :ref:`projection<class_Camera_property_projection>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`size<class_Camera_property_size>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`v_offset<class_Camera_property_v_offset>` |
+-----------------------------------------------------+-----------------------------------------------------------------+
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
| :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>` | null |
+-----------------------------------------------------+-----------------------------------------------------------------+-----------------+
| :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
-------
@@ -145,11 +145,13 @@ Property Descriptions
- :ref:`int<class_int>` **cull_mask**
+----------+----------------------+
| *Setter* | set_cull_mask(value) |
+----------+----------------------+
| *Getter* | get_cull_mask() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 1048575 |
+-----------+----------------------+
| *Setter* | set_cull_mask(value) |
+-----------+----------------------+
| *Getter* | get_cull_mask() |
+-----------+----------------------+
The culling mask that describes which 3D render layers are rendered by this camera.
@@ -157,35 +159,41 @@ The culling mask that describes which 3D render layers are rendered by this came
- :ref:`bool<class_bool>` **current**
+----------+--------------------+
| *Setter* | set_current(value) |
+----------+--------------------+
| *Getter* | is_current() |
+----------+--------------------+
+-----------+--------------------+
| *Default* | false |
+-----------+--------------------+
| *Setter* | set_current(value) |
+-----------+--------------------+
| *Getter* | is_current() |
+-----------+--------------------+
If ``true``, the ancestor :ref:`Viewport<class_Viewport>` is currently using this camera. Default value: ``false``.
If ``true``, the ancestor :ref:`Viewport<class_Viewport>` is currently using this camera.
.. _class_Camera_property_doppler_tracking:
- :ref:`DopplerTracking<enum_Camera_DopplerTracking>` **doppler_tracking**
+----------+-----------------------------+
| *Setter* | set_doppler_tracking(value) |
+----------+-----------------------------+
| *Getter* | get_doppler_tracking() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | 0 |
+-----------+-----------------------------+
| *Setter* | set_doppler_tracking(value) |
+-----------+-----------------------------+
| *Getter* | get_doppler_tracking() |
+-----------+-----------------------------+
If not :ref:`DOPPLER_TRACKING_DISABLED<class_Camera_constant_DOPPLER_TRACKING_DISABLED>`, this camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. See :ref:`DopplerTracking<enum_Camera_DopplerTracking>` for possible values. Default value: :ref:`DOPPLER_TRACKING_DISABLED<class_Camera_constant_DOPPLER_TRACKING_DISABLED>`.
If not :ref:`DOPPLER_TRACKING_DISABLED<class_Camera_constant_DOPPLER_TRACKING_DISABLED>`, this camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. See :ref:`DopplerTracking<enum_Camera_DopplerTracking>` for possible values.
.. _class_Camera_property_environment:
- :ref:`Environment<class_Environment>` **environment**
+----------+------------------------+
| *Setter* | set_environment(value) |
+----------+------------------------+
| *Getter* | get_environment() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | null |
+-----------+------------------------+
| *Setter* | set_environment(value) |
+-----------+------------------------+
| *Getter* | get_environment() |
+-----------+------------------------+
The :ref:`Environment<class_Environment>` to use for this camera.
@@ -193,11 +201,13 @@ The :ref:`Environment<class_Environment>` to use for this camera.
- :ref:`float<class_float>` **far**
+----------+-----------------+
| *Setter* | set_zfar(value) |
+----------+-----------------+
| *Getter* | get_zfar() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | 100.0 |
+-----------+-----------------+
| *Setter* | set_zfar(value) |
+-----------+-----------------+
| *Getter* | get_zfar() |
+-----------+-----------------+
The distance to the far culling boundary for this camera relative to its local Z axis.
@@ -205,11 +215,13 @@ The distance to the far culling boundary for this camera relative to its local Z
- :ref:`float<class_float>` **fov**
+----------+----------------+
| *Setter* | set_fov(value) |
+----------+----------------+
| *Getter* | get_fov() |
+----------+----------------+
+-----------+----------------+
| *Default* | 70.0 |
+-----------+----------------+
| *Setter* | set_fov(value) |
+-----------+----------------+
| *Getter* | get_fov() |
+-----------+----------------+
The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect<class_Camera_property_keep_aspect>` locks one axis, ``fov`` sets the other axis' field of view angle.
@@ -217,21 +229,25 @@ The camera's field of view angle (in degrees). Only applicable in perspective mo
- :ref:`Vector2<class_Vector2>` **frustum_offset**
+----------+---------------------------+
| *Setter* | set_frustum_offset(value) |
+----------+---------------------------+
| *Getter* | get_frustum_offset() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+---------------------------+
| *Setter* | set_frustum_offset(value) |
+-----------+---------------------------+
| *Getter* | get_frustum_offset() |
+-----------+---------------------------+
.. _class_Camera_property_h_offset:
- :ref:`float<class_float>` **h_offset**
+----------+---------------------+
| *Setter* | set_h_offset(value) |
+----------+---------------------+
| *Getter* | get_h_offset() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0.0 |
+-----------+---------------------+
| *Setter* | set_h_offset(value) |
+-----------+---------------------+
| *Getter* | get_h_offset() |
+-----------+---------------------+
The horizontal (X) offset of the camera viewport.
@@ -239,11 +255,13 @@ The horizontal (X) offset of the camera viewport.
- :ref:`KeepAspect<enum_Camera_KeepAspect>` **keep_aspect**
+----------+-----------------------------+
| *Setter* | set_keep_aspect_mode(value) |
+----------+-----------------------------+
| *Getter* | get_keep_aspect_mode() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | 1 |
+-----------+-----------------------------+
| *Setter* | set_keep_aspect_mode(value) |
+-----------+-----------------------------+
| *Getter* | get_keep_aspect_mode() |
+-----------+-----------------------------+
The axis to lock during :ref:`fov<class_Camera_property_fov>`/:ref:`size<class_Camera_property_size>` adjustments. Can be either :ref:`KEEP_WIDTH<class_Camera_constant_KEEP_WIDTH>` or :ref:`KEEP_HEIGHT<class_Camera_constant_KEEP_HEIGHT>`.
@@ -251,11 +269,13 @@ The axis to lock during :ref:`fov<class_Camera_property_fov>`/:ref:`size<class_C
- :ref:`float<class_float>` **near**
+----------+------------------+
| *Setter* | set_znear(value) |
+----------+------------------+
| *Getter* | get_znear() |
+----------+------------------+
+-----------+------------------+
| *Default* | 0.05 |
+-----------+------------------+
| *Setter* | set_znear(value) |
+-----------+------------------+
| *Getter* | get_znear() |
+-----------+------------------+
The distance to the near culling boundary for this camera relative to its local Z axis.
@@ -263,11 +283,13 @@ The distance to the near culling boundary for this camera relative to its local
- :ref:`Projection<enum_Camera_Projection>` **projection**
+----------+-----------------------+
| *Setter* | set_projection(value) |
+----------+-----------------------+
| *Getter* | get_projection() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 0 |
+-----------+-----------------------+
| *Setter* | set_projection(value) |
+-----------+-----------------------+
| *Getter* | get_projection() |
+-----------+-----------------------+
The camera's projection mode. In :ref:`PROJECTION_PERSPECTIVE<class_Camera_constant_PROJECTION_PERSPECTIVE>` mode, objects' Z distance from the camera's local space scales their perceived size.
@@ -275,11 +297,13 @@ The camera's projection mode. In :ref:`PROJECTION_PERSPECTIVE<class_Camera_const
- :ref:`float<class_float>` **size**
+----------+-----------------+
| *Setter* | set_size(value) |
+----------+-----------------+
| *Getter* | get_size() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | 1.0 |
+-----------+-----------------+
| *Setter* | set_size(value) |
+-----------+-----------------+
| *Getter* | get_size() |
+-----------+-----------------+
The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since :ref:`keep_aspect<class_Camera_property_keep_aspect>` locks on axis, ``size`` sets the other axis' size length.
@@ -287,11 +311,13 @@ The camera's size measured as 1/2 the width or height. Only applicable in orthog
- :ref:`float<class_float>` **v_offset**
+----------+---------------------+
| *Setter* | set_v_offset(value) |
+----------+---------------------+
| *Getter* | get_v_offset() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0.0 |
+-----------+---------------------+
| *Setter* | set_v_offset(value) |
+-----------+---------------------+
| *Getter* | get_v_offset() |
+-----------+---------------------+
The vertical (Y) offset of the camera viewport.

406
classes/class_camera2d.rst
View File

@@ -19,57 +19,57 @@ Camera node for 2D scenes.
Properties
----------
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`AnchorMode<enum_Camera2D_AnchorMode>` | :ref:`anchor_mode<class_Camera2D_property_anchor_mode>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`current<class_Camera2D_property_current>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_Camera2D_property_custom_viewport>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_bottom<class_Camera2D_property_drag_margin_bottom>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`drag_margin_h_enabled<class_Camera2D_property_drag_margin_h_enabled>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_left<class_Camera2D_property_drag_margin_left>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_right<class_Camera2D_property_drag_margin_right>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_top<class_Camera2D_property_drag_margin_top>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`drag_margin_v_enabled<class_Camera2D_property_drag_margin_v_enabled>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`editor_draw_drag_margin<class_Camera2D_property_editor_draw_drag_margin>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`editor_draw_limits<class_Camera2D_property_editor_draw_limits>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`editor_draw_screen<class_Camera2D_property_editor_draw_screen>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_bottom<class_Camera2D_property_limit_bottom>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_left<class_Camera2D_property_limit_left>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_right<class_Camera2D_property_limit_right>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`limit_smoothed<class_Camera2D_property_limit_smoothed>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_top<class_Camera2D_property_limit_top>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_Camera2D_property_offset>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`offset_h<class_Camera2D_property_offset_h>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`offset_v<class_Camera2D_property_offset_v>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` | :ref:`process_mode<class_Camera2D_property_process_mode>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`rotating<class_Camera2D_property_rotating>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`smoothing_enabled<class_Camera2D_property_smoothing_enabled>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`smoothing_speed<class_Camera2D_property_smoothing_speed>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`zoom<class_Camera2D_property_zoom>` |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
| :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>` | true |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
| :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>` | true |
+---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+
| :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
-------
@@ -131,11 +131,13 @@ Property Descriptions
- :ref:`AnchorMode<enum_Camera2D_AnchorMode>` **anchor_mode**
+----------+------------------------+
| *Setter* | set_anchor_mode(value) |
+----------+------------------------+
| *Getter* | get_anchor_mode() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 1 |
+-----------+------------------------+
| *Setter* | set_anchor_mode(value) |
+-----------+------------------------+
| *Getter* | get_anchor_mode() |
+-----------+------------------------+
The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants.
@@ -143,9 +145,11 @@ The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants.
- :ref:`bool<class_bool>` **current**
+----------+--------------+
| *Getter* | is_current() |
+----------+--------------+
+-----------+--------------+
| *Default* | false |
+-----------+--------------+
| *Getter* | is_current() |
+-----------+--------------+
If ``true``, the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one.
@@ -165,11 +169,13 @@ The custom :ref:`Viewport<class_Viewport>` node attached to the ``Camera2D``. If
- :ref:`float<class_float>` **drag_margin_bottom**
+----------+------------------------+
| *Setter* | set_drag_margin(value) |
+----------+------------------------+
| *Getter* | get_drag_margin() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 0.2 |
+-----------+------------------------+
| *Setter* | set_drag_margin(value) |
+-----------+------------------------+
| *Getter* | get_drag_margin() |
+-----------+------------------------+
Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
@@ -177,23 +183,27 @@ Bottom margin needed to drag the camera. A value of ``1`` makes the camera move
- :ref:`bool<class_bool>` **drag_margin_h_enabled**
+----------+---------------------------+
| *Setter* | set_h_drag_enabled(value) |
+----------+---------------------------+
| *Getter* | is_h_drag_enabled() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | true |
+-----------+---------------------------+
| *Setter* | set_h_drag_enabled(value) |
+-----------+---------------------------+
| *Getter* | is_h_drag_enabled() |
+-----------+---------------------------+
If ``true``, the camera only moves when reaching the horizontal drag margins. If ``false``, the camera moves horizontally regardless of margins. Default value: ``true``.
If ``true``, the camera only moves when reaching the horizontal drag margins. If ``false``, the camera moves horizontally regardless of margins.
.. _class_Camera2D_property_drag_margin_left:
- :ref:`float<class_float>` **drag_margin_left**
+----------+------------------------+
| *Setter* | set_drag_margin(value) |
+----------+------------------------+
| *Getter* | get_drag_margin() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 0.2 |
+-----------+------------------------+
| *Setter* | set_drag_margin(value) |
+-----------+------------------------+
| *Getter* | get_drag_margin() |
+-----------+------------------------+
Left margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
@@ -201,11 +211,13 @@ Left margin needed to drag the camera. A value of ``1`` makes the camera move on
- :ref:`float<class_float>` **drag_margin_right**
+----------+------------------------+
| *Setter* | set_drag_margin(value) |
+----------+------------------------+
| *Getter* | get_drag_margin() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 0.2 |
+-----------+------------------------+
| *Setter* | set_drag_margin(value) |
+-----------+------------------------+
| *Getter* | get_drag_margin() |
+-----------+------------------------+
Right margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
@@ -213,11 +225,13 @@ Right margin needed to drag the camera. A value of ``1`` makes the camera move o
- :ref:`float<class_float>` **drag_margin_top**
+----------+------------------------+
| *Setter* | set_drag_margin(value) |
+----------+------------------------+
| *Getter* | get_drag_margin() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 0.2 |
+-----------+------------------------+
| *Setter* | set_drag_margin(value) |
+-----------+------------------------+
| *Getter* | get_drag_margin() |
+-----------+------------------------+
Top margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
@@ -225,59 +239,69 @@ Top margin needed to drag the camera. A value of ``1`` makes the camera move onl
- :ref:`bool<class_bool>` **drag_margin_v_enabled**
+----------+---------------------------+
| *Setter* | set_v_drag_enabled(value) |
+----------+---------------------------+
| *Getter* | is_v_drag_enabled() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | true |
+-----------+---------------------------+
| *Setter* | set_v_drag_enabled(value) |
+-----------+---------------------------+
| *Getter* | is_v_drag_enabled() |
+-----------+---------------------------+
If ``true``, the camera only moves when reaching the vertical drag margins. If ``false``, the camera moves vertically regardless of margins. Default value: ``true``.
If ``true``, the camera only moves when reaching the vertical drag margins. If ``false``, the camera moves vertically regardless of margins.
.. _class_Camera2D_property_editor_draw_drag_margin:
- :ref:`bool<class_bool>` **editor_draw_drag_margin**
+----------+-----------------------------------+
| *Setter* | set_margin_drawing_enabled(value) |
+----------+-----------------------------------+
| *Getter* | is_margin_drawing_enabled() |
+----------+-----------------------------------+
+-----------+-----------------------------------+
| *Default* | false |
+-----------+-----------------------------------+
| *Setter* | set_margin_drawing_enabled(value) |
+-----------+-----------------------------------+
| *Getter* | is_margin_drawing_enabled() |
+-----------+-----------------------------------+
If ``true``, draws the camera's drag margin rectangle in the editor. Default value: ``false``.
If ``true``, draws the camera's drag margin rectangle in the editor.
.. _class_Camera2D_property_editor_draw_limits:
- :ref:`bool<class_bool>` **editor_draw_limits**
+----------+----------------------------------+
| *Setter* | set_limit_drawing_enabled(value) |
+----------+----------------------------------+
| *Getter* | is_limit_drawing_enabled() |
+----------+----------------------------------+
+-----------+----------------------------------+
| *Default* | false |
+-----------+----------------------------------+
| *Setter* | set_limit_drawing_enabled(value) |
+-----------+----------------------------------+
| *Getter* | is_limit_drawing_enabled() |
+-----------+----------------------------------+
If ``true``, draws the camera's limits rectangle in the editor. Default value: ``true``.
If ``true``, draws the camera's limits rectangle in the editor.
.. _class_Camera2D_property_editor_draw_screen:
- :ref:`bool<class_bool>` **editor_draw_screen**
+----------+-----------------------------------+
| *Setter* | set_screen_drawing_enabled(value) |
+----------+-----------------------------------+
| *Getter* | is_screen_drawing_enabled() |
+----------+-----------------------------------+
+-----------+-----------------------------------+
| *Default* | true |
+-----------+-----------------------------------+
| *Setter* | set_screen_drawing_enabled(value) |
+-----------+-----------------------------------+
| *Getter* | is_screen_drawing_enabled() |
+-----------+-----------------------------------+
If ``true``, draws the camera's screen rectangle in the editor. Default value: ``false``.
If ``true``, draws the camera's screen rectangle in the editor.
.. _class_Camera2D_property_limit_bottom:
- :ref:`int<class_int>` **limit_bottom**
+----------+------------------+
| *Setter* | set_limit(value) |
+----------+------------------+
| *Getter* | get_limit() |
+----------+------------------+
+-----------+------------------+
| *Default* | 10000000 |
+-----------+------------------+
| *Setter* | set_limit(value) |
+-----------+------------------+
| *Getter* | get_limit() |
+-----------+------------------+
Bottom scroll limit in pixels. The camera stops moving when reaching this value.
@@ -285,11 +309,13 @@ Bottom scroll limit in pixels. The camera stops moving when reaching this value.
- :ref:`int<class_int>` **limit_left**
+----------+------------------+
| *Setter* | set_limit(value) |
+----------+------------------+
| *Getter* | get_limit() |
+----------+------------------+
+-----------+------------------+
| *Default* | -10000000 |
+-----------+------------------+
| *Setter* | set_limit(value) |
+-----------+------------------+
| *Getter* | get_limit() |
+-----------+------------------+
Left scroll limit in pixels. The camera stops moving when reaching this value.
@@ -297,11 +323,13 @@ Left scroll limit in pixels. The camera stops moving when reaching this value.
- :ref:`int<class_int>` **limit_right**
+----------+------------------+
| *Setter* | set_limit(value) |
+----------+------------------+
| *Getter* | get_limit() |
+----------+------------------+
+-----------+------------------+
| *Default* | 10000000 |
+-----------+------------------+
| *Setter* | set_limit(value) |
+-----------+------------------+
| *Getter* | get_limit() |
+-----------+------------------+
Right scroll limit in pixels. The camera stops moving when reaching this value.
@@ -309,23 +337,27 @@ Right scroll limit in pixels. The camera stops moving when reaching this value.
- :ref:`bool<class_bool>` **limit_smoothed**
+----------+------------------------------------+
| *Setter* | set_limit_smoothing_enabled(value) |
+----------+------------------------------------+
| *Getter* | is_limit_smoothing_enabled() |
+----------+------------------------------------+
+-----------+------------------------------------+
| *Default* | false |
+-----------+------------------------------------+
| *Setter* | set_limit_smoothing_enabled(value) |
+-----------+------------------------------------+
| *Getter* | is_limit_smoothing_enabled() |
+-----------+------------------------------------+
If ``true``, the camera smoothly stops when reaches its limits. Default value: ``false``.
If ``true``, the camera smoothly stops when reaches its limits.
.. _class_Camera2D_property_limit_top:
- :ref:`int<class_int>` **limit_top**
+----------+------------------+
| *Setter* | set_limit(value) |
+----------+------------------+
| *Getter* | get_limit() |
+----------+------------------+
+-----------+------------------+
| *Default* | -10000000 |
+-----------+------------------+
| *Setter* | set_limit(value) |
+-----------+------------------+
| *Getter* | get_limit() |
+-----------+------------------+
Top scroll limit in pixels. The camera stops moving when reaching this value.
@@ -333,11 +365,13 @@ Top scroll limit in pixels. The camera stops moving when reaching this value.
- :ref:`Vector2<class_Vector2>` **offset**
+----------+-------------------+
| *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.
@@ -345,69 +379,81 @@ The camera's offset, useful for looking around or camera shake animations.
- :ref:`float<class_float>` **offset_h**
+----------+---------------------+
| *Setter* | set_h_offset(value) |
+----------+---------------------+
| *Getter* | get_h_offset() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0.0 |
+-----------+---------------------+
| *Setter* | set_h_offset(value) |
+-----------+---------------------+
| *Getter* | get_h_offset() |
+-----------+---------------------+
The horizontal offset of the camera, relative to the drag margins. Default value: ``0``.
The horizontal offset of the camera, relative to the drag margins.
.. _class_Camera2D_property_offset_v:
- :ref:`float<class_float>` **offset_v**
+----------+---------------------+
| *Setter* | set_v_offset(value) |
+----------+---------------------+
| *Getter* | get_v_offset() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0.0 |
+-----------+---------------------+
| *Setter* | set_v_offset(value) |
+-----------+---------------------+
| *Getter* | get_v_offset() |
+-----------+---------------------+
The vertical offset of the camera, relative to the drag margins. Default value: ``0``.
The vertical offset of the camera, relative to the drag margins.
.. _class_Camera2D_property_process_mode:
- :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` **process_mode**
+----------+-------------------------+
| *Setter* | set_process_mode(value) |
+----------+-------------------------+
| *Getter* | get_process_mode() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 1 |
+-----------+-------------------------+
| *Setter* | set_process_mode(value) |
+-----------+-------------------------+
| *Getter* | get_process_mode() |
+-----------+-------------------------+
.. _class_Camera2D_property_rotating:
- :ref:`bool<class_bool>` **rotating**
+----------+---------------------+
| *Setter* | set_rotating(value) |
+----------+---------------------+
| *Getter* | is_rotating() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_rotating(value) |
+-----------+---------------------+
| *Getter* | is_rotating() |
+-----------+---------------------+
If ``true``, the camera rotates with the target. Default value: ``false``.
If ``true``, the camera rotates with the target.
.. _class_Camera2D_property_smoothing_enabled:
- :ref:`bool<class_bool>` **smoothing_enabled**
+----------+------------------------------------+
| *Setter* | set_enable_follow_smoothing(value) |
+----------+------------------------------------+
| *Getter* | is_follow_smoothing_enabled() |
+----------+------------------------------------+
+-----------+------------------------------------+
| *Default* | false |
+-----------+------------------------------------+
| *Setter* | set_enable_follow_smoothing(value) |
+-----------+------------------------------------+
| *Getter* | is_follow_smoothing_enabled() |
+-----------+------------------------------------+
If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_speed<class_Camera2D_property_smoothing_speed>`. Default value: ``false``.
If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_speed<class_Camera2D_property_smoothing_speed>`.
.. _class_Camera2D_property_smoothing_speed:
- :ref:`float<class_float>` **smoothing_speed**
+----------+-----------------------------+
| *Setter* | set_follow_smoothing(value) |
+----------+-----------------------------+
| *Getter* | get_follow_smoothing() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | 5.0 |
+-----------+-----------------------------+
| *Setter* | set_follow_smoothing(value) |
+-----------+-----------------------------+
| *Getter* | get_follow_smoothing() |
+-----------+-----------------------------+
Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled<class_Camera2D_property_smoothing_enabled>` is ``true``.
@@ -415,11 +461,13 @@ Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing
- :ref:`Vector2<class_Vector2>` **zoom**
+----------+-----------------+
| *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.

34
classes/class_camerafeed.rst
View File

@@ -19,11 +19,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>` |
+---------------------------------------+-----------------------------------------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`feed_transform<class_CameraFeed_property_feed_transform>` |
+---------------------------------------+-----------------------------------------------------------------+
+---------------------------------------+-----------------------------------------------------------------+----------------------------------+
| :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,21 +89,25 @@ Property Descriptions
- :ref:`bool<class_bool>` **feed_is_active**
+----------+-------------------+
| *Setter* | set_active(value) |
+----------+-------------------+
| *Getter* | is_active() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | false |
+-----------+-------------------+
| *Setter* | set_active(value) |
+-----------+-------------------+
| *Getter* | is_active() |
+-----------+-------------------+
.. _class_CameraFeed_property_feed_transform:
- :ref:`Transform2D<class_Transform2D>` **feed_transform**
+----------+----------------------+
| *Setter* | set_transform(value) |
+----------+----------------------+
| *Getter* | get_transform() |
+----------+----------------------+
+-----------+----------------------------------+
| *Default* | Transform2D( 1, 0, 0, -1, 0, 1 ) |
+-----------+----------------------------------+
| *Setter* | set_transform(value) |
+-----------+----------------------------------+
| *Getter* | get_transform() |
+-----------+----------------------------------+
Method Descriptions
-------------------

50
classes/class_cameratexture.rst
View File

@@ -21,13 +21,13 @@ 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>` |
+-----------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`camera_is_active<class_CameraTexture_property_camera_is_active>` |
+-----------------------------------------------+------------------------------------------------------------------------+
| :ref:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` |
+-----------------------------------------------+------------------------------------------------------------------------+
+-----------------------------------------------+------------------------------------------------------------------------+-------+
| :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:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` | 0 |
+-----------------------------------------------+------------------------------------------------------------------------+-------+
Property Descriptions
---------------------
@@ -36,11 +36,13 @@ Property Descriptions
- :ref:`int<class_int>` **camera_feed_id**
+----------+---------------------------+
| *Setter* | set_camera_feed_id(value) |
+----------+---------------------------+
| *Getter* | get_camera_feed_id() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 0 |
+-----------+---------------------------+
| *Setter* | set_camera_feed_id(value) |
+-----------+---------------------------+
| *Getter* | get_camera_feed_id() |
+-----------+---------------------------+
The ID of the :ref:`CameraFeed<class_CameraFeed>` for which we want to display the image.
@@ -48,11 +50,13 @@ The ID of the :ref:`CameraFeed<class_CameraFeed>` for which we want to display t
- :ref:`bool<class_bool>` **camera_is_active**
+----------+--------------------------+
| *Setter* | set_camera_active(value) |
+----------+--------------------------+
| *Getter* | get_camera_active() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | false |
+-----------+--------------------------+
| *Setter* | set_camera_active(value) |
+-----------+--------------------------+
| *Getter* | get_camera_active() |
+-----------+--------------------------+
Convenience property that gives access to the active property of the :ref:`CameraFeed<class_CameraFeed>`.
@@ -60,11 +64,13 @@ Convenience property that gives access to the active property of the :ref:`Camer
- :ref:`FeedImage<enum_CameraServer_FeedImage>` **which_feed**
+----------+-----------------------+
| *Setter* | set_which_feed(value) |
+----------+-----------------------+
| *Getter* | get_which_feed() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 0 |
+-----------+-----------------------+
| *Setter* | set_which_feed(value) |
+-----------+-----------------------+
| *Getter* | get_which_feed() |
+-----------+-----------------------+
Which image within the :ref:`CameraFeed<class_CameraFeed>` we want access to, important if the camera image is split in a Y and CbCr component.

134
classes/class_canvasitem.rst
View File

@@ -21,23 +21,23 @@ Base class of anything 2D.
Properties
----------
+---------------------------------+---------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`light_mask<class_CanvasItem_property_light_mask>` |
+---------------------------------+---------------------------------------------------------------------------+
| :ref:`Material<class_Material>` | :ref:`material<class_CanvasItem_property_material>` |
+---------------------------------+---------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`modulate<class_CanvasItem_property_modulate>` |
+---------------------------------+---------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`self_modulate<class_CanvasItem_property_self_modulate>` |
+---------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`show_behind_parent<class_CanvasItem_property_show_behind_parent>` |
+---------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`show_on_top<class_CanvasItem_property_show_on_top>` |
+---------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`use_parent_material<class_CanvasItem_property_use_parent_material>` |
+---------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`visible<class_CanvasItem_property_visible>` |
+---------------------------------+---------------------------------------------------------------------------+
+---------------------------------+---------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`light_mask<class_CanvasItem_property_light_mask>` | 1 |
+---------------------------------+---------------------------------------------------------------------------+---------------------+
| :ref:`Material<class_Material>` | :ref:`material<class_CanvasItem_property_material>` | null |
+---------------------------------+---------------------------------------------------------------------------+---------------------+
| :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
-------
@@ -242,91 +242,105 @@ Property Descriptions
- :ref:`int<class_int>` **light_mask**
+----------+-----------------------+
| *Setter* | set_light_mask(value) |
+----------+-----------------------+
| *Getter* | get_light_mask() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 1 |
+-----------+-----------------------+
| *Setter* | set_light_mask(value) |
+-----------+-----------------------+
| *Getter* | get_light_mask() |
+-----------+-----------------------+
The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D<class_Light2D>` nodes. Default value: ``1``.
The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D<class_Light2D>` nodes.
.. _class_CanvasItem_property_material:
- :ref:`Material<class_Material>` **material**
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
The material applied to textures on this ``CanvasItem``. Default value: ``null``.
The material applied to textures on this ``CanvasItem``.
.. _class_CanvasItem_property_modulate:
- :ref:`Color<class_Color>` **modulate**
+----------+---------------------+
| *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``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white").
The color applied to textures on this ``CanvasItem``.
.. _class_CanvasItem_property_self_modulate:
- :ref:`Color<class_Color>` **self_modulate**
+----------+--------------------------+
| *Setter* | set_self_modulate(value) |
+----------+--------------------------+
| *Getter* | get_self_modulate() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | Color( 1, 1, 1, 1 ) |
+-----------+--------------------------+
| *Setter* | set_self_modulate(value) |
+-----------+--------------------------+
| *Getter* | get_self_modulate() |
+-----------+--------------------------+
The color applied to textures on this ``CanvasItem``. This is not inherited by children ``CanvasItem``\ s. Default value: ``Color(1, 1, 1, 1)`` (opaque "white")..
The color applied to textures on this ``CanvasItem``. This is not inherited by children ``CanvasItem``\ s.
.. _class_CanvasItem_property_show_behind_parent:
- :ref:`bool<class_bool>` **show_behind_parent**
+----------+---------------------------------+
| *Setter* | set_draw_behind_parent(value) |
+----------+---------------------------------+
| *Getter* | is_draw_behind_parent_enabled() |
+----------+---------------------------------+
+-----------+---------------------------------+
| *Default* | false |
+-----------+---------------------------------+
| *Setter* | set_draw_behind_parent(value) |
+-----------+---------------------------------+
| *Getter* | is_draw_behind_parent_enabled() |
+-----------+---------------------------------+
If ``true``, the object draws behind its parent. Default value: ``false``.
If ``true``, the object draws behind its parent.
.. _class_CanvasItem_property_show_on_top:
- :ref:`bool<class_bool>` **show_on_top**
If ``true``, the object draws on top of its parent. Default value: ``true``.
If ``true``, the object draws on top of its parent.
.. _class_CanvasItem_property_use_parent_material:
- :ref:`bool<class_bool>` **use_parent_material**
+----------+--------------------------------+
| *Setter* | set_use_parent_material(value) |
+----------+--------------------------------+
| *Getter* | get_use_parent_material() |
+----------+--------------------------------+
+-----------+--------------------------------+
| *Default* | false |
+-----------+--------------------------------+
| *Setter* | set_use_parent_material(value) |
+-----------+--------------------------------+
| *Getter* | get_use_parent_material() |
+-----------+--------------------------------+
If ``true``, the parent ``CanvasItem``'s :ref:`material<class_CanvasItem_property_material>` property is used as this one's material. Default value: ``false``.
If ``true``, the parent ``CanvasItem``'s :ref:`material<class_CanvasItem_property_material>` property is used as this one's material.
.. _class_CanvasItem_property_visible:
- :ref:`bool<class_bool>` **visible**
+----------+--------------------+
| *Setter* | set_visible(value) |
+----------+--------------------+
| *Getter* | is_visible() |
+----------+--------------------+
+-----------+--------------------+
| *Default* | true |
+-----------+--------------------+
| *Setter* | set_visible(value) |
+-----------+--------------------+
| *Getter* | is_visible() |
+-----------+--------------------+
If ``true``, this ``CanvasItem`` is drawn. Default value: ``true``. For controls that inherit :ref:`Popup<class_Popup>`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead.
If ``true``, this ``CanvasItem`` is drawn. For controls that inherit :ref:`Popup<class_Popup>`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead.
Method Descriptions
-------------------

62
classes/class_canvasitemmaterial.rst
View File

@@ -19,19 +19,19 @@ A material for :ref:`CanvasItem<class_CanvasItem>`\ s.
Properties
----------
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` | :ref:`blend_mode<class_CanvasItemMaterial_property_blend_mode>` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` | :ref:`light_mode<class_CanvasItemMaterial_property_light_mode>` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`particles_anim_h_frames<class_CanvasItemMaterial_property_particles_anim_h_frames>` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`particles_anim_loop<class_CanvasItemMaterial_property_particles_anim_loop>` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`particles_anim_v_frames<class_CanvasItemMaterial_property_particles_anim_v_frames>` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`particles_animation<class_CanvasItemMaterial_property_particles_animation>` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+
| :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,11 +88,13 @@ Property Descriptions
- :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` **blend_mode**
+----------+-----------------------+
| *Setter* | set_blend_mode(value) |
+----------+-----------------------+
| *Getter* | get_blend_mode() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 0 |
+-----------+-----------------------+
| *Setter* | set_blend_mode(value) |
+-----------+-----------------------+
| *Getter* | get_blend_mode() |
+-----------+-----------------------+
The manner in which a material's rendering is applied to underlying textures.
@@ -100,11 +102,13 @@ The manner in which a material's rendering is applied to underlying textures.
- :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` **light_mode**
+----------+-----------------------+
| *Setter* | set_light_mode(value) |
+----------+-----------------------+
| *Getter* | get_light_mode() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 0 |
+-----------+-----------------------+
| *Setter* | set_light_mode(value) |
+-----------+-----------------------+
| *Getter* | get_light_mode() |
+-----------+-----------------------+
The manner in which material reacts to lighting.
@@ -142,9 +146,11 @@ The manner in which material reacts to lighting.
- :ref:`bool<class_bool>` **particles_animation**
+----------+--------------------------------+
| *Setter* | set_particles_animation(value) |
+----------+--------------------------------+
| *Getter* | get_particles_animation() |
+----------+--------------------------------+
+-----------+--------------------------------+
| *Default* | false |
+-----------+--------------------------------+
| *Setter* | set_particles_animation(value) |
+-----------+--------------------------------+
| *Getter* | get_particles_animation() |
+-----------+--------------------------------+

136
classes/class_canvaslayer.rst
View File

@@ -21,25 +21,25 @@ Canvas drawing layer.
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>` |
+---------------------------------------+----------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`follow_viewport_scale<class_CanvasLayer_property_follow_viewport_scale>` |
+---------------------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`layer<class_CanvasLayer_property_layer>` |
+---------------------------------------+----------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_CanvasLayer_property_offset>` |
+---------------------------------------+----------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`rotation<class_CanvasLayer_property_rotation>` |
+---------------------------------------+----------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`rotation_degrees<class_CanvasLayer_property_rotation_degrees>` |
+---------------------------------------+----------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`scale<class_CanvasLayer_property_scale>` |
+---------------------------------------+----------------------------------------------------------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`transform<class_CanvasLayer_property_transform>` |
+---------------------------------------+----------------------------------------------------------------------------------+
+---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+
| :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,43 +79,51 @@ The custom :ref:`Viewport<class_Viewport>` node assigned to the ``CanvasLayer``.
- :ref:`bool<class_bool>` **follow_viewport_enable**
+----------+----------------------------+
| *Setter* | set_follow_viewport(value) |
+----------+----------------------------+
| *Getter* | is_following_viewport() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | false |
+-----------+----------------------------+
| *Setter* | set_follow_viewport(value) |
+-----------+----------------------------+
| *Getter* | is_following_viewport() |
+-----------+----------------------------+
.. _class_CanvasLayer_property_follow_viewport_scale:
- :ref:`float<class_float>` **follow_viewport_scale**
+----------+----------------------------------+
| *Setter* | set_follow_viewport_scale(value) |
+----------+----------------------------------+
| *Getter* | get_follow_viewport_scale() |
+----------+----------------------------------+
+-----------+----------------------------------+
| *Default* | 1.0 |
+-----------+----------------------------------+
| *Setter* | set_follow_viewport_scale(value) |
+-----------+----------------------------------+
| *Getter* | get_follow_viewport_scale() |
+-----------+----------------------------------+
.. _class_CanvasLayer_property_layer:
- :ref:`int<class_int>` **layer**
+----------+------------------+
| *Setter* | set_layer(value) |
+----------+------------------+
| *Getter* | get_layer() |
+----------+------------------+
+-----------+------------------+
| *Default* | 1 |
+-----------+------------------+
| *Setter* | set_layer(value) |
+-----------+------------------+
| *Getter* | get_layer() |
+-----------+------------------+
Layer index for draw order. Lower values are drawn first. Default value: ``1``.
Layer index for draw order. Lower values are drawn first.
.. _class_CanvasLayer_property_offset:
- :ref:`Vector2<class_Vector2>` **offset**
+----------+-------------------+
| *Setter* | set_offset(value) |
+----------+-------------------+
| *Getter* | get_offset() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+-------------------+
| *Setter* | set_offset(value) |
+-----------+-------------------+
| *Getter* | get_offset() |
+-----------+-------------------+
The layer's base offset.
@@ -123,11 +131,13 @@ The layer's base offset.
- :ref:`float<class_float>` **rotation**
+----------+---------------------+
| *Setter* | set_rotation(value) |
+----------+---------------------+
| *Getter* | get_rotation() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | 0.0 |
+-----------+---------------------+
| *Setter* | set_rotation(value) |
+-----------+---------------------+
| *Getter* | get_rotation() |
+-----------+---------------------+
The layer's rotation in radians.
@@ -135,11 +145,13 @@ The layer's rotation in radians.
- :ref:`float<class_float>` **rotation_degrees**
+----------+-----------------------------+
| *Setter* | set_rotation_degrees(value) |
+----------+-----------------------------+
| *Getter* | get_rotation_degrees() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | 0.0 |
+-----------+-----------------------------+
| *Setter* | set_rotation_degrees(value) |
+-----------+-----------------------------+
| *Getter* | get_rotation_degrees() |
+-----------+-----------------------------+
The layer's rotation in degrees.
@@ -147,11 +159,13 @@ The layer's rotation in degrees.
- :ref:`Vector2<class_Vector2>` **scale**
+----------+------------------+
| *Setter* | set_scale(value) |
+----------+------------------+
| *Getter* | get_scale() |
+----------+------------------+
+-----------+------------------+
| *Default* | Vector2( 1, 1 ) |
+-----------+------------------+
| *Setter* | set_scale(value) |
+-----------+------------------+
| *Getter* | get_scale() |
+-----------+------------------+
The layer's scale.
@@ -159,11 +173,13 @@ The layer's scale.
- :ref:`Transform2D<class_Transform2D>` **transform**
+----------+----------------------+
| *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.

18
classes/class_canvasmodulate.rst
View File

@@ -19,9 +19,9 @@ Tint the entire canvas.
Properties
----------
+---------------------------+---------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_CanvasModulate_property_color>` |
+---------------------------+---------------------------------------------------+
+---------------------------+---------------------------------------------------+---------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_CanvasModulate_property_color>` | Color( 1, 1, 1, 1 ) |
+---------------------------+---------------------------------------------------+---------------------+
Description
-----------
@@ -35,11 +35,13 @@ Property Descriptions
- :ref:`Color<class_Color>` **color**
+----------+------------------+
| *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.

74
classes/class_capsulemesh.rst
View File

@@ -19,15 +19,15 @@ Class representing a capsule-shaped :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
Properties
----------
+---------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleMesh_property_mid_height>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`radial_segments<class_CapsuleMesh_property_radial_segments>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleMesh_property_radius>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`rings<class_CapsuleMesh_property_rings>` |
+---------------------------+--------------------------------------------------------------------+
+---------------------------+--------------------------------------------------------------------+-----+
| :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 |
+---------------------------+--------------------------------------------------------------------+-----+
Description
-----------
@@ -41,47 +41,55 @@ Property Descriptions
- :ref:`float<class_float>` **mid_height**
+----------+-----------------------+
| *Setter* | set_mid_height(value) |
+----------+-----------------------+
| *Getter* | get_mid_height() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 1.0 |
+-----------+-----------------------+
| *Setter* | set_mid_height(value) |
+-----------+-----------------------+
| *Getter* | get_mid_height() |
+-----------+-----------------------+
Height of the capsule mesh from the center point. Defaults to 1.0.
Height of the capsule mesh from the center point.
.. _class_CapsuleMesh_property_radial_segments:
- :ref:`int<class_int>` **radial_segments**
+----------+----------------------------+
| *Setter* | set_radial_segments(value) |
+----------+----------------------------+
| *Getter* | get_radial_segments() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | 64 |
+-----------+----------------------------+
| *Setter* | set_radial_segments(value) |
+-----------+----------------------------+
| *Getter* | get_radial_segments() |
+-----------+----------------------------+
Number of radial segments on the capsule mesh. Defaults to 64.
Number of radial segments on the capsule mesh.
.. _class_CapsuleMesh_property_radius:
- :ref:`float<class_float>` **radius**
+----------+-------------------+
| *Setter* | set_radius(value) |
+----------+-------------------+
| *Getter* | get_radius() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1.0 |
+-----------+-------------------+
| *Setter* | set_radius(value) |
+-----------+-------------------+
| *Getter* | get_radius() |
+-----------+-------------------+
Radius of the capsule mesh. Defaults to 1.0.
Radius of the capsule mesh.
.. _class_CapsuleMesh_property_rings:
- :ref:`int<class_int>` **rings**
+----------+------------------+
| *Setter* | set_rings(value) |
+----------+------------------+
| *Getter* | get_rings() |
+----------+------------------+
+-----------+------------------+
| *Default* | 8 |
+-----------+------------------+
| *Setter* | set_rings(value) |
+-----------+------------------+
| *Getter* | get_rings() |
+-----------+------------------+
Number of rings along the height of the capsule. Defaults to 8.
Number of rings along the height of the capsule.

34
classes/class_capsuleshape.rst
View File

@@ -19,11 +19,11 @@ Capsule shape for collisions.
Properties
----------
+---------------------------+---------------------------------------------------+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape_property_height>` |
+---------------------------+---------------------------------------------------+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape_property_radius>` |
+---------------------------+---------------------------------------------------+
+---------------------------+---------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape_property_height>` | 1.0 |
+---------------------------+---------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape_property_radius>` | 1.0 |
+---------------------------+---------------------------------------------------+-----+
Description
-----------
@@ -37,11 +37,13 @@ Property Descriptions
- :ref:`float<class_float>` **height**
+----------+-------------------+
| *Setter* | set_height(value) |
+----------+-------------------+
| *Getter* | get_height() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1.0 |
+-----------+-------------------+
| *Setter* | set_height(value) |
+-----------+-------------------+
| *Getter* | get_height() |
+-----------+-------------------+
The capsule's height.
@@ -49,11 +51,13 @@ The capsule's height.
- :ref:`float<class_float>` **radius**
+----------+-------------------+
| *Setter* | set_radius(value) |
+----------+-------------------+
| *Getter* | get_radius() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1.0 |
+-----------+-------------------+
| *Setter* | set_radius(value) |
+-----------+-------------------+
| *Getter* | get_radius() |
+-----------+-------------------+
The capsule's radius.

34
classes/class_capsuleshape2d.rst
View File

@@ -19,11 +19,11 @@ Capsule shape for 2D collisions.
Properties
----------
+---------------------------+-----------------------------------------------------+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>` |
+---------------------------+-----------------------------------------------------+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>` |
+---------------------------+-----------------------------------------------------+
+---------------------------+-----------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>` | 20.0 |
+---------------------------+-----------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>` | 10.0 |
+---------------------------+-----------------------------------------------------+------+
Description
-----------
@@ -37,11 +37,13 @@ Property Descriptions
- :ref:`float<class_float>` **height**
+----------+-------------------+
| *Setter* | set_height(value) |
+----------+-------------------+
| *Getter* | get_height() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 20.0 |
+-----------+-------------------+
| *Setter* | set_height(value) |
+-----------+-------------------+
| *Getter* | get_height() |
+-----------+-------------------+
The capsule's height.
@@ -49,11 +51,13 @@ The capsule's height.
- :ref:`float<class_float>` **radius**
+----------+-------------------+
| *Setter* | set_radius(value) |
+----------+-------------------+
| *Getter* | get_radius() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 10.0 |
+-----------+-------------------+
| *Setter* | set_radius(value) |
+-----------+-------------------+
| *Getter* | get_radius() |
+-----------+-------------------+
The capsule's radius.

20
classes/class_centercontainer.rst
View File

@@ -19,9 +19,9 @@ Keeps children controls centered.
Properties
----------
+-------------------------+------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`use_top_left<class_CenterContainer_property_use_top_left>` |
+-------------------------+------------------------------------------------------------------+
+-------------------------+------------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`use_top_left<class_CenterContainer_property_use_top_left>` | false |
+-------------------------+------------------------------------------------------------------+-------+
Description
-----------
@@ -35,11 +35,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **use_top_left**
+----------+-------------------------+
| *Setter* | set_use_top_left(value) |
+----------+-------------------------+
| *Getter* | is_using_top_left() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | false |
+-----------+-------------------------+
| *Setter* | set_use_top_left(value) |
+-----------+-------------------------+
| *Getter* | is_using_top_left() |
+-----------+-------------------------+
If ``true``, centers children relative to the ``CenterContainer``'s top left corner. Default value: ``false``.
If ``true``, centers children relative to the ``CenterContainer``'s top left corner.

74
classes/class_checkbox.rst
View File

@@ -19,43 +19,43 @@ Binary choice user interface widget.
Theme Properties
----------------
+---------------------------------+--------------------------+
| :ref:`int<class_int>` | check_vadjust |
+---------------------------------+--------------------------+
| :ref:`Texture<class_Texture>` | checked |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus |
+---------------------------------+--------------------------+
| :ref:`Font<class_Font>` | font |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>` | font_color |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>` | font_color_disabled |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>` | font_color_hover |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>` | font_color_hover_pressed |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>` | font_color_pressed |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover_pressed |
+---------------------------------+--------------------------+
| :ref:`int<class_int>` | hseparation |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed |
+---------------------------------+--------------------------+
| :ref:`Texture<class_Texture>` | radio_checked |
+---------------------------------+--------------------------+
| :ref:`Texture<class_Texture>` | radio_unchecked |
+---------------------------------+--------------------------+
| :ref:`Texture<class_Texture>` | unchecked |
+---------------------------------+--------------------------+
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`int<class_int>` | check_vadjust | 0 |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | checked | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover_pressed | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`int<class_int>` | hseparation | 4 |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | radio_checked | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | radio_unchecked | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | unchecked | |
+---------------------------------+--------------------------+------------------------------------------+
Description
-----------

74
classes/class_checkbutton.rst
View File

@@ -19,43 +19,43 @@ Checkable button.
Theme Properties
----------------
+---------------------------------+--------------------------+
| :ref:`int<class_int>` | check_vadjust |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus |
+---------------------------------+--------------------------+
| :ref:`Font<class_Font>` | font |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>` | font_color |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>` | font_color_disabled |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>` | font_color_hover |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>` | font_color_hover_pressed |
+---------------------------------+--------------------------+
| :ref:`Color<class_Color>` | font_color_pressed |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover_pressed |
+---------------------------------+--------------------------+
| :ref:`int<class_int>` | hseparation |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal |
+---------------------------------+--------------------------+
| :ref:`Texture<class_Texture>` | off |
+---------------------------------+--------------------------+
| :ref:`Texture<class_Texture>` | off_disabled |
+---------------------------------+--------------------------+
| :ref:`Texture<class_Texture>` | on |
+---------------------------------+--------------------------+
| :ref:`Texture<class_Texture>` | on_disabled |
+---------------------------------+--------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed |
+---------------------------------+--------------------------+
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`int<class_int>` | check_vadjust | 0 |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover_pressed | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`int<class_int>` | hseparation | 4 |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | off | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | off_disabled | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | on | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`Texture<class_Texture>` | on_disabled | |
+---------------------------------+--------------------------+------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+--------------------------+------------------------------------------+
Description
-----------

18
classes/class_circleshape2d.rst
View File

@@ -19,9 +19,9 @@ Circular shape for 2D collisions.
Properties
----------
+---------------------------+----------------------------------------------------+
| :ref:`float<class_float>` | :ref:`radius<class_CircleShape2D_property_radius>` |
+---------------------------+----------------------------------------------------+
+---------------------------+----------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`radius<class_CircleShape2D_property_radius>` | 10.0 |
+---------------------------+----------------------------------------------------+------+
Description
-----------
@@ -35,11 +35,13 @@ Property Descriptions
- :ref:`float<class_float>` **radius**
+----------+-------------------+
| *Setter* | set_radius(value) |
+----------+-------------------+
| *Getter* | get_radius() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 10.0 |
+-----------+-------------------+
| *Setter* | set_radius(value) |
+-----------+-------------------+
| *Getter* | get_radius() |
+-----------+-------------------+
The circle's radius.

82
classes/class_clippedcamera.rst
View File

@@ -19,17 +19,17 @@ Brief Description
Properties
----------
+----------------------------------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`clip_to_areas<class_ClippedCamera_property_clip_to_areas>` |
+----------------------------------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`clip_to_bodies<class_ClippedCamera_property_clip_to_bodies>` |
+----------------------------------------------------+--------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`collision_mask<class_ClippedCamera_property_collision_mask>` |
+----------------------------------------------------+--------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`margin<class_ClippedCamera_property_margin>` |
+----------------------------------------------------+--------------------------------------------------------------------+
| :ref:`ProcessMode<enum_ClippedCamera_ProcessMode>` | :ref:`process_mode<class_ClippedCamera_property_process_mode>` |
+----------------------------------------------------+--------------------------------------------------------------------+
+----------------------------------------------------+--------------------------------------------------------------------+-------+
| :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
-------
@@ -74,51 +74,61 @@ Property Descriptions
- :ref:`bool<class_bool>` **clip_to_areas**
+----------+----------------------------+
| *Setter* | set_clip_to_areas(value) |
+----------+----------------------------+
| *Getter* | is_clip_to_areas_enabled() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | false |
+-----------+----------------------------+
| *Setter* | set_clip_to_areas(value) |
+-----------+----------------------------+
| *Getter* | is_clip_to_areas_enabled() |
+-----------+----------------------------+
.. _class_ClippedCamera_property_clip_to_bodies:
- :ref:`bool<class_bool>` **clip_to_bodies**
+----------+-----------------------------+
| *Setter* | set_clip_to_bodies(value) |
+----------+-----------------------------+
| *Getter* | is_clip_to_bodies_enabled() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | true |
+-----------+-----------------------------+
| *Setter* | set_clip_to_bodies(value) |
+-----------+-----------------------------+
| *Getter* | is_clip_to_bodies_enabled() |
+-----------+-----------------------------+
.. _class_ClippedCamera_property_collision_mask:
- :ref:`int<class_int>` **collision_mask**
+----------+---------------------------+
| *Setter* | set_collision_mask(value) |
+----------+---------------------------+
| *Getter* | get_collision_mask() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 1 |
+-----------+---------------------------+
| *Setter* | set_collision_mask(value) |
+-----------+---------------------------+
| *Getter* | get_collision_mask() |
+-----------+---------------------------+
.. _class_ClippedCamera_property_margin:
- :ref:`float<class_float>` **margin**
+----------+-------------------+
| *Setter* | set_margin(value) |
+----------+-------------------+
| *Getter* | get_margin() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 0.0 |
+-----------+-------------------+
| *Setter* | set_margin(value) |
+-----------+-------------------+
| *Getter* | get_margin() |
+-----------+-------------------+
.. _class_ClippedCamera_property_process_mode:
- :ref:`ProcessMode<enum_ClippedCamera_ProcessMode>` **process_mode**
+----------+-------------------------+
| *Setter* | set_process_mode(value) |
+----------+-------------------------+
| *Getter* | get_process_mode() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0 |
+-----------+-------------------------+
| *Setter* | set_process_mode(value) |
+-----------+-------------------------+
| *Getter* | get_process_mode() |
+-----------+-------------------------+
Method Descriptions
-------------------

38
classes/class_collisionobject.rst
View File

@@ -21,11 +21,11 @@ Base node for collision objects.
Properties
----------
+-------------------------+------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`input_capture_on_drag<class_CollisionObject_property_input_capture_on_drag>` |
+-------------------------+------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`input_ray_pickable<class_CollisionObject_property_input_ray_pickable>` |
+-------------------------+------------------------------------------------------------------------------------+
+-------------------------+------------------------------------------------------------------------------------+-------+
| :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
-------
@@ -99,25 +99,29 @@ Property Descriptions
- :ref:`bool<class_bool>` **input_capture_on_drag**
+----------+----------------------------------+
| *Setter* | set_capture_input_on_drag(value) |
+----------+----------------------------------+
| *Getter* | get_capture_input_on_drag() |
+----------+----------------------------------+
+-----------+----------------------------------+
| *Default* | false |
+-----------+----------------------------------+
| *Setter* | set_capture_input_on_drag(value) |
+-----------+----------------------------------+
| *Getter* | get_capture_input_on_drag() |
+-----------+----------------------------------+
If ``true``, the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``.
If ``true``, the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes.
.. _class_CollisionObject_property_input_ray_pickable:
- :ref:`bool<class_bool>` **input_ray_pickable**
+----------+-------------------------+
| *Setter* | set_ray_pickable(value) |
+----------+-------------------------+
| *Getter* | is_ray_pickable() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | true |
+-----------+-------------------------+
| *Setter* | set_ray_pickable(value) |
+-----------+-------------------------+
| *Getter* | is_ray_pickable() |
+-----------+-------------------------+
If ``true``, the ``CollisionObject``'s shapes will respond to :ref:`RayCast<class_RayCast>`\ s. Default value: ``true``.
If ``true``, the ``CollisionObject``'s shapes will respond to :ref:`RayCast<class_RayCast>`\ s.
Method Descriptions
-------------------

18
classes/class_collisionobject2d.rst
View File

@@ -21,9 +21,9 @@ Base node for 2D collision objects.
Properties
----------
+-------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`input_pickable<class_CollisionObject2D_property_input_pickable>` |
+-------------------------+------------------------------------------------------------------------+
+-------------------------+------------------------------------------------------------------------+------+
| :ref:`bool<class_bool>` | :ref:`input_pickable<class_CollisionObject2D_property_input_pickable>` | true |
+-------------------------+------------------------------------------------------------------------+------+
Methods
-------
@@ -105,11 +105,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **input_pickable**
+----------+---------------------+
| *Setter* | set_pickable(value) |
+----------+---------------------+
| *Getter* | is_pickable() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | true |
+-----------+---------------------+
| *Setter* | set_pickable(value) |
+-----------+---------------------+
| *Getter* | is_pickable() |
+-----------+---------------------+
If ``true``, this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. Requires at least one ``collision_layer`` bit to be set.

50
classes/class_collisionpolygon.rst
View File

@@ -19,13 +19,13 @@ Editor-only class for defining a collision polygon in 3D space.
Properties
----------
+-------------------------------------------------+-----------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`depth<class_CollisionPolygon_property_depth>` |
+-------------------------------------------------+-----------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon_property_disabled>` |
+-------------------------------------------------+-----------------------------------------------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon_property_polygon>` |
+-------------------------------------------------+-----------------------------------------------------------+
+-------------------------------------------------+-----------------------------------------------------------+----------------------+
| :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( ) |
+-------------------------------------------------+-----------------------------------------------------------+----------------------+
Description
-----------
@@ -39,11 +39,13 @@ Property Descriptions
- :ref:`float<class_float>` **depth**
+----------+------------------+
| *Setter* | set_depth(value) |
+----------+------------------+
| *Getter* | get_depth() |
+----------+------------------+
+-----------+------------------+
| *Default* | 1.0 |
+-----------+------------------+
| *Setter* | set_depth(value) |
+-----------+------------------+
| *Getter* | get_depth() |
+-----------+------------------+
Length that the resulting collision extends in either direction perpendicular to its polygon.
@@ -51,11 +53,13 @@ Length that the resulting collision extends in either direction perpendicular to
- :ref:`bool<class_bool>` **disabled**
+----------+---------------------+
| *Setter* | set_disabled(value) |
+----------+---------------------+
| *Getter* | is_disabled() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_disabled(value) |
+-----------+---------------------+
| *Getter* | is_disabled() |
+-----------+---------------------+
If ``true``, no collision will be produced.
@@ -63,11 +67,13 @@ If ``true``, no collision will be produced.
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
+----------+--------------------+
| *Setter* | set_polygon(value) |
+----------+--------------------+
| *Getter* | get_polygon() |
+----------+--------------------+
+-----------+----------------------+
| *Default* | PoolVector2Array( ) |
+-----------+----------------------+
| *Setter* | set_polygon(value) |
+-----------+----------------------+
| *Getter* | get_polygon() |
+-----------+----------------------+
Array of vertices which define the polygon.

84
classes/class_collisionpolygon2d.rst
View File

@@ -19,17 +19,17 @@ Defines a 2D collision polygon.
Properties
----------
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` | :ref:`build_mode<class_CollisionPolygon2D_property_build_mode>` |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionPolygon2D_property_disabled>` |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionPolygon2D_property_one_way_collision>` |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`one_way_collision_margin<class_CollisionPolygon2D_property_one_way_collision_margin>` |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon2D_property_polygon>` |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+
+-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+
| :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
------------
@@ -58,23 +58,27 @@ Property Descriptions
- :ref:`BuildMode<enum_CollisionPolygon2D_BuildMode>` **build_mode**
+----------+-----------------------+
| *Setter* | set_build_mode(value) |
+----------+-----------------------+
| *Getter* | get_build_mode() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 0 |
+-----------+-----------------------+
| *Setter* | set_build_mode(value) |
+-----------+-----------------------+
| *Getter* | get_build_mode() |
+-----------+-----------------------+
Collision build mode. Use one of the ``BUILD_*`` constants. Default value: :ref:`BUILD_SOLIDS<class_CollisionPolygon2D_constant_BUILD_SOLIDS>`.
Collision build mode. Use one of the ``BUILD_*`` constants.
.. _class_CollisionPolygon2D_property_disabled:
- :ref:`bool<class_bool>` **disabled**
+----------+---------------------+
| *Setter* | set_disabled(value) |
+----------+---------------------+
| *Getter* | is_disabled() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_disabled(value) |
+-----------+---------------------+
| *Getter* | is_disabled() |
+-----------+---------------------+
If ``true``, no collisions will be detected.
@@ -82,11 +86,13 @@ If ``true``, no collisions will be detected.
- :ref:`bool<class_bool>` **one_way_collision**
+----------+--------------------------------+
| *Setter* | set_one_way_collision(value) |
+----------+--------------------------------+
| *Getter* | is_one_way_collision_enabled() |
+----------+--------------------------------+
+-----------+--------------------------------+
| *Default* | false |
+-----------+--------------------------------+
| *Setter* | set_one_way_collision(value) |
+-----------+--------------------------------+
| *Getter* | is_one_way_collision_enabled() |
+-----------+--------------------------------+
If ``true``, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects.
@@ -94,21 +100,25 @@ If ``true``, only edges that face up, relative to CollisionPolygon2D's rotation,
- :ref:`float<class_float>` **one_way_collision_margin**
+----------+-------------------------------------+
| *Setter* | set_one_way_collision_margin(value) |
+----------+-------------------------------------+
| *Getter* | get_one_way_collision_margin() |
+----------+-------------------------------------+
+-----------+-------------------------------------+
| *Default* | 1.0 |
+-----------+-------------------------------------+
| *Setter* | set_one_way_collision_margin(value) |
+-----------+-------------------------------------+
| *Getter* | get_one_way_collision_margin() |
+-----------+-------------------------------------+
.. _class_CollisionPolygon2D_property_polygon:
- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**
+----------+--------------------+
| *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 PoolVector2Array, not a reference.

34
classes/class_collisionshape.rst
View File

@@ -19,11 +19,11 @@ Node that represents collision shape data in 3D space.
Properties
----------
+---------------------------+---------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape_property_disabled>` |
+---------------------------+---------------------------------------------------------+
| :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>` | null |
+---------------------------+---------------------------------------------------------+-------+
Methods
-------
@@ -51,11 +51,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **disabled**
+----------+---------------------+
| *Setter* | set_disabled(value) |
+----------+---------------------+
| *Getter* | is_disabled() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_disabled(value) |
+-----------+---------------------+
| *Getter* | is_disabled() |
+-----------+---------------------+
A disabled collision shape has no effect in the world.
@@ -63,11 +65,13 @@ A disabled collision shape has no effect in the world.
- :ref:`Shape<class_Shape>` **shape**
+----------+------------------+
| *Setter* | set_shape(value) |
+----------+------------------+
| *Getter* | get_shape() |
+----------+------------------+
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_shape(value) |
+-----------+------------------+
| *Getter* | get_shape() |
+-----------+------------------+
The actual shape owned by this collision shape.

66
classes/class_collisionshape2d.rst
View File

@@ -19,15 +19,15 @@ Node that represents collision shape data in 2D space.
Properties
----------
+-------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`disabled<class_CollisionShape2D_property_disabled>` |
+-------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`one_way_collision<class_CollisionShape2D_property_one_way_collision>` |
+-------------------------------+-------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`one_way_collision_margin<class_CollisionShape2D_property_one_way_collision_margin>` |
+-------------------------------+-------------------------------------------------------------------------------------------+
| :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>` | null |
+-------------------------------+-------------------------------------------------------------------------------------------+-------+
Description
-----------
@@ -46,11 +46,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **disabled**
+----------+---------------------+
| *Setter* | set_disabled(value) |
+----------+---------------------+
| *Getter* | is_disabled() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_disabled(value) |
+-----------+---------------------+
| *Getter* | is_disabled() |
+-----------+---------------------+
A disabled collision shape has no effect in the world.
@@ -58,11 +60,13 @@ A disabled collision shape has no effect in the world.
- :ref:`bool<class_bool>` **one_way_collision**
+----------+--------------------------------+
| *Setter* | set_one_way_collision(value) |
+----------+--------------------------------+
| *Getter* | is_one_way_collision_enabled() |
+----------+--------------------------------+
+-----------+--------------------------------+
| *Default* | false |
+-----------+--------------------------------+
| *Setter* | set_one_way_collision(value) |
+-----------+--------------------------------+
| *Getter* | is_one_way_collision_enabled() |
+-----------+--------------------------------+
Sets whether this collision shape should only detect collision on one side (top or bottom).
@@ -70,21 +74,25 @@ Sets whether this collision shape should only detect collision on one side (top
- :ref:`float<class_float>` **one_way_collision_margin**
+----------+-------------------------------------+
| *Setter* | set_one_way_collision_margin(value) |
+----------+-------------------------------------+
| *Getter* | get_one_way_collision_margin() |
+----------+-------------------------------------+
+-----------+-------------------------------------+
| *Default* | 1.0 |
+-----------+-------------------------------------+
| *Setter* | set_one_way_collision_margin(value) |
+-----------+-------------------------------------+
| *Getter* | get_one_way_collision_margin() |
+-----------+-------------------------------------+
.. _class_CollisionShape2D_property_shape:
- :ref:`Shape2D<class_Shape2D>` **shape**
+----------+------------------+
| *Setter* | set_shape(value) |
+----------+------------------+
| *Getter* | get_shape() |
+----------+------------------+
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_shape(value) |
+-----------+------------------+
| *Getter* | get_shape() |
+-----------+------------------+
The actual shape owned by this collision shape.

90
classes/class_color.rst
View File

@@ -17,29 +17,29 @@ Color in RGBA format with some support for ARGB format.
Properties
----------
+---------------------------+------------------------------------+
| :ref:`float<class_float>` | :ref:`a<class_Color_property_a>` |
+---------------------------+------------------------------------+
| :ref:`int<class_int>` | :ref:`a8<class_Color_property_a8>` |
+---------------------------+------------------------------------+
| :ref:`float<class_float>` | :ref:`b<class_Color_property_b>` |
+---------------------------+------------------------------------+
| :ref:`int<class_int>` | :ref:`b8<class_Color_property_b8>` |
+---------------------------+------------------------------------+
| :ref:`float<class_float>` | :ref:`g<class_Color_property_g>` |
+---------------------------+------------------------------------+
| :ref:`int<class_int>` | :ref:`g8<class_Color_property_g8>` |
+---------------------------+------------------------------------+
| :ref:`float<class_float>` | :ref:`h<class_Color_property_h>` |
+---------------------------+------------------------------------+
| :ref:`float<class_float>` | :ref:`r<class_Color_property_r>` |
+---------------------------+------------------------------------+
| :ref:`int<class_int>` | :ref:`r8<class_Color_property_r8>` |
+---------------------------+------------------------------------+
| :ref:`float<class_float>` | :ref:`s<class_Color_property_s>` |
+---------------------------+------------------------------------+
| :ref:`float<class_float>` | :ref:`v<class_Color_property_v>` |
+---------------------------+------------------------------------+
+---------------------------+------------------------------------+-----+
| :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
-------
@@ -685,66 +685,110 @@ Property Descriptions
- :ref:`float<class_float>` **a**
+-----------+-----+
| *Default* | 1.0 |
+-----------+-----+
Alpha value (range 0 to 1).
.. _class_Color_property_a8:
- :ref:`int<class_int>` **a8**
+-----------+-----+
| *Default* | 255 |
+-----------+-----+
Alpha value (range 0 to 255).
.. _class_Color_property_b:
- :ref:`float<class_float>` **b**
+-----------+-----+
| *Default* | 0.0 |
+-----------+-----+
Blue value (range 0 to 1).
.. _class_Color_property_b8:
- :ref:`int<class_int>` **b8**
+-----------+---+
| *Default* | 0 |
+-----------+---+
Blue value (range 0 to 255).
.. _class_Color_property_g:
- :ref:`float<class_float>` **g**
+-----------+-----+
| *Default* | 0.0 |
+-----------+-----+
Green value (range 0 to 1).
.. _class_Color_property_g8:
- :ref:`int<class_int>` **g8**
+-----------+---+
| *Default* | 0 |
+-----------+---+
Green value (range 0 to 255).
.. _class_Color_property_h:
- :ref:`float<class_float>` **h**
+-----------+-----+
| *Default* | 0.0 |
+-----------+-----+
HSV hue value (range 0 to 1).
.. _class_Color_property_r:
- :ref:`float<class_float>` **r**
+-----------+-----+
| *Default* | 0.0 |
+-----------+-----+
Red value (range 0 to 1).
.. _class_Color_property_r8:
- :ref:`int<class_int>` **r8**
+-----------+---+
| *Default* | 0 |
+-----------+---+
Red value (range 0 to 255).
.. _class_Color_property_s:
- :ref:`float<class_float>` **s**
+-----------+-----+
| *Default* | 0.0 |
+-----------+-----+
HSV saturation value (range 0 to 1).
.. _class_Color_property_v:
- :ref:`float<class_float>` **v**
+-----------+-----+
| *Default* | 0.0 |
+-----------+-----+
HSV value (range 0 to 1).
Method Descriptions

156
classes/class_colorpicker.rst
View File

@@ -19,21 +19,21 @@ Color picker control.
Properties
----------
+---------------------------+--------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_ColorPicker_property_color>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`deferred_mode<class_ColorPicker_property_deferred_mode>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPicker_property_edit_alpha>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`hsv_mode<class_ColorPicker_property_hsv_mode>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`presets_enabled<class_ColorPicker_property_presets_enabled>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`presets_visible<class_ColorPicker_property_presets_visible>` |
+---------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`raw_mode<class_ColorPicker_property_raw_mode>` |
+---------------------------+--------------------------------------------------------------------+
+---------------------------+--------------------------------------------------------------------+---------------------+
| :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
-------
@@ -49,27 +49,27 @@ Methods
Theme Properties
----------------
+-------------------------------+---------------+
| :ref:`Texture<class_Texture>` | add_preset |
+-------------------------------+---------------+
| :ref:`Texture<class_Texture>` | color_hue |
+-------------------------------+---------------+
| :ref:`Texture<class_Texture>` | color_sample |
+-------------------------------+---------------+
| :ref:`int<class_int>` | h_width |
+-------------------------------+---------------+
| :ref:`int<class_int>` | label_width |
+-------------------------------+---------------+
| :ref:`int<class_int>` | margin |
+-------------------------------+---------------+
| :ref:`Texture<class_Texture>` | preset_bg |
+-------------------------------+---------------+
| :ref:`Texture<class_Texture>` | screen_picker |
+-------------------------------+---------------+
| :ref:`int<class_int>` | sv_height |
+-------------------------------+---------------+
| :ref:`int<class_int>` | sv_width |
+-------------------------------+---------------+
+-------------------------------+---------------+-----+
| :ref:`Texture<class_Texture>` | add_preset | |
+-------------------------------+---------------+-----+
| :ref:`Texture<class_Texture>` | color_hue | |
+-------------------------------+---------------+-----+
| :ref:`Texture<class_Texture>` | color_sample | |
+-------------------------------+---------------+-----+
| :ref:`int<class_int>` | h_width | 30 |
+-------------------------------+---------------+-----+
| :ref:`int<class_int>` | label_width | 10 |
+-------------------------------+---------------+-----+
| :ref:`int<class_int>` | margin | 4 |
+-------------------------------+---------------+-----+
| :ref:`Texture<class_Texture>` | preset_bg | |
+-------------------------------+---------------+-----+
| :ref:`Texture<class_Texture>` | screen_picker | |
+-------------------------------+---------------+-----+
| :ref:`int<class_int>` | sv_height | 256 |
+-------------------------------+---------------+-----+
| :ref:`int<class_int>` | sv_width | 256 |
+-------------------------------+---------------+-----+
Signals
-------
@@ -104,11 +104,13 @@ Property Descriptions
- :ref:`Color<class_Color>` **color**
+----------+-----------------------+
| *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.
@@ -116,11 +118,13 @@ The currently selected color.
- :ref:`bool<class_bool>` **deferred_mode**
+----------+--------------------------+
| *Setter* | set_deferred_mode(value) |
+----------+--------------------------+
| *Getter* | is_deferred_mode() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | false |
+-----------+--------------------------+
| *Setter* | set_deferred_mode(value) |
+-----------+--------------------------+
| *Getter* | is_deferred_mode() |
+-----------+--------------------------+
If ``true``, the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues).
@@ -128,11 +132,13 @@ If ``true``, the color will apply only after the user releases the mouse button,
- :ref:`bool<class_bool>` **edit_alpha**
+----------+-----------------------+
| *Setter* | set_edit_alpha(value) |
+----------+-----------------------+
| *Getter* | is_editing_alpha() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | true |
+-----------+-----------------------+
| *Setter* | set_edit_alpha(value) |
+-----------+-----------------------+
| *Getter* | is_editing_alpha() |
+-----------+-----------------------+
If ``true``, shows an alpha channel slider (transparency).
@@ -140,11 +146,13 @@ If ``true``, shows an alpha channel slider (transparency).
- :ref:`bool<class_bool>` **hsv_mode**
+----------+---------------------+
| *Setter* | set_hsv_mode(value) |
+----------+---------------------+
| *Getter* | is_hsv_mode() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_hsv_mode(value) |
+-----------+---------------------+
| *Getter* | is_hsv_mode() |
+-----------+---------------------+
If ``true``, allows editing the color with Hue/Saturation/Value sliders.
@@ -154,31 +162,37 @@ If ``true``, allows editing the color with Hue/Saturation/Value sliders.
- :ref:`bool<class_bool>` **presets_enabled**
+----------+----------------------------+
| *Setter* | set_presets_enabled(value) |
+----------+----------------------------+
| *Getter* | are_presets_enabled() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | true |
+-----------+----------------------------+
| *Setter* | set_presets_enabled(value) |
+-----------+----------------------------+
| *Getter* | are_presets_enabled() |
+-----------+----------------------------+
.. _class_ColorPicker_property_presets_visible:
- :ref:`bool<class_bool>` **presets_visible**
+----------+----------------------------+
| *Setter* | set_presets_visible(value) |
+----------+----------------------------+
| *Getter* | are_presets_visible() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | true |
+-----------+----------------------------+
| *Setter* | set_presets_visible(value) |
+-----------+----------------------------+
| *Getter* | are_presets_visible() |
+-----------+----------------------------+
.. _class_ColorPicker_property_raw_mode:
- :ref:`bool<class_bool>` **raw_mode**
+----------+---------------------+
| *Setter* | set_raw_mode(value) |
+----------+---------------------+
| *Getter* | is_raw_mode() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_raw_mode(value) |
+-----------+---------------------+
| *Getter* | is_raw_mode() |
+-----------+---------------------+
If ``true``, allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).

86
classes/class_colorpickerbutton.rst
View File

@@ -19,11 +19,11 @@ Button that pops out a :ref:`ColorPicker<class_ColorPicker>`.
Properties
----------
+---------------------------+----------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_ColorPickerButton_property_color>` |
+---------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`edit_alpha<class_ColorPickerButton_property_edit_alpha>` |
+---------------------------+----------------------------------------------------------------+
+---------------------------+----------------------------------------------------------------+---------------------+
| :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 |
+---------------------------+----------------------------------------------------------------+---------------------+
Methods
-------
@@ -37,31 +37,31 @@ Methods
Theme Properties
----------------
+---------------------------------+---------------------+
| :ref:`Texture<class_Texture>` | bg |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | focus |
+---------------------------------+---------------------+
| :ref:`Font<class_Font>` | font |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>` | font_color |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>` | font_color_disabled |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>` | font_color_hover |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>` | font_color_pressed |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | hover |
+---------------------------------+---------------------+
| :ref:`int<class_int>` | hseparation |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | normal |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed |
+---------------------------------+---------------------+
+---------------------------------+---------------------+-----------------------------+
| :ref:`Texture<class_Texture>` | bg | |
+---------------------------------+---------------------+-----------------------------+
| :ref:`StyleBox<class_StyleBox>` | disabled | |
+---------------------------------+---------------------+-----------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus | |
+---------------------------------+---------------------+-----------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+---------------------+-----------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+-----------------------------+
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.3 ) |
+---------------------------------+---------------------+-----------------------------+
| :ref:`Color<class_Color>` | font_color_hover | Color( 1, 1, 1, 1 ) |
+---------------------------------+---------------------+-----------------------------+
| :ref:`Color<class_Color>` | font_color_pressed | Color( 0.8, 0.8, 0.8, 1 ) |
+---------------------------------+---------------------+-----------------------------+
| :ref:`StyleBox<class_StyleBox>` | hover | |
+---------------------------------+---------------------+-----------------------------+
| :ref:`int<class_int>` | hseparation | 2 |
+---------------------------------+---------------------+-----------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal | |
+---------------------------------+---------------------+-----------------------------+
| :ref:`StyleBox<class_StyleBox>` | pressed | |
+---------------------------------+---------------------+-----------------------------+
Signals
-------
@@ -88,11 +88,13 @@ Property Descriptions
- :ref:`Color<class_Color>` **color**
+----------+-----------------------+
| *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.
@@ -100,13 +102,15 @@ The currently selected color.
- :ref:`bool<class_bool>` **edit_alpha**
+----------+-----------------------+
| *Setter* | set_edit_alpha(value) |
+----------+-----------------------+
| *Getter* | is_editing_alpha() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | true |
+-----------+-----------------------+
| *Setter* | set_edit_alpha(value) |
+-----------+-----------------------+
| *Getter* | is_editing_alpha() |
+-----------+-----------------------+
If ``true``, the alpha channel in the displayed :ref:`ColorPicker<class_ColorPicker>` will be visible. Default value: ``true``.
If ``true``, the alpha channel in the displayed :ref:`ColorPicker<class_ColorPicker>` will be visible.
Method Descriptions
-------------------

18
classes/class_colorrect.rst
View File

@@ -19,9 +19,9 @@ Colored rectangle.
Properties
----------
+---------------------------+----------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_ColorRect_property_color>` |
+---------------------------+----------------------------------------------+
+---------------------------+----------------------------------------------+---------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_ColorRect_property_color>` | Color( 1, 1, 1, 1 ) |
+---------------------------+----------------------------------------------+---------------------+
Description
-----------
@@ -35,11 +35,13 @@ Property Descriptions
- :ref:`Color<class_Color>` **color**
+----------+------------------------+
| *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.

18
classes/class_concavepolygonshape2d.rst
View File

@@ -19,9 +19,9 @@ Concave polygon 2D shape resource for physics.
Properties
----------
+-------------------------------------------------+----------------------------------------------------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`segments<class_ConcavePolygonShape2D_property_segments>` |
+-------------------------------------------------+----------------------------------------------------------------+
+-------------------------------------------------+----------------------------------------------------------------+----------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`segments<class_ConcavePolygonShape2D_property_segments>` | PoolVector2Array( ) |
+-------------------------------------------------+----------------------------------------------------------------+----------------------+
Description
-----------
@@ -37,11 +37,13 @@ Property Descriptions
- :ref:`PoolVector2Array<class_PoolVector2Array>` **segments**
+----------+---------------------+
| *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.

70
classes/class_conetwistjoint.rst
View File

@@ -19,17 +19,17 @@ A twist joint between two 3D bodies.
Properties
----------
+---------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`bias<class_ConeTwistJoint_property_bias>` |
+---------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`relaxation<class_ConeTwistJoint_property_relaxation>` |
+---------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`softness<class_ConeTwistJoint_property_softness>` |
+---------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`swing_span<class_ConeTwistJoint_property_swing_span>` |
+---------------------------+-------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`twist_span<class_ConeTwistJoint_property_twist_span>` |
+---------------------------+-------------------------------------------------------------+
+---------------------------+-------------------------------------------------------------+-------+
| :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 |
+---------------------------+-------------------------------------------------------------+-------+
Enumerations
------------
@@ -56,7 +56,7 @@ The swing span defines, how much rotation will not get corrected along the swing
Could be defined as looseness in the ``ConeTwistJoint``.
If below 0.05, this behavior is locked. Default value: ``PI/4``.
If below 0.05, this behavior is locked.
- **PARAM_TWIST_SPAN** = **1** --- Twist is the rotation around the twist axis, this value defined how far the joint can twist.
@@ -88,11 +88,13 @@ Property Descriptions
- :ref:`float<class_float>` **bias**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
+-----------+------------------+
| *Default* | 0.3 |
+-----------+------------------+
| *Setter* | set_param(value) |
+-----------+------------------+
| *Getter* | get_param() |
+-----------+------------------+
The speed with which the swing or twist will take place.
@@ -102,11 +104,13 @@ The higher, the faster.
- :ref:`float<class_float>` **relaxation**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
+-----------+------------------+
| *Default* | 1.0 |
+-----------+------------------+
| *Setter* | set_param(value) |
+-----------+------------------+
| *Getter* | get_param() |
+-----------+------------------+
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
@@ -114,11 +118,13 @@ Defines, how fast the swing- and twist-speed-difference on both sides gets synce
- :ref:`float<class_float>` **softness**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
+-----------+------------------+
| *Default* | 0.8 |
+-----------+------------------+
| *Setter* | set_param(value) |
+-----------+------------------+
| *Getter* | get_param() |
+-----------+------------------+
The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
@@ -126,18 +132,26 @@ 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 |
+-----------+------+
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
The swing span defines, how much rotation will not get corrected along the swing axis.
Could be defined as looseness in the ``ConeTwistJoint``.
If below 0.05, this behavior is locked. Default value: ``PI/4``.
If below 0.05, this behavior is locked.
.. _class_ConeTwistJoint_property_twist_span:
- :ref:`float<class_float>` **twist_span**
+-----------+-------+
| *Default* | 180.0 |
+-----------+-------+
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
Twist is locked if below 0.05.

482
classes/class_control.rst
View File

@@ -21,71 +21,71 @@ All User Interface nodes inherit from Control. A control's anchors and margins a
Properties
----------
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`anchor_bottom<class_Control_property_anchor_bottom>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`anchor_left<class_Control_property_anchor_left>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`anchor_right<class_Control_property_anchor_right>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`anchor_top<class_Control_property_anchor_top>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`focus_mode<class_Control_property_focus_mode>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_bottom<class_Control_property_focus_neighbour_bottom>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_left<class_Control_property_focus_neighbour_left>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_right<class_Control_property_focus_neighbour_right>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`focus_neighbour_top<class_Control_property_focus_neighbour_top>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`focus_next<class_Control_property_focus_next>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`focus_previous<class_Control_property_focus_previous>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`GrowDirection<enum_Control_GrowDirection>` | :ref:`grow_horizontal<class_Control_property_grow_horizontal>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`GrowDirection<enum_Control_GrowDirection>` | :ref:`grow_vertical<class_Control_property_grow_vertical>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`hint_tooltip<class_Control_property_hint_tooltip>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`margin_bottom<class_Control_property_margin_bottom>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`margin_left<class_Control_property_margin_left>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`margin_right<class_Control_property_margin_right>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`margin_top<class_Control_property_margin_top>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`CursorShape<enum_Control_CursorShape>` | :ref:`mouse_default_cursor_shape<class_Control_property_mouse_default_cursor_shape>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`MouseFilter<enum_Control_MouseFilter>` | :ref:`mouse_filter<class_Control_property_mouse_filter>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`rect_clip_content<class_Control_property_rect_clip_content>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :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>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`rect_position<class_Control_property_rect_position>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`rect_rotation<class_Control_property_rect_rotation>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`rect_scale<class_Control_property_rect_scale>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`rect_size<class_Control_property_rect_size>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size_flags_horizontal<class_Control_property_size_flags_horizontal>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`size_flags_stretch_ratio<class_Control_property_size_flags_stretch_ratio>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size_flags_vertical<class_Control_property_size_flags_vertical>` |
+--------------------------------------------------+--------------------------------------------------------------------------------------+
| :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>` | null |
+--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+
Methods
-------
@@ -594,51 +594,61 @@ Property Descriptions
- :ref:`float<class_float>` **anchor_bottom**
+----------+--------------+
| *Getter* | get_anchor() |
+----------+--------------+
+-----------+--------------+
| *Default* | 0.0 |
+-----------+--------------+
| *Getter* | get_anchor() |
+-----------+--------------+
Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`.
Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience.
.. _class_Control_property_anchor_left:
- :ref:`float<class_float>` **anchor_left**
+----------+--------------+
| *Getter* | get_anchor() |
+----------+--------------+
+-----------+--------------+
| *Default* | 0.0 |
+-----------+--------------+
| *Getter* | get_anchor() |
+-----------+--------------+
Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience.Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`.
Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience.
.. _class_Control_property_anchor_right:
- :ref:`float<class_float>` **anchor_right**
+----------+--------------+
| *Getter* | get_anchor() |
+----------+--------------+
+-----------+--------------+
| *Default* | 0.0 |
+-----------+--------------+
| *Getter* | get_anchor() |
+-----------+--------------+
Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`.
Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience.
.. _class_Control_property_anchor_top:
- :ref:`float<class_float>` **anchor_top**
+----------+--------------+
| *Getter* | get_anchor() |
+----------+--------------+
+-----------+--------------+
| *Default* | 0.0 |
+-----------+--------------+
| *Getter* | get_anchor() |
+-----------+--------------+
Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: :ref:`ANCHOR_BEGIN<class_Control_constant_ANCHOR_BEGIN>`.
Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience.
.. _class_Control_property_focus_mode:
- :ref:`FocusMode<enum_Control_FocusMode>` **focus_mode**
+----------+-----------------------+
| *Setter* | set_focus_mode(value) |
+----------+-----------------------+
| *Getter* | get_focus_mode() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | 0 |
+-----------+-----------------------+
| *Setter* | set_focus_mode(value) |
+-----------+-----------------------+
| *Getter* | get_focus_mode() |
+-----------+-----------------------+
The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals.
@@ -646,11 +656,13 @@ The focus access mode for the control (None, Click or All). Only one Control can
- :ref:`NodePath<class_NodePath>` **focus_neighbour_bottom**
+----------+----------------------------+
| *Setter* | set_focus_neighbour(value) |
+----------+----------------------------+
| *Getter* | get_focus_neighbour() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | NodePath("") |
+-----------+----------------------------+
| *Setter* | set_focus_neighbour(value) |
+-----------+----------------------------+
| *Getter* | get_focus_neighbour() |
+-----------+----------------------------+
Tells Godot which node it should give keyboard focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the ``ui_down`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one.
@@ -658,11 +670,13 @@ Tells Godot which node it should give keyboard focus to if the user presses the
- :ref:`NodePath<class_NodePath>` **focus_neighbour_left**
+----------+----------------------------+
| *Setter* | set_focus_neighbour(value) |
+----------+----------------------------+
| *Getter* | get_focus_neighbour() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | NodePath("") |
+-----------+----------------------------+
| *Setter* | set_focus_neighbour(value) |
+-----------+----------------------------+
| *Getter* | get_focus_neighbour() |
+-----------+----------------------------+
Tells Godot which node it should give keyboard focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the ``ui_left`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the left of this one.
@@ -670,11 +684,13 @@ Tells Godot which node it should give keyboard focus to if the user presses the
- :ref:`NodePath<class_NodePath>` **focus_neighbour_right**
+----------+----------------------------+
| *Setter* | set_focus_neighbour(value) |
+----------+----------------------------+
| *Getter* | get_focus_neighbour() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | NodePath("") |
+-----------+----------------------------+
| *Setter* | set_focus_neighbour(value) |
+-----------+----------------------------+
| *Getter* | get_focus_neighbour() |
+-----------+----------------------------+
Tells Godot which node it should give keyboard focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the ``ui_right`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one.
@@ -682,11 +698,13 @@ Tells Godot which node it should give keyboard focus to if the user presses the
- :ref:`NodePath<class_NodePath>` **focus_neighbour_top**
+----------+----------------------------+
| *Setter* | set_focus_neighbour(value) |
+----------+----------------------------+
| *Getter* | get_focus_neighbour() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | NodePath("") |
+-----------+----------------------------+
| *Setter* | set_focus_neighbour(value) |
+-----------+----------------------------+
| *Getter* | get_focus_neighbour() |
+-----------+----------------------------+
Tells Godot which node it should give keyboard focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the ``ui_top`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one.
@@ -694,11 +712,13 @@ Tells Godot which node it should give keyboard focus to if the user presses the
- :ref:`NodePath<class_NodePath>` **focus_next**
+----------+-----------------------+
| *Setter* | set_focus_next(value) |
+----------+-----------------------+
| *Getter* | get_focus_next() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | NodePath("") |
+-----------+-----------------------+
| *Setter* | set_focus_next(value) |
+-----------+-----------------------+
| *Getter* | get_focus_next() |
+-----------+-----------------------+
Tells Godot which node it should give keyboard focus to if the user presses Tab on a keyboard by default. You can change the key by editing the ``ui_focus_next`` input action.
@@ -708,11 +728,13 @@ If this property is not set, Godot will select a "best guess" based on surroundi
- :ref:`NodePath<class_NodePath>` **focus_previous**
+----------+---------------------------+
| *Setter* | set_focus_previous(value) |
+----------+---------------------------+
| *Getter* | get_focus_previous() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | NodePath("") |
+-----------+---------------------------+
| *Setter* | set_focus_previous(value) |
+-----------+---------------------------+
| *Getter* | get_focus_previous() |
+-----------+---------------------------+
Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab on a keyboard by default. You can change the key by editing the ``ui_focus_prev`` input action.
@@ -722,11 +744,13 @@ If this property is not set, Godot will select a "best guess" based on surroundi
- :ref:`GrowDirection<enum_Control_GrowDirection>` **grow_horizontal**
+----------+-----------------------------+
| *Setter* | set_h_grow_direction(value) |
+----------+-----------------------------+
| *Getter* | get_h_grow_direction() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | 1 |
+-----------+-----------------------------+
| *Setter* | set_h_grow_direction(value) |
+-----------+-----------------------------+
| *Getter* | get_h_grow_direction() |
+-----------+-----------------------------+
Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.
@@ -734,11 +758,13 @@ Controls the direction on the horizontal axis in which the control should grow i
- :ref:`GrowDirection<enum_Control_GrowDirection>` **grow_vertical**
+----------+-----------------------------+
| *Setter* | set_v_grow_direction(value) |
+----------+-----------------------------+
| *Getter* | get_v_grow_direction() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | 1 |
+-----------+-----------------------------+
| *Setter* | set_v_grow_direction(value) |
+-----------+-----------------------------+
| *Getter* | get_v_grow_direction() |
+-----------+-----------------------------+
Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.
@@ -746,9 +772,11 @@ Controls the direction on the vertical axis in which the control should grow if
- :ref:`String<class_String>` **hint_tooltip**
+----------+--------------------+
| *Setter* | set_tooltip(value) |
+----------+--------------------+
+-----------+--------------------+
| *Default* | "" |
+-----------+--------------------+
| *Setter* | set_tooltip(value) |
+-----------+--------------------+
Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the :ref:`mouse_filter<class_Control_property_mouse_filter>` property is not :ref:`MOUSE_FILTER_IGNORE<class_Control_constant_MOUSE_FILTER_IGNORE>`.
@@ -756,11 +784,13 @@ Changes the tooltip text. The tooltip appears when the user's mouse cursor stays
- :ref:`float<class_float>` **margin_bottom**
+----------+-------------------+
| *Setter* | set_margin(value) |
+----------+-------------------+
| *Getter* | get_margin() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 0.0 |
+-----------+-------------------+
| *Setter* | set_margin(value) |
+-----------+-------------------+
| *Getter* | get_margin() |
+-----------+-------------------+
Distance between the node's bottom edge and its parent control, based on :ref:`anchor_bottom<class_Control_property_anchor_bottom>`.
@@ -770,11 +800,13 @@ Margins are often controlled by one or multiple parent :ref:`Container<class_Con
- :ref:`float<class_float>` **margin_left**
+----------+-------------------+
| *Setter* | set_margin(value) |
+----------+-------------------+
| *Getter* | get_margin() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 0.0 |
+-----------+-------------------+
| *Setter* | set_margin(value) |
+-----------+-------------------+
| *Getter* | get_margin() |
+-----------+-------------------+
Distance between the node's left edge and its parent control, based on :ref:`anchor_left<class_Control_property_anchor_left>`.
@@ -784,11 +816,13 @@ Margins are often controlled by one or multiple parent :ref:`Container<class_Con
- :ref:`float<class_float>` **margin_right**
+----------+-------------------+
| *Setter* | set_margin(value) |
+----------+-------------------+
| *Getter* | get_margin() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 0.0 |
+-----------+-------------------+
| *Setter* | set_margin(value) |
+-----------+-------------------+
| *Getter* | get_margin() |
+-----------+-------------------+
Distance between the node's right edge and its parent control, based on :ref:`anchor_right<class_Control_property_anchor_right>`.
@@ -798,11 +832,13 @@ Margins are often controlled by one or multiple parent :ref:`Container<class_Con
- :ref:`float<class_float>` **margin_top**
+----------+-------------------+
| *Setter* | set_margin(value) |
+----------+-------------------+
| *Getter* | get_margin() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 0.0 |
+-----------+-------------------+
| *Setter* | set_margin(value) |
+-----------+-------------------+
| *Getter* | get_margin() |
+-----------+-------------------+
Distance between the node's top edge and its parent control, based on :ref:`anchor_top<class_Control_property_anchor_top>`.
@@ -812,11 +848,13 @@ Margins are often controlled by one or multiple parent :ref:`Container<class_Con
- :ref:`CursorShape<enum_Control_CursorShape>` **mouse_default_cursor_shape**
+----------+---------------------------------+
| *Setter* | set_default_cursor_shape(value) |
+----------+---------------------------------+
| *Getter* | get_default_cursor_shape() |
+----------+---------------------------------+
+-----------+---------------------------------+
| *Default* | 0 |
+-----------+---------------------------------+
| *Setter* | set_default_cursor_shape(value) |
+-----------+---------------------------------+
| *Getter* | get_default_cursor_shape() |
+-----------+---------------------------------+
The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors.
@@ -826,11 +864,13 @@ The default cursor shape for this control. Useful for Godot plugins and applicat
- :ref:`MouseFilter<enum_Control_MouseFilter>` **mouse_filter**
+----------+-------------------------+
| *Setter* | set_mouse_filter(value) |
+----------+-------------------------+
| *Getter* | get_mouse_filter() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 0 |
+-----------+-------------------------+
| *Setter* | set_mouse_filter(value) |
+-----------+-------------------------+
| *Getter* | get_mouse_filter() |
+-----------+-------------------------+
Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input<class_Control_method__gui_input>` and how these events should be handled. Also controls whether the control can receive the :ref:`mouse_entered<class_Control_signal_mouse_entered>`, and :ref:`mouse_exited<class_Control_signal_mouse_exited>` signals. See the constants to learn what each does.
@@ -838,11 +878,13 @@ Controls whether the control will be able to receive mouse button input events t
- :ref:`bool<class_bool>` **rect_clip_content**
+----------+--------------------------+
| *Setter* | set_clip_contents(value) |
+----------+--------------------------+
| *Getter* | is_clipping_contents() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | false |
+-----------+--------------------------+
| *Setter* | set_clip_contents(value) |
+-----------+--------------------------+
| *Getter* | is_clipping_contents() |
+-----------+--------------------------+
Enables whether rendering of children should be clipped to this control's rectangle. If ``true``, parts of a child which would be visibly outside of this control's rectangle will not be rendered.
@@ -860,11 +902,13 @@ The node's global position, relative to the world (usually to the top-left corne
- :ref:`Vector2<class_Vector2>` **rect_min_size**
+----------+--------------------------------+
| *Setter* | set_custom_minimum_size(value) |
+----------+--------------------------------+
| *Getter* | get_custom_minimum_size() |
+----------+--------------------------------+
+-----------+--------------------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+--------------------------------+
| *Setter* | set_custom_minimum_size(value) |
+-----------+--------------------------------+
| *Getter* | get_custom_minimum_size() |
+-----------+--------------------------------+
The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes.
@@ -872,11 +916,13 @@ The minimum size of the node's bounding rectangle. If you set it to a value grea
- :ref:`Vector2<class_Vector2>` **rect_pivot_offset**
+----------+-------------------------+
| *Setter* | set_pivot_offset(value) |
+----------+-------------------------+
| *Getter* | get_pivot_offset() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+-------------------------+
| *Setter* | set_pivot_offset(value) |
+-----------+-------------------------+
| *Getter* | get_pivot_offset() |
+-----------+-------------------------+
By default, the node's pivot is its top-left corner. When you change its :ref:`rect_scale<class_Control_property_rect_scale>`, it will scale around this pivot. Set this property to :ref:`rect_size<class_Control_property_rect_size>` / 2 to center the pivot in the node's rectangle.
@@ -884,9 +930,11 @@ By default, the node's pivot is its top-left corner. When you change its :ref:`r
- :ref:`Vector2<class_Vector2>` **rect_position**
+----------+----------------+
| *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>`.
@@ -894,11 +942,13 @@ The node's position, relative to its parent. It corresponds to the rectangle's t
- :ref:`float<class_float>` **rect_rotation**
+----------+-----------------------------+
| *Setter* | set_rotation_degrees(value) |
+----------+-----------------------------+
| *Getter* | get_rotation_degrees() |
+----------+-----------------------------+
+-----------+-----------------------------+
| *Default* | 0.0 |
+-----------+-----------------------------+
| *Setter* | set_rotation_degrees(value) |
+-----------+-----------------------------+
| *Getter* | get_rotation_degrees() |
+-----------+-----------------------------+
The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset<class_Control_property_rect_pivot_offset>` to change the pivot's position.
@@ -906,11 +956,13 @@ The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset<cl
- :ref:`Vector2<class_Vector2>` **rect_scale**
+----------+------------------+
| *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>`.
@@ -918,9 +970,11 @@ The node's scale, relative to its :ref:`rect_size<class_Control_property_rect_si
- :ref:`Vector2<class_Vector2>` **rect_size**
+----------+------------+
| *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.
@@ -928,11 +982,13 @@ The size of the node's bounding rectangle, in pixels. :ref:`Container<class_Cont
- :ref:`int<class_int>` **size_flags_horizontal**
+----------+-------------------------+
| *Setter* | set_h_size_flags(value) |
+----------+-------------------------+
| *Getter* | get_h_size_flags() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 1 |
+-----------+-------------------------+
| *Setter* | set_h_size_flags(value) |
+-----------+-------------------------+
| *Getter* | get_h_size_flags() |
+-----------+-------------------------+
Tells the parent :ref:`Container<class_Container>` nodes how they should resize and place the node on the X axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does.
@@ -940,11 +996,13 @@ Tells the parent :ref:`Container<class_Container>` nodes how they should resize
- :ref:`float<class_float>` **size_flags_stretch_ratio**
+----------+--------------------------+
| *Setter* | set_stretch_ratio(value) |
+----------+--------------------------+
| *Getter* | get_stretch_ratio() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 1.0 |
+-----------+--------------------------+
| *Setter* | set_stretch_ratio(value) |
+-----------+--------------------------+
| *Getter* | get_stretch_ratio() |
+-----------+--------------------------+
If the node and at least one of its neighbours uses the :ref:`SIZE_EXPAND<class_Control_constant_SIZE_EXPAND>` size flag, the parent :ref:`Container<class_Container>` will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space.
@@ -952,11 +1010,13 @@ If the node and at least one of its neighbours uses the :ref:`SIZE_EXPAND<class_
- :ref:`int<class_int>` **size_flags_vertical**
+----------+-------------------------+
| *Setter* | set_v_size_flags(value) |
+----------+-------------------------+
| *Getter* | get_v_size_flags() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | 1 |
+-----------+-------------------------+
| *Setter* | set_v_size_flags(value) |
+-----------+-------------------------+
| *Getter* | get_v_size_flags() |
+-----------+-------------------------+
Tells the parent :ref:`Container<class_Container>` nodes how they should resize and place the node on the Y axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does.
@@ -964,11 +1024,13 @@ Tells the parent :ref:`Container<class_Container>` nodes how they should resize
- :ref:`Theme<class_Theme>` **theme**
+----------+------------------+
| *Setter* | set_theme(value) |
+----------+------------------+
| *Getter* | get_theme() |
+----------+------------------+
+-----------+------------------+
| *Default* | null |
+-----------+------------------+
| *Setter* | set_theme(value) |
+-----------+------------------+
| *Getter* | get_theme() |
+-----------+------------------+
Changing this property replaces the current :ref:`Theme<class_Theme>` resource this node and all its ``Control`` children use.

18
classes/class_convexpolygonshape.rst
View File

@@ -19,9 +19,9 @@ Convex polygon shape for 3D physics.
Properties
----------
+-------------------------------------------------+---------------------------------------------------------+
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`points<class_ConvexPolygonShape_property_points>` |
+-------------------------------------------------+---------------------------------------------------------+
+-------------------------------------------------+---------------------------------------------------------+----------------------+
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`points<class_ConvexPolygonShape_property_points>` | PoolVector3Array( ) |
+-------------------------------------------------+---------------------------------------------------------+----------------------+
Description
-----------
@@ -35,11 +35,13 @@ Property Descriptions
- :ref:`PoolVector3Array<class_PoolVector3Array>` **points**
+----------+-------------------+
| *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.

18
classes/class_convexpolygonshape2d.rst
View File

@@ -19,9 +19,9 @@ Convex polygon shape for 2D physics.
Properties
----------
+-------------------------------------------------+-----------------------------------------------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`points<class_ConvexPolygonShape2D_property_points>` |
+-------------------------------------------------+-----------------------------------------------------------+
+-------------------------------------------------+-----------------------------------------------------------+----------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`points<class_ConvexPolygonShape2D_property_points>` | PoolVector2Array( ) |
+-------------------------------------------------+-----------------------------------------------------------+----------------------+
Methods
-------
@@ -44,11 +44,13 @@ Property Descriptions
- :ref:`PoolVector2Array<class_PoolVector2Array>` **points**
+----------+-------------------+
| *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.

990
classes/class_cpuparticles.rst
View File

File diff suppressed because it is too large Load Diff

982
classes/class_cpuparticles2d.rst
View File

File diff suppressed because it is too large Load Diff

66
classes/class_csgbox.rst
View File

@@ -19,15 +19,15 @@ A CSG Box shape.
Properties
----------
+---------------------------------+-------------------------------------------------+
| :ref:`float<class_float>` | :ref:`depth<class_CSGBox_property_depth>` |
+---------------------------------+-------------------------------------------------+
| :ref:`float<class_float>` | :ref:`height<class_CSGBox_property_height>` |
+---------------------------------+-------------------------------------------------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGBox_property_material>` |
+---------------------------------+-------------------------------------------------+
| :ref:`float<class_float>` | :ref:`width<class_CSGBox_property_width>` |
+---------------------------------+-------------------------------------------------+
+---------------------------------+-------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`depth<class_CSGBox_property_depth>` | 2.0 |
+---------------------------------+-------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`height<class_CSGBox_property_height>` | 2.0 |
+---------------------------------+-------------------------------------------------+------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGBox_property_material>` | null |
+---------------------------------+-------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`width<class_CSGBox_property_width>` | 2.0 |
+---------------------------------+-------------------------------------------------+------+
Description
-----------
@@ -41,11 +41,13 @@ Property Descriptions
- :ref:`float<class_float>` **depth**
+----------+------------------+
| *Setter* | set_depth(value) |
+----------+------------------+
| *Getter* | get_depth() |
+----------+------------------+
+-----------+------------------+
| *Default* | 2.0 |
+-----------+------------------+
| *Setter* | set_depth(value) |
+-----------+------------------+
| *Getter* | get_depth() |
+-----------+------------------+
Depth of the box measured from the center of the box.
@@ -53,11 +55,13 @@ Depth of the box measured from the center of the box.
- :ref:`float<class_float>` **height**
+----------+-------------------+
| *Setter* | set_height(value) |
+----------+-------------------+
| *Getter* | get_height() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 2.0 |
+-----------+-------------------+
| *Setter* | set_height(value) |
+-----------+-------------------+
| *Getter* | get_height() |
+-----------+-------------------+
Height of the box measured from the center of the box.
@@ -65,11 +69,13 @@ Height of the box measured from the center of the box.
- :ref:`Material<class_Material>` **material**
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
The material used to render the box.
@@ -77,11 +83,13 @@ The material used to render the box.
- :ref:`float<class_float>` **width**
+----------+------------------+
| *Setter* | set_width(value) |
+----------+------------------+
| *Getter* | get_width() |
+----------+------------------+
+-----------+------------------+
| *Default* | 2.0 |
+-----------+------------------+
| *Setter* | set_width(value) |
+-----------+------------------+
| *Getter* | get_width() |
+-----------+------------------+
Width of the box measured from the center of the box.

98
classes/class_csgcylinder.rst
View File

@@ -19,19 +19,19 @@ A CSG Cylinder shape.
Properties
----------
+---------------------------------+--------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`cone<class_CSGCylinder_property_cone>` |
+---------------------------------+--------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`height<class_CSGCylinder_property_height>` |
+---------------------------------+--------------------------------------------------------------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGCylinder_property_material>` |
+---------------------------------+--------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`radius<class_CSGCylinder_property_radius>` |
+---------------------------------+--------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sides<class_CSGCylinder_property_sides>` |
+---------------------------------+--------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`smooth_faces<class_CSGCylinder_property_smooth_faces>` |
+---------------------------------+--------------------------------------------------------------+
+---------------------------------+--------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`cone<class_CSGCylinder_property_cone>` | false |
+---------------------------------+--------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`height<class_CSGCylinder_property_height>` | 1.0 |
+---------------------------------+--------------------------------------------------------------+-------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGCylinder_property_material>` | null |
+---------------------------------+--------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`radius<class_CSGCylinder_property_radius>` | 1.0 |
+---------------------------------+--------------------------------------------------------------+-------+
| :ref:`int<class_int>` | :ref:`sides<class_CSGCylinder_property_sides>` | 8 |
+---------------------------------+--------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`smooth_faces<class_CSGCylinder_property_smooth_faces>` | true |
+---------------------------------+--------------------------------------------------------------+-------+
Description
-----------
@@ -45,11 +45,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **cone**
+----------+-----------------+
| *Setter* | set_cone(value) |
+----------+-----------------+
| *Getter* | is_cone() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | false |
+-----------+-----------------+
| *Setter* | set_cone(value) |
+-----------+-----------------+
| *Getter* | is_cone() |
+-----------+-----------------+
If ``true`` a cone is created, the :ref:`radius<class_CSGCylinder_property_radius>` will only apply to one side.
@@ -57,11 +59,13 @@ If ``true`` a cone is created, the :ref:`radius<class_CSGCylinder_property_radiu
- :ref:`float<class_float>` **height**
+----------+-------------------+
| *Setter* | set_height(value) |
+----------+-------------------+
| *Getter* | get_height() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1.0 |
+-----------+-------------------+
| *Setter* | set_height(value) |
+-----------+-------------------+
| *Getter* | get_height() |
+-----------+-------------------+
The height of the cylinder.
@@ -69,11 +73,13 @@ The height of the cylinder.
- :ref:`Material<class_Material>` **material**
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
The material used to render the cylinder.
@@ -81,11 +87,13 @@ The material used to render the cylinder.
- :ref:`float<class_float>` **radius**
+----------+-------------------+
| *Setter* | set_radius(value) |
+----------+-------------------+
| *Getter* | get_radius() |
+----------+-------------------+
+-----------+-------------------+
| *Default* | 1.0 |
+-----------+-------------------+
| *Setter* | set_radius(value) |
+-----------+-------------------+
| *Getter* | get_radius() |
+-----------+-------------------+
The radius of the cylinder.
@@ -93,11 +101,13 @@ The radius of the cylinder.
- :ref:`int<class_int>` **sides**
+----------+------------------+
| *Setter* | set_sides(value) |
+----------+------------------+
| *Getter* | get_sides() |
+----------+------------------+
+-----------+------------------+
| *Default* | 8 |
+-----------+------------------+
| *Setter* | set_sides(value) |
+-----------+------------------+
| *Getter* | get_sides() |
+-----------+------------------+
The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.
@@ -105,11 +115,13 @@ The number of sides of the cylinder, the higher this number the more detail ther
- :ref:`bool<class_bool>` **smooth_faces**
+----------+-------------------------+
| *Setter* | set_smooth_faces(value) |
+----------+-------------------------+
| *Getter* | get_smooth_faces() |
+----------+-------------------------+
+-----------+-------------------------+
| *Default* | true |
+-----------+-------------------------+
| *Setter* | set_smooth_faces(value) |
+-----------+-------------------------+
| *Getter* | get_smooth_faces() |
+-----------+-------------------------+
If ``true`` the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If ``false`` the cylinder will have a flat shaded look.

34
classes/class_csgmesh.rst
View File

@@ -19,11 +19,11 @@ A CSG Mesh shape that uses a mesh resource.
Properties
----------
+---------------------------------+--------------------------------------------------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGMesh_property_material>` |
+---------------------------------+--------------------------------------------------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CSGMesh_property_mesh>` |
+---------------------------------+--------------------------------------------------+
+---------------------------------+--------------------------------------------------+------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGMesh_property_material>` | null |
+---------------------------------+--------------------------------------------------+------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CSGMesh_property_mesh>` | null |
+---------------------------------+--------------------------------------------------+------+
Description
-----------
@@ -37,21 +37,25 @@ Property Descriptions
- :ref:`Material<class_Material>` **material**
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | null |
+-----------+---------------------+
| *Setter* | set_material(value) |
+-----------+---------------------+
| *Getter* | get_material() |
+-----------+---------------------+
.. _class_CSGMesh_property_mesh:
- :ref:`Mesh<class_Mesh>` **mesh**
+----------+-----------------+
| *Setter* | set_mesh(value) |
+----------+-----------------+
| *Getter* | get_mesh() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | null |
+-----------+-----------------+
| *Setter* | set_mesh(value) |
+-----------+-----------------+
| *Getter* | get_mesh() |
+-----------+-----------------+
The mesh resource to use as a CSG shape.

Some files were not shown because too many files have changed in this diff Show More